TCheckGroup
extends TField
in package
implements
AdiantiWidgetInterface
A group of CheckButton's
Tags
Table of Contents
Interfaces
- AdiantiWidgetInterface
- Widget Interface
Properties
- $changeFunction : mixed
- $editable : mixed
- $formName : mixed
- $id : mixed
- $label : mixed
- $labelClass : mixed
- $name : mixed
- $properties : mixed
- $separator : mixed
- $size : mixed
- $tag : mixed
- $useButton : mixed
- $useSwitch : mixed
- $value : mixed
- $valueCallback : mixed
- $allItemsChecked : mixed
- $breakItems : mixed
- $buttons : mixed
- $changeAction : mixed
- $items : mixed
- $labels : mixed
- $layout : mixed
- $validations : mixed
Methods
- __call() : mixed
- Redirects function call
- __clone() : mixed
- Clone 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
- addItems() : mixed
- Add items to the check group
- addValidation() : mixed
- Add a field validator
- checkAll() : mixed
- Check all options
- clearField() : mixed
- clear the field
- disableField() : mixed
- Disable the field
- enableField() : mixed
- Enable the field
- getButtons() : mixed
- Return the option buttons
- 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
- getItems() : mixed
- Return the items
- getLabel() : mixed
- Returns the field's label
- getLabels() : mixed
- Return the option labels
- getLayout() : mixed
- Get the direction (vertical or horizontal)
- 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
- reload() : mixed
- Reload checkbox items after it is already shown
- setBreakItems() : mixed
- Define after how much items, it will break
- setChangeAction() : mixed
- Define the action to be executed when the user changes the combo
- setChangeFunction() : mixed
- Set change function
- 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
- setLayout() : mixed
- Define the direction of the options
- setName() : mixed
- Define the field's name
- 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
- setUseButton() : mixed
- Show as button
- setUseSwitch() : mixed
- Show as switch
- setValue() : mixed
- Define the field's value
- setValueCallback() : mixed
- Set callback for setValue method
- setValueSeparator() : mixed
- Define the field's separator
- show() : mixed
- Shows the widget at the screen
- validate() : mixed
- Validate a field
Properties
$changeFunction
protected
mixed
$changeFunction
$editable
protected
mixed
$editable
$formName
protected
mixed
$formName
$id
protected
mixed
$id
$label
protected
mixed
$label
$labelClass
protected
mixed
$labelClass
$name
protected
mixed
$name
$properties
protected
mixed
$properties
$separator
protected
mixed
$separator
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$useButton
protected
mixed
$useButton
$useSwitch
protected
mixed
$useSwitch
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$allItemsChecked
private
mixed
$allItemsChecked
$breakItems
private
mixed
$breakItems
$buttons
private
mixed
$buttons
$changeAction
private
mixed
$changeAction
$items
private
mixed
$items
$labels
private
mixed
$labels
$layout
private
mixed
$layout
= 'vertical'
$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 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
addItems()
Add items to the check group
public
addItems(mixed $items) : mixed
Parameters
- $items : mixed
-
An indexed array containing the options
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
checkAll()
Check all options
public
checkAll() : mixed
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
enableField()
Enable the field
public
static enableField(mixed $form_name, mixed $field) : mixed
Parameters
- $form_name : mixed
-
Form name
- $field : mixed
-
Field name
getButtons()
Return the option buttons
public
getButtons() : 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
getItems()
Return the items
public
getItems() : mixed
getLabel()
Returns the field's label
public
getLabel() : mixed
getLabels()
Return the option labels
public
getLabels() : mixed
getLayout()
Get the direction (vertical or horizontal)
public
getLayout() : 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
reload()
Reload checkbox items after it is already shown
public
static reload(mixed $formname, mixed $name, mixed $items, mixed $options) : mixed
Parameters
- $formname : mixed
-
form name (used in gtk version)
- $name : mixed
-
field name
- $items : mixed
-
array with items
- $options : mixed
-
array of options [layout, size, breakItems, useButton, valueSeparator, value, changeAction, changeFunction, checkAll]
setBreakItems()
Define after how much items, it will break
public
setBreakItems(mixed $breakItems) : mixed
Parameters
- $breakItems : mixed
setChangeAction()
Define the action to be executed when the user changes the combo
public
setChangeAction(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction object
setChangeFunction()
Set change function
public
setChangeFunction(mixed $function) : mixed
Parameters
- $function : mixed
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
setLayout()
Define the direction of the options
public
setLayout(mixed $dir) : mixed
Parameters
- $dir : mixed
setName()
Define the field's name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
-
A string containing the field's name
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
setUseButton()
Show as button
public
setUseButton() : mixed
setUseSwitch()
Show as switch
public
setUseSwitch([mixed $useSwitch = TRUE ][, mixed $labelClass = 'blue' ]) : mixed
Parameters
- $useSwitch : mixed = TRUE
- $labelClass : mixed = 'blue'
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
setValueSeparator()
Define the field's separator
public
setValueSeparator(mixed $sep) : mixed
Parameters
- $sep : mixed
-
A string containing the field's separator
show()
Shows the widget at the screen
public
show() : mixed
validate()
Validate a field
public
validate() : mixed