Adianti Solutions

Class TField

Description

Base class to construct all the widgets

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

Located in /widget/form/TField.php (line 27)

Direct descendents

Class	Description
TSelect	Select Widget
TFile	FileChooser widget
TCheckGroup	A group of CheckButton's
TPassword	Password Widget
TSlider	Slider Widget
TSpinner	Spinner Widget (also known as spin button)
THtmlEditor	Html Editor
TMultiFile	FileChooser widget
TLabel	Label Widget
TText	Text Widget (also known as Memo)
TRadioGroup	A group of RadioButton's
TImageCropper	Image uploader with cropper
TCheckButton	CheckButton widget
TSortList	A Sortable list
THidden	Hidden field
TButton	Button Widget
TEntry	Entry Widget
TCombo	ComboBox Widget
TRadioButton	RadioButton Widget

Variable Summary

mixed $editable

mixed $formName

mixed $id

mixed $label

mixed $name

mixed $properties

mixed $size

mixed $tag

mixed $value

mixed $valueCallback

Method Summary

static clearField ($form_name, $field)

static disableField ($form_name, $field)

static enableField ($form_name, $field)

__construct ($name)

addValidation ($label, $validator, [$parameters = NULL])

getContents ()

getEditable ()

getFormName ()

getId ()

getLabel ()

getName ()

getPostData ()

getPropertiesAsString ([$filter = null])

getProperty ($name, 1)

getSize ()

getValidations ()

getValue ()

isRequired ()

setEditable ($editable)

setFormName ($name)

setId ($id)

setLabel ($label)

setName ($name)

setProperty ($name, $value, [$replace = TRUE])

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

setTip ($tip)

setValue ($value)

setValueCallback ($callback)

validate ()

__call ($method, $param)

__clone ()

__get ($name)

__isset ($name)

__set ($name, $value)

__toString ()

Variables

mixed $editable (line 33)

access: protected

Redefined in descendants as:

mixed $formName (line 35)

access: protected

Redefined in descendants as:

mixed $id (line 29)

access: protected

Redefined in descendants as:

mixed $label (line 36)

access: protected

Redefined in descendants as:

TButton::$label

mixed $name (line 30)

access: protected

Redefined in descendants as:

mixed $properties (line 37)

access: protected

Redefined in descendants as:

TButton::$properties

mixed $size (line 31)

access: protected

Redefined in descendants as:

mixed $tag (line 34)

access: protected

mixed $value (line 32)

access: protected

Redefined in descendants as:

mixed $valueCallback (line 38)

access: protected

Methods

static clearField (line 469)

Clear the field

access: public

static clearField ($form_name, $field)

$form_name: Form name
$field: Field name

Redefined in descendants as:

TSelect::clearField() : Clear the field
TMultiEntry::clearField() : Clear the field
TMultiSearch::clearField() : Clear the field
TFile::clearField() : Clear the field
TCheckGroup::clearField() : clear the field
THtmlEditor::clearField() : Clear the field
TMultiFile::clearField() : Clear the field
TRadioGroup::clearField() : clear the field
TSortList::clearField() : Clear the field
TCombo::clearField() : Clear the field

static disableField (line 459)

Disable the field

access: public

static disableField ($form_name, $field)

$form_name: Form name
$field: Field name

Redefined in descendants as:

TSelect::disableField() : Disable the field
TMultiEntry::disableField() : Disable the field
TMultiSearch::disableField() : Disable the field
TFile::disableField() : Disable the field
TCheckGroup::disableField() : Disable the field
TSlider::disableField() : Disable the field
TSpinner::disableField() : Disable the field
THtmlEditor::disableField() : Disable the field
TMultiFile::disableField() : Disable the field
TRadioGroup::disableField() : Disable the field
TSortList::disableField() : Disable the field
TButton::disableField() : Disable the field
TIcon::disableField() : Disable the field
TDateTime::disableField() : Disable the field
TDate::disableField() : Disable the field
TSeekButton::disableField() : Disable the field
TColor::disableField() : Disable the field
TTime::disableField() : Disable the field
TCombo::disableField() : Disable the field

static enableField (line 449)

Enable the field

access: public

static enableField ($form_name, $field)

$form_name: Form name
$field: Field name

Redefined in descendants as:

