com.vaadin.flow.component.richtexteditor.

java.lang.Object
- com.vaadin.flow.component.Component
- - com.vaadin.flow.component.AbstractField<C,T>
  - - com.vaadin.flow.component.AbstractSinglePropertyField<R,T>
    - - com.vaadin.flow.component.richtexteditor.GeneratedVaadinRichTextEditor<RichTextEditor,String>
      - com.vaadin.flow.component.richtexteditor.RichTextEditor

All Implemented Interfaces:

AttachNotifier, CompositionNotifier, DetachNotifier, HasElement, HasEnabled, HasSize, HasStyle, HasTheme, HasValue<AbstractField.ComponentValueChangeEvent<RichTextEditor,String>,String>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<RichTextEditor,String>,String>, InputNotifier, KeyNotifier, HasValueChangeMode, Serializable
```
@Tag(value="vaadin-rich-text-editor")
 @NpmPackage(value="@vaadin/polymer-legacy-adapter",
            version="22.1.0")
 @JsModule(value="@vaadin/polymer-legacy-adapter/style-modules.js")
public class RichTextEditor
extends GeneratedVaadinRichTextEditor<RichTextEditor,String>
implements HasSize, HasValueChangeMode, InputNotifier, KeyNotifier, CompositionNotifier
```
Server-side component for the <vaadin-rich-text-editor> component.
The value of the rich text editor is in Delta format. The setValue and getValue methods deal with the default Delta format, but it is also possible to get and set the value as an HTML string using rte.asHtml().getValue(), rte.asHtml().setValue() and getHtmlValue().

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RichTextEditor.RichTextEditorI18n
The internationalization properties for RichTextEditor.
- Nested classes/interfaces inherited from class com.vaadin.flow.component.richtexteditor.GeneratedVaadinRichTextEditor
  GeneratedVaadinRichTextEditor.ChangeEvent<R extends GeneratedVaadinRichTextEditor<R,?>>
- Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
  AbstractField.ComponentValueChangeEvent<C extends Component,V>
- Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
  HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>

Field Summary
- Fields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode
  DEFAULT_CHANGE_TIMEOUT

Constructor Summary

Constructors
Constructor and Description
`RichTextEditor()` Constructs an empty `RichTextEditor`.
`RichTextEditor(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<RichTextEditor,String>> listener)` Constructs an empty `RichTextEditor` with a value change listener.
`RichTextEditor(String initialValue)` Constructs a `RichTextEditor` with the initial value
`RichTextEditor(String initialValue, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<RichTextEditor,String>> listener)` Constructs an empty `RichTextEditor` with a value change listener and an initial value.

Method Summary

All Methods
Modifier and Type	Method and Description
`HasValue<HasValue.ValueChangeEvent<String>,String>`	`asHtml()` Gets an instance of `HasValue` for binding the html value of the editor with `Binder`.
`String`	`getHtmlValue()` The value of the editor presented as an HTML string.
`RichTextEditor.RichTextEditorI18n`	`getI18n()` Gets the internationalization object previously set for this component.
`String`	`getValue()` Returns the current value of the text editor in Delta format.
`ValueChangeMode`	`getValueChangeMode()` Gets current value change mode of the component.
`void`	`setI18n(RichTextEditor.RichTextEditorI18n i18n)` Sets the internationalization properties for this component.
`void`	`setValue(String value)` Sets the value of this editor.
`void`	`setValueChangeMode(ValueChangeMode valueChangeMode)` Sets new value change mode for the component.

Methods inherited from class com.vaadin.flow.component.richtexteditor.GeneratedVaadinRichTextEditor
addChangeListener, addThemeVariants, getHtmlValueString, getI18nJsonArray, isDisabledBoolean, isReadonlyBoolean, removeThemeVariants, setDisabled, setI18n, setReadonly

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, getEmptyValue, isEmpty, setModelValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

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

Methods inherited from interface com.vaadin.flow.component.HasSize
getCssSize, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasElement
getElement

Methods inherited from interface com.vaadin.flow.data.value.HasValueChangeMode
getValueChangeTimeout, setValueChangeTimeout

Methods inherited from interface com.vaadin.flow.component.InputNotifier
addInputListener

Methods inherited from interface com.vaadin.flow.component.KeyNotifier
addKeyDownListener, addKeyDownListener, addKeyPressListener, addKeyPressListener, addKeyUpListener, addKeyUpListener

Methods inherited from interface com.vaadin.flow.component.CompositionNotifier
addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener

Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Methods inherited from interface com.vaadin.flow.component.HasValue
clear, getOptionalValue

Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener

- Constructor Detail
  - RichTextEditor
```
public RichTextEditor()
```
    Constructs an empty RichTextEditor.
  - RichTextEditor
```
public RichTextEditor(String initialValue)
```
    Constructs a RichTextEditor with the initial value
    
    Parameters:
    
    initialValue - the initial value in Delta format, not null
    
    See Also:
    
    AbstractField.setValue(Object)
  - RichTextEditor
