Class: TextArea

FormElement::__construct(): General abstract, hidden formelement constructor.
FormElement::addCssClasses(): Adds one or many css-classes to the element's class-attribute.
FormElement::addElement(): Adds a subelement to the element.
FormElement::determineRefiller(): Returns the supposed source of refill values.
FormElement::doRender(): Returns the compiled html-code for the element.
FormElement::getId(): Return the element's html-id.
FormElement::getLabel(): Return the element's label text.
FormElement::getMasterElement(): Return the currently connected owner element for the element.
FormElement::getMasterForm(): Returns the currently connected owner form for the element.
FormElement::getName(): Return the element's html-name.
FormElement::getSubElements(): Return all owned elements of this element.
FormElement::getTitle(): Return the element's html-title.
FormElement::getValidator(): Return the currently connected validator for the element.
FormElement::getValue(): Returns the value of the element if there is any.
FormElement::getValueSet(): Returns the compiled valueset for this element including the elements owned by this one.
FormElement::insertElementAfter(): Searches the subelements of the element if present and inserts a given element after the first found one.
FormElement::isValid(): Answers if the element is in a valid state at the moment.
FormElement::needsUtf8Safety(): Answers if the element needs to be treated with precautions according to possible utf-8 values.
FormElement::printCssClasses(): Compiles the html-class-attribute-string of the element.
FormElement::printDisabled(): Compiles the html-disabled-attribute-string of the element.
FormElement::printId(): Compiles the html-id-attribute-string of the element.
FormElement::printJavascriptEventHandler(): Compiles html-javascript-eventhandler-string of the element.
FormElement::printJavascriptValidationCode(): Grabs the compiled JS-validation-code for the element from its validator, if present and returns the code as a string.
FormElement::printMessages(): Returns a string of all aggregated error messages of the element.
FormElement::printName(): Compiles the html-name-string of the element.
FormElement::printNameArray(): Comiles the html-name-string of the element, if the element is part of a group of values.
FormElement::printTabIndex(): Calculates current ongoing tabindex of the form, refreshes it and returns the proper value for the element.
FormElement::printTitle(): Compiles the html-title-string of the element.
FormElement::printWrapperClasses(): Compiles a string of all classes for the tag-wrapper for the element's html-code.
FormElement::setCssClasses(): Sets the html-class-attribute for the element.
FormElement::setDisabled(): Set the element disabled.
FormElement::setId(): Sets the html-id for this element.
FormElement::setJavascriptEventHandler(): Sets a javascript-handler for the element.
FormElement::setLabel(): Inserts a label for the element.
FormElement::setMasterElement(): Sets the owning element for an element.
FormElement::setMasterForm(): Sets the owning form for an element and by doing so inserts the element into the logical structure of the form.
FormElement::setTitle(): Sets the html-title for this element.
FormElement::setUsable(): Set the element usables or disabled based on an expression.
FormElement::setValidator(): Sets a validator for a value-bearing element.
FormElement::validate(): Starts validation for the element and all subelements according to the rules laid out in the element's validator.

Class Details

[line 24]
Wraps a textarea.

This element is made for long, multi-line text entries in contrast to short inputs handled by InputText. In general both mostly work the same way, with a tad more config-options for the textarea.

Tags:

author:	Sebastian Schlapkohl
version:	1.0

[ Top ]

Class Variables

$cols =

[line 38]

the amount of characters to display horizontally, defines visual width as well

Tags:

access:

protected

Type:

String

[ Top ]

$readonly =

[line 51]

defines if the input is in read-only-state or not

Tags:

access:

protected

Type:

Boolean

[ Top ]

$rows =

[line 44]

the amount of lines to display vertically, defines visual height as well

Tags:

access:

protected

Type:

unknown_type

[ Top ]

$text =

[line 31]

the currently entered text (used for refill mostly, not synchronized to user input)

Tags:

access:

protected

Type:

String

[ Top ]

Class Methods

static method get [line 81]

static TextArea get(
String
$name, [String
$id = ''])

Factory method for TextArea, returns new instance.

Factories are used to make instant chaining possible.

Tags:

return:	new TextArea-instance
access:	public

Parameters:

String	$name	html-name for the element
String	$id	html-id for the element

[ Top ]

constructor __construct [line 60]

TextArea __construct(
String
$name, [String
$id = ''])

Hidden constructor.

Get new instances with "get()" instead.

Tags:

access:

protected

Overrides FormElement::__construct() (General abstract, hidden formelement constructor.)

Parameters:

String	$name	html-name for the element
String	$id	html-id for the element

[ Top ]

method doRender [line 266]

String doRender(
)

Compiles and returns the html-fragment for the element.

Tags:

return:	html-fragment for the element
access:	public

Overrides FormElement::doRender() (Returns the compiled html-code for the element.)

[ Top ]

method getValue [line 171]

String getValue(
)

Returns the current value of the element.

In case of a textarea this is always a simple, single string.

Tags:

return:	current value of element
access:	public

Overrides FormElement::getValue() (Returns the value of the element if there is any.)

[ Top ]

method printCols [line 233]

String printCols(
)

Compiles and returns the html-cols-attribute for the element.

Tags:

return:	the html-cols-attribute of the element
access:	protected

[ Top ]

method printReadonly [line 255]

String printReadonly(
)

Compiles and returns the html-readonly-attribute for the element.

Tags:

return:	the html-readonly-attribute of the element
access:	protected

[ Top ]

method printRows [line 244]

String printRows(
)

Compiles and returns the html-rows-attribute for the element.

Tags:

return:	the html-rows-attribute of the element
access:	protected

[ Top ]

method refill [line 188]

TextArea refill(
[Array[String]|null
$refiller = array()], [Boolean
$condition = true])

Tries to refill the element-value from existing data.

This data can eiter be one of the method-arrays dependent on the method the surrounding form uses or a supplied array of name-value-pairs.

Tags:

return:	method owner
access:	public

Parameters:

Array[String]\|null	$refiller	data to use as the refill source
Boolean	$condition	expression which defines if the refill will take place or not, to make it conditional so to speak

[ Top ]

method setCols [line 111]

TextArea setCols(
uint
$cols)

Sets the amount of characters to display horizontally, defines visual width as well

Tags:

return:	method owner
access:	public

Parameters:

uint

$cols

amount of characters to show horizontally

[ Top ]

method setReadonly [line 156]

TextArea setReadonly(
)

Sets that the element should be read-only.

Tags:

return:	method owner
access:	public

[ Top ]

method setRows [line 126]

TextArea setRows(
uint
$rows)

Sets the amount of lines to display vertically, defines visual height as well.

Tags:

return:	method owner
access:	public

Parameters:

uint

$rows

the amount of lines to show

[ Top ]

method setSize [line 143]

TextArea setSize(
uint
$cols, uint
$rows)

Combination of setCols() and setRows().

Sets both characters to display horizontally and lines to show vertically at once.

Tags:

return:	method owner
access:	public

Parameters:

uint	$cols	amount of characters to show horizontally
uint	$rows	the amount of lines to show

[ Top ]

method setText [line 98]

TextArea setText(
String
$text)

Sets the text to start with.

This text will be rendered into the html-code.

Tags:

return:	method owner
access:	public

Parameters:

String

$text

the text to insert into the element

[ Top ]

method validate [line 213]

Boolean validate(
)

Starts the validation-process for the element.

Calculates the validity-status, based on the currently entered value, by applying the rules of a present validator. If there is none, the element is always valid.

Tags:

return:	element is currently valid yes/no
access:	public

Overrides FormElement::validate() (Starts validation for the element and all subelements according to the rules laid out in the element's validator.)

[ Top ]

Documentation generated on Fri, 18 Jul 2014 16:32:00 +0200 by phpDocumentor 1.4.3