Class FETextArea

Description

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

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

FormElement
   |
   --FEBoxElement
      |
      --FETextArea
Variable Summary
Method Summary
void FETextArea (label $label, [bool $required = TRUE], int $rows, int $cols, [int $width = NULL], [int $height = NULL], [int $limit_char_count = -1])
object get_element ()
mixed get_value ()
void set_cols (int $cols)
void set_rows (int $rows)
Variables
Methods
Constructor FETextArea (line 42)

The constructor

void 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
get_value (line 82)

This function will return the elements value

mixed get_value ()

Redefinition of:
FormElement::get_value()
This function will return the elements value
set_cols (line 108)

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

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

void set_rows (int $rows)
  • int $rows:

    the rows attribute value

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:39 -0700 by phpDocumentor 1.2.0