API Documentação da API
Inscrições abertas para nosso Webinar anual Adianti Framework 2024!
Clique aqui para saber mais
Conheça Características Quem usa Galeria Cursos Docs Fórum
Downloads
Guia rápido Estrutura FAQ Changelog Migração API Guia
Pacote Dominando o Adianti 7
Curso + Livro + Apps exemplo
Curso completo em Video Aulas (114 aulas).
Livro completo em PDF (463 páginas).
Códigos-fontes de Apps de exemplo.
Conhecer agora
API
API do Framework
Documentation

Documentation

TDBCheckGroup extends TCheckGroup
in package
Uses AdiantiDatabaseWidgetTrait

Database CheckBox Widget

Tags
version
7.6
subpackage

wrapper

author

Pablo Dall'Oglio

copyright

Copyright (c) 2006 Adianti Solutions Ltd. (http://www.adianti.com.br)

license

https://adiantiframework.com.br/license

Table of Contents

Properties

$changeFunction  : mixed
$editable  : mixed
$formName  : mixed
$id  : mixed
$items  : 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
$labels  : mixed
$layout  : 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
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
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 checkbox items after it is already shown
reloadFromModel()  : mixed
Reload checkbox from model data
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

$editable

protected mixed $editable

$formName

protected mixed $formName

$properties

protected mixed $properties

$valueCallback

protected mixed $valueCallback

$validations

private mixed $validations

Methods

__call()

Redirects function call

public __call( $method,  $param) : mixed
Parameters
$method :

Method name

$param :

Array of parameters

__clone()

Clone the object

public __clone() : mixed

__construct()

Class Constructor

public __construct( $name,  $database,  $model,  $key,  $value[,  $ordercolumn = NULL ][,  $criteria = NULL ]) : mixed
Parameters
$name :

widget's name

$database :

database name

$model :

model class name

$key :

table field to be used as key in the combo

$value :

table field to be listed in the combo

$ordercolumn : = NULL

column to order the fields (optional)

$criteria : = NULL

criteria (TCriteria object) to filter the model (optional)

__get()

Returns a property value

public __get( $name) : mixed
Parameters
$name :

Property Name

__isset()

Returns if the property is set

public __isset( $name) : mixed
Parameters
$name :

Property Name

__set()

Intercepts whenever someones assign a new property's value

public __set( $name,  $value) : mixed
Parameters
$name :

Property Name

$value :

Property Value

__toString()

Converts the object into a string

public __toString() : mixed

addItems()

Add items to the check group

public addItems( $items) : mixed
Parameters
$items :

An indexed array containing the options

addValidation()

Add a field validator

public addValidation( $label,  $validator[,  $parameters = NULL ]) : mixed
Parameters
$label :

Field name

$validator :

TFieldValidator object

$parameters : = NULL

Aditional parameters

checkAll()

Check all options

public checkAll() : mixed

clearField()

Clear the field

public static clearField( $form_name,  $field) : mixed
Parameters
$form_name :

Form name

$field :

Field name

disableField()

Disable the field

public static disableField( $form_name,  $field) : mixed
Parameters
$form_name :

Form name

$field :

Field name

enableField()

Enable the field

public static enableField( $form_name,  $field) : mixed
Parameters
$form_name :

Form name

$field :

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 $criteria = NULL ]) : mixed
Parameters
$database : mixed
$model : mixed
$key : mixed
$value : mixed
$ordercolumn : mixed = NULL
$criteria : TCriteria = 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 $criteria = NULL ]) : mixed
Parameters
$database : mixed
$model : mixed
$key : mixed
$ordercolumn : mixed = NULL
$criteria : TCriteria = 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( $name) : mixed
Parameters
$name :

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( $formname,  $name,  $items,  $options) : mixed
Parameters
$formname :

form name (used in gtk version)

$name :

field name

$items :

array with items

$options :

array of options [layout, size, breakItems, useButton, valueSeparator, value, changeAction, changeFunction, checkAll]

reloadFromModel()

Reload checkbox from model data

public static reloadFromModel( $formname,  $field,  $database,  $model,  $key,  $value[,  $ordercolumn = NULL ][,  $criteria = NULL ][,  $options = [] ]) : mixed
Parameters
$formname :

form name

$field :

field name

$database :

database name

$model :

model class name

$key :

table field to be used as key in the checkbox

$value :

table field to be listed in the checkbox

$ordercolumn : = NULL

column to order the fields (optional)

$criteria : = NULL

criteria (TCriteria object) to filter the model (optional)

$options : = []

array of options [layout, breakItems, useButton, value, valueSeparator, changeAction, changeFunction]

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( $action) : mixed
Parameters
$action :

TAction object

setChangeFunction()

Set change function

public setChangeFunction(mixed $function) : mixed
Parameters
$function : mixed

setEditable()

Define if the field is editable

public setEditable( $editable) : mixed
Parameters
$editable :

A boolean

setFormName()

Define the name of the form to wich the field is attached

public setFormName( $name) : mixed
Parameters
$name :

A string containing the name of the form

Tags
ignore-autocomplete

on

setId()

Define the field's id

public setId( $id) : mixed
Parameters
$id :

A string containing the field's id

setLabel()

Define the field's label

public setLabel( $label) : mixed
Parameters
$label :

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( $name) : mixed
Parameters
$name :

A string containing the field's name

setProperty()

Define a field property

public setProperty( $name,  $value[, mixed $replace = TRUE ]) : mixed
Parameters
$name :

Property Name

$value :

Property Value

$replace : mixed = TRUE

setSize()

Define the Field's width

public setSize( $width[, mixed $height = NULL ]) : mixed
Parameters
$width :

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( $value) : mixed
Parameters
$value :

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( $sep) : mixed
Parameters
$sep :

A string containing the field's separator

show()

Shows the widget at the screen

public show() : mixed

validate()

Validate a field

public validate() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results