com.vaadin.ui.

java.lang.Object
- com.vaadin.server.AbstractClientConnector
- - com.vaadin.ui.AbstractComponent
  - - com.vaadin.ui.AbstractField<String>
    - - com.vaadin.ui.RichTextArea

All Implemented Interfaces:

HasValue<String>, ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, HasValueChangeMode, Serializable
```
public class RichTextArea
extends AbstractField<String>
implements HasValueChangeMode
```
A simple RichTextArea to edit HTML format text.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
  ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
- Nested classes/interfaces inherited from interface com.vaadin.ui.Component
  Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
- Nested classes/interfaces inherited from interface com.vaadin.data.HasValue
  HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>
- Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
  Sizeable.Unit

Field Summary
- Fields inherited from class com.vaadin.ui.AbstractComponent
  DESIGN_ATTR_PLAIN_TEXT
- Fields inherited from interface com.vaadin.server.Sizeable
  SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors
Constructor	Description
`RichTextArea()`	Constructs an empty `RichTextArea` with no caption.
`RichTextArea(HasValue.ValueChangeListener<String> valueChangeListener)`	Constructs a new `RichTextArea` with a value change listener.
`RichTextArea(String caption)`	Constructs an empty `RichTextArea` with the given caption.
`RichTextArea(String caption, HasValue.ValueChangeListener<String> valueChangeListener)`	Constructs a new `RichTextArea` with the given caption and a value change listener.
`RichTextArea(String caption, String value)`	Constructs a new `RichTextArea` with the given caption and initial text contents.
`RichTextArea(String caption, String value, HasValue.ValueChangeListener<String> valueChangeListener)`	Constructs a new `RichTextArea` with the given caption, initial text contents and a value change listener.

Method Summary

All Methods
Modifier and Type	Method	Description
`void`	`addSnippet(Snippet snippet)`	Add a `Snippet` object to the menu.
`void`	`addSnippet(String snippet)`	Add a predefined content snippet to the menu.
`void`	`addSnippet(String title, String snippet)`	Add a predefined content snippet to the menu.
`void`	`addSnippets(String[] snippets)`	Add predefined content snippets to the menu.
`void`	`addSnippets(String[] titles, String[] snippets)`	Add predefined content snippets to the menu.
`void`	`addSnippets(Collection<Snippet> snippets)`	Add `Snippet` objects to the menu.
`void`	`clearSnippets()`	Remove all snippets - this also hides the snippets drop-down unless new snippets are added.
`protected void`	`doSetValue(String value)`	Sets the value of this field.
`String`	`getEmptyValue()`	Returns the value that represents an empty value.
`protected RichTextAreaState`	`getState()`	Returns the shared state bean with information to be sent from the server to the client.
`protected RichTextAreaState`	`getState(boolean markAsDirty)`	Returns the shared state for this connector.
`String`	`getValue()`	Returns the current value of this object.
`ValueChangeMode`	`getValueChangeMode()`	Returns the currently set `ValueChangeMode`.
`int`	`getValueChangeTimeout()`	Returns the currently set timeout, in milliseconds, for how often `HasValue.ValueChangeEvent`s are triggered if the current `ValueChangeMode` is set to either `ValueChangeMode.LAZY` or `ValueChangeMode.TIMEOUT`.
`void`	`readDesign(org.jsoup.nodes.Element design, DesignContext designContext)`	Reads the component state from the given design.
`void`	`selectAll()`	Selects all text in the rich text area.
`void`	`setValue(String value)`	Sets the value of this object.
`void`	`setValueChangeMode(ValueChangeMode mode)`	Sets the mode how the TextField triggers `HasValue.ValueChangeEvent`s.
`void`	`setValueChangeTimeout(int timeout)`	Sets how often `HasValue.ValueChangeEvent`s are triggered when the `ValueChangeMode` is set to either `ValueChangeMode.LAZY` or `ValueChangeMode.TIMEOUT`.
`void`	`writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)`	Writes the component state to the given design.

Methods inherited from class com.vaadin.ui.AbstractField
addValueChangeListener, createValueChange, focus, getCustomAttributes, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue

Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.shared.Connector
getConnectorId

Methods inherited from interface com.vaadin.data.HasValue
clear, getDefaultValidator, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

- Constructor Detail
  - RichTextArea
```
public RichTextArea()
```
    Constructs an empty RichTextArea with no caption.
  - RichTextArea
```
public RichTextArea(String caption)
```
    Constructs an empty RichTextArea with the given caption.
    
    Parameters:
    
    caption - the caption for the editor.
  - RichTextArea
```
public RichTextArea(String caption,
                    String value)
```
    Constructs a new RichTextArea with the given caption and initial text contents.
    
    Parameters:
    
    caption - the caption for the editor.
    
    value - the initial text content of the editor, not null
  - RichTextArea
