Class FEDataList

Description

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

Located in Program_Root/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.
Variable Summary
mixed $_data_list
Method Summary
void FEDataList (label $label, [bool $required = TRUE], [array $width = NULL], [int $height = NULL], [mixed $data_list = array()])
string get_value_text (mixed $value)
void set_list_data ([array $data_list = array()])
void validate (FormValidation &$_FormValidation)
Variables
Methods
Constructor FEDataList (line 45)

The constructor

void FEDataList (label $label, [bool $required = TRUE], [array $width = NULL], [int $height = NULL], [mixed $data_list = array()])
  • label $label:

    string - text label for the element

  • bool $required:

    required - is this a required element

  • array $width:

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

  • int $height:

    required - element width in characters, pixels (px), percentage (%) or elements (em)

get_value_text (line 74)

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 (mixed $value)
  • mixed $value:

    - the value to look up


Redefinition of:
FormElement::get_value_text()
This provides a method
set_list_data (line 56)

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)

validate (line 91)

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

void validate (FormValidation &$_FormValidation)

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

Inherited Methods

Inherited From FEBoxElement

FEBoxElement::FEBoxElement()

Inherited From FormElement

FormElement::FormElement()
FormElement::create_element_name()
FormElement::get_attribute()
FormElement::get_element()
FormElement::get_element_name()
FormElement::get_errors()
FormElement::get_error_message()
FormElement::get_init_value()
FormElement::get_label()
FormElement::get_label_text()
FormElement::get_required_symbol()
FormElement::get_value()
FormElement::get_value_text()
FormElement::has_error()
FormElement::is_disabled()
FormElement::is_required()
FormElement::javascript()
FormElement::onBlur()
FormElement::onChange()
FormElement::onClick()
FormElement::onFocus()
FormElement::onSubmit()
FormElement::set_attribute()
FormElement::set_disabled()
FormElement::set_error_message()
FormElement::set_form_name()
FormElement::set_label_text()
FormElement::set_required()
FormElement::set_stripslashes()
FormElement::set_style_attribute()
FormElement::set_title()
FormElement::set_value()
FormElement::validate()
FormElement::_build_element_attributes()
FormElement::_build_javascript()
FormElement::_do_validation()

Documention generated on Thu, 31 Jul 2003 18:32:30 -0700 by phpDocumentor 1.2.0