io.jmix.ui.component.impl

Class TextFieldImpl<V>

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<JmixTextField,java.lang.String,V>

io.jmix.ui.component.impl.TextFieldImpl<V>

All Implemented Interfaces:

AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<V>, Field<V>, HasContextHelp, HasConversionErrorMessage, HasDatatype<V>, HasDebugId, HasFormatter<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasValidator<V>, HasValue<V>, Requirable, TextField<V>, TextInputField<V>, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressNotifier, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported, Validatable, org.springframework.beans.factory.InitializingBean

public class TextFieldImpl<V>
extends AbstractField<JmixTextField,java.lang.String,V>
implements TextField<V>, 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 java.lang.String	conversionErrorMessage
protected DataAwareComponentsTools	dataAwareComponentsTools
protected io.jmix.core.metamodel.datatype.Datatype<V>	datatype
protected com.vaadin.shared.Registration	enterShortcutRegistration
protected Formatter<? super V>	formatter
protected java.util.Locale	locale
protected boolean	trimming

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

NAME, TYPE_BIGDECIMAL, TYPE_DATE, TYPE_DATETIME, TYPE_DEFAULT, TYPE_DOUBLE, TYPE_INTEGER, TYPE_LOCALDATE, TYPE_LOCALDATETIME, TYPE_LONG, TYPE_OFFSETTIME, TYPE_STRING, TYPE_TIME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
TextFieldImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addEnterPressListener(java.util.function.Consumer<TextInputField.EnterPressEvent> listener) Adds a listener that is invoked when the user presses Enter.
io.jmix.core.common.event.Subscription	addTextChangeListener(java.util.function.Consumer<TextInputField.TextChangeEvent> listener) Adds a listener that is fired when the component value is changed.
void	afterPropertiesSet()
void	commit() Updates all changes since the previous commit to the data source.
protected void	componentValueChanged(java.lang.String prevComponentValue, java.lang.String newComponentValue, boolean isUserOriginated)
protected V	convertToModel(java.lang.String componentRawValue)
protected java.lang.String	convertToPresentation(V modelValue)
protected JmixTextField	createComponent()
void	discard() Discards all changes since last commit.
protected void	fireTextChangeEvent(java.lang.String newComponentValue)
void	focus() Sets focus to this component
TextInputField.CaseConversion	getCaseConversion()
java.lang.String	getConversionErrorMessage()
protected java.lang.String	getConversionErrorMessageInternal()
io.jmix.core.metamodel.datatype.Datatype<V>	getDatatype()
Formatter<V>	getFormatter()
java.lang.String	getHtmlName()
java.lang.String	getInputPrompt()
int	getMaxLength()
java.lang.String	getRawValue() Returns a string representation of the value.
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
TextInputField.TextChangeEventMode	getTextChangeEventMode()
int	getTextChangeTimeout() Gets the timeout used to fire TextInputField.TextChangeEvents and ValueChangeEvents when the TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
protected void	initComponent(JmixTextField component)
protected void	internalRemoveEnterPressListener(java.util.function.Consumer<TextInputField.EnterPressEvent> listener)
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.
boolean	isTrimming()
void	selectAll()
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setCaseConversion(TextInputField.CaseConversion caseConversion) Disable automatic case conversion or enable with chosen mode
void	setConversionErrorMessage(java.lang.String conversionErrorMessage) Sets custom conversion error message that is used when value doesn't correspond to datatype.
void	setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)
void	setCursorPosition(int position) Sets the cursor position in the field.
void	setDataAwareComponentsTools(DataAwareComponentsTools dataAwareComponentsTools)
void	setDatatype(io.jmix.core.metamodel.datatype.Datatype<V> datatype) Sets the given datatype to the component.
void	setFormatter(Formatter<? super V> formatter)
void	setHtmlName(java.lang.String htmlName) Sets the given htmlName as a value of "name" HTML attribute.
void	setInputPrompt(java.lang.String inputPrompt) Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
void	setMaxLength(int maxLength)
void	setSelectionRange(int pos, int length)
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
void	setTextChangeEventMode(TextInputField.TextChangeEventMode mode) Sets the mode how the TextField triggers TextInputField.TextChangeEvents and ValueChangeEvents.
void	setTextChangeTimeout(int timeout) The text change timeout modifies how often text change events are communicated to the application when TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
void	setTrimming(boolean trimming)
protected void	valueBindingConnected(ValueSource<V> valueSource)

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

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getDefaultRequiredMessage, 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, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated

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, sanitize, 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