TSelect::enableField() : Enable the field
TMultiEntry::enableField() : Enable the field
TMultiSearch::enableField() : Enable the field
TFile::enableField() : Enable the field
TCheckGroup::enableField() : Enable the field
TSlider::enableField() : Enable the field
TSpinner::enableField() : Enable the field
THtmlEditor::enableField() : Enable the field
TMultiFile::enableField() : Enable the field
TRadioGroup::enableField() : Enable the field
TSortList::enableField() : Enable the field
TButton::enableField() : Enable the field
TIcon::enableField() : Enable the field
TDateTime::enableField() : Enable the field
TDate::enableField() : Enable the field
TSeekButton::enableField() : Enable the field
TColor::enableField() : Enable the field
TTime::enableField() : Enable the field
TCombo::enableField() : Enable the field

Constructor __construct (line 45)

Class Constructor

access: public

__construct ($name)

$name: name of the field

Redefined in descendants as:

TSelect::__construct() : Class Constructor
TMultiEntry::__construct() : Class Constructor
TMultiSearch::__construct() : Class Constructor
TUniqueSearch::__construct() : Class Constructor
TDBMultiSearch::__construct() : Class Constructor
TDBUniqueSearch::__construct() : Class Constructor
TDBSelect::__construct() : Class Constructor
TFile::__construct() : Constructor method
TCheckGroup::__construct() : Class Constructor
TDBCheckGroup::__construct() : Class Constructor
TPassword::__construct() : Class Constructor
TSlider::__construct() : Class Constructor
TSpinner::__construct() : Class Constructor
THtmlEditor::__construct() : Class Constructor
TMultiFile::__construct() : Constructor method
TLabel::__construct() : Class Constructor
TText::__construct() : Class Constructor
TRadioGroup::__construct() : Class Constructor
TDBRadioGroup::__construct() : Class Constructor
TImageCropper::__construct()
TImageCapture::__construct()
TCheckButton::__construct() : Class Constructor
TSortList::__construct() : Class Constructor
TDBSortList::__construct() : Class Constructor
TEntry::__construct() : Class Constructor
TIcon::__construct() : Class Constructor
TDateTime::__construct() : Class Constructor
TDate::__construct() : Class Constructor
TBarCodeInputReader::__construct() : Class Constructor
TSeekButton::__construct() : Class Constructor
TDBSeekButton::__construct() : Class Constructor
TColor::__construct() : Class Constructor
TTime::__construct() : Class Constructor
TNumeric::__construct()
TQRCodeInputReader::__construct() : Class Constructor
TDBEntry::__construct() : Class Constructor
TCombo::__construct() : Class Constructor
TDBCombo::__construct() : Class Constructor
TRadioButton::__construct() : Class Constructor

addValidation (line 354)

Add a field validator

access: public

addValidation ($label, $validator, [$parameters = NULL])

$label: Field name
$validator: TFieldValidator object
$parameters: Aditional parameters

getContents (line 435)

Returns the element content as a string

access: public

getContents ()

getEditable (line 264)

Returns if the field is editable

return: boolean
access: public

getEditable ()

getFormName (line 222)

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

access: public

getFormName ()

getId (line 181)

Returns the field's id

access: public

getId ()

getLabel (line 147)

Returns the field's label

access: public

getLabel ()

Redefined in descendants as:

TButton::getLabel() : Returns the button label

getName (line 164)

Returns the field's name

access: public

getName ()

getPostData (line 239)

Return the post data

access: public

getPostData ()

Redefined in descendants as:

TSelect::getPostData() : Return the post data
TMultiSearch::getPostData() : Return the post data
TUniqueSearch::getPostData() : Return the post data
TDBMultiSearch::getPostData() : Return the post data
TDBUniqueSearch::getPostData() : Return the post data
TFile::getPostData() : Return the post data
TCheckGroup::getPostData() : Return the post data
TMultiFile::getPostData() : Return the post data
TText::getPostData() : Return the post data
TRadioGroup::getPostData() : Return the post data
TSortList::getPostData() : Return the post data
THidden::getPostData() : Return the post data
TEntry::getPostData() : Return the post data
TDateTime::getPostData() : Return the post data
TDate::getPostData() : Return the post data
TCombo::getPostData() : Return the post data

