Docs For Class FERadioGroup

## Class FERadioGroup

Description

This is the Radio Button Group FormElement which builds a List of Radio buttons that can be used in any style of layout.

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/FERadioGroup.inc (line 31)

    FormElement
       |
       --FERadioGroup

Direct descendents

Class | Description
--- | ---
FEYesNoRadioGroup | This is the Yes/No Radio Button Group FormElement.
FEActiveDIVRadioButtonGroup | This is a special FERadioButtonGroup form element that allows each of the radio buttons to show/hide a div on the fly.

Variable Summary
mixed $_br_flag
mixed $_data_list
Method Summary
FERadioGroup FERadioGroup (label $label, [array $data_list = array()], [boolean $required = true])
object get_element ([int $index = NULL], [boolean $br_flag = FALSE])
string get_value_text (mixed 0)
void set_br_flag ([boolean $flag = TRUE])
INPUTtag _get_index_element (int $index)
Variables
mixed $_br_flag = FALSE (line 43)

the br flag

mixed $_data_list = array() (line 38)

Holds the list of available

data elements

#### Inherited Variables

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
Constructor FERadioGroup (line 53)

The constructor

FERadioGroup FERadioGroup (label $label, [array $data_list = array()], [boolean $required = true])

- label $label: string - text label for the element
- array $data_list: - the name => value pairs of the radio buttons text => value
- boolean $required: - required flag

get_element (line 106)

This function builds and returns the form element object

object get_element ([int $index = NULL], [boolean $br_flag = FALSE])

- int $index: the index to get
- boolean $br_flag: the br flag. NOTE: the class's br flag takes precedence.

Redefinition of:

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

get_value_text (line 73)

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

- mixed 0: - the value to look up

Redefinition of:

FormElement::get_value_text()
  This provides a method

set_br_flag (line 92)

This function is used to set the br flag that will automatically add a BR tag after each radio button

void set_br_flag ([boolean $flag = TRUE])

- boolean $flag

_get_index_element (line 139)

This method builds an individual Radio button with its associated text

- return: of type radio

INPUTtag _get_index_element (int $index)

- int $index: - the index

Redefined in descendants as:

- FEActiveDIVRadioButtonGroup::_get_index_element() : This method builds an individual Radio button with its associated text

#### Inherited Methods

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