Contact us
Create app
You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.
com.vaadin.flow.component.richtexteditor.

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

  • All Implemented Interfaces:

    AttachNotifier, DetachNotifier, HasElement, HasEnabled, HasStyle, HasTheme, HasValue<AbstractField.ComponentValueChangeEvent<R,​T>,​T>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<R,​T>,​T>, Serializable

    Direct Known Subclasses:

    RichTextEditor

    @Tag("vaadin-rich-text-editor")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.15") @NpmPackage(value="@vaadin/rich-text-editor",version="23.1.15") @NpmPackage(value="@vaadin/vaadin-rich-text-editor",version="23.1.15")
@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 AbstractSinglePropertyField<R,​T>
implements HasStyle, HasTheme

    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:

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

    The following shadow DOM parts are available for styling:

    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
    Shadow parts

    See ThemableMixin ? how to apply styles for shadow parts

    See Also:

    Serialized Form

    • Constructor Detail

      • GeneratedVaadinRichTextEditor

        public GeneratedVaadinRichTextEditor​(T initialValue,
                                     T defaultValue,
                                     Class<P> elementPropertyType,
                                     SerializableFunction<P,​T> presentationToModel,
                                     SerializableFunction<T,​P> modelToPresentation)

        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

        public GeneratedVaadinRichTextEditor​(T initialValue,
                                     T defaultValue,
                                     boolean acceptNullValues,
                                     boolean isInitialValueOptional)

        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

        public GeneratedVaadinRichTextEditor​(T initialValue,
                                     T defaultValue,
                                     Class<P> elementPropertyType,
                                     SerializableBiFunction<R,​P,​T> presentationToModel,
                                     SerializableBiFunction<R,​T,​P> modelToPresentation)

        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

        public GeneratedVaadinRichTextEditor()

        Default constructor.

    • Method Detail

      • addThemeVariants

        public void addThemeVariants​(RichTextEditorVariant... variants)

        Adds theme variants to the component.

        Parameters:

        variants - theme variants to add

      • removeThemeVariants

        public void removeThemeVariants​(RichTextEditorVariant... variants)

        Removes theme variants from the component.

        Parameters:

        variants - theme variants to remove

      • getHtmlValueString

        @Synchronize(property="htmlValue",
             value="html-value-changed")
protected String getHtmlValueString()

        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

        protected boolean isDisabledBoolean()

        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

        protected void setDisabled​(boolean disabled)

        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

        protected boolean isReadonlyBoolean()

        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

        protected void setReadonly​(boolean readonly)

        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

        protected elemental.json.JsonArray getI18nJsonArray()

        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

        protected void setI18n​(elemental.json.JsonArray i18n)

        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