Class RichTextEditor

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(), RichTextEditor.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(), RichTextEditor.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 RichTextEditor.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(), RichTextEditor.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