Class: HTML_QuickForm_textarea

Source Location: /HTML_QuickForm-3.2.14/QuickForm/textarea.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_textarea

HTML class for a textarea type field

Author(s):

Bertrand Mansion <bmansion at mamasam.com>
Adam Daniel <adaniel1 at eesus.jnj.com>

Version:

Release: 3.2.14

Methods

Inherited Variables

Inherited Methods

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable

Class Details

[line 40]
HTML class for a textarea type field

Author: Bertrand Mansion <bmansion@mamasam.com>
Author: Adam Daniel <adaniel1@eesus.jnj.com>
Version: Release: 3.2.14
Since: 1.0

[ Top ]

Method Detail

HTML_QuickForm_textarea (Constructor) [line 65]

void HTML_QuickForm_textarea(
[string
$elementName = null], [mixed
$elementLabel = null], [mixed
$attributes = null])

Class constructor

Since: 1.0
Access: public

Parameters:

string	`$elementName`	—	Input field name attribute
mixed	`$elementLabel`	—	Label(s) for a field
mixed	`$attributes`	—	Either a typical HTML attribute string or an associative array

[ Top ]

getFrozenHtml [line 215]

string getFrozenHtml(
)

Returns the value of field without HTML tags (in this case, value is changed to a mask)

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::getFrozenHtml() (Returns the value of field without HTML tags)

[ Top ]

getName [line 98]

string getName(
)

Returns the element name

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::getName() (Returns the element name)

[ Top ]

getValue [line 129]

string getValue(
)

Returns the value of the form element

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::getValue() (Returns the value of the form element)

[ Top ]

setCols [line 177]

void setCols(
string
$cols)

Sets width in cols for textarea element

Since: 1.0
Access: public

Parameters:

string $cols — Width expressed in cols

[ Top ]

setName [line 83]

void setName(
string
$name)

Sets the input field name

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::setName() (Sets the input field name)

Parameters:

string $name — Input field name attribute

[ Top ]

setRows [line 161]

void setRows(
string
$rows)

Sets height in rows for textarea element

Since: 1.0
Access: public

Parameters:

string $rows — Height expressed in rows

[ Top ]

setValue [line 114]

void setValue(
string
$value)

Sets value for textarea element

Since: 1.0
Access: public

Overrides HTML_QuickForm_element::setValue() (Sets the value of the form element)

Parameters:

string $value — Value for textarea element

[ Top ]

setWrap [line 145]

void setWrap(
string
$wrap)

Sets wrap type for textarea element

Since: 1.0
Access: public

Parameters:

string $wrap — Wrap type

[ Top ]

toHtml [line 192]

string toHtml(
)

Returns the textarea element in HTML

Since: 1.0
Access: public

[ Top ]