io.jmix.ui.component

Interface MaskedField<V>

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<V>, HasContextHelp, HasDatatype<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<V>, HasValue<V>, HasValueSource<V>, Requirable, TextInputField<V>, TextInputField.CursorPositionSupported, TextInputField.EnterPressNotifier, TextInputField.TextSelectionSupported, Validatable

All Known Implementing Classes:

MaskedFieldImpl

@StudioComponent(caption="MaskedField",
                 category="Components",
                 xmlElement="maskedField",
                 icon="io/jmix/ui/icon/component/maskedField.svg",
                 canvasBehaviour=INPUT_FIELD,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/masked-field.html")
public interface MaskedField<V>
extends TextInputField<V>, HasDatatype<V>, TextInputField.TextSelectionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressNotifier

Masked field component generic interface. FieldConfig supports following format symbols:

• # - Digit
• U - Uppercase letter
• L - Lowercase letter
• A - Letter or digit
• * - Any symbol
• H - Hex symbol
• ~ - + or -

Any other symbols in format will be treated as mask literals.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MaskedField.ValueMode

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
static java.lang.String	NAME
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.math.BigDecimal>>	TYPE_BIGDECIMAL
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.String>>	TYPE_DEFAULT
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Double>>	TYPE_DOUBLE
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Integer>>	TYPE_INTEGER
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Long>>	TYPE_LONG
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.String>>	TYPE_STRING
static org.springframework.core.ParameterizedTypeReference<MaskedField<java.util.UUID>>	TYPE_UUID

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMask()
java.lang.String	getRawValue() Returns a string representation of the value.
MaskedField.ValueMode	getValueMode()
boolean	isSendNullRepresentation()
void	setMask(java.lang.String mask)
void	setSendNullRepresentation(boolean sendNullRepresentation)
void	setValueMode(MaskedField.ValueMode mode) Sets ValueMode for component

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, isEmpty, 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.Buffered

commit, discard, isBuffered, isModified, setBuffered

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

getDatatype, setDatatype

Methods inherited from interface io.jmix.ui.component.TextInputField.TextSelectionSupported

selectAll, setSelectionRange

Methods inherited from interface io.jmix.ui.component.TextInputField.CursorPositionSupported

setCursorPosition

Methods inherited from interface io.jmix.ui.component.TextInputField.EnterPressNotifier

addEnterPressListener

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

TYPE_DEFAULT

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.String>> TYPE_DEFAULT

TYPE_STRING

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.String>> TYPE_STRING

TYPE_INTEGER

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Integer>> TYPE_INTEGER

TYPE_LONG

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Long>> TYPE_LONG

TYPE_DOUBLE

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Double>> TYPE_DOUBLE

TYPE_BIGDECIMAL

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.math.BigDecimal>> TYPE_BIGDECIMAL

TYPE_UUID

static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.util.UUID>> TYPE_UUID

Method Detail

setMask

@StudioProperty(required=true)
void setMask(java.lang.String mask)

getMask

java.lang.String getMask()

setValueMode

@StudioProperty(name="valueMode",
                type=ENUMERATION,
                defaultValue="clear",
                options={"clear","masked"})
void setValueMode(MaskedField.ValueMode mode)

Sets ValueMode for component

MASKED - value contain mask literals CLEAR - value contain only user input.

Parameters:

mode - value mode

getValueMode

MaskedField.ValueMode getValueMode()

isSendNullRepresentation

boolean isSendNullRepresentation()

setSendNullRepresentation

void setSendNullRepresentation(boolean sendNullRepresentation)

getRawValue

java.lang.String getRawValue()

Returns a string representation of the value.