nextapp.echo.extras.app
Class RichTextArea

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.extras.app.RichTextArea

All Implemented Interfaces:

java.io.Serializable, nextapp.echo.app.RenderIdSupport

public class RichTextArea
extends nextapp.echo.app.Component

RichTextArea component: a rich text user input field which allows the user to select text styles, and insert/manipulate objects such as links, images, enumerated lists, or tables. This component may not contain children. Security warning: HTML input provided by this component should be considered potentially malicious. Directly rendering the HTML entered by one user to other users of a multi-user application without first "cleaning" it could be disastrous to the other users. For example, a user could potentially embed JavaScript code in URLs that would execute in the other users' browsers. Any cleaning operations must be performed on the client that will render such HTML (not the client sending it) or on a central trusted server.

See Also:

Serialized Form

Field Summary

static java.lang.String	DOCUMENT_CHANGED_PROPERTY
static java.lang.String	ICON_ALIGNMENT
static java.lang.String	ICON_ALIGNMENT_CENTER
static java.lang.String	ICON_ALIGNMENT_JUSTIFY
static java.lang.String	ICON_ALIGNMENT_LEFT
static java.lang.String	ICON_ALIGNMENT_RIGHT
static java.lang.String	ICON_BACKGROUND
static java.lang.String	ICON_BOLD
static java.lang.String	ICON_BULLETED_LIST
static java.lang.String	ICON_CANCEL
static java.lang.String	ICON_COPY
static java.lang.String	ICON_CUT
static java.lang.String	ICON_DELETE
static java.lang.String	ICON_FOREGROUND
static java.lang.String	ICON_FORMAT_PARAGRAPH_STYLE
static java.lang.String	ICON_FORMAT_TEXT_STYLE
static java.lang.String	ICON_HORIZONTAL_RULE
static java.lang.String	ICON_HYPERLINK
static java.lang.String	ICON_IMAGE
static java.lang.String	ICON_INDENT
static java.lang.String	ICON_ITALIC
static java.lang.String	ICON_NUMBERED_LIST
static java.lang.String	ICON_OK
static java.lang.String	ICON_OUTDENT
static java.lang.String	ICON_PARAGRAPH_STYLE_HEADING_1
static java.lang.String	ICON_PARAGRAPH_STYLE_HEADING_2
static java.lang.String	ICON_PARAGRAPH_STYLE_HEADING_3
static java.lang.String	ICON_PARAGRAPH_STYLE_HEADING_4
static java.lang.String	ICON_PARAGRAPH_STYLE_HEADING_5
static java.lang.String	ICON_PARAGRAPH_STYLE_HEADING_6
static java.lang.String	ICON_PARAGRAPH_STYLE_NORMAL
static java.lang.String	ICON_PARAGRAPH_STYLE_PREFORMATTED
static java.lang.String	ICON_PASTE
static java.lang.String	ICON_PLAIN_TEXT
static java.lang.String	ICON_REDO
static java.lang.String	ICON_SELECT_ALL
static java.lang.String	ICON_STRIKETHROUGH
static java.lang.String	ICON_SUBSCRIPT
static java.lang.String	ICON_SUPERSCRIPT
static java.lang.String	ICON_TABLE
static java.lang.String	ICON_UNDERLINE
static java.lang.String	ICON_UNDO
static java.lang.String	PROPERTY_BORDER
static java.lang.String	PROPERTY_CONTROL_PANE_BUTTON_STYLE_NAME
static java.lang.String	PROPERTY_CONTROL_PANE_ROW_STYLE_NAME
static java.lang.String	PROPERTY_CONTROL_PANE_SPLIT_PANE_STYLE_NAME
static java.lang.String	PROPERTY_ICONS
static java.lang.String	PROPERTY_MENU_STYLE_NAME
static java.lang.String	PROPERTY_TOOLBAR_BUTTON_STYLE_NAME
static java.lang.String	PROPERTY_TOOLBAR_PANEL_STYLE_NAME
static java.lang.String	PROPERTY_WINDOW_PANE_STYLE_NAME
static java.lang.String	TEXT_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

RichTextArea()
Creates a new RichTextArea with an empty StringDocument as its model.

RichTextArea(nextapp.echo.app.text.Document document)
Creates a new RichTextArea with the specified Document as its model.

Method Summary

nextapp.echo.app.Border	getBorder() Returns the border surrounding the text entry area.
java.lang.String	getControlPaneButtonStyleName()
java.lang.String	getControlPaneRowStyleName()
java.lang.String	getControlPaneSplitPaneStyleName()
nextapp.echo.app.text.Document	getDocument() Returns the model associated with this RichTextArea.
IconSet	getIcons()
java.lang.String	getMenuStyleName()
java.lang.String	getText() Returns the text contained in the Document model of this rich text area.
java.lang.String	getToolbarButtonStyleName()
java.lang.String	getToolbarPanelStyleName()
java.lang.String	getWindowPaneStyleName()
void	processInput(java.lang.String inputName, java.lang.Object inputValue)
void	setBorder(nextapp.echo.app.Border newValue) Sets the border displayed around the text entry area.
void	setControlPaneButtonStyleName(java.lang.String newValue)
void	setControlPaneRowStyleName(java.lang.String newValue)
void	setControlPaneSplitPaneStyleName(java.lang.String newValue)
void	setDocument(nextapp.echo.app.text.Document newValue) Sets the model associated with this RichTextArea.
void	setIcons(IconSet newValue)
void	setMenuStyleName(java.lang.String newValue)
void	setText(java.lang.String newValue) Sets the text of document model of this rich text area.
void	setToolbarButtonStyleName(java.lang.String newValue)
void	setToolbarPanelStyleName(java.lang.String newValue)
void	setWindowPaneStyleName(java.lang.String newValue)

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ICON_ALIGNMENT

