Docs For Class FESubmitButton

Description

This is the SubmitButton FormElement which builds a input field of type="submit". 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/FEButton.inc (line 101)

FormElement
   |
   --FEBoxElement
      |
      --FEButton
         |
         --FESubmitButton

Method Summary

FESubmitButton FESubmitButton (label $label, string $value, [int $width = NULL], [int $height = NULL])

object get_element ()

string onClick ()

Variables

Inherited Variables

Inherited from FEButton

FEButton::$_action

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 FESubmitButton (line 111)

The constructor

FESubmitButton FESubmitButton (label $label, string $value, [int $width = NULL], [int $height = NULL])

label $label: string - text label for the element
string $value: value - button text
int $width: required - element width in pixels (px), percentage (%) or elements (em)
int $height: required - element height in pixels (px), percentage (%) or elements (em)

get_element (line 131)

This function builds and returns the form element object

object get_element ()

Redefinition of:

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

onClick (line 121)

This function return the javaScript code for an onSubmit event

return: - javascript code

string onClick ()

Redefinition of:

FEButton::onClick(): This function return the javaScript code for an onClick event

Inherited Methods

Inherited From FEButton

FEButton::FEButton()
FEButton::get_element()
FEButton::onClick()

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