Docs For Class FECheckBoxList

## Class FECheckBoxList

Description

This is the CheckBoxList FormElement which builds a list of checkboxes inside a scrollable DIV.

It has no validation method.

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

Located in /form/form_elements/FECheckBox.inc (line 104)

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

Variable Summary
mixed $_checkall_flag
Method Summary
void enable_checkall ([boolean $flag = TRUE])
object get_element ()
string javascript ()
string _js_checkall_name ()
Variables
mixed $_checkall_flag = FALSE (line 110)

Flag to tell us to render the check all

checkbox

#### 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
enable_checkall (line 119)

This method is used to turn on/off the magic 'check all' checkbox

void enable_checkall ([boolean $flag = TRUE])

- boolean $flag

get_element (line 175)

This function builds and returns the form element object

object get_element ()

Redefinition of:

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

javascript (line 130)

This returns the JS require to do the work of the check all checkbox

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

_js_checkall_name (line 253)

This private method builds the name of the js checkall function

string _js_checkall_name ()

#### Inherited Methods

Inherited From FEMultiListBox

> FEMultiListBox::create_element_name()
> FEMultiListBox::get_element()
> FEMultiListBox::get_value_text()

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:41 -0700 by phpDocumentor 1.3.0RC3