Docs For Class FEText

Description

This is the Text FormElement which builds a text input field. It has no validation method.

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

Located in /form/form_elements/FEText.inc (line 29)

FormElement
   |
   --FEText

Direct descendents

Class	Description
FEName	This is the Name FormElement which builds a text input field, and validates against the is_name() method.
FEEmail	This is the Email FormElement which builds a text input field.
FEEmailMany	This is the EmailMany FormElement which builds a text input field. This allows for multiple email addresses in 1 text input field seperated by commas.
FEDomainName	This is the DomainName FormElement which builds a text input field.
FEHostNameWithPort	This is the DomainName FormElement which builds a text input field. It also includes a port # It validates as is_domainname().
FEIPAddress	This is the Ip Address FormElement which builds a text input field.
FEUrl	This is the URL FormElement which builds a text input field.
FEUrlStrict	This is the URLStrict FormElement which builds a text input field.
FEZipcode	This is the FEZipcode class.
FERegEx	This is the RegEx FormElement which builds a text input field, and validates against the is_regex() method.
FEColorPicker	This Form Element is used as a DHTML color picker.
FEPassword	This is the Password FormElement which builds a input field of type="password". It validates the data as is_password().
FEFile	This is the FileUpload FormElement which builds a input field of type="file". This automagically handles the case of a confirmation page.
FENumber	This is the FormElement which builds a text input field that validates It validates as is_number().
FENumberFloat	This is the float FormElement which builds a text input field.
FENumberPrice	This is the Price FormElement which builds a text input field.
FENumberInRange	This is the Number Range FormElement which builds a text input field.

Method Summary

FEText FEText (label $label, [bool $required = FALSE], [int $width = NULL], [int $maxlength = NULL])

object get_element ()

Variables

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 FEText (line 39)

The constructor

FEText FEText (label $label, [bool $required = FALSE], [int $width = NULL], [int $maxlength = NULL])

label $label: string - text label for the element
bool $required: required - is this a required element
int $width: required - element width in characters, pixels (px), percentage (%) or elements (em)
int $maxlength: required - maximum number of chars allowed to type in

get_element (line 60)

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.

Redefined in descendants as:

FEHostNameWithPort::get_element() : This function builds and returns the form element object
FEColorPicker::get_element()
FEPassword::get_element() : This function builds and returns the form element object
FEFile::get_element() : This function builds and returns the form element object

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