com.haulmont.cuba.gui.components

Interface MaskedField

All Superinterfaces:

Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent, Field, TextInputField, TextInputField.CursorPositionSupported, TextInputField.EnterPressNotifier, TextInputField.TextSelectionSupported

public interface MaskedField
extends TextInputField, 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.EnterPressListener, TextInputField.EnterPressNotifier, TextInputField.MaxLengthLimited, TextInputField.TextChangeEvent, TextInputField.TextChangeEventMode, TextInputField.TextChangeListener, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported

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

Field.Validator

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, 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.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

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.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.Component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

commit, discard, isBuffered, isModified, setBuffered

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

getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

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.