public static final java.lang.String ICON_ALIGNMENT

See Also:

Constant Field Values

ICON_ALIGNMENT_CENTER

public static final java.lang.String ICON_ALIGNMENT_CENTER

See Also:

Constant Field Values

ICON_ALIGNMENT_JUSTIFY

public static final java.lang.String ICON_ALIGNMENT_JUSTIFY

See Also:

Constant Field Values

ICON_ALIGNMENT_LEFT

public static final java.lang.String ICON_ALIGNMENT_LEFT

See Also:

Constant Field Values

ICON_ALIGNMENT_RIGHT

public static final java.lang.String ICON_ALIGNMENT_RIGHT

See Also:

Constant Field Values

ICON_BACKGROUND

public static final java.lang.String ICON_BACKGROUND

See Also:

Constant Field Values

ICON_BOLD

public static final java.lang.String ICON_BOLD

See Also:

Constant Field Values

ICON_BULLETED_LIST

public static final java.lang.String ICON_BULLETED_LIST

See Also:

Constant Field Values

ICON_CANCEL

public static final java.lang.String ICON_CANCEL

See Also:

Constant Field Values

ICON_COPY

public static final java.lang.String ICON_COPY

See Also:

Constant Field Values

ICON_CUT

public static final java.lang.String ICON_CUT

See Also:

Constant Field Values

ICON_DELETE

public static final java.lang.String ICON_DELETE

See Also:

Constant Field Values

ICON_FOREGROUND

public static final java.lang.String ICON_FOREGROUND

See Also:

Constant Field Values

ICON_FORMAT_PARAGRAPH_STYLE

public static final java.lang.String ICON_FORMAT_PARAGRAPH_STYLE

See Also:

Constant Field Values

ICON_FORMAT_TEXT_STYLE

public static final java.lang.String ICON_FORMAT_TEXT_STYLE

See Also:

Constant Field Values

ICON_HORIZONTAL_RULE

public static final java.lang.String ICON_HORIZONTAL_RULE

See Also:

Constant Field Values

ICON_HYPERLINK

public static final java.lang.String ICON_HYPERLINK

See Also:

Constant Field Values

ICON_IMAGE

public static final java.lang.String ICON_IMAGE

See Also:

Constant Field Values

ICON_INDENT

public static final java.lang.String ICON_INDENT

See Also:

Constant Field Values

ICON_ITALIC

public static final java.lang.String ICON_ITALIC

See Also:

Constant Field Values

ICON_NUMBERED_LIST

public static final java.lang.String ICON_NUMBERED_LIST

See Also:

Constant Field Values

ICON_OK

public static final java.lang.String ICON_OK

See Also:

Constant Field Values

ICON_OUTDENT

public static final java.lang.String ICON_OUTDENT

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_HEADING_1

public static final java.lang.String ICON_PARAGRAPH_STYLE_HEADING_1

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_HEADING_2

public static final java.lang.String ICON_PARAGRAPH_STYLE_HEADING_2

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_HEADING_3

public static final java.lang.String ICON_PARAGRAPH_STYLE_HEADING_3

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_HEADING_4

public static final java.lang.String ICON_PARAGRAPH_STYLE_HEADING_4

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_HEADING_5

public static final java.lang.String ICON_PARAGRAPH_STYLE_HEADING_5

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_HEADING_6

public static final java.lang.String ICON_PARAGRAPH_STYLE_HEADING_6

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_NORMAL

public static final java.lang.String ICON_PARAGRAPH_STYLE_NORMAL

See Also:

Constant Field Values

ICON_PARAGRAPH_STYLE_PREFORMATTED

public static final java.lang.String ICON_PARAGRAPH_STYLE_PREFORMATTED

See Also:

Constant Field Values

ICON_PASTE

public static final java.lang.String ICON_PASTE

See Also:

Constant Field Values

ICON_PLAIN_TEXT

public static final java.lang.String ICON_PLAIN_TEXT

See Also:

Constant Field Values

ICON_REDO

public static final java.lang.String ICON_REDO

See Also:

Constant Field Values

ICON_SELECT_ALL

public static final java.lang.String ICON_SELECT_ALL

See Also:

Constant Field Values

ICON_STRIKETHROUGH

public static final java.lang.String ICON_STRIKETHROUGH

See Also:

Constant Field Values

