TText
extends TField
in package
implements
AdiantiWidgetInterface
Text Widget (also known as Memo)
Tags
Table of Contents
Interfaces
- AdiantiWidgetInterface
- Widget Interface
Properties
- $editable : mixed
- $formName : mixed
- $height : mixed
- $id : mixed
- $label : mixed
- $name : mixed
- $properties : mixed
- $size : mixed
- $tag : mixed
- $value : mixed
- $valueCallback : mixed
- $exitAction : mixed
- $exitFunction : 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
- clearField() : mixed
- Clear the field
- disableField() : mixed
- Disable the field
- enableField() : mixed
- Enable the field
- 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() : array<string|int, mixed>
- Returns the size
- getValidations() : mixed
- Returns field validations
- getValue() : mixed
- Returns the field's value
- isRequired() : mixed
- Returns if the field is required
- 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
- Set exit function
- setFormName() : mixed
- Define the name of the form to wich the field is attached
- setId() : mixed
- Define the field's id
- setLabel() : mixed
- Define the field's label
- setMaxLength() : mixed
- Define max length
- setName() : mixed
- Define the field's name
- setProperty() : mixed
- Define a field property
- setSize() : mixed
- Define the widget's size
- 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
- Show the widget
- validate() : mixed
- Validate a field
Properties
$editable
protected
mixed
$editable
$formName
protected
mixed
$formName
$height
protected
mixed
$height
$id
protected
mixed
$id
$label
protected
mixed
$label
$name
protected
mixed
$name
$properties
protected
mixed
$properties
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$exitAction
private
mixed
$exitAction
$exitFunction
private
mixed
$exitFunction
$validations
private
mixed
$validations
Methods
__call()
Redirects function call
public
__call( $method, $param) : mixed
Parameters
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct( $name) : mixed
Parameters
__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
addValidation()
Add a field validator
public
addValidation( $label, $validator[, $parameters = NULL ]) : mixed
Parameters
clearField()
Clear the field
public
static clearField( $form_name, $field) : mixed
Parameters
disableField()
Disable the field
public
static disableField( $form_name, $field) : mixed
Parameters
enableField()
Enable the field
public
static enableField( $form_name, $field) : mixed
Parameters
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( $name) : mixed
Parameters
getSize()
Returns the size
public
getSize() : array<string|int, mixed>
Return values
array<string|int, 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
setEditable()
Define if the field is editable
public
setEditable( $editable) : mixed
Parameters
setExitAction()
Define the action to be executed when the user leaves the form field
public
setExitAction( $action) : mixed
Parameters
setExitFunction()
Set exit function
public
setExitFunction(mixed $function) : mixed
Parameters
- $function : mixed
setFormName()
Define the name of the form to wich the field is attached
public
setFormName( $name) : mixed
Parameters
Tags
setId()
Define the field's id
public
setId( $id) : mixed
Parameters
setLabel()
Define the field's label
public
setLabel( $label) : mixed
Parameters
setMaxLength()
Define max length
public
setMaxLength( $length) : mixed
Parameters
setName()
Define the field's name
public
setName( $name) : mixed
Parameters
setProperty()
Define a field property
public
setProperty( $name, $value[, mixed $replace = TRUE ]) : mixed
Parameters
setSize()
Define the widget's size
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
setValue()
Define the field's value
public
setValue( $value) : mixed
Parameters
setValueCallback()
Set callback for setValue method
public
setValueCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
show()
Show the widget
public
show() : mixed
validate()
Validate a field
public
validate() : mixed