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<R,T>

All Implemented Interfaces:: com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<R,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<R,T>,T>, Serializable

Direct Known Subclasses:: RichTextEditor

@Deprecated
@Tag("vaadin-rich-text-editor")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.3.28") @NpmPackage(value="@vaadin/rich-text-editor",version="23.3.28") @NpmPackage(value="@vaadin/vaadin-rich-text-editor",version="23.3.28")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/rich-text-editor/src/vaadin-rich-text-editor.js")
public abstract class GeneratedVaadinRichTextEditor<R extends GeneratedVaadinRichTextEditor<R,T>,T>
extends com.vaadin.flow.component.AbstractSinglePropertyField<R,T>
implements com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme

Deprecated.

since v23.3, generated classes will be removed in v24.

Description copied from corresponding location in WebComponent:

<vaadin-rich-text-editor> is a Web Component for rich text editing. It provides a set of toolbar controls to apply formatting on the content, which is stored and can be accessed as HTML5 or JSON string.

<vaadin-rich-text-editor></vaadin-rich-text-editor>

Vaadin Rich Text Editor focuses on the structure, not the styling of content. Therefore, the semantic HTML5 tags and CSS usage is limited to most common cases, like horizontal text alignment.

Styling

The following state attributes are available for styling:

Styling
Attribute	Description	Part name
`disabled`	Set to a disabled text editor	:host
`readonly`	Set to a readonly text editor	:host

The following shadow DOM parts are available for styling:

Shadow parts
Part name	Description
`toolbar`	The toolbar wrapper
`content`	The content wrapper
`group`	The group for toolbar controls
`undo-button`	The "undo" button
`redo-button`	The "redo" button
`bold-button`	The "bold" button
`italic-button`	The "italic" button
`underline-button`	The "underline" button
`strike-button`	The "strike-through" button
`h1-button`	The "header 1" button
`h2-button`	The "header 2" button
`h3-button`	The "header 3" button
`subscript-button`	The "subscript" button
`superscript-button`	The "superscript" button
`list-ordered-button`	The "ordered list" button
`list-bullet-button`	The "bullet list" button
`align-left-button`	The "left align" button
`align-center-button`	The "center align" button
`align-right-button`	The "right align" button
`image-button`	The "image" button
`blockquote-button`	The "blockquote" button
`code-block-button`	The "code block" button
`clean-button`	The "clean formatting" button

See ThemableMixin – how to apply styles for shadow parts

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`GeneratedVaadinRichTextEditor.ChangeEvent<R extends GeneratedVaadinRichTextEditor<R,?>>`	Deprecated. since v23.3, generated classes will be removed in v24.

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V extends Object>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors
Constructor	Description
`GeneratedVaadinRichTextEditor()`	Deprecated. since v23.3, generated classes will be removed in v24.
`GeneratedVaadinRichTextEditor(T initialValue, T defaultValue, boolean acceptNullValues, boolean isInitialValueOptional)`	Deprecated. since v23.3, generated classes will be removed in v24.
`GeneratedVaadinRichTextEditor(T initialValue, T defaultValue, Class<P> elementPropertyType, com.vaadin.flow.function.SerializableBiFunction<R,P,T> presentationToModel, com.vaadin.flow.function.SerializableBiFunction<R,T,P> modelToPresentation)`	Deprecated. since v23.3, generated classes will be removed in v24.
`GeneratedVaadinRichTextEditor(T initialValue, T defaultValue, Class<P> elementPropertyType, com.vaadin.flow.function.SerializableFunction<P,T> presentationToModel, com.vaadin.flow.function.SerializableFunction<T,P> modelToPresentation)`	Deprecated. since v23.3, generated classes will be removed in v24.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected com.vaadin.flow.shared.Registration`	`addChangeListener(com.vaadin.flow.component.ComponentEventListener<GeneratedVaadinRichTextEditor.ChangeEvent<R>> listener)`	Deprecated. since v23.3, generated classes will be removed in v24.
`void`	`addThemeVariants(RichTextEditorVariant... variants)`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected String`	`getHtmlValueString()`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected elemental.json.JsonArray`	`getI18nJsonArray()`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected boolean`	`isDisabledBoolean()`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected boolean`	`isReadonlyBoolean()`	Deprecated. since v23.3, generated classes will be removed in v24.
`void`	`removeThemeVariants(RichTextEditorVariant... variants)`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected void`	`setDisabled(boolean disabled)`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected void`	`setI18n(elemental.json.JsonArray i18n)`	Deprecated. since v23.3, generated classes will be removed in v24.
`protected void`	`setReadonly(boolean readonly)`	Deprecated. since v23.3, generated classes will be removed in v24.

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

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

Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, 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.AttachNotifier
addAttachListener

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

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

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

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.HasValue
clear, getOptionalValue

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

- Constructor Detail
  - GeneratedVaadinRichTextEditor
```
@Deprecated
public GeneratedVaadinRichTextEditor(T initialValue,
                                     T defaultValue,
                                     Class<P> elementPropertyType,
                                     com.vaadin.flow.function.SerializableFunction<P,T> presentationToModel,
                                     com.vaadin.flow.function.SerializableFunction<T,P> modelToPresentation)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Constructs a new GeneratedVaadinRichTextEditor component with the given arguments.
    
    Type Parameters:
    
    P - the property type
    
    Parameters:
    
    initialValue - the initial value to set to the value
    
    defaultValue - the default value to use if the value isn't defined
    
    elementPropertyType - the type of the element property
    
    presentationToModel - a function that converts a string value to a model value
    
    modelToPresentation - a function that converts a model value to a string value
  - GeneratedVaadinRichTextEditor