ICON_SUBSCRIPT

public static final java.lang.String ICON_SUBSCRIPT

See Also:

Constant Field Values

ICON_SUPERSCRIPT

public static final java.lang.String ICON_SUPERSCRIPT

See Also:

Constant Field Values

ICON_TABLE

public static final java.lang.String ICON_TABLE

See Also:

Constant Field Values

ICON_UNDERLINE

public static final java.lang.String ICON_UNDERLINE

See Also:

Constant Field Values

ICON_UNDO

public static final java.lang.String ICON_UNDO

See Also:

Constant Field Values

DOCUMENT_CHANGED_PROPERTY

public static final java.lang.String DOCUMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

PROPERTY_BORDER

public static final java.lang.String PROPERTY_BORDER

See Also:

Constant Field Values

PROPERTY_CONTROL_PANE_BUTTON_STYLE_NAME

public static final java.lang.String PROPERTY_CONTROL_PANE_BUTTON_STYLE_NAME

See Also:

Constant Field Values

PROPERTY_CONTROL_PANE_ROW_STYLE_NAME

public static final java.lang.String PROPERTY_CONTROL_PANE_ROW_STYLE_NAME

See Also:

Constant Field Values

PROPERTY_CONTROL_PANE_SPLIT_PANE_STYLE_NAME

public static final java.lang.String PROPERTY_CONTROL_PANE_SPLIT_PANE_STYLE_NAME

See Also:

Constant Field Values

PROPERTY_ICONS

public static final java.lang.String PROPERTY_ICONS

See Also:

Constant Field Values

PROPERTY_MENU_STYLE_NAME

public static final java.lang.String PROPERTY_MENU_STYLE_NAME

See Also:

Constant Field Values

PROPERTY_TOOLBAR_BUTTON_STYLE_NAME

public static final java.lang.String PROPERTY_TOOLBAR_BUTTON_STYLE_NAME

See Also:

Constant Field Values

PROPERTY_TOOLBAR_PANEL_STYLE_NAME

public static final java.lang.String PROPERTY_TOOLBAR_PANEL_STYLE_NAME

See Also:

Constant Field Values

PROPERTY_WINDOW_PANE_STYLE_NAME

public static final java.lang.String PROPERTY_WINDOW_PANE_STYLE_NAME

See Also:

Constant Field Values

TEXT_CHANGED_PROPERTY

public static final java.lang.String TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

RichTextArea

public RichTextArea()

Creates a new RichTextArea with an empty StringDocument as its model.

RichTextArea

public RichTextArea(nextapp.echo.app.text.Document document)

Creates a new RichTextArea with the specified Document as its model.

Parameters:

document - the desired model

Method Detail

getBorder

public nextapp.echo.app.Border getBorder()

Returns the border surrounding the text entry area.

Returns:

the border

getControlPaneButtonStyleName

public java.lang.String getControlPaneButtonStyleName()

getControlPaneRowStyleName

public java.lang.String getControlPaneRowStyleName()

getControlPaneSplitPaneStyleName

public java.lang.String getControlPaneSplitPaneStyleName()

getDocument

public nextapp.echo.app.text.Document getDocument()

Returns the model associated with this RichTextArea.

Returns:

the model

getIcons

public IconSet getIcons()

getMenuStyleName

public java.lang.String getMenuStyleName()

getText

public java.lang.String getText()

Returns the text contained in the Document model of this rich text area. Note that this HTML is not "cleaned" in any way, and could potentially contain malicious code.

Returns:

the text contained in the document

getToolbarButtonStyleName

public java.lang.String getToolbarButtonStyleName()

getToolbarPanelStyleName

public java.lang.String getToolbarPanelStyleName()

getWindowPaneStyleName

public java.lang.String getWindowPaneStyleName()

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

Overrides:

processInput in class nextapp.echo.app.Component

See Also:

Component.processInput(java.lang.String, java.lang.Object)

setBorder

public void setBorder(nextapp.echo.app.Border newValue)

Sets the border displayed around the text entry area.

Parameters:

newValue - the new border

setControlPaneButtonStyleName

public void setControlPaneButtonStyleName(java.lang.String newValue)

setControlPaneRowStyleName

public void setControlPaneRowStyleName(java.lang.String newValue)

setControlPaneSplitPaneStyleName

public void setControlPaneSplitPaneStyleName(java.lang.String newValue)

setDocument

public void setDocument(nextapp.echo.app.text.Document newValue)

Sets the model associated with this RichTextArea.

Parameters:

newValue - the new model (may not be null)

setIcons

public void setIcons(IconSet newValue)

setMenuStyleName

public void setMenuStyleName(java.lang.String newValue)

setText

public void setText(java.lang.String newValue)

Sets the text of document model of this rich text area.

Parameters:

newValue - the new text

setToolbarButtonStyleName

public void setToolbarButtonStyleName(java.lang.String newValue)

setToolbarPanelStyleName

public void setToolbarPanelStyleName(java.lang.String newValue)

setWindowPaneStyleName

public void setWindowPaneStyleName(java.lang.String newValue)