Class HtmlTextArea

Description
Description | Vars (details) | Methods (details)

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.

Located in /polyphony/main/library/Wizard/Components/HtmlTextArea.class.php (line 28) 

SObject
   |
   --WizardComponent
      |
      --ErrorCheckingWizardComponent
         |
         --WTextInput
            |
            --WTextArea
               |
               --HtmlTextArea
Variable Summary
Description | Vars (details) | Methods (details)
object $editorChoice
array $editors
Method Summary
Description | Vars (details) | Methods (details)
void __construct ()
void addEditor (string $name, string $displayName, WTextArea $editor)
void addOnChange (string $commands)
void chooseEditor (string $name)
object WTextArea getCurrentEditor ()
void getEditor (string $name)
string getMarkup (string $fieldName)
void setColumns (integer $cols)
void setRows (integer $rows)
void setStartingDisplayText (string $text)
void setStyle (string $style)
void setValue (string $value)
boolean update (string $fieldName)
boolean validate ()
ref withRowsAndColumns (integer $rows, integer $cols, [mixed $class = 'HtmlTextArea'])
Variables
Description | Vars (details) | Methods (details)
object $editorChoice (line 49)
  • var: A slect field for the editor choice
  • access: private
  • since: 9/5/07
array $editors = array() (line 56)
  • access: private
  • since: 9/5/07

Inherited Variables

Inherited from WTextArea

WTextArea::$_cols
 WTextArea::$_rows

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
Description | Vars (details) Methods (details)
Constructor __construct (line 65)

Constructor

  • access: public
  • since: 9/5/07
void __construct ()
Redefinition of:
WTextArea::__construct()
Constructor
addEditor (line 87)

Add a new editor to those supported

  • access: public
  • since: 9/5/07
void addEditor (string $name, string $displayName, WTextArea $editor)
addOnChange (line 202)

Add commands to the javascript onchange attribute.

  • access: public
void addOnChange (string $commands)
  • string $commands
Redefinition of:
WTextInput::addOnChange()
Add commands to the javascript onchange attribute.
chooseEditor (line 105)

Choose an editor.

  • access: public
  • since: 9/5/07
void chooseEditor (string $name)
  • string $name
getCurrentEditor (line 142)

Answer the current Editor

  • access: public
  • since: 9/5/07
object WTextArea getCurrentEditor ()
getEditor (line 129)

Answer an editor so that it may be configured

  • access: public
  • since: 9/5/07
void getEditor (string $name)
  • string $name
getMarkup (line 255)

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:
WTextArea::getMarkup()
Returns a block of XHTML-valid code that contains markup for this specific component.
setColumns (line 169)

Sets the number of visible columns in this textarea.

  • access: public
void setColumns (integer $cols)
  • integer $cols
Redefinition of:
WTextArea::setColumns()
Sets the number of visible columns in this textarea.
setRows (line 158)

Sets the number of visible rows in this textarea.

  • access: public
void setRows (integer $rows)
  • integer $rows
Redefinition of:
WTextArea::setRows()
Sets the number of visible rows in this textarea.
setStartingDisplayText (line 180)

Sets the text of the field to display until the user enters the field.

  • access: public
void setStartingDisplayText (string $text)
  • string $text
Redefinition of:
WTextInput::setStartingDisplayText()
Sets the text of the field to display until the user enters the field.
setStyle (line 191)

Sets the CSS style of this field.

  • access: public
void setStyle (string $style)
  • string $style
Redefinition of:
WTextInput::setStyle()
Sets the CSS style of this field.
setValue (line 242)

Sets the value of this text field.

  • access: public
void setValue (string $value)
  • string $value
Redefinition of:
WTextInput::setValue()
Sets the value of this text field.
update (line 226)

Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

  • return: - TRUE if everything is OK
  • access: public
boolean update (string $fieldName)
  • string $fieldName: The field name to use when outputting form data or similar parameters/information.
Redefinition of:
WTextInput::update()
Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.
validate (line 213)

Returns true if this component (and all child components if applicable) have valid values.

By default, this will just return TRUE.

  • access: public
boolean validate ()
Redefinition of:
WTextInput::validate()
Returns true if this component (and all child components if applicable) have valid values.
withRowsAndColumns (line 40)

Virtual Constructor

  • return: object
  • static:
  • access: public
ref withRowsAndColumns (integer $rows, integer $cols, [mixed $class = 'HtmlTextArea'])
  • integer $rows
  • integer $cols
Redefinition of:
WTextArea::withRowsAndColumns()
Virtual Constructor

Inherited Methods

Inherited From WTextArea

WTextArea::__construct()
WTextArea::getMarkup()
WTextArea::setColumns()
WTextArea::setRows()
WTextArea::setSize()
WTextArea::withRowsAndColumns()

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()

Documentation generated on Wed, 19 Sep 2007 10:24:35 -0400 by phpDocumentor 1.3.0RC3