com.google.gwt.user.client.ui
Class RichTextArea

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.FocusWidget
              com.google.gwt.user.client.ui.RichTextArea

All Implemented Interfaces:

HasAllFocusHandlers, HasAllKeyHandlers, HasAllMouseHandlers, HasBlurHandlers, HasClickHandlers, HasFocusHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasInitializeHandlers, HasHandlers, EventListener, Focusable, HasFocus, HasHTML, HasText, SourcesClickEvents, SourcesFocusEvents, SourcesKeyboardEvents, SourcesMouseEvents

public class RichTextArea
extends FocusWidget
implements HasHTML, HasInitializeHandlers

A rich text editor that allows complex styling and formatting. Because some browsers do not support rich text editing, and others support only a limited subset of functionality, there are two formatter interfaces, accessed via getBasicFormatter() and getExtendedFormatter() . A browser that does not support rich text editing at all will return null for both of these, while one that supports only the basic functionality will return null for the latter.

CSS Style Rules

.gwt-RichTextArea

Applied to the rich text element.

Nested Class Summary

static interface	RichTextArea.BasicFormatter Deprecated. use RichTextArea.Formatter instead
static interface	RichTextArea.ExtendedFormatter Deprecated. use RichTextArea.Formatter instead
static class	RichTextArea.FontSize Font size enumeration.
static interface	RichTextArea.Formatter This interface is used to access full formatting options, when available.
static class	RichTextArea.Justification Justification enumeration.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

RichTextArea()
Creates a new, blank RichTextArea object with no stylesheet.

Method Summary

HandlerRegistration	addInitializeHandler(InitializeHandler handler) Adds a InitializeEvent handler.
RichTextArea.BasicFormatter	getBasicFormatter() Deprecated. use getFormatter() instead
RichTextArea.ExtendedFormatter	getExtendedFormatter() Deprecated. use getFormatter() instead
RichTextArea.Formatter	getFormatter() Gets the rich text formatting interface.
java.lang.String	getHTML() Gets this object's contents as HTML.
java.lang.String	getText() Gets this object's text.
boolean	isEnabled() Gets whether this widget is enabled.
void	setEnabled(boolean enabled) Sets whether this widget is enabled.
void	setFocus(boolean focused) Explicitly focus/unfocus this widget.
void	setHTML(java.lang.String html) Sets this object's contents via HTML.
void	setText(java.lang.String text) Sets this object's text.

Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

addBlurHandler, addClickHandler, addClickListener, addFocusHandler, addFocusListener, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, getTabIndex, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setTabIndex

Methods inherited from class com.google.gwt.user.client.ui.Widget

fireEvent, getLayoutData, getParent, isAttached, onBrowserEvent, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

RichTextArea

public RichTextArea()

Creates a new, blank RichTextArea object with no stylesheet.

Method Detail

addInitializeHandler

public HandlerRegistration addInitializeHandler(InitializeHandler handler)

Description copied from interface: HasInitializeHandlers

Adds a InitializeEvent handler.

Specified by:

addInitializeHandler in interface HasInitializeHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getBasicFormatter

@Deprecated
public RichTextArea.BasicFormatter getBasicFormatter()

Deprecated. use getFormatter() instead

Gets the basic rich text formatting interface. Note that formatting can only be done when the RichTextArea is attached, visible on the page, and has been focused by the user.

Returns:

null if basic formatting is not supported

getExtendedFormatter

@Deprecated
public RichTextArea.ExtendedFormatter getExtendedFormatter()

Deprecated. use getFormatter() instead

Gets the full rich text formatting interface. Note that formatting can only be done when the RichTextArea is attached, visible on the page, and has been focused by the user.

Returns:

null if full formatting is not supported

getFormatter

public RichTextArea.Formatter getFormatter()

Gets the rich text formatting interface. Note that formatting can only be done when the RichTextArea is attached, visible on the page, and has been focused by the user.

Returns:

null if full formatting is not supported

getHTML

public java.lang.String getHTML()

Description copied from interface: HasHTML

Gets this object's contents as HTML.

Specified by:

getHTML in interface HasHTML

Returns:

the object's HTML

getText

public java.lang.String getText()

Description copied from interface: HasText

Gets this object's text.

Specified by:

getText in interface HasText

Returns:

the object's text

isEnabled

public boolean isEnabled()

Description copied from class: FocusWidget

Gets whether this widget is enabled.

Overrides:

isEnabled in class FocusWidget

Returns:

true if the widget is enabled

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: FocusWidget

Sets whether this widget is enabled.

Overrides:

setEnabled in class FocusWidget

Parameters:

enabled - true to enable the widget, false to disable it

setFocus

public void setFocus(boolean focused)

Description copied from interface: Focusable

Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Specified by:

setFocus in interface Focusable

Overrides:

setFocus in class FocusWidget

Parameters:

focused - whether this widget should take focus or release it

setHTML

public void setHTML(java.lang.String html)

Description copied from interface: HasHTML

Sets this object's contents via HTML. Use care when setting an object's HTML; it is an easy way to expose script-based security problems. Consider using HasText.setText(String) whenever possible.

Specified by:

setHTML in interface HasHTML

Parameters:

html - the object's new HTML

setText

public void setText(java.lang.String text)

Description copied from interface: HasText

Sets this object's text.

Specified by:

setText in interface HasText

Parameters:

text - the object's new text