Docs For Class FEMultiListBox

## Class FEMultiListBox

Description

This is the MultiListBox FormElement which builds a select field with all of its options. It enables the ability to have multiple selections.

It has no validation method.

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

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

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

Direct descendents

Class | Description
--- | ---
FECheckBoxList | This is the CheckBoxList FormElement which builds a list of checkboxes inside a scrollable DIV.

Method Summary
void create_element_name ()
object get_element ()
string get_value_text ()
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
create_element_name (line 318)

This function creates element name used in the form based on the text label or any other parameters

Overriding things function to make sure an array is created instead of a single variable

void create_element_name ()

Redefinition of:

FormElement::create_element_name()
  This function creates element name

get_element (line 349)

This function builds and returns the form element object

object get_element ()

Redefinition of:

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

Redefined in descendants as:

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

get_value_text (line 330)

build the string for the confirmation page

string get_value_text ()

Redefinition of:

FEDataList::get_value_text()
  This provides a method

#### Inherited Methods

Inherited From FEListBox

> FEListBox::get_element()

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

Documentation generated on Thu, 1 Sep 2005 17:05:45 -0700 by phpDocumentor 1.3.0RC3