datatype

protected io.jmix.core.metamodel.datatype.Datatype<V> datatype

formatter

protected Formatter<? super V> formatter

locale

protected java.util.Locale locale

trimming

protected boolean trimming

enterShortcutRegistration

protected com.vaadin.shared.Registration enterShortcutRegistration

conversionErrorMessage

protected java.lang.String conversionErrorMessage

dataAwareComponentsTools

protected DataAwareComponentsTools dataAwareComponentsTools

Constructor Detail

TextFieldImpl

public TextFieldImpl()

Method Detail

setDataAwareComponentsTools

@Autowired
public void setDataAwareComponentsTools(DataAwareComponentsTools dataAwareComponentsTools)

setCurrentAuthentication

@Autowired
public void setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)

createComponent

protected JmixTextField createComponent()

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

initComponent

protected void initComponent(JmixTextField component)

valueBindingConnected

protected void valueBindingConnected(ValueSource<V> valueSource)

Overrides:

valueBindingConnected in class AbstractValueComponent<JmixTextField,java.lang.String,V>

convertToPresentation

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

Overrides:

convertToPresentation in class AbstractValueComponent<JmixTextField,java.lang.String,V>

Throws:

ConversionException

convertToModel

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

Overrides:

convertToModel in class AbstractValueComponent<JmixTextField,java.lang.String,V>

Throws:

ConversionException

setConversionErrorMessage

public void setConversionErrorMessage(@Nullable
                                      java.lang.String conversionErrorMessage)

Description copied from interface: HasConversionErrorMessage

Sets custom conversion error message that is used when value doesn't correspond to datatype.

Specified by:

setConversionErrorMessage in interface HasConversionErrorMessage

Parameters:

conversionErrorMessage - custom conversion error message

getConversionErrorMessage

@Nullable
public java.lang.String getConversionErrorMessage()

Specified by:

getConversionErrorMessage in interface HasConversionErrorMessage

Returns:

custom conversion error message

getConversionErrorMessageInternal

protected java.lang.String getConversionErrorMessageInternal()

componentValueChanged

protected void componentValueChanged(java.lang.String prevComponentValue,
                                     java.lang.String newComponentValue,
                                     boolean isUserOriginated)

Overrides:

componentValueChanged in class AbstractValueComponent<JmixTextField,java.lang.String,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasValue<V>

getDatatype

@Nullable
public io.jmix.core.metamodel.datatype.Datatype<V> getDatatype()

Specified by:

getDatatype in interface HasDatatype<V>

Returns:

a datatype that is used by this component

setDatatype

public void setDatatype(io.jmix.core.metamodel.datatype.Datatype<V> datatype)

Description copied from interface: HasDatatype

Sets the given datatype to the component. Its value will be formatted according to this datatype.

Specified by:

setDatatype in interface HasDatatype<V>

Parameters:

datatype - Datatype instance

getCaseConversion

public TextInputField.CaseConversion getCaseConversion()

Specified by:

getCaseConversion in interface TextInputField.CaseConversionSupported

Returns:

conversion mode or null if automatic conversion is disabled

setCaseConversion

public void setCaseConversion(TextInputField.CaseConversion caseConversion)

Description copied from interface: TextInputField.CaseConversionSupported

Disable automatic case conversion or enable with chosen mode

Specified by:

setCaseConversion in interface TextInputField.CaseConversionSupported

getFormatter

@Nullable
public Formatter<V> getFormatter()

Specified by:

getFormatter in interface HasFormatter<V>

setFormatter

public void setFormatter(@Nullable
                         Formatter<? super V> formatter)

Specified by:

setFormatter in interface HasFormatter<V>

getMaxLength

public int getMaxLength()

Specified by:

getMaxLength in interface TextInputField.MaxLengthLimited

setMaxLength

public void setMaxLength(int maxLength)

Specified by:

setMaxLength in interface TextInputField.MaxLengthLimited

isTrimming

public boolean isTrimming()

Specified by:

isTrimming in interface TextInputField.TrimSupported

setTrimming

public void setTrimming(boolean trimming)

Specified by:

setTrimming in interface TextInputField.TrimSupported

getInputPrompt

@Nullable
public java.lang.String getInputPrompt()