```
@Deprecated
public GeneratedVaadinRichTextEditor(T initialValue,
                                     T defaultValue,
                                     boolean acceptNullValues,
                                     boolean isInitialValueOptional)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Constructs a new GeneratedVaadinRichTextEditor component with the given arguments.
    
    Parameters:
    
    initialValue - the initial value to set to the value
    
    defaultValue - the default value to use if the value isn't defined
    
    acceptNullValues - whether null is accepted as a model value
    
    isInitialValueOptional - if isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set
  - GeneratedVaadinRichTextEditor
```
@Deprecated
public GeneratedVaadinRichTextEditor(T initialValue,
                                     T defaultValue,
                                     Class<P> elementPropertyType,
                                     com.vaadin.flow.function.SerializableBiFunction<R,P,T> presentationToModel,
                                     com.vaadin.flow.function.SerializableBiFunction<R,T,P> modelToPresentation)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Constructs a new GeneratedVaadinRichTextEditor component with the given arguments.
    
    Type Parameters:
    
    P - the property type
    
    Parameters:
    
    initialValue - the initial value to set to the value
    
    defaultValue - the default value to use if the value isn't defined
    
    elementPropertyType - the type of the element property
    
    presentationToModel - a function that accepts this component and a property value and returns a model value
    
    modelToPresentation - a function that accepts this component and a model value and returns a property value
  - GeneratedVaadinRichTextEditor
```
@Deprecated
public GeneratedVaadinRichTextEditor()
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Default constructor.
- Method Detail
  - addThemeVariants
```
@Deprecated
public void addThemeVariants(RichTextEditorVariant... variants)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24. Use RichTextEditor.addThemeVariants(com.vaadin.flow.component.richtexteditor.RichTextEditorVariant...) instead.
    
    Adds theme variants to the component.
    
    Parameters:
    
    variants - theme variants to add
  - removeThemeVariants
```
@Deprecated
public void removeThemeVariants(RichTextEditorVariant... variants)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24. Use RichTextEditor.removeThemeVariants(com.vaadin.flow.component.richtexteditor.RichTextEditorVariant...) instead.
    
    Removes theme variants from the component.
    
    Parameters:
    
    variants - theme variants to remove
  - getHtmlValueString
```
@Deprecated
@Synchronize(property="htmlValue",
             value="html-value-changed")
protected String getHtmlValueString()
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    HTML representation of the rich text editor content.
    This property is synchronized automatically from client side when a 'html-value-changed' event happens.
    
    Returns:
    
    the htmlValue property from the webcomponent
  - isDisabledBoolean
```
@Deprecated
protected boolean isDisabledBoolean()
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    When true, the user can not modify, nor copy the editor content.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    the disabled property from the webcomponent
  - setDisabled
```
@Deprecated
protected void setDisabled(boolean disabled)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    When true, the user can not modify, nor copy the editor content.
    
    Parameters:
    
    disabled - the boolean value to set
  - isReadonlyBoolean
```
@Deprecated
protected boolean isReadonlyBoolean()
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    When true, the user can not modify the editor content, but can copy it.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    the readonly property from the webcomponent
  - setReadonly
```
@Deprecated
protected void setReadonly(boolean readonly)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    When true, the user can not modify the editor content, but can copy it.
    
    Parameters:
    
    readonly - the boolean value to set
  - getI18nJsonArray
```
@Deprecated
protected elemental.json.JsonArray getI18nJsonArray()
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    An object used to localize this component. The properties are used e.g. as the tooltips for the editor toolbar buttons.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    the i18n property from the webcomponent
  - setI18n
```
@Deprecated
protected void setI18n(elemental.json.JsonArray i18n)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Description copied from corresponding location in WebComponent:
    
    An object used to localize this component. The properties are used e.g. as the tooltips for the editor toolbar buttons.
    
    Parameters:
    
    i18n - the JsonArray value to set
  - addChangeListener
```
@Deprecated
protected com.vaadin.flow.shared.Registration addChangeListener(com.vaadin.flow.component.ComponentEventListener<GeneratedVaadinRichTextEditor.ChangeEvent<R>> listener)
```
    Deprecated.
    since v23.3, generated classes will be removed in v24.
    
    Adds a listener for change events fired by the webcomponent.
    
    Parameters:
    
    listener - the listener
    
    Returns:
    
    a Registration for removing the event listener

Class GeneratedVaadinRichTextEditor<R extends GeneratedVaadinRichTextEditor<R,​T>,​T>

Styling

Nested Class Summary

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

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

Constructor Summary

Method Summary

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.AttachNotifier

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

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

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

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.HasValue

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

Constructor Detail

GeneratedVaadinRichTextEditor

GeneratedVaadinRichTextEditor

GeneratedVaadinRichTextEditor

GeneratedVaadinRichTextEditor

Method Detail

addThemeVariants

removeThemeVariants

getHtmlValueString

isDisabledBoolean

setDisabled

isReadonlyBoolean

setReadonly

getI18nJsonArray

setI18n

addChangeListener

Class GeneratedVaadinRichTextEditor<R extends GeneratedVaadinRichTextEditor<R,T>,T>