```
public RichTextEditor(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<RichTextEditor,String>> listener)
```
    Constructs an empty RichTextEditor with a value change listener.
    
    Parameters:
    
    listener - the value change listener
    
    See Also:
    
    AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)
  - RichTextEditor
```
public RichTextEditor(String initialValue,
                      HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<RichTextEditor,String>> listener)
```
    Constructs an empty RichTextEditor with a value change listener and an initial value.
    
    Parameters:
    
    initialValue - the initial value
    
    listener - the value change listener
    
    See Also:
    
    AbstractField.setValue(Object), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)
- Method Detail
  - getI18n
```
public RichTextEditor.RichTextEditorI18n getI18n()
```
    Gets the internationalization object previously set for this component.
    Note: updating the object content that is gotten from this method will not update the lang on the component if not set back using setI18n(RichTextEditorI18n)
    
    Returns:
    
    the i18n object. It will be null, If the i18n properties weren't set.
  - setI18n
```
public void setI18n(RichTextEditor.RichTextEditorI18n i18n)
```
    Sets the internationalization properties for this component.
    
    Parameters:
    
    i18n - the internationalized properties, not null
  - getValueChangeMode
```
public ValueChangeMode getValueChangeMode()
```
    Gets current value change mode of the component.
    The default value is ValueChangeMode.ON_CHANGE.
    
    Specified by:
    
    getValueChangeMode in interface HasValueChangeMode
    
    Returns:
    
    current value change mode of the component, or null if the value is not synchronized
  - setValueChangeMode
```
public void setValueChangeMode(ValueChangeMode valueChangeMode)
```
    Description copied from interface: HasValueChangeMode
    
    Sets new value change mode for the component.
    
    Specified by:
    
    setValueChangeMode in interface HasValueChangeMode
    
    Parameters:
    
    valueChangeMode - new value change mode, or null to disable the value synchronization
  - setValue
```
public void setValue(String value)
```
    Sets the value of this editor. Should be in Delta format. If the new value is not equal to getValue(), fires a value change event. Throws NullPointerException, if the value is null.
    Note: Binder will take care of the null conversion when integrates with the editor, as long as no new converter is defined.
    
    Specified by:
    
    setValue in interface HasValue<AbstractField.ComponentValueChangeEvent<RichTextEditor,String>,String>
    
    Overrides:
    
    setValue in class AbstractField<RichTextEditor,String>
    
    Parameters:
    
    value - the new value in Delta format, not null
    
    See Also:
    
    asHtml(), AsHtml#setValue(String)
  - getValue
```
public String getValue()
```
    Returns the current value of the text editor in Delta format. By default, the empty editor will return an empty string.
    
    Specified by:
    
    getValue in interface HasValue<AbstractField.ComponentValueChangeEvent<RichTextEditor,String>,String>
    
    Overrides:
    
    getValue in class AbstractField<RichTextEditor,String>
    
    Returns:
    
    the current value.
    
    See Also:
    
    getHtmlValue(), asHtml(), AsHtml#getValue()
  - getHtmlValue
```
public String getHtmlValue()
```
    The value of the editor presented as an HTML string.
    This represents the value currently set on the client side. If you have just set the value on the server side using setValue(String) or AsHtml#setValue(String) then the value returned from this method will not yet correspond to the newly set value until the next server round trip.
    
    Returns:
    
    the sanitized htmlValue property from the web component or null if it is not available.
    
    See Also:
    
    getValue(), asHtml(), AsHtml#getValue()
  - asHtml
```
public HasValue<HasValue.ValueChangeEvent<String>,String> asHtml()
```
    Gets an instance of HasValue for binding the html value of the editor with Binder.
    
    Returns:
    
    an instance of HasValue

com.vaadin.flow.component.richtexteditor.

Class RichTextEditor

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.richtexteditor.GeneratedVaadinRichTextEditor

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

Field Summary

Fields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.flow.component.richtexteditor.GeneratedVaadinRichTextEditor

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

Methods inherited from class com.vaadin.flow.component.AbstractField

Methods inherited from class com.vaadin.flow.component.Component

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.flow.component.HasSize

Methods inherited from interface com.vaadin.flow.component.HasElement

Methods inherited from interface com.vaadin.flow.data.value.HasValueChangeMode

Methods inherited from interface com.vaadin.flow.component.InputNotifier

Methods inherited from interface com.vaadin.flow.component.KeyNotifier

Methods inherited from interface com.vaadin.flow.component.CompositionNotifier

Methods inherited from interface com.vaadin.flow.component.HasStyle

Methods inherited from interface com.vaadin.flow.component.HasTheme

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

Methods inherited from interface com.vaadin.flow.component.HasValue

Methods inherited from interface com.vaadin.flow.component.HasEnabled

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

Constructor Detail

RichTextEditor

RichTextEditor

RichTextEditor

RichTextEditor

Method Detail

getI18n

setI18n

getValueChangeMode

setValueChangeMode

setValue

getValue

getHtmlValue

asHtml