Docs For Class FEListBox

Description

This is the ListBox FormElement which builds a select field with all of its options.

It has no validation method.

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

Located in /form/form_elements/FEListBox.inc (line 29)

FormElement
   |
   --FEBoxElement
      |
      --FEDataList
         |
         --FEListBox

Direct descendents

Class	Description
FEYesNoListBox	Build a Yes/No Select box
FEMultiListBox	This is the MultiListBox FormElement which builds a select field with all of its options. It enables the ability to have multiple selections.
FEUnitedStates	This class builds a FEDataList that shows a select box for States of the U.S.A.
FEEuropeanUnion	This class builds a FEDataList that shows a select box for states of the European Union.
FEMonths	This class builds a FEDataList that shows a select box for Months of the year
FEYears	This class builds a FEDataList that shows a select box listing a range of years
FEDays	This class builds a FEDataList that shows a select box listing the days of the month
FEGMTTimeZoneListBox	This class is used to build a ListBox for GMT timezone selection
FEWeekdaysListBox	This Form Element builds a list box of the days of the week.
FEListBoxMaster	This element builds the master datalist that will control one slave datalist to change the value of the slave datalist when master changes in JS. It will also set the valid list for the slave depending on the value of the master.

Method Summary

object get_element ()

Variables

Inherited Variables

Inherited from FEDataList

FEDataList::$_data_list
FEDataList::$_disabled_items

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

get_element (line 37)

This function builds and returns the form element object

object get_element ()

Redefinition of:

FormElement::get_element(): This function builds and returns the form element object. This method ignores the readonly flag.

Redefined in descendants as:

FEMultiListBox::get_element() : This function builds and returns the form element object
FECheckBoxList::get_element() : This function builds and returns the form element object

Inherited Methods

Inherited From FEDataList

FEDataList::FEDataList()
FEDataList::disable_item()
FEDataList::get_value_text()
FEDataList::set_list_data()
FEDataList::validate()

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