Class: HTML_QuickForm_textarea

Source Location: /pear/HTML/QuickForm/textarea.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_textarea

HTML class for a textarea type field

Author(s):

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

Version:

Methods

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: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::charset(): Sets the charset to use by htmlspecialchars() function
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttribute(): Sets the value of the attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes

Class Details

[line 33]
HTML class for a textarea type field

Tags:

author:	Adam Daniel <adaniel1@eesus.jnj.com>
author:	Bertrand Mansion <bmansion@mamasam.com>
version:	1.0
since:	PHP4.04pl1
access:	public

[ Top ]

Class Methods

constructor HTML_QuickForm_textarea [line 58]

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

Class constructor

Tags:

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 ]

method getFrozenHtml [line 208]

string getFrozenHtml(
)

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

Tags:

since:	1.0
access:	public

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

[ Top ]

method getName [line 91]

string getName(
)

Returns the element name

Tags:

since:	1.0
access:	public

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

[ Top ]

method getValue [line 122]

string getValue(
)

Returns the value of the form element

Tags:

since:	1.0
access:	public

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

[ Top ]

method setCols [line 170]

void setCols(
string
$cols)

Sets width in cols for textarea element

Tags:

since:	1.0
access:	public

Parameters:

string

$cols

Width expressed in cols

[ Top ]

method setName [line 76]

void setName(
string
$name)

Sets the input field name

Tags:

since:	1.0
access:	public

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

Parameters:

string

$name

Input field name attribute

[ Top ]

method setRows [line 154]

void setRows(
string
$rows)

Sets height in rows for textarea element

Tags:

since:	1.0
access:	public

Parameters:

string

$rows

Height expressed in rows

[ Top ]

method setValue [line 107]

void setValue(
string
$value)

Sets value for textarea element

Tags:

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 ]

method setWrap [line 138]

void setWrap(
string
$wrap)

Sets wrap type for textarea element

Tags:

since:	1.0
access:	public

Parameters:

string

$wrap

Wrap type

[ Top ]

method toHtml [line 185]

string toHtml(
)

Returns the textarea element in HTML

Tags:

since:	1.0
access:	public

Overrides HTML_Common::toHtml() (Abstract method. Must be extended to return the objects HTML)

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:52:05 +0100 by phpDocumentor 1.4.3