getPropertiesAsString (line 302)

Get properties as string

access: public

getPropertiesAsString ([$filter = null])

$filter

getProperty (line 326)

Return a field property

access: public

getProperty ($name, 1)

1: Property Value
$name: Property Name

Redefined in descendants as:

TButton::getProperty() : Return field property

getSize (line 343)

Returns the field size

access: public

getSize ()

Redefined in descendants as:

TSelect::getSize() : Returns the size
TMultiSearch::getSize() : Returns the size
TUniqueSearch::getSize() : Returns the size
TDBUniqueSearch::getSize() : Returns the size
THtmlEditor::getSize() : Returns the size
TText::getSize() : Returns the size

getValidations (line 382)

Returns field validations

access: public

getValidations ()

getValue (line 204)

Returns the field's value

access: public

getValue ()

Redefined in descendants as:

TLabel::getValue() : Get value
TRadioGroup::getValue() : Returns the field's value
TCombo::getValue() : Returns the field's value

isRequired (line 390)

Returns if the field is required

access: public

isRequired ()

setEditable (line 255)

Define if the field is editable

access: public

setEditable ($editable)

$editable: A boolean

setFormName (line 214)

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

access: public

setFormName ($name)

$name: A string containing the name of the form

setId (line 173)

Define the field's id

access: public

setId ($id)

$id: A string containing the field's id

setLabel (line 139)

Define the field's label

access: public

setLabel ($label)

$label: A string containing the field's label

Redefined in descendants as:

TButton::setLabel() : Define the label of the button

setName (line 156)

Define the field's name

access: public

setName ($name)

$name: A string containing the field's name

setProperty (line 274)

Define a field property

access: public

setProperty ($name, $value, [$replace = TRUE])

$name: Property Name
$value: Property Value
$replace

Redefined in descendants as:

TButton::setProperty() : Define a field property

setSize (line 335)

Define the Field's width

access: public

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

$width: Field's width in pixels
$height

Redefined in descendants as:

TSelect::setSize() : Define the Field's width
TMultiEntry::setSize() : Define the widget's size
TMultiSearch::setSize() : Define the widget's size
TFile::setSize() : Set field size
THtmlEditor::setSize() : Define the widget's size
TMultiFile::setSize() : Set field size
TText::setSize() : Define the widget's size
TImageCropper::setSize() : Define the Field's width
TSortList::setSize() : Define the list size
TSeekButton::setSize() : Define the Field's width

setTip (line 231)

Define the field's tooltip

access: public

setTip ($tip)

$tip: A string containing the field's tooltip

setValue (line 190)

Define the field's value

access: public

setValue ($value)

$value: A string containing the field's value

Redefined in descendants as:

TSelect::setValue() : Define the field's value
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
TFile::setValue() : Set field value
TCheckGroup::setValue() : Define the field's value
TSpinner::setValue() : Set the value
TMultiFile::setValue() : Set field value
TRadioGroup::setValue() : Define the field's value
TImageCropper::setValue() : Define image initial
TSortList::setValue() : Define the field's value
TEntry::setValue() : Define the field's value
TDateTime::setValue() : Store the value inside the object
TDate::setValue() : Store the value inside the object
TDBSeekButton::setValue() : Define the field's value
TCombo::setValue() : Define the field's value

setValueCallback (line 130)

Set callback for setValue method

access: public

setValueCallback ($callback)

$callback

validate (line 409)

Validate a field

access: public

validate ()

__call (line 115)

Redirects function call

access: public

__call ($method, $param)

$method: Method name
$param: Array of parameters

__clone (line 105)

Clone the object

__clone ()

Redefined in descendants as:

TCheckGroup::__clone() : Clone object
TLabel::__clone() : Clone the object
TRadioGroup::__clone() : Clone object

__get (line 88)

Returns a property value

access: public

__get ($name)

$name: Property Name

Redefined in descendants as:

TSeekButton::__get() : Returns a property value

__isset (line 97)

Returns if the property is set

access: public

__isset ($name)

$name: Property Name

__set (line 74)

Intercepts whenever someones assign a new property's value

access: public

__set ($name, $value)

$name: Property Name
$value: Property Value

__toString (line 427)

Converts the object into a string

access: public

__toString ()

Adianti Solutions

API

Class TField