```
public RichTextArea(HasValue.ValueChangeListener<String> valueChangeListener)
```
    Constructs a new RichTextArea with a value change listener.
    The listener is called when the value of this TextField is changed either by the user or programmatically.
    
    Parameters:
    
    valueChangeListener - the value change listener, not null
    
    Since:
    
    8.0
  - RichTextArea
```
public RichTextArea(String caption,
                    HasValue.ValueChangeListener<String> valueChangeListener)
```
    Constructs a new RichTextArea with the given caption and a value change listener.
    The listener is called when the value of this TextField is changed either by the user or programmatically.
    
    Parameters:
    
    caption - the caption for the field
    
    valueChangeListener - the value change listener, not null
    
    Since:
    
    8.0
  - RichTextArea
```
public RichTextArea(String caption,
                    String value,
                    HasValue.ValueChangeListener<String> valueChangeListener)
```
    Constructs a new RichTextArea with the given caption, initial text contents and a value change listener.
    The listener is called when the value of this RichTextArea is changed either by the user or programmatically.
    
    Parameters:
    
    caption - the caption for the field
    
    value - the value for the field, not null
    
    valueChangeListener - the value change listener, not null
    
    Since:
    
    8.0
- Method Detail
  - readDesign
```
public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext designContext)
```
    Description copied from interface: Component
    
    Reads the component state from the given design.
    The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.
    It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.
    This method must not modify the design.
    
    Specified by:
    
    readDesign in interface Component
    
    Overrides:
    
    readDesign in class AbstractField<String>
    
    Parameters:
    
    design - The element to obtain the state from
    
    designContext - The DesignContext instance used for parsing the design
  - writeDesign
```
public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext designContext)
```
    Description copied from interface: Component
    
    Writes the component state to the given design.
    The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.
    This method must not modify the component state.
    
    Specified by:
    
    writeDesign in interface Component
    
    Overrides:
    
    writeDesign in class AbstractField<String>
    
    Parameters:
    
    design - The element to write the component state to. Any previous attributes or child nodes are not cleared.
    
    designContext - The DesignContext instance used for writing the design
  - getState
```
protected RichTextAreaState getState()
```
    Description copied from class: AbstractComponent
    
    Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
    
    Overrides:
    
    getState in class AbstractField<String>
    
    Returns:
    
    updated component shared state
  - getState
```
protected RichTextAreaState getState(boolean markAsDirty)
```
    Description copied from class: AbstractClientConnector
    
    Returns the shared state for this connector.
    
    Overrides:
    
    getState in class AbstractField<String>
    
    Parameters:
    
    markAsDirty - true if the connector should automatically be marked dirty, false otherwise
    
    Returns:
    
    The shared state for this connector. Never null.
    
    See Also:
    
    AbstractClientConnector.getState()
  - setValue
```
public void setValue(String value)
```
    Sets the value of this object. If the new value is not equal to getValue(), fires a HasValue.ValueChangeEvent. Throws NullPointerException if the value is null.
    
    Specified by:
    
    setValue in interface HasValue<String>
    
    Overrides:
    
    setValue in class AbstractField<String>
    
    Parameters:
    
    value - the new value, not null
    
    Throws:
    
    NullPointerException - if value is null
  - getValue
```
public String getValue()
```
    Description copied from interface: HasValue
    
    Returns the current value of this object.
    Implementation note: the implementing class should document whether null values may be returned or not.
    
    Specified by:
    
    getValue in interface HasValue<String>
    
    Returns:
    
    the current value
  - getEmptyValue
```
public String getEmptyValue()
```
    Description copied from interface: HasValue
    
    Returns the value that represents an empty value.
    By default HasValue is expected to support null as empty values. Specific implementations might not support this.
    
    Specified by:
    
    getEmptyValue in interface HasValue<String>
    
    Returns:
    
    empty value
    
    See Also:
    
    Binder#bind(HasValue, ValueProvider, Setter)
  - doSetValue
```
protected void doSetValue(String value)
```
    Description copied from class: AbstractField
    
    Sets the value of this field. May do sanitization or throw IllegalArgumentException if the value is invalid. Typically saves the value to shared state.
    
    Specified by:
    
    doSetValue in class AbstractField<String>
    
    Parameters:
    
    value - the new value of the field
  - selectAll
```
public void selectAll()
```
    Selects all text in the rich text area. As a side effect, focuses the rich text area.
    
    Since:
    
    6.5
  - setValueChangeMode
```
public void setValueChangeMode(ValueChangeMode mode)
```
    Description copied from interface: HasValueChangeMode
    
    Sets the mode how the TextField triggers HasValue.ValueChangeEvents.
    
    Specified by:
    
    setValueChangeMode in interface HasValueChangeMode
    
    Parameters:
    
    mode - the new mode
    
    See Also:
    
    ValueChangeMode
  - getValueChangeMode
