Docs For Class FETextArea

Description

This is the TextArea FormElement which builds a textarea field. It has no validation method.

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

Located in /form/form_elements/FETextArea.inc (line 28)

FormElement
   |
   --FEBoxElement
      |
      --FETextArea

Direct descendents

Class	Description
FEBBCodeTextArea	BBCodeTeatArea class widget. A text area widget to input and parse BBCode formatted text.

Variable Summary

mixed $_limit_char_count

Method Summary

FETextArea FETextArea (label $label, [bool $required = TRUE], int $rows, int $cols, [int $width = NULL], [int $height = NULL], [int $limit_char_count = -1])

object get_element ()

void set_cols (int $cols)

void set_rows (int $rows)

void validate (FormValidation &$_FormValidation)

Variables

mixed $_limit_char_count = -1 (line 55)

This lets you limit the amount of data to

accept in the field

Inherited Variables

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

Constructor FETextArea (line 42)

The constructor

FETextArea FETextArea (label $label, [bool $required = TRUE], int $rows, int $cols, [int $width = NULL], [int $height = NULL], [int $limit_char_count = -1])

label $label: string - text label for the element
bool $required: required - is this a required element
int $rows: required - the rows attribute
int $cols: required - the cols attribute
int $width: optional - element width in pixels (px), percentage (%) or elements (em)
int $height: optional - element height in pixels (px), percentage (%) or elements (em)
int $limit_char_count: optional - the number of characters to limit the value to.

get_element (line 63)

This function builds and returns the form element object

object get_element ()

Redefinition of:

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

set_cols (line 114)

This method is used as a shortcut to set the cols attribute

void set_cols (int $cols)

int $cols: the cols attribute value

set_rows (line 104)

This method is used as a shortcut to set the rows attribute

void set_rows (int $rows)

int $rows: the rows attribute value

validate (line 83)

This method validates the data for this Form Element.

It validates as is_name().

void validate (FormValidation &$_FormValidation)

FormValidation &$_FormValidation: object.

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