Docs For Class input

Description

Input textbox class.

version: $Revision: 1.5 $

input_base
   |
   --input_form_element
      |
      --input_textbox

Direct descendents

Class	Description
input_passwordbox	Password textbox class.
input_hiddenbox	Input hidden textbox class.

Variable Summary

string $type

Method Summary

input_textbox input_textbox (string $name, object &$form, [string $regex = NULL], [string $value = NULL], [string $caption = NULL], [bool $required = TRUE])

void display ([string $class = NULL], [int $size = NULL], [string $javascript = NULL])

Variables

string $type (line 37)

The textbox type.

Inherited Variables

Inherited from input_form_element

input_form_element::$caption
input_form_element::$form

Inherited from input_base

input_base::$default
input_base::$name
input_base::$regex
input_base::$required
input_base::$value
input_base::$wasSet
input_base::$wasValid

Methods

Constructor input_textbox (line 49)

Constructs a new textbox object.

input_textbox input_textbox (string $name, object &$form, [string $regex = NULL], [string $value = NULL], [string $caption = NULL], [bool $required = TRUE])

string $name: The name of the textbox.
object $form: Reference to associated form.
string $regex: The validation regular expression.
string $value: The initial contents value.
string $caption: The caption to display by the textbox.
bool $required: Whether the texbox is allowed to contain no value.

display (line 72)

Display the textbox.

If the value was not valid, the CSS class is set/changed to 'error'.

uses: input_form_element::_get_error_css() - to get/modify the specified CSS class
uses: infuse_ensureIntInRange() - to make sure textbox size is within min/max.
uses: INFUSE_TEXTBOX_SIZE_MIN - to ensure that box size is within defined range.
uses: INFUSE_TEXTBOX_SIZE_MAX - to ensure that box size is within defined range.

void display ([string $class = NULL], [int $size = NULL], [string $javascript = NULL])

string $class: CSS class name used in <input.. > tag.
int $size: Integer specifying the size of the textbox; compared to INFUSE_.._MAX/MIN to ensure that size is within range. If $size is not specified, INFUSE_..._MAX is used.
string $javascript: Specification of javascript: onClick, etc.

Redefined in descendants as:

input_hiddenbox::display() : Display the hidden textbox.

Inherited Methods

Inherited From input_form_element

input_form_element::input_form_element()
input_form_element::_get_error_css()

Inherited From input_base

input_base::input_base()
input_base::reset()
input_base::set()