TDBRadioGroup
        
        extends TRadioGroup
    
    
            
            in package
            
        
    
    
            
            uses
                            AdiantiDatabaseWidgetTrait                    
    
Database Radio Widget
Tags
Table of Contents
Properties
- $changeFunction : mixed
- $editable : mixed
- $formName : mixed
- $id : mixed
- $is_boolean : mixed
- $items : mixed
- $label : mixed
- $labelClass : mixed
- $name : mixed
- $properties : mixed
- $size : mixed
- $tag : mixed
- $useButton : mixed
- $value : mixed
- $valueCallback : 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 radio group
- addValidation() : mixed
- Add a field validator
- 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
- getItemsFromModel() : mixed
- Get items (key/value) from database to populate widget
- 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
- getObjectsFromModel() : mixed
- Get objects from database to populate widget
- 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 radio items after it is already shown
- reloadFromModel() : mixed
- Reload radio from model data
- setBooleanMode() : mixed
- Enable/disable boolean mode
- 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
- setValue() : mixed
- Define the field's value
- setValueCallback() : mixed
- Set callback for setValue method
- show() : mixed
- Show 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
    
    
    
    
    
    
$is_boolean
        protected
            mixed
    $is_boolean
    
    
    
    
    
    
$items
        protected
            mixed
    $items
    
    
    
    
    
    
$label
        protected
            mixed
    $label
    
    
    
    
    
    
$labelClass
        protected
            mixed
    $labelClass
    
    
    
    
    
    
$name
        protected
            mixed
    $name
    
    
    
    
    
    
$properties
        protected
            mixed
    $properties
    
    
    
    
    
    
$size
        protected
            mixed
    $size
    
    
    
    
    
    
$tag
        protected
            mixed
    $tag
    
    
    
    
    
    
$useButton
        protected
            mixed
    $useButton
    
    
    
    
    
    
$value
        protected
            mixed
    $value
    
    
    
    
    
    
$valueCallback
        protected
            mixed
    $valueCallback
    
    
    
    
    
    
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 $database, mixed $model, mixed $key, mixed $value[, mixed $ordercolumn = NULL ][, mixed $criteria = NULL ]) : mixed
    Parameters
- $name : mixed
- 
                    widget's name 
- $database : mixed
- 
                    database name 
- $model : mixed
- 
                    model class name 
- $key : mixed
- 
                    table field to be used as key in the combo 
- $value : mixed
- 
                    table field to be listed in the combo 
- $ordercolumn : mixed = NULL
- 
                    column to order the fields (optional) 
- $criteria : mixed = NULL
- 
                    criteria (TCriteria object) to filter the model (optional) 
__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 radio 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 
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
    getItemsFromModel()
Get items (key/value) from database to populate widget
    public
            static        getItemsFromModel(mixed $database, mixed $model, mixed $key, mixed $value[, mixed $ordercolumn = NULL ][, TCriteria|null $criteria = NULL ]) : mixed
    Parameters
- $database : mixed
- $model : mixed
- $key : mixed
- $value : mixed
- $ordercolumn : mixed = NULL
- $criteria : TCriteria|null = NULL
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
    getObjectsFromModel()
Get objects from database to populate widget
    public
            static        getObjectsFromModel(mixed $database, mixed $model, mixed $key[, mixed $ordercolumn = NULL ][, TCriteria|null $criteria = NULL ]) : mixed
    Parameters
- $database : mixed
- $model : mixed
- $key : mixed
- $ordercolumn : mixed = NULL
- $criteria : TCriteria|null = NULL
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 radio 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, breakItems, size, useButton, value, changeAction, changeFunction, checkAll] 
reloadFromModel()
Reload radio from model data
    public
            static        reloadFromModel(mixed $formname, mixed $field, mixed $database, mixed $model, mixed $key, mixed $value[, mixed $ordercolumn = NULL ][, mixed $criteria = NULL ][, mixed $options = [] ]) : mixed
    Parameters
- $formname : mixed
- 
                    form name 
- $field : mixed
- 
                    field name 
- $database : mixed
- 
                    database name 
- $model : mixed
- 
                    model class name 
- $key : mixed
- 
                    table field to be used as key in the radio 
- $value : mixed
- 
                    table field to be listed in the radio 
- $ordercolumn : mixed = NULL
- 
                    column to order the fields (optional) 
- $criteria : mixed = NULL
- 
                    criteria (TCriteria object) to filter the model (optional) 
- $options : mixed = []
- 
                    array of options [layout, breakItems, useButton, value, changeAction, changeFunction] 
setBooleanMode()
Enable/disable boolean mode
    public
                    setBooleanMode() : mixed
    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
    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 at the screen
    public
                    show() : mixed
    validate()
Validate a field
    public
                    validate() : mixed