THtmlEditor
extends TField
in package
implements
AdiantiWidgetInterface
Html Editor
Tags
Table of Contents
Interfaces
- AdiantiWidgetInterface
- Widget Interface
Properties
- $completion : mixed
- $customButtons : mixed
- $editable : mixed
- $formName : mixed
- $id : mixed
- $label : mixed
- $name : mixed
- $options : mixed
- $properties : mixed
- $size : mixed
- $tag : mixed
- $toolbar : mixed
- $value : mixed
- $valueCallback : mixed
- $height : 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
- addCustomButton() : mixed
- Add custom button
- addValidation() : mixed
- Add a field validator
- clearField() : mixed
- Clear the field
- disableField() : mixed
- Disable the field
- disableToolbar() : mixed
- Disable toolbar
- enableField() : mixed
- Enable the field
- 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 size
- getValidations() : mixed
- Returns field validations
- getValue() : mixed
- Returns the field's value
- insertHTML() : mixed
- Insert html
- insertText() : mixed
- Insert text
- isRequired() : mixed
- Returns if the field is required
- reloadCompletion() : mixed
- Reload completion
- setCompletion() : mixed
- Define options for completion
- setEditable() : mixed
- Define if the field is editable
- 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
- setOption() : mixed
- Set extra calendar options
- 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
$completion
protected
mixed
$completion
$customButtons
protected
mixed
$customButtons
$editable
protected
mixed
$editable
$formName
protected
mixed
$formName
$id
protected
mixed
$id
$label
protected
mixed
$label
$name
protected
mixed
$name
$options
protected
mixed
$options
$properties
protected
mixed
$properties
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$toolbar
protected
mixed
$toolbar
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$height
private
mixed
$height
$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
-
Widet's name
__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
addCustomButton()
Add custom button
public
addCustomButton(mixed $name, mixed $function, mixed $title, mixed $icon[, mixed $showLabel = false ]) : mixed
Parameters
- $name : mixed
-
String name action
- $function : mixed
-
String function(context){ }
- $title : mixed
-
String title icon
- $icon : mixed
-
TImage toolbar icon
- $showLabel : mixed = false
Tags
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
clearField()
Clear the field
public
static clearField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
disableField()
Disable the field
public
static disableField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
disableToolbar()
Disable toolbar
public
disableToolbar() : mixed
enableField()
Enable the field
public
static enableField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
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 size
public
getSize() : mixed
Tags
getValidations()
Returns field validations
public
getValidations() : mixed
getValue()
Returns the field's value
public
getValue() : mixed
insertHTML()
Insert html
public
static insertHTML(mixed $form_name, mixed $field, mixed $content) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
- $content : mixed
-
Text content
insertText()
Insert text
public
static insertText(mixed $form_name, mixed $field, mixed $content) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
- $content : mixed
-
Text content
isRequired()
Returns if the field is required
public
isRequired() : mixed
reloadCompletion()
Reload completion
public
static reloadCompletion(mixed $field, mixed $options) : mixed
Parameters
- $field : mixed
-
Field name or id
- $options : mixed
-
array of options for autocomplete
setCompletion()
Define options for completion
public
setCompletion(mixed $options) : mixed
Parameters
- $options : mixed
-
array of options for completion
setEditable()
Define if the field is editable
public
setEditable(mixed $editable) : mixed
Parameters
- $editable : mixed
-
A boolean
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
setLabel()
Define the field's label
public
setLabel(mixed $label) : mixed
Parameters
- $label : mixed
-
A string containing the field's label
setMaxLength()
Define max length
public
setMaxLength(mixed $length) : mixed
Parameters
- $length : mixed
-
Max length
setName()
Define the field's name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the field's name
setOption()
Set extra calendar options
public
setOption(mixed $option, mixed $value) : mixed
Parameters
- $option : mixed
- $value : mixed
Tags
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 widget's size
public
setSize(mixed $width[, mixed $height = NULL ]) : mixed
Parameters
- $width : mixed
-
Widget's width
- $height : mixed = NULL
-
Widget's height
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()
Show the widget
public
show() : mixed
validate()
Validate a field
public
validate() : mixed