```
public ValueChangeMode getValueChangeMode()
```
    Description copied from interface: HasValueChangeMode
    
    Returns the currently set ValueChangeMode.
    
    Specified by:
    
    getValueChangeMode in interface HasValueChangeMode
    
    Returns:
    
    the mode used to trigger HasValue.ValueChangeEvents.
    
    See Also:
    
    ValueChangeMode
  - setValueChangeTimeout
```
public void setValueChangeTimeout(int timeout)
```
    Description copied from interface: HasValueChangeMode
    
    Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to either ValueChangeMode.LAZY or ValueChangeMode.TIMEOUT.
    
    Specified by:
    
    setValueChangeTimeout in interface HasValueChangeMode
    
    Parameters:
    
    timeout - timeout in milliseconds, must be greater or equal to 0
    
    See Also:
    
    ValueChangeMode
  - getValueChangeTimeout
```
public int getValueChangeTimeout()
```
    Description copied from interface: HasValueChangeMode
    
    Returns the currently set timeout, in milliseconds, for how often HasValue.ValueChangeEvents are triggered if the current ValueChangeMode is set to either ValueChangeMode.LAZY or ValueChangeMode.TIMEOUT.
    
    Specified by:
    
    getValueChangeTimeout in interface HasValueChangeMode
    
    Returns:
    
    the timeout in milliseconds of how often HasValue.ValueChangeEvents are triggered.
  - addSnippet
```
public void addSnippet(String snippet)
```
    Add a predefined content snippet to the menu. HTML formatting is allowed. Drop-down menu is visible after the first snippet is added. The title of the snippet is automatically generated from the first 20 characters of the snippet.
    
    Parameters:
    
    snippet - snippet text, can be HTML formatted
    
    Since:
    
    8.16
  - addSnippet
```
public void addSnippet(String title,
                       String snippet)
```
    Add a predefined content snippet to the menu. HTML formatting is allowed in the snippet text. Drop down menu is visible after the first snippet is added. This method allows assigning a custom title to the added snippet.
    
    Parameters:
    
    title - string to display in drop-down menu
    
    snippet - snippet text, can be HTML formatted
    
    Since:
    
    8.16
  - addSnippet
```
public void addSnippet(Snippet snippet)
```
    Add a Snippet object to the menu. Drop-down menu is visible after the first snippet is added.
    
    Parameters:
    
    snippet - a Snippet object
    
    Since:
    
    8.16
  - addSnippets
```
public void addSnippets(String[] snippets)
```
    Add predefined content snippets to the menu. HTML formatting is allowed. Drop down menu is visible after the first snippet is added. The titles of snippets in the drop-down menu are automatically generated from the first 20 characters of the snippet text.
    
    Parameters:
    
    snippets - array of snippet body text, can be HTML formatted
    
    Since:
    
    8.16
  - addSnippets
```
public void addSnippets(String[] titles,
                        String[] snippets)
```
    Add predefined content snippets to the menu. HTML formatting is allowed in the snippet text. Drop-down menu is visible after the first snippet is added. Each snippet is assigned a title from the titles array, or has one automatically generated from the snippet text if the corresponding value in the titles array is null. The array sizes must match exactly.
    
    Parameters:
    
    titles - array of strings to display as snippet titles. This array may include nulls, in which case the title is automatically generated from the first 20 characters in the snippet text.
    
    snippets - array of snippet text, can be HTML formatted
    
    Since:
    
    8.16
  - addSnippets
```
public void addSnippets(Collection<Snippet> snippets)
```
    Add Snippet objects to the menu. Drop-down menu is visible after the first snippet has been added.
    
    Parameters:
    
    snippets - a Collection of Snippet objects
    
    Since:
    
    8.16
  - clearSnippets
```
public void clearSnippets()
```
    Remove all snippets - this also hides the snippets drop-down unless new snippets are added.
    
    Since:
    
    8.16

com.vaadin.ui.

Class RichTextArea

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

Fields inherited from interface com.vaadin.server.Sizeable

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.ui.AbstractField

Methods inherited from class com.vaadin.ui.AbstractComponent

Methods inherited from class com.vaadin.server.AbstractClientConnector

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.server.ClientConnector

Methods inherited from interface com.vaadin.ui.Component

Methods inherited from interface com.vaadin.shared.Connector

Methods inherited from interface com.vaadin.data.HasValue

Methods inherited from interface com.vaadin.server.Sizeable

Constructor Detail

RichTextArea

RichTextArea

RichTextArea

RichTextArea

RichTextArea

RichTextArea

Method Detail

readDesign

writeDesign

getState

getState

setValue

getValue

getEmptyValue

doSetValue

selectAll

setValueChangeMode

getValueChangeMode

setValueChangeTimeout

getValueChangeTimeout

addSnippet

addSnippet

addSnippet

addSnippets

addSnippets

addSnippets

clearSnippets