TArrowStep
extends TField
in package
implements
AdiantiWidgetInterface
Arrow Step
Tags
Table of Contents
Interfaces
- AdiantiWidgetInterface
- Widget Interface
Properties
- $action : mixed
- $className : mixed
- $color : mixed
- $colorItems : mixed
- $container : mixed
- $disableColor : mixed
- $disableFontColor : mixed
- $editable : mixed
- $fontColor : mixed
- $fontSize : mixed
- $formName : mixed
- $height : mixed
- $hideText : mixed
- $id : mixed
- $items : mixed
- $label : mixed
- $name : mixed
- $properties : mixed
- $selected : mixed
- $size : mixed
- $tag : mixed
- $value : mixed
- $valueCallback : mixed
- $width : mixed
- $validations : mixed
Methods
- __call() : mixed
- Redirects function call
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Constructor
- __get() : mixed
- Returns a property value
- __isset() : mixed
- Returns if the property is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- addItem() : mixed
- Add an item
- addItems() : mixed
- Add items
- addValidation() : mixed
- Add a field validator
- clearField() : mixed
- Clear currents item on steps
- defineCurrent() : mixed
- Define current item on steps
- disableField() : mixed
- Disable field
- enableField() : mixed
- Enable field
- getAction() : mixed
- Get action
- getContents() : mixed
- Returns the element content as a string
- getCurrent() : mixed
- Get current item
- getEditable() : A
- Returns if the field is editable
- getFormName() : mixed
- Return the name of the form to wich the field is attached
- getHeight() : mixed
- Get heigth
- getId() : mixed
- Returns the field's id
- getItem() : mixed
- Get item
- getItems() : mixed
- Get items
- getLabel() : mixed
- Returns the field's label
- getName() : mixed
- Get name
- getPostData() : mixed
- Return the post data
- getPropertiesAsString() : mixed
- Get properties as string
- getProperty() : mixed
- Return a field property
- getSize() : mixed
- Get size
- getValidations() : mixed
- Returns field validations
- getValue() : mixed
- Get value current step
- getWidth() : mixed
- Get width
- isRequired() : mixed
- Returns if the field is required
- setAction() : mixed
- Set action
- setColorItems() : mixed
- Set color items
- setCurrent() : mixed
- Select current item
- setCurrentKey() : mixed
- Select current item
- setEditable() : mixed
- Define if the field is editable
- setFilledColor() : mixed
- Set color arrows
- setFilledFontColor() : mixed
- Set font color arrows
- setFontSize() : mixed
- Set font size
- setFormName() : mixed
- Set form name
- setHeight() : mixed
- Set height arrows
- setHideText() : mixed
- Set hide text
- setId() : mixed
- Define the field's id
- setItems() : mixed
- Set items
- setLabel() : mixed
- Define the field's label
- setName() : mixed
- Set name
- setProperty() : mixed
- Define a field property
- setSize() : mixed
- Set sizes
- setTagName() : mixed
- Change input tag name
- setTip() : mixed
- Define the field's tooltip
- setUnfilledColor() : mixed
- Set color arrows
- setUnfilledFontColor() : mixed
- Set color arrows
- setValue() : mixed
- Set value current step
- setValueCallback() : mixed
- Set callback for setValue method
- setWidth() : mixed
- Set width
- show() : mixed
- Show component
- validate() : mixed
- Validate a field
- getSerializedAction() : mixed
- Get action in serialized way
- makeItem() : mixed
- Make a html of item
- makeStyle() : mixed
- Make component style
Properties
$action
protected
mixed
$action
$className
protected
mixed
$className
$color
protected
mixed
$color
$colorItems
protected
mixed
$colorItems
$container
protected
mixed
$container
$disableColor
protected
mixed
$disableColor
$disableFontColor
protected
mixed
$disableFontColor
$editable
protected
mixed
$editable
$fontColor
protected
mixed
$fontColor
$fontSize
protected
mixed
$fontSize
$formName
protected
mixed
$formName
$height
protected
mixed
$height
$hideText
protected
mixed
$hideText
$id
protected
mixed
$id
$items
protected
mixed
$items
$label
protected
mixed
$label
$name
protected
mixed
$name
$properties
protected
mixed
$properties
$selected
protected
mixed
$selected
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$width
protected
mixed
$width
$validations
private
mixed
$validations
Methods
__call()
Redirects function call
public
__call( $method, $param) : mixed
Parameters
__clone()
Clone the object
public
__clone() : mixed
__construct()
Constructor
public
__construct(mixed $name) : mixed
Parameters
- $name : mixed
-
name of the field
__get()
Returns a property value
public
__get( $name) : mixed
Parameters
__isset()
Returns if the property is set
public
__isset( $name) : mixed
Parameters
__set()
Intercepts whenever someones assign a new property's value
public
__set( $name, $value) : mixed
Parameters
__toString()
Converts the object into a string
public
__toString() : mixed
addItem()
Add an item
public
addItem( $title[, $id = null ][, $color = null ]) : mixed
Parameters
addItems()
Add items
public
addItems(mixed $items) : mixed
Parameters
- $items : mixed
addValidation()
Add a field validator
public
addValidation( $label, $validator[, $parameters = NULL ]) : mixed
Parameters
clearField()
Clear currents item on steps
public
static clearField(mixed $formName, $name) : mixed
Parameters
defineCurrent()
Define current item on steps
public
static defineCurrent( $name, $value) : mixed
Parameters
disableField()
Disable field
public
static disableField(mixed $formName, $name) : mixed
Parameters
enableField()
Enable field
public
static enableField(mixed $formName, $name) : mixed
Parameters
getAction()
Get action
public
getAction() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getCurrent()
Get current item
public
getCurrent() : mixed
getEditable()
Returns if the field is editable
public
getEditable() : A
Return values
A —boolean
getFormName()
Return the name of the form to wich the field is attached
public
getFormName() : mixed
getHeight()
Get heigth
public
getHeight() : mixed
getId()
Returns the field's id
public
getId() : mixed
getItem()
Get item
public
getItem(mixed $key) : mixed
Parameters
- $key : mixed
getItems()
Get items
public
getItems() : mixed
getLabel()
Returns the field's label
public
getLabel() : mixed
getName()
Get name
public
getName() : mixed
getPostData()
Return the post data
public
getPostData() : mixed
getPropertiesAsString()
Get properties as string
public
getPropertiesAsString([mixed $filter = null ]) : mixed
Parameters
- $filter : mixed = null
getProperty()
Return a field property
public
getProperty( $name) : mixed
Parameters
getSize()
Get size
public
getSize() : mixed
getValidations()
Returns field validations
public
getValidations() : mixed
getValue()
Get value current step
public
getValue() : mixed
getWidth()
Get width
public
getWidth() : mixed
isRequired()
Returns if the field is required
public
isRequired() : mixed
setAction()
Set action
public
setAction( $action) : mixed
Parameters
setColorItems()
Set color items
public
setColorItems( $colorItems) : mixed
Parameters
setCurrent()
Select current item
public
setCurrent(mixed $title) : mixed
Parameters
- $title : mixed
setCurrentKey()
Select current item
public
setCurrentKey(mixed $key) : mixed
Parameters
- $key : mixed
setEditable()
Define if the field is editable
public
setEditable( $editable) : mixed
Parameters
setFilledColor()
Set color arrows
public
setFilledColor( $color[, $fontColor = null ]) : mixed
Parameters
setFilledFontColor()
Set font color arrows
public
setFilledFontColor(string $fontColor) : mixed
Parameters
- $fontColor : string
setFontSize()
Set font size
public
setFontSize(mixed $fontSize) : mixed
Parameters
- $fontSize : mixed
setFormName()
Set form name
public
setFormName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the name of the form
setHeight()
Set height arrows
public
setHeight( $height) : mixed
Parameters
setHideText()
Set hide text
public
setHideText([ $hide = true ]) : mixed
Parameters
setId()
Define the field's id
public
setId( $id) : mixed
Parameters
setItems()
Set items
public
setItems(mixed $items) : mixed
Parameters
- $items : mixed
setLabel()
Define the field's label
public
setLabel( $label) : mixed
Parameters
setName()
Set name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the field's name
setProperty()
Define a field property
public
setProperty( $name, $value[, mixed $replace = TRUE ]) : mixed
Parameters
setSize()
Set sizes
public
setSize( $width[, mixed $height = null ]) : mixed
Parameters
setTagName()
Change input tag name
public
setTagName(mixed $name) : mixed
Parameters
- $name : mixed
setTip()
Define the field's tooltip
public
setTip(mixed $tip) : mixed
Parameters
- $tip : mixed
setUnfilledColor()
Set color arrows
public
setUnfilledColor( $color[, $fontColor = null ]) : mixed
Parameters
setUnfilledFontColor()
Set color arrows
public
setUnfilledFontColor(string $color) : mixed
Parameters
- $color : string
setValue()
Set value current step
public
setValue(mixed $value) : mixed
Parameters
- $value : mixed
-
A string containing the field's value
setValueCallback()
Set callback for setValue method
public
setValueCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
setWidth()
Set width
public
setWidth( $width) : mixed
Parameters
show()
Show component
public
show() : mixed
validate()
Validate a field
public
validate() : mixed
getSerializedAction()
Get action in serialized way
private
getSerializedAction(mixed $key, mixed $value[, mixed $selected = false ]) : mixed
Parameters
- $key : mixed
- $value : mixed
- $selected : mixed = false
makeItem()
Make a html of item
private
makeItem(mixed $key, mixed $value[, mixed $selected = false ]) : mixed
Parameters
- $key : mixed
- $value : mixed
- $selected : mixed = false
makeStyle()
Make component style
private
makeStyle() : mixed