Docs For Class RichTextArea

Description

RocketSledObject
   |
   --FormInput
      |
      --RichTextArea

Located in File: /rs/packages/sys/display/form/rich_text_area.class.php

This represents a Rich Text Input area. Currently this uses the external RTE library. To create a rich text area use:

<richtext name="my_rte">
<validation type="REQUIRED">
<error-message>You need to enter a value for my rte</error-message>
</validation>
<content>Here is some default content to include. <b>It can have some HTML formatting</b></content>
</richtext>

This will produce a form input that allows your user to do things like create html links, lists, bold text etc. This will be changing in the near future from using RTE to using the dojo package.

todo: - update this meta widget to use the dojo Editor
copyright: - Iain Dooley 2003 - 2004
extends: - FormInput
see: - RteUtility
access: - public
author: - Iain Dooley <iain@iaindooley.com>

Class Variables

Summary:

mixed $cols

mixed $rows

mixed $value

$cols (line 35)

Data type : mixed

The number of columns for the area

$rows (line 31)

Data type : mixed

The number of rows for the area

$value (line 39)

Data type : mixed

The value to be displayed in the area

Class Constants

Summary:

Method Detail

Summary:

RichTextArea RichTextArea ( $name, $class, $id, [ $value = ''])

void getTemplateData ([ $vars = ''])

void setValue ( $value)

void value ()

Constructor RichTextArea (line 44)

RichTextArea RichTextArea( $name, $class, $id, [ $value = ''])

Create a new RichTextArea object

Parameters

$name:
$class:
$id:
$value:

Info

Method getTemplateData (line 65)

void getTemplateData( [ $vars = ''])

Overrides : FormInput::getTemplateData() parent method not documented

Abstract method to print out this field using the appropriate method in the Display class

Parameters

$vars:

Info

Method setValue (line 51)

void setValue( $value)

Overrides : FormInput::setValue() parent method not documented

Parameters

$value:

Info

Method value (line 56)

void value( )

Overrides : FormInput::value() parent method not documented

Class RichTextArea

Description

This represents a Rich Text Input area. Currently this uses the external RTE library. To create a rich text area use:

Class Variables

$cols (line 35)

Data type : mixed

The number of columns for the area

$rows (line 31)

Data type : mixed

The number of rows for the area

$value (line 39)

Data type : mixed

The value to be displayed in the area

Class Constants

Method Detail

Constructor RichTextArea (line 44)

RichTextArea RichTextArea( $name, $class, $id, [ $value = ''])

Create a new RichTextArea object

Parameters

Info

Method getTemplateData (line 65)

void getTemplateData( [ $vars = ''])

Abstract method to print out this field using the appropriate method in the Display class

Parameters

Info

Method setValue (line 51)

void setValue( $value)

Parameters

Info

Method value (line 56)

void value( )

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class RocketSledObject

RocketSledObject::$display_info_values - An array of display information values

Inherited Methods

Inherited Method Summary

Inherited From Class FormInput

FormInput::FormInput() - Create a new FormInput object

FormInput::addOption() - Add an option by an already constructed array

FormInput::addOptions() - Add options as an associative array

FormInput::allowsOptions() - Return whether or not this object is allowed options

FormInput::getTemplateData() -

FormInput::name() -

FormInput::setAllowsOptions() - Set whether or not this object is allowed options

FormInput::setOptions() - Set the options array using an associative array

FormInput::setValue() -

FormInput::setValueOverride() -

FormInput::toHTML() -

FormInput::toString() -

FormInput::value() -

FormInput::valueOverride() -

Inherited From Class RocketSledObject

RocketSledObject::RocketSledObject() - Create a new RocketSledObject

RocketSledObject::displayInfoValue() - Retrieve some display information for this object

RocketSledObject::displayInfoValues() - Return all display info values

RocketSledObject::getClass() - Return the class of the current object

RocketSledObject::offsetExists() -

RocketSledObject::offsetExists() - Implement the offsetExists method proscribed by the

RocketSledObject::offsetGet() -

RocketSledObject::offsetGet() - Implement the offsetGet method proscribed by the

RocketSledObject::offsetSet() -

RocketSledObject::offsetSet() - Implement the offsetSet method proscribed by the

RocketSledObject::offsetUnset() -

RocketSledObject::offsetUnset() - Implement the offsetUnset method proscribed by the

RocketSledObject::setDisplayInfoValue() - Store some display information for this object

RocketSledObject::setDisplayInfoValues() - Store some display information for this object

RocketSledObject::toString() - Returns a string representation of this object