@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
Modifier and Type | Interface and Description |
---|---|
static class |
MaskedField.ValueMode |
TextInputField.CaseConversion, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressEvent, TextInputField.EnterPressNotifier, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeEvent, TextInputField.TextChangeEventMode, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported
HasValue.ValueChangeEvent<V>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
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 |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
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
|
getValueSource, setValueSource
addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
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
isValid, isValidateOnCommit, validate
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
addValidator, addValidators, getValidators, removeValidator
getRequiredMessage, isRequired, setRequired, setRequiredMessage
commit, discard, isBuffered, isModified, setBuffered
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
getDatatype, setDatatype
selectAll, setSelectionRange
setCursorPosition
addEnterPressListener
static final java.lang.String NAME
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.String>> TYPE_DEFAULT
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.String>> TYPE_STRING
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Integer>> TYPE_INTEGER
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Long>> TYPE_LONG
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.lang.Double>> TYPE_DOUBLE
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.math.BigDecimal>> TYPE_BIGDECIMAL
static final org.springframework.core.ParameterizedTypeReference<MaskedField<java.util.UUID>> TYPE_UUID
@StudioProperty(required=true) void setMask(java.lang.String mask)
java.lang.String getMask()
@StudioProperty(name="valueMode", type=ENUMERATION, defaultValue="clear", options={"clear","masked"}) void setValueMode(MaskedField.ValueMode mode)
MASKED - value contain mask literals CLEAR - value contain only user input.
mode
- value modeMaskedField.ValueMode getValueMode()
boolean isSendNullRepresentation()
void setSendNullRepresentation(boolean sendNullRepresentation)
java.lang.String getRawValue()