Docs For Class FEListBoxMaster

Description

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.

Please use regular FEListBox element for non-master lists.

please examples area.

author: Sumedh Thakar
copyright: LGPL - See LICENCE

Located in /form/form_elements/FEListBoxMaster.inc (line 26)

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

Direct descendents

Class	Description
FECountryListMaster	A simple class to be the master. It contains a list of countries and the acceptable states for each county.

Variable Summary

mixed $mdata

Method Summary

string javascript ()

string onChange ()

void set_list_data (array $data)

void set_slave_data (the &$slave, $value)

Variables

mixed $mdata = array() (line 28)

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

javascript (line 72)

This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor

return: - raw js

string javascript ()

Redefinition of:

FormElement::javascript(): This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor

onChange (line 149)

this function retuns the javaScript code for an onChange event

return: - javascript code

string onChange ()

Redefinition of:

FormElement::onChange(): this function retuns the javaScript code for

set_list_data (line 35)

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

void set_list_data (array $data)

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

Redefinition of:

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

set_slave_data (line 53)

This function will set the data the parent wants to set for the slave

void set_slave_data (the &$slave, $value)

the &$slave: slave
$value

Redefinition of:

FormElement::set_slave_data(): This function will set the data the parent wants to set for the slave

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