TEntry
extends TField
in package
implements
AdiantiWidgetInterface
Entry Widget
Tags
Table of Contents
Interfaces
- AdiantiWidgetInterface
- Widget Interface
Properties
- $allowNegative : mixed
- $completion : mixed
- $decimals : mixed
- $decimalsSeparator : mixed
- $delimiter : mixed
- $editable : mixed
- $exitAction : mixed
- $exitFunction : mixed
- $exitOnEnterOn : mixed
- $formName : mixed
- $id : mixed
- $innerIcon : mixed
- $label : mixed
- $minLength : mixed
- $name : mixed
- $numericMask : mixed
- $properties : mixed
- $replaceOnPost : mixed
- $reverse : mixed
- $size : mixed
- $tag : mixed
- $thousandSeparator : mixed
- $value : mixed
- $valueCallback : mixed
- $mask : mixed
- $toggleVisibility : mixed
- $validations : mixed
Methods
- __call() : mixed
- Redirects function call
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Class 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
- addValidation() : mixed
- Add a field validator
- changeMask() : mixed
- Change mask dynamically
- clearField() : mixed
- Clear the field
- disableAutoComplete() : mixed
- Disable auto complete
- disableField() : mixed
- Disable the field
- enableField() : mixed
- Enable the field
- enableToggleVisibility() : mixed
- Enable toggle visible
- exitOnEnter() : mixed
- Turn on exit on enter
- forceLowerCase() : mixed
- Force lower case
- forceUpperCase() : mixed
- Force upper case
- getContents() : mixed
- Returns the element content as a string
- getEditable() : A
- Returns if the field is editable
- getFormName() : mixed
- Return the name of the form to wich the field is attached
- getId() : mixed
- Returns the field's id
- getLabel() : mixed
- Returns the field's label
- getName() : mixed
- Returns the field's name
- getPostData() : mixed
- Return the post data
- getPropertiesAsString() : mixed
- Get properties as string
- getProperty() : mixed
- Return a field property
- getSize() : mixed
- Returns the field size
- getValidations() : mixed
- Returns field validations
- getValue() : mixed
- Returns the field's value
- isRequired() : mixed
- Returns if the field is required
- reloadCompletion() : mixed
- Reload completion
- setCompletion() : mixed
- Define options for completion
- setDelimiter() : mixed
- Set autocomplete delimiter
- setEditable() : mixed
- Define if the field is editable
- setExitAction() : mixed
- Define the action to be executed when the user leaves the form field
- setExitFunction() : mixed
- Define the javascript function to be executed when the user leaves the form field
- setFormName() : mixed
- Define the name of the form to wich the field is attached
- setId() : mixed
- Define the field's id
- setInnerIcon() : mixed
- Define the Inner icon
- setInputType() : mixed
- Define input type
- setLabel() : mixed
- Define the field's label
- setMask() : mixed
- Define the field's mask
- setMaxLength() : mixed
- Define max length
- setMinLength() : mixed
- Define the minimum length for search
- setName() : mixed
- Define the field's name
- setNumericMask() : mixed
- Define the field's numeric mask (available just in web)
- setProperty() : mixed
- Define a field property
- setSize() : mixed
- Define the Field's width
- setTagName() : mixed
- Change input tag name
- setTip() : mixed
- Define the field's tooltip
- setValue() : mixed
- Define the field's value
- setValueCallback() : mixed
- Set callback for setValue method
- show() : mixed
- Shows the widget at the screen
- validate() : mixed
- Validate a field
- formatMask() : mixed
- Apply mask
Properties
$allowNegative
protected
mixed
$allowNegative
$completion
protected
mixed
$completion
$decimals
protected
mixed
$decimals
$decimalsSeparator
protected
mixed
$decimalsSeparator
$delimiter
protected
mixed
$delimiter
$editable
protected
mixed
$editable
$exitAction
protected
mixed
$exitAction
$exitFunction
protected
mixed
$exitFunction
$exitOnEnterOn
protected
mixed
$exitOnEnterOn
$formName
protected
mixed
$formName
$id
protected
mixed
$id
$innerIcon
protected
mixed
$innerIcon
$label
protected
mixed
$label
$minLength
protected
mixed
$minLength
$name
protected
mixed
$name
$numericMask
protected
mixed
$numericMask
$properties
protected
mixed
$properties
$replaceOnPost
protected
mixed
$replaceOnPost
$reverse
protected
mixed
$reverse
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$thousandSeparator
protected
mixed
$thousandSeparator
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$mask
private
mixed
$mask
$toggleVisibility
private
mixed
$toggleVisibility
$validations
private
mixed
$validations
Methods
__call()
Redirects function call
public
__call(mixed $method, mixed $param) : mixed
Parameters
- $method : mixed
-
Method name
- $param : mixed
-
Array of parameters
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct(mixed $name) : mixed
Parameters
- $name : mixed
-
name of the field
__get()
Returns a property value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns if the property is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
addValidation()
Add a field validator
public
addValidation(mixed $label, mixed $validator[, mixed $parameters = NULL ]) : mixed
Parameters
- $label : mixed
-
Field name
- $validator : mixed
-
TFieldValidator object
- $parameters : mixed = NULL
-
Aditional parameters
changeMask()
Change mask dynamically
public
static changeMask(mixed $formName, mixed $name, mixed $mask) : mixed
Parameters
- $formName : mixed
- $name : mixed
- $mask : mixed
clearField()
Clear the field
public
static clearField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
disableAutoComplete()
Disable auto complete
public
disableAutoComplete() : mixed
disableField()
Disable the field
public
static disableField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
enableField()
Enable the field
public
static enableField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
enableToggleVisibility()
Enable toggle visible
public
enableToggleVisibility([mixed $toggleVisibility = TRUE ]) : mixed
Parameters
- $toggleVisibility : mixed = TRUE
exitOnEnter()
Turn on exit on enter
public
exitOnEnter() : mixed
forceLowerCase()
Force lower case
public
forceLowerCase() : mixed
forceUpperCase()
Force upper case
public
forceUpperCase() : mixed
getContents()
Returns the element content as a string
public
getContents() : 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
getId()
Returns the field's id
public
getId() : mixed
getLabel()
Returns the field's label
public
getLabel() : mixed
getName()
Returns the field's 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(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
getSize()
Returns the field size
public
getSize() : mixed
getValidations()
Returns field validations
public
getValidations() : mixed
getValue()
Returns the field's value
public
getValue() : mixed
isRequired()
Returns if the field is required
public
isRequired() : mixed
reloadCompletion()
Reload completion
public
static reloadCompletion(mixed $field, mixed $list[, mixed $options = null ]) : mixed
Parameters
- $field : mixed
-
Field name or id
- $list : mixed
- $options : mixed = null
-
array of options for autocomplete
setCompletion()
Define options for completion
public
setCompletion(mixed $options) : mixed
Parameters
- $options : mixed
-
array of options for completion
setDelimiter()
Set autocomplete delimiter
public
setDelimiter(mixed $delimiter) : mixed
Parameters
- $delimiter : mixed
-
autocomplete delimiter
setEditable()
Define if the field is editable
public
setEditable(mixed $editable) : mixed
Parameters
- $editable : mixed
-
A boolean
setExitAction()
Define the action to be executed when the user leaves the form field
public
setExitAction(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction object
setExitFunction()
Define the javascript function to be executed when the user leaves the form field
public
setExitFunction(mixed $function) : mixed
Parameters
- $function : mixed
-
Javascript function
setFormName()
Define the name of the form to wich the field is attached
public
setFormName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the name of the form
Tags
setId()
Define the field's id
public
setId(mixed $id) : mixed
Parameters
- $id : mixed
-
A string containing the field's id
setInnerIcon()
Define the Inner icon
public
setInnerIcon(TImage $image[, mixed $side = 'right' ]) : mixed
Parameters
- $image : TImage
- $side : mixed = 'right'
setInputType()
Define input type
public
setInputType(mixed $type) : mixed
Parameters
- $type : mixed
setLabel()
Define the field's label
public
setLabel(mixed $label) : mixed
Parameters
- $label : mixed
-
A string containing the field's label
setMask()
Define the field's mask
public
setMask(mixed $mask[, mixed $replaceOnPost = FALSE ]) : mixed
Parameters
- $mask : mixed
-
A mask for input data
- $replaceOnPost : mixed = FALSE
setMaxLength()
Define max length
public
setMaxLength(mixed $length) : mixed
Parameters
- $length : mixed
-
Max length
setMinLength()
Define the minimum length for search
public
setMinLength(mixed $length) : mixed
Parameters
- $length : mixed
setName()
Define the field's name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the field's name
setNumericMask()
Define the field's numeric mask (available just in web)
public
setNumericMask(mixed $decimals, mixed $decimalsSeparator, mixed $thousandSeparator[, mixed $replaceOnPost = FALSE ][, mixed $reverse = FALSE ][, mixed $allowNegative = TRUE ]) : mixed
Parameters
- $decimals : mixed
-
Sets the number of decimal points.
- $decimalsSeparator : mixed
-
Sets the separator for the decimal point.
- $thousandSeparator : mixed
-
Sets the thousands separator.
- $replaceOnPost : mixed = FALSE
- $reverse : mixed = FALSE
- $allowNegative : mixed = TRUE
-
Sets negative allowed.
setProperty()
Define a field property
public
setProperty(mixed $name, mixed $value[, mixed $replace = TRUE ]) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
- $replace : mixed = TRUE
setSize()
Define the Field's width
public
setSize(mixed $width[, mixed $height = NULL ]) : mixed
Parameters
- $width : mixed
-
Field's width in pixels
- $height : mixed = NULL
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
setValue()
Define the field's value
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
show()
Shows the widget at the screen
public
show() : mixed
validate()
Validate a field
public
validate() : mixed
formatMask()
Apply mask
protected
formatMask(mixed $mask, mixed $value) : mixed
Parameters
- $mask : mixed
-
Mask
- $value : mixed
-
Value