Class: THtmlArea

Source Location: /Web/UI/WebControls/THtmlArea.php

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TTextBox
            |
            --THtmlArea

THtmlArea class

Class Details

[line 75]
THtmlArea class

THtmlArea wraps the visual editting functionalities provided by the TinyMCE project http://tinymce.moxiecode.com/.

THtmlArea displays a WYSIWYG text area on the Web page for user input in the HTML format. The text displayed in the THtmlArea component is specified or determined by using the Text property.

To enable the visual editting on the client side, set the property EnableVisualEdit to true (which is default value). To set the size of the editor when the visual editting is enabled, set the Width and Height properties instead of Columns and Rows because the latter has no meaning under the situation.

To prevent the text displayed in the component from being modified, set the ReadOnly property to true. (If EnableVisualEdit is set to true, the user will still be able to modify the text on the client side, however the server side text will not be changed. Future version of this component may correct this inconsistency.)

Note, Text will be HTML encoded before it is displayed in the THtmlArea component. If you don't want it to be so, set EncodeText to false.

Note, to use this component, you have to copy the directory "<framework>/js/htmlarea" to the "js" directory which should be under the directory containing the entry script file.

Namespace: System.Web.UI.WebControls

Properties

EnableVisualEdit, boolean, default=true, kept in viewstate
Gets or sets whether WYSIWYG editting capability should be enabled.
Culture, string, kept in viewstate
Gets or sets culture (language) of the displaying editor dialogs.
Options, string, kept in viewstate
Gets or sets a list of options for the WYSIWYG (TinyMCE) editor.
See http://tinymce.moxiecode.com/tinymce/docs/index.html for TinyMCE manual.

Compatibility

The client-side visual editting capability is supported by

Internet Explorer 5.5+ for Windows, Mozilla 1.3+, Mozilla Firefox, Netscape 7.1+ and any other Gecko-based browser. If the browser does not support the visual editting, a traditional textarea will be displayed.

version:	v1.0, last update on 2004/08/13 21:44:52
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Constants

JS_HTMLAREA

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TTextBox

TTextBox::allowBody(): Overrides parent implementation to disable body addition.
TTextBox::getAttributesToRender(): Returns the attributes to be rendered.
TTextBox::getColumns()
TTextBox::getMaxLength()
TTextBox::getRows()
TTextBox::getText()
TTextBox::getTextMode()
TTextBox::getValidationPropertyValue(): Returns the value of the property that needs validation.
TTextBox::isAutoPostBack()
TTextBox::isAutoTrim()
TTextBox::isEncodeText()
TTextBox::isReadOnly()
TTextBox::isWrap()
TTextBox::loadPostData(): Loads user input data.
TTextBox::onTextChanged(): This method is invoked when the value of the Text property changes between posts to the server.
TTextBox::raisePostDataChangedEvent(): Raises postdata changed event.
TTextBox::render(): Renders the text box
TTextBox::setAutoPostBack(): Sets the value indicating if postback automatically.
TTextBox::setAutoTrim(): Sets the value indicating if the input text should be trimmed spaces
TTextBox::setColumns(): Sets the display width of the text box in characters.
TTextBox::setEncodeText(): Sets the value indicating whether the text should be HTML encoded before rendering
TTextBox::setMaxLength(): Sets the maximum number of characters allowed in the text box.
TTextBox::setReadOnly()
TTextBox::setRows(): Sets the number of rows displayed in a multiline text box.
TTextBox::setText(): Sets the text content of the TTextBox component.
TTextBox::setTextMode(): Sets the behavior mode (SingleLine, MultiLine, or Password) of the TTextBox component.
TTextBox::setWrap(): Sets the value indicating whether the text content wraps within a multiline text box.

Class: TWebControl

TWebControl::appendJavascriptEvent(): Append a javascript statement to a particular attribute, e.g. "onclick".
TWebControl::getAccessKey()
TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getForeColor()
TWebControl::getHeight()
TWebControl::getJavascriptEvents(): Get the list of all the javascript statements.
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::isEnabled()
TWebControl::parseStyle(): Parses a CSS style string into an array representation.
TWebControl::removeJavascriptEvent(): Remove all or a particular javascript statements.
TWebControl::setAccessKey(): Sets the access key of the control.
TWebControl::setBackColor(): Sets the background color of the control
TWebControl::setBorderColor(): Sets the border color of the control
TWebControl::setBorderStyle(): Sets the border style of the control
TWebControl::setBorderWidth(): Sets the border width of the control
TWebControl::setCssClass(): Sets the CSS class name of the control
TWebControl::setEnabled(): Enables or disables a control.
TWebControl::setForeColor(): Sets the foreground color of the control
TWebControl::setHeight(): Sets the height of the control
TWebControl::setStyle(): Sets the CSS style of the control.
TWebControl::setTabIndex(): Sets the tab index of the control.
TWebControl::setToolTip(): Sets the tooltip of the control.
TWebControl::setWidth(): Sets the width of the control

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

method enableVisualEdit [line 114]

void enableVisualEdit(
boolean
$value)

Sets whether to show WYSIWYG text editor.

access:

public

Parameters:

boolean

$value

whether to show WYSIWYG text editor

[ Top ]

method getCulture [line 123]

string getCulture(
)

Gets the current culture.

return:	current culture, e.g. en_AU.
access:	public

[ Top ]

method getJsOptions [line 211]

void getJsOptions(
)

access:

protected

[ Top ]

method getLanguageSuffix [line 243]

void getLanguageSuffix(
mixed
$culture)

access:

protected

[ Top ]

method getOptions [line 142]

string getOptions(
)

Gets the list of options for the WYSIWYG (TinyMCE) editor

return:	options
access:	public
see:	http://tinymce.moxiecode.com/tinymce/docs/index.html

[ Top ]

method getTextMode [line 87]

string getTextMode(
)

Overrides the parent implementation.

TextMode for THtmlArea control is always 'MultiLine'

return:	the behavior mode of the THtmlArea component.
access:	public

Overrides TTextBox::getTextMode() (parent method not documented)

[ Top ]

method isVisualEditEnabled [line 105]

boolean isVisualEditEnabled(
)

return:	whether to show WYSIWYG text editor
access:	public

[ Top ]

method parseOptions [line 230]

void parseOptions(
mixed
$string)

access:

protected

[ Top ]

method render [line 161]

string render(
)

Renders the HTMLArea

return:	the rendering result
access:	public

Overrides TTextBox::render() (Renders the text box)

[ Top ]

method renderJsEditor [line 187]

void renderJsEditor(
)

access:

protected

[ Top ]

method renderJsOptions [line 203]

void renderJsOptions(
mixed
$options)

access:

protected

[ Top ]

method setCulture [line 132]

void setCulture(
string
$value)

Sets the culture/language for the date picker.

access:

public

Parameters:

string

$value

a culture string, e.g. en_AU.

[ Top ]

method setOptions [line 152]

void setOptions(
string
$value)

Sets the list of options for the WYSIWYG (TinyMCE) editor

access:	public
see:	http://tinymce.moxiecode.com/tinymce/docs/index.html

Parameters:

string

$value

options

[ Top ]

method setTextMode [line 97]

void setTextMode(
string
$value)

Overrides the parent implementation.

TextMode for THtmlArea is always 'MultiLine' and cannot be changed to others.

access:

public

Overrides TTextBox::setTextMode() (Sets the behavior mode (SingleLine, MultiLine, or Password) of the TTextBox component.)

Parameters:

string

$value

the text mode

[ Top ]

Class Constants

JS_HTMLAREA = 'tiny_mce/'

[line 80]

URL (either relative or absolute) of javascript file that contains functions for visual editting

[ Top ]