com.haulmont.cuba.gui.components

Interface MaskedField<V>

All Superinterfaces:

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

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 com.haulmont.cuba.gui.components.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 com.haulmont.cuba.gui.components.Field

Field.Validator<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static com.google.common.reflect.TypeToken<MaskedField<java.math.BigDecimal>>	TYPE_BIGDECIMAL
static com.google.common.reflect.TypeToken<MaskedField<java.lang.String>>	TYPE_DEFAULT
static com.google.common.reflect.TypeToken<MaskedField<java.lang.Double>>	TYPE_DOUBLE
static com.google.common.reflect.TypeToken<MaskedField<java.lang.Integer>>	TYPE_INTEGER
static com.google.common.reflect.TypeToken<MaskedField<java.lang.Long>>	TYPE_LONG
static com.google.common.reflect.TypeToken<MaskedField<java.lang.String>>	TYPE_STRING
static com.google.common.reflect.TypeToken<MaskedField<java.util.UUID>>	TYPE_UUID

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

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 com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.HasDatatype

getDatatype, setDatatype

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.TextSelectionSupported

selectAll, setSelectionRange

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.CursorPositionSupported

setCursorPosition

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.EnterPressNotifier

addEnterPressListener, removeEnterPressListener

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

TYPE_DEFAULT

static final com.google.common.reflect.TypeToken<MaskedField<java.lang.String>> TYPE_DEFAULT

TYPE_STRING

static final com.google.common.reflect.TypeToken<MaskedField<java.lang.String>> TYPE_STRING

TYPE_INTEGER

static final com.google.common.reflect.TypeToken<MaskedField<java.lang.Integer>> TYPE_INTEGER

TYPE_LONG

static final com.google.common.reflect.TypeToken<MaskedField<java.lang.Long>> TYPE_LONG

TYPE_DOUBLE

static final com.google.common.reflect.TypeToken<MaskedField<java.lang.Double>> TYPE_DOUBLE

TYPE_BIGDECIMAL

static final com.google.common.reflect.TypeToken<MaskedField<java.math.BigDecimal>> TYPE_BIGDECIMAL

TYPE_UUID

static final com.google.common.reflect.TypeToken<MaskedField<java.util.UUID>> TYPE_UUID

Method Detail

setMask

void setMask(java.lang.String mask)

getMask

java.lang.String getMask()

setValueMode

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.