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

TDBCheckList extends TCheckList
in package
Uses AdiantiDatabaseWidgetTrait

Database Checklist

Tags
version
7.6
subpackage

form

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

$checkAllButton  : mixed
$checkColumn  : mixed
$datagrid  : mixed
$fields  : mixed
$formName  : mixed
$idColumn  : mixed
$items  : mixed
$keyColumn  : mixed
$name  : mixed
$selectAction  : mixed
$separator  : mixed
$validations  : mixed
$value  : mixed
$valueColumn  : mixed
$width  : mixed

Methods

__call()  : mixed
Redirect calls to decorated object
__construct()  : mixed
Class Constructor
addColumn()  : mixed
Add list column
addItem()  : mixed
Add item
addItems()  : mixed
add Items
addValidation()  : mixed
Add a field validator
checkAll()  : mixed
checkNone()  : mixed
clear()  : mixed
Clear datagrid
disableCheckAll()  : mixed
Disable check all button
disableField()  : mixed
Disable the field
disableHtmlConversion()  : mixed
Disable htmlspecialchars on output
enableField()  : mixed
Enable the field
fillWith()  : mixed
Fill with model objects
getFields()  : mixed
Get fields
getFormName()  : mixed
Return the name of the form to wich the field is attached
getItemsFromModel()  : mixed
Get items (key/value) from database to populate widget
getName()  : mixed
Returns the field's name
getObjectsFromModel()  : mixed
Get objects from database to populate widget
getPostData()  : mixed
Get post data
getSize()  : mixed
Returns checklist size
getValidations()  : mixed
Returns field validations
getValue()  : mixed
Returns the selected ids
setFormName()  : mixed
Define the name of the form to wich the field is attached
setId()  : mixed
Change Id
setIdColumn()  : mixed
Define the Identification column
setName()  : mixed
Define the field's name
setSelectAction()  : mixed
Define the action to be executed when the user selects a row
setSize()  : mixed
Set checklist size
setValue()  : mixed
Define the checklist selected ids
setValueSeparator()  : mixed
Define the field's separator
show()  : mixed
show
validate()  : mixed
Validate a field

Properties

Methods

__call()

Redirect calls to decorated object

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

__construct()

Class Constructor

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

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)

addColumn()

Add list column

public addColumn( $name,  $label,  $align,  $width) : mixed
Parameters
$name :

= Name of the column in the database

$label :

= Text label that will be shown in the header

$align :

= Column align (left, center, right)

$width :

= Column Width (pixels)

addItem()

Add item

public addItem(mixed $object) : mixed
Parameters
$object : mixed

addItems()

add Items

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

addValidation()

Add a field validator

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

Field name

$validator :

TFieldValidator object

$parameters : = NULL

Aditional parameters

checkAll()

public static checkAll(mixed $name[, mixed $fire_events = true ]) : mixed
Parameters
$name : mixed
$fire_events : mixed = true

checkNone()

public static checkNone(mixed $name[, mixed $fire_events = true ]) : mixed
Parameters
$name : mixed
$fire_events : mixed = true

disableCheckAll()

Disable check all button

public disableCheckAll() : mixed

disableField()

Disable the field

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

Field name

disableHtmlConversion()

Disable htmlspecialchars on output

public disableHtmlConversion() : mixed

enableField()

Enable the field

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

Field name

fillWith()

Fill with model objects

public fillWith(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

getFields()

Get fields

public getFields() : mixed

getFormName()

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

public getFormName() : 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

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()

Get post data

public getPostData() : mixed

getSize()

Returns checklist size

public getSize() : mixed

getValidations()

Returns field validations

public getValidations() : mixed

getValue()

Returns the selected ids

public getValue() : mixed

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()

Change Id

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

setIdColumn()

Define the Identification column

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

setName()

Define the field's name

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

A string containing the field's name

setSelectAction()

Define the action to be executed when the user selects a row

public setSelectAction( $action) : mixed
Parameters
$action :

TAction object

setSize()

Set checklist size

public setSize(mixed $size) : mixed
Parameters
$size : mixed

setValue()

Define the checklist selected ids

public setValue(mixed $value) : mixed
Parameters
$value : mixed

setValueSeparator()

Define the field's separator

public setValueSeparator( $sep) : mixed
Parameters
$sep :

A string containing the field's separator

validate()

Validate a field

public validate() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results