Docs For Class WTextArea

Description

This class allows for the creation of a textarea element

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WTextArea.class.php,v 1.12 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: Jul 21, 2005

Located in /polyphony/main/library/Wizard/Components/WTextArea.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --ErrorCheckingWizardComponent
         |
         --WTextInput
            |
            --WTextArea

Direct descendents

Class	Description
PrimitiveIO_string
FckTextArea	The FckTextArea uses the FCKEditor from http://www.fckeditor.net/ to do WYSIWYG editing of text
HtmlTextArea	The HtmlTextArea is a text input block that allows the user to use one of several editing interfaces to aid in the entry of HTML text. Some of the editing interfaces may be WYSIWYG editors, while others may simply supply shortcut buttons for entering HTML markup.

Variable Summary

mixed $_cols

mixed $_rows

Method Summary

WTextArea __construct ()

string getMarkup (string $fieldName)

void setColumns (integer $cols)

void setRows (integer $rows)

void setSize (int $size)

ref withRowsAndColumns (integer $rows, integer $cols, [mixed $class = 'WTextArea'])

Variables

mixed $_cols (line 30)

mixed $_rows (line 29)

Inherited Variables

Inherited from WTextInput

WTextInput::$_onchange
WTextInput::$_showError
WTextInput::$_startingDisplay
WTextInput::$_style
WTextInput::$_value

Inherited from ErrorCheckingWizardComponent

ErrorCheckingWizardComponent::$_errorMessage
ErrorCheckingWizardComponent::$_errorRule
ErrorCheckingWizardComponent::$_errorStyle

Inherited from WizardComponent

WizardComponent::$_enabled
WizardComponent::$_enabledSticky
WizardComponent::$_parent

Methods

Constructor __construct (line 52)

Constructor

access: public

WTextArea __construct ()

Redefined in descendants as:

FckTextArea::__construct() : Constructor
HtmlTextArea::__construct() : Constructor

getMarkup (line 99)

Returns a block of XHTML-valid code that contains markup for this specific component.

access: public

string getMarkup (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefinition of:

WizardComponent::getMarkup(): Returns a block of XHTML-valid code that contains markup for this specific component.

Redefined in descendants as:

FckTextArea::getMarkup() : Returns a block of XHTML-valid code that contains markup for this specific component.
HtmlTextArea::getMarkup() : Returns a block of XHTML-valid code that contains markup for this specific component.

setColumns (line 75)

Sets the number of visible columns in this textarea.

access: public

void setColumns (integer $cols)

integer $cols

Redefined in descendants as:

HtmlTextArea::setColumns() : Sets the number of visible columns in this textarea.

setRows (line 64)

Sets the number of visible rows in this textarea.

access: public

void setRows (integer $rows)

integer $rows

Redefined in descendants as:

HtmlTextArea::setRows() : Sets the number of visible rows in this textarea.

setSize (line 87)

Sets the size of this text area. This method allows Text-Areas to be used

more interchangebly with text-fields

access: public

void setSize (int $size)

int $size

withRowsAndColumns (line 40)

Virtual Constructor

return: object
static:
access: public

ref withRowsAndColumns (integer $rows, integer $cols, [mixed $class = 'WTextArea'])

integer $rows
integer $cols

Redefined in descendants as:

FckTextArea::withRowsAndColumns() : Virtual Constructor
HtmlTextArea::withRowsAndColumns() : Virtual Constructor

Inherited Methods

Inherited From WTextInput

WTextInput::addOnChange()
WTextInput::getAllValues()
WTextInput::setStartingDisplayText()
WTextInput::setStyle()
WTextInput::setValue()
WTextInput::update()
WTextInput::validate()

Inherited From ErrorCheckingWizardComponent

ErrorCheckingWizardComponent::getErrorRule()
ErrorCheckingWizardComponent::getErrorStyle()
ErrorCheckingWizardComponent::getErrorText()
ErrorCheckingWizardComponent::setErrorRule()
ErrorCheckingWizardComponent::setErrorStyle()
ErrorCheckingWizardComponent::setErrorText()

Inherited From WizardComponent

WizardComponent::getAllValues()
WizardComponent::getMarkup()
WizardComponent::getWizard()
WizardComponent::isEnabled()
WizardComponent::setEnabled()
WizardComponent::setParent()
WizardComponent::update()
WizardComponent::validate()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()