Class Exanpe.RichTextEditor

Represents a RichTextEditor object
Defined in: exanpe-t5-lib.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Exanpe.RichTextEditor(id, title, collapse, include, exclude, messages, include, exclude, messages) Constructor

Field Summary
Field Attributes	Field Name and Description
	autofocus Autofocus the textarea on display or not
	buttons List of available buttons
	collapse Collapse/Expand the toolbar
	config YUI Editor config object
	exclude List of buttons to exclude
	height Editor textarea height
	id The id of the instance
	include List of buttons to include (and only these buttons)
	messages Messages for Toolbar buttons labels
	title Editor title
	width Editor textarea width
	yui The wrapped YUI Editor widget

Method Summary
Method Attributes	Method Name and Description
	beforeRenderRichTextEditor() Called before rendering RichTextEditor component Does nothing by default, override to define your own action.
	getConfig() Get the configuration object of the RichTextEditor
	getContainer() Return the container of the editor
	getToolbar() Get the YUI toolbar object of the RichTextEditor, ONCE loaded.
	save() This will trigger the editors save handler and place the new content back into the textarea before the form is submitted.

Class Detail

Exanpe.RichTextEditor(id, title, collapse, include, exclude, messages, include, exclude, messages)

Constructor

Parameters:
{String} id: the id of the RichTextEditor Mixin container element
{String} title: the title of the dialog box
{boolean} collapse: indicating if the the toolbar should have a collapse button or not
{Array} include: list of buttons to include : only theses buttons will be retained
{Array} exclude: list of buttons to exclude
{Object.} messages: the messages used to display Toolbar buttons labels
include
exclude
messages

Field Detail

autofocus

Autofocus the textarea on display or not

buttons

List of available buttons

collapse

Collapse/Expand the toolbar

config

YUI Editor config object

exclude

List of buttons to exclude

height

Editor textarea height

The id of the instance

include

List of buttons to include (and only these buttons)

messages

Messages for Toolbar buttons labels

title

Editor title

width

Editor textarea width

yui

The wrapped YUI Editor widget

Method Detail

beforeRenderRichTextEditor()

Called before rendering RichTextEditor component Does nothing by default, override to define your own action.

{Object} getConfig()

Get the configuration object of the RichTextEditor

Returns:: {Object} the json object used to configure the RTE

{HTMLElement} getContainer()

Return the container of the editor

Returns:: {HTMLElement} the DOM element corresponding to the editor container

{Object} getToolbar()

Get the YUI toolbar object of the RichTextEditor, ONCE loaded.

Returns:: {Object} the json object used to configure the toolbar

save()

This will trigger the editors save handler and place the new content back into the textarea before the form is submitted. A listener is attached on the native Tapestry.FORM_PREPARE_FOR_SUBMIT_EVENT event to the textarea parent form.

Classes

Class Exanpe.RichTextEditor