io.jmix.ui.component.impl

Class RichTextAreaImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixRichTextArea,java.lang.String,java.lang.String>

io.jmix.ui.component.impl.RichTextAreaImpl

All Implemented Interfaces:

AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<java.lang.String>, Field<java.lang.String>, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<java.lang.String>, HasValue<java.lang.String>, Requirable, RichTextArea, TextInputField<java.lang.String>, Validatable, org.springframework.beans.factory.InitializingBean

public class RichTextAreaImpl
extends AbstractField<JmixRichTextArea,java.lang.String,java.lang.String>
implements RichTextArea, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.TextInputField

TextInputField.CaseConversion, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressEvent, TextInputField.EnterPressNotifier, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeEvent, TextInputField.TextChangeEventMode, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CLOSED_LINE_BREAK_TAG
protected static java.lang.String	LINE_BREAK_TAG

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.RichTextArea

NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
RichTextAreaImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	commit() Updates all changes since the previous commit to the data source.
protected java.lang.String	convertToModel(java.lang.String componentRawValue)
protected java.lang.String	convertToPresentation(java.lang.String modelValue)
protected JmixRichTextArea	createComponent()
void	discard() Discards all changes since last commit.
void	focus() Sets focus to this component
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
protected void	initComponent(JmixRichTextArea component)
boolean	isBuffered()
boolean	isEmpty()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
protected java.util.Map<java.lang.String,java.lang.String>	loadLabels(io.jmix.core.Messages messages)
protected java.lang.String	postSanitize(java.lang.String html) Hook to replace the <br /> with <br> in the sanitized string of HTML, since the RichTextArea component does not support <br />.
protected java.lang.String	sanitize(java.lang.String html)
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setMessages(io.jmix.core.Messages messages)
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setEditableToComponent, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, componentValueChanged, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Component.Focusable

isFocusable, setFocusable

Field Detail

LINE_BREAK_TAG

protected static final java.lang.String LINE_BREAK_TAG

See Also:

Constant Field Values

CLOSED_LINE_BREAK_TAG

protected static final java.lang.String CLOSED_LINE_BREAK_TAG

See Also:

Constant Field Values

Constructor Detail

RichTextAreaImpl

public RichTextAreaImpl()

Method Detail

createComponent

protected JmixRichTextArea createComponent()

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

initComponent

protected void initComponent(JmixRichTextArea component)

setMessages

@Autowired
public void setMessages(io.jmix.core.Messages messages)

loadLabels

protected java.util.Map<java.lang.String,java.lang.String> loadLabels(io.jmix.core.Messages messages)

convertToPresentation

protected java.lang.String convertToPresentation(@Nullable
                                                 java.lang.String modelValue)
                                          throws ConversionException

Overrides:

convertToPresentation in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

Throws:

ConversionException

convertToModel

@Nullable
protected java.lang.String convertToModel(@Nullable
                                                    java.lang.String componentRawValue)
                                             throws ConversionException

Overrides:

convertToModel in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

Throws:

ConversionException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasValue<java.lang.String>

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

commit

public void commit()

Description copied from interface: Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Buffered

Overrides:

commit in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

discard

public void discard()

Description copied from interface: Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Buffered

Overrides:

discard in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

Overrides:

isBuffered in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Buffered.commit() is called. Calling Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Buffered.commit() and Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Buffered

Overrides:

setBuffered in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Buffered

Overrides:

isModified in class AbstractValueComponent<JmixRichTextArea,java.lang.String,java.lang.String>

Returns:

true if the value in the object has been modified since the last data source update, false if not.

sanitize

@Nullable
protected java.lang.String sanitize(@Nullable
                                              java.lang.String html)

Overrides:

sanitize in class AbstractComponent<JmixRichTextArea>

postSanitize

@Nullable
protected java.lang.String postSanitize(@Nullable
                                                  java.lang.String html)

Hook to replace the <br /> with <br> in the sanitized string of HTML, since the RichTextArea component does not support <br />.

Parameters:

html - the sanitized string of HTML

Returns:

a post-processed sanitized string of HTML