Docs For Class FEDataList

Description

This is the DataList FormElement which builds a a complex FEBoxElement. It has no validation method.

author: Suren Markossian <suren@bcsweb.com>
author: Walter A. Boring IV <waboring@newsblob.com>
copyright: LGPL - See LICENCE

Located in /form/form_elements/FEDataList.inc (line 28)

FormElement
   |
   --FEBoxElement
      |
      --FEDataList

Direct descendents

Class	Description
FEListBox	This is the ListBox FormElement which builds a select field with all of its options.
FENestedListBox	This class builds a nested select box that is used to select an entry from nested levels.
FEComboListBox	This builds a complex dual select box with buttons to move entries from one select box to another.

Variable Summary

mixed $_data_list

mixed $_disabled_items

Method Summary

FEDataList FEDataList (string $label, [boolean $required = TRUE], [int $width = NULL], [int $height = NULL], [array $data_list = array()])

none disable_item (string $name)

string get_value_text ()

void set_list_data ([array $data_list = array()])

void validate (FormValidation &$_FormValidation)

Variables

mixed $_data_list = array() (line 35)

Holds the list of available

data elements

mixed $_disabled_items = array() (line 41)

The list of disabled items

(if any)

Inherited Variables

Inherited from FEBoxElement

FEBoxElement::$_height
FEBoxElement::$_width

Inherited from FormElement

FormElement::$onBlurJS
FormElement::$onChangeJS
FormElement::$onClickJS
FormElement::$onFocusJS
FormElement::$onSubmitJS
FormElement::$_attributes
FormElement::$_element_name
FormElement::$_errors
FormElement::$_error_message
FormElement::$_form_name
FormElement::$_has_error
FormElement::$_has_form_on_submit
FormElement::$_is_disabled
FormElement::$_is_readonly
FormElement::$_is_required
FormElement::$_label_colon_flag
FormElement::$_label_text
FormElement::$_required_field_marker
FormElement::$_slave_elements
FormElement::$_stripslashes
FormElement::$_style_attributes
FormElement::$_validation_enabled
FormElement::$_value

Methods

Constructor FEDataList (line 52)

The constructor

FEDataList FEDataList (string $label, [boolean $required = TRUE], [int $width = NULL], [int $height = NULL], [array $data_list = array()])

string $label: text label for the element
boolean $required: is this a required element?
int $width: element width in characters, pixels (px), percentage (%) or elements (em)
int $height: element height in px
array $data_list: data_list - list of data elements (name=>value)

disable_item (line 124)

This method allows you to disable one of the items in the list of checkboxes.

none disable_item (string $name)

string $name: the name of the checkbox to disable

get_value_text (line 80)

This provides a method

for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation

return: - the text associated

string get_value_text ()

Redefinition of:

FormElement::get_value_text(): This provides a method

Redefined in descendants as:

FEMultiListBox::get_value_text() : build the string for the confirmation page
FENestedListBox::get_value_text() : This provides a method
FEComboListBox::get_value_text() : This provides a method

set_list_data (line 63)

This function sets the array of data to be used in the data list

void set_list_data ([array $data_list = array()])

array $data_list: data_list - list of data elements (name=>value)

Redefined in descendants as:

FEListBoxMaster::set_list_data() : This function sets the array of data to be used in the data list

validate (line 98)

This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation

void validate (FormValidation &$_FormValidation)

FormValidation &$_FormValidation: object

Redefinition of:

FormElement::validate(): This function performs the actual validation It is called only if the validation is required by this element

Redefined in descendants as:

FENestedListBox::validate() : This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
FEComboListBox::validate() : This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation

Inherited Methods

Inherited From FEBoxElement

FEBoxElement::FEBoxElement()

Inherited From FormElement

FormElement::FormElement()
FormElement::build_id_name()
FormElement::create_element_name()
FormElement::enable_validation()
FormElement::form_tag_onsubmit()
FormElement::get_attribute()
FormElement::get_confirm_element()
FormElement::get_element()
FormElement::get_element_name()
FormElement::get_errors()
FormElement::get_error_message()
FormElement::get_form_element()
FormElement::get_init_value()
FormElement::get_label()
FormElement::get_label_text()
FormElement::get_required_symbol()
FormElement::get_slave_elements()
FormElement::get_tabindex()
FormElement::get_value()
FormElement::get_value_text()
FormElement::has_error()
FormElement::is_disabled()
FormElement::is_readonly()
FormElement::is_required()
FormElement::javascript()
FormElement::onBlur()
FormElement::onChange()
FormElement::onClick()
FormElement::onFocus()
FormElement::onSubmit()
FormElement::set_attribute()
FormElement::set_colon_flag()
FormElement::set_data_all_slaves()
FormElement::set_disabled()
FormElement::set_element_name()
FormElement::set_error_message()
FormElement::set_form_name()
FormElement::set_label_text()
FormElement::set_onBlur()
FormElement::set_onChange()
FormElement::set_onClick()
FormElement::set_onFocus()
FormElement::set_onSubmit()
FormElement::set_readonly()
FormElement::set_required()
FormElement::set_required_symbol()
FormElement::set_slave_data()
FormElement::set_slave_elements()
FormElement::set_stripslashes()
FormElement::set_style_attribute()
FormElement::set_tabindex()
FormElement::set_title()
FormElement::set_value()
FormElement::validate()
FormElement::_build_element_attributes()
FormElement::_build_javascript()
FormElement::_do_validation()
FormElement::_sanitize_string()