Adianti Solutions

Class TSelect

Description

Implements interfaces:

AdiantiWidgetInterface

Select Widget

author: Pablo Dall'Oglio
version: 7.4
copyright: Copyright (c) 2006 Adianti Solutions Ltd. (http://www.adianti.com.br)
license: http://www.adianti.com.br/framework-license

Located in /widget/form/TSelect.php (line 24)

TField
   |
   --TSelect

Direct descendents

Class	Description
TMultiEntry	Multi Entry Widget
TMultiSearch	Multi Search Widget
TDBSelect	Database Select Widget

Variable Summary

mixed $changeAction

mixed $changeFunction

mixed $defaultOption

mixed $formName

mixed $height

mixed $id

mixed $items

mixed $separator

mixed $value

mixed $withTitles

Method Summary

static clearField ($form_name, $field)

static disableField ($form_name, $field)

static enableField ($form_name, $field)

static reload ($formname, $name, $items, [$startEmpty = FALSE])

__construct ($name)

addItems ($items)

disableMultiple ()

disableTitles ()

getItems ()

getPostData ()

getSize ()

renderItems ([$with_titles = true])

setChangeAction ($action)

setChangeFunction ($function)

setDefaultOption ($option)

setSize ($width, [$height = NULL])

setValue ($value)

setValueSeparator ($sep)

show ()

Variables

mixed $changeAction (line 31)

access: protected

Redefined in descendants as:

mixed $changeFunction (line 30)

access: protected

Redefined in descendants as:

mixed $defaultOption (line 32)

access: protected

mixed $formName (line 29)

access: protected

Redefinition of:

TField::$formName

mixed $height (line 27)

access: protected

Redefined in descendants as:

mixed $id (line 26)

access: protected

Redefinition of:

TField::$id

Redefined in descendants as:

mixed $items (line 28)

access: protected

Redefined in descendants as:

mixed $separator (line 33)

access: protected

Redefined in descendants as:

TMultiSearch::$separator

mixed $value (line 34)

access: protected

Redefinition of:

TField::$value

Redefined in descendants as:

TMultiSearch::$value

mixed $withTitles (line 35)

access: protected

Inherited Variables

Inherited from TField

TField::$editable
TField::$label
TField::$name
TField::$properties
TField::$size
TField::$tag
TField::$valueCallback

Methods

static clearField (line 255)

Clear the field

access: public

static clearField ($form_name, $field)

$form_name: Form name
$field: Field name

Redefinition of:

TField::clearField(): Clear the field

Redefined in descendants as:

TMultiEntry::clearField() : Clear the field
TMultiSearch::clearField() : Clear the field

static disableField (line 245)

Disable the field

access: public

static disableField ($form_name, $field)

$form_name: Form name
$field: Field name

Redefinition of:

TField::disableField(): Disable the field

Redefined in descendants as:

TMultiEntry::disableField() : Disable the field
TMultiSearch::disableField() : Disable the field

static enableField (line 235)

Enable the field

access: public

static enableField ($form_name, $field)

$form_name: Form name
$field: Field name

Redefinition of:

TField::enableField(): Enable the field

Redefined in descendants as:

TMultiEntry::enableField() : Enable the field
TMultiSearch::enableField() : Enable the field

static reload (line 212)

Reload combobox items after it is already shown

access: public

static reload ($formname, $name, $items, [$startEmpty = FALSE])

$formname: form name (used in gtk version)
$name: field name
$items: array with items
$startEmpty: ...

Constructor __construct (line 41)

Class Constructor

access: public

__construct ($name)

$name: widget's name

Redefinition of:

TField::__construct(): Class Constructor

Redefined in descendants as:

TMultiEntry::__construct() : Class Constructor
TMultiSearch::__construct() : Class Constructor
TUniqueSearch::__construct() : Class Constructor
TDBMultiSearch::__construct() : Class Constructor
TDBUniqueSearch::__construct() : Class Constructor
TDBSelect::__construct() : Class Constructor

addItems (line 83)

Add items to the select

access: public

addItems ($items)

$items: An indexed array containing the combo options

disableMultiple (line 60)

Disable multiple selection

access: public

disableMultiple ()

Redefined in descendants as:

TMultiSearch::disableMultiple() : Disable multiple selection

disableTitles (line 69)

Disable option titles

access: public

disableTitles ()

getItems (line 94)

Return the items

access: public

getItems ()

getPostData (line 154)

Return the post data

access: public

getPostData ()

Redefinition of:

TField::getPostData(): Return the post data

Redefined in descendants as:

TMultiSearch::getPostData() : Return the post data
TUniqueSearch::getPostData() : Return the post data
TDBMultiSearch::getPostData() : Return the post data
TDBUniqueSearch::getPostData() : Return the post data

getSize (line 114)

Returns the size

return: height)
access: public

getSize ()

Redefinition of:

TField::getSize(): Returns the field size

Redefined in descendants as:

TMultiSearch::getSize() : Returns the size
TUniqueSearch::getSize() : Returns the size
TDBUniqueSearch::getSize() : Returns the size

renderItems (line 263)

Render items

access: protected

renderItems ([$with_titles = true])

$with_titles

Redefined in descendants as:

TMultiEntry::renderItems() : Render items

setChangeAction (line 184)

Define the action to be executed when the user changes the combo

access: public

setChangeAction ($action)

$action: TAction object

setChangeFunction (line 200)

Set change function

access: public

setChangeFunction ($function)

$function

setDefaultOption (line 74)

access: public

setDefaultOption ($option)

$option

setSize (line 104)

Define the Field's width

access: public

setSize ($width, [$height = NULL])

$width: Field's width in pixels
$height: Field's height in pixels

Redefinition of:

TField::setSize(): Define the Field's width

Redefined in descendants as:

TMultiEntry::setSize() : Define the widget's size
TMultiSearch::setSize() : Define the widget's size

setValue (line 132)

Define the field's value

access: public

setValue ($value)

$value: A string containing the field's value

Redefinition of:

TField::setValue(): Define the field's value

Implementation of:

AdiantiWidgetInterface::setValue()

Redefined in descendants as:

TMultiSearch::setValue() : Define the field's value
TUniqueSearch::setValue() : Set value
TDBMultiSearch::setValue() : Define the field's value
TDBUniqueSearch::setValue() : Define the field's value

setValueSeparator (line 123)

Define the field's separator

access: public

setValueSeparator ($sep)

$sep: A string containing the field's separator

Redefined in descendants as:

TMultiSearch::setValueSeparator() : Define the field's separator

show (line 325)

Shows the widget

access: public

show ()

Implementation of:

AdiantiWidgetInterface::show()

Redefined in descendants as:

TMultiEntry::show() : Shows the widget
TMultiSearch::show() : Shows the widget
TUniqueSearch::show() : Show the component
TDBMultiSearch::show() : Shows the widget
TDBUniqueSearch::show() : Show the component

Inherited Methods

Inherited From TField

TField::__construct()
TField::addValidation()
TField::clearField()
TField::disableField()
TField::enableField()
TField::getContents()
TField::getEditable()
TField::getFormName()
TField::getId()
TField::getLabel()
TField::getName()
TField::getPostData()
TField::getPropertiesAsString()
TField::getProperty()
TField::getSize()
TField::getValidations()
TField::getValue()
TField::isRequired()
TField::setEditable()
TField::setFormName()
TField::setId()
TField::setLabel()
TField::setName()
TField::setProperty()
TField::setSize()
TField::setTip()
TField::setValue()
TField::setValueCallback()
TField::validate()
TField::__call()
TField::__clone()
TField::__get()
TField::__isset()
TField::__set()
TField::__toString()

Adianti Solutions

API

Class TSelect

Inherited Variables

Inherited Methods