Docs For Class FckTextArea

Description

The FckTextArea uses the FCKEditor from http://www.fckeditor.net/ to do WYSIWYG editing of text

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: FckTextArea.class.php,v 1.3 2007/09/19 14:04:50 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2007, Middlebury College
since: 9/6/07

Located in /polyphony/main/library/Wizard/Components/FckTextArea.class.php (line 27)

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

Variable Summary

object $editor

Method Summary

void __construct ()

void enableFileBrowsingAtUrl (string $url)

string getMarkup (string $fieldName)

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

Variables

object $editor (line 48)

access: public
since: 9/6/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

Constructor __construct (line 57)

Constructor

access: public
since: 9/5/07

void __construct ()

Redefinition of:

WTextArea::__construct(): Constructor

enableFileBrowsingAtUrl (line 96)

Set a file browser URL and enable uploading. This is a helper method, the same effect can be accomplished by modifying the editor configuration directly.

access: public
since: 9/6/07

void enableFileBrowsingAtUrl (string $url)

string $url

getMarkup (line 112)

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.

withRowsAndColumns (line 39)

Virtual Constructor

return: object
static:
access: public

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

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