Specified by:

getInputPrompt in interface HasInputPrompt

Returns:

current input prompt.

setInputPrompt

public void setInputPrompt(@Nullable
                           java.lang.String inputPrompt)

Description copied from interface: HasInputPrompt

Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

Specified by:

setInputPrompt in interface HasInputPrompt

Parameters:

inputPrompt - input prompt

setCursorPosition

public void setCursorPosition(int position)

Description copied from interface: TextInputField.CursorPositionSupported

Sets the cursor position in the field.

Specified by:

setCursorPosition in interface TextInputField.CursorPositionSupported

Parameters:

position - new cursor position

getRawValue

public java.lang.String getRawValue()

Description copied from interface: TextField

Returns a string representation of the value.

Specified by:

getRawValue in interface TextField<V>

selectAll

public void selectAll()

Specified by:

selectAll in interface TextInputField.TextSelectionSupported

setSelectionRange

public void setSelectionRange(int pos,
                              int length)

Specified by:

setSelectionRange in interface TextInputField.TextSelectionSupported

fireTextChangeEvent

protected void fireTextChangeEvent(java.lang.String newComponentValue)

setTextChangeTimeout

public void setTextChangeTimeout(int timeout)

Description copied from interface: TextInputField.TextChangeNotifier

The text change timeout modifies how often text change events are communicated to the application when TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Specified by:

setTextChangeTimeout in interface TextInputField.TextChangeNotifier

Parameters:

timeout - timeout in milliseconds

addTextChangeListener

public io.jmix.core.common.event.Subscription addTextChangeListener(java.util.function.Consumer<TextInputField.TextChangeEvent> listener)

Description copied from interface: TextInputField.TextChangeNotifier

Adds a listener that is fired when the component value is changed.

Specified by:

addTextChangeListener in interface TextInputField.TextChangeNotifier

Parameters:

listener - a listener to add

Returns:

a Subscription object

getTextChangeTimeout

public int getTextChangeTimeout()

Description copied from interface: TextInputField.TextChangeNotifier

Gets the timeout used to fire TextInputField.TextChangeEvents and ValueChangeEvents when the TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Specified by:

getTextChangeTimeout in interface TextInputField.TextChangeNotifier

Returns:

timeout in milliseconds

getTextChangeEventMode

public TextInputField.TextChangeEventMode getTextChangeEventMode()

Specified by:

getTextChangeEventMode in interface TextInputField.TextChangeNotifier

Returns:

the mode used to trigger TextInputField.TextChangeEvents and ValueChangeEvents.

setTextChangeEventMode

public void setTextChangeEventMode(TextInputField.TextChangeEventMode mode)

Description copied from interface: TextInputField.TextChangeNotifier

Sets the mode how the TextField triggers TextInputField.TextChangeEvents and ValueChangeEvents.

Specified by:

setTextChangeEventMode in interface TextInputField.TextChangeNotifier

Parameters:

mode - the new mode

addEnterPressListener

public io.jmix.core.common.event.Subscription addEnterPressListener(java.util.function.Consumer<TextInputField.EnterPressEvent> listener)

Description copied from interface: TextInputField.EnterPressNotifier

Adds a listener that is invoked when the user presses Enter.

Specified by:

addEnterPressListener in interface TextInputField.EnterPressNotifier

Parameters:

listener - a listener to add

Returns:

a Subscription

internalRemoveEnterPressListener

protected void internalRemoveEnterPressListener(java.util.function.Consumer<TextInputField.EnterPressEvent> listener)

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<JmixTextField,java.lang.String,V>

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<JmixTextField,java.lang.String,V>

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

Overrides:

isBuffered in class AbstractValueComponent<JmixTextField,java.lang.String,V>

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<JmixTextField,java.lang.String,V>

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<JmixTextField,java.lang.String,V>

Returns:

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

setHtmlName

public void setHtmlName(@Nullable
                        java.lang.String htmlName)

Description copied from interface: TextInputField.HtmlNameSupported

Sets the given htmlName as a value of "name" HTML attribute.

Specified by:

setHtmlName in interface TextInputField.HtmlNameSupported

Parameters:

htmlName - name

getHtmlName

@Nullable
public java.lang.String getHtmlName()

Specified by:

getHtmlName in interface TextInputField.HtmlNameSupported

Returns:

a value of "name" HTML attribute