MaskTextField (module-fields 0.9.1 API)

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - javafx.scene.control.Control
      - javafx.scene.control.TextInputControl
        
        javafx.scene.control.TextField
        
        jidefx.scene.control.field.MaskTextField

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
```
public class MaskTextField
extends javafx.scene.control.TextField
```
MaskTextField is a TextField that can restrict the user input by applying a mask.
Position-based Mask
Position-base mask works for all the editing cases when the input string has a fixed length and each character can be restricted based on its position. To address this case, we allow you define the masks on a MaskTextField.
InputMask
MaskTextField has setInputMask(String mask) to set the mask we mentioned above. The pre-defined mask characters are:
- A INPUT_MASK_LETTER ASCII alphabetic character required. A-Z, a-z.
- N INPUT_MASK_DIGIT_OR_LETTER ASCII alphanumeric character required. A-Z, a-z, 0-9.
- X INPUT_MASK_ANY_NON_SPACE Any character required except spaces.
- H INPUT_MASK_HAX Hexadecimal character required. A-F, a-f, 0-9.
- D INPUT_MASK_DIGIT_NON_ZERO ASCII digit required. 1-9.
- 9 INPUT_MASK_DIGIT ASCII digit required. 0-9.
- 8 INPUT_MASK_DIGIT_0_TO_8 ASCII digit required. 0-8.
- 7, 6, 5, 4, 3, 2 and so on which means only allows from 0 to that number
- 2 INPUT_MASK_DIGIT_0_TO_2 ASCII digit required. 0-2.
- 1 INPUT_MASK_DIGIT_0_TO_1 ASCII digit required. 0-1, for example, a binary number
- 0 INPUT_MASK_DIGIT_ZERO 0 required
- G INPUT_MASK_DIGIT_GROUP Indicates a Group. This is the special one, we will discuss it later
If the setInitialText is not called, the InputMask will be used to create the initial text for the field. We create it by removing all masks, replace them with spaces or the specified placeholder character, and leave the non-mask characters where they are. The placeholder character can be set using setPlaceholderCharacter(char). See below. In both cases, the InputMask is 999-99-9999.
ConversionMask
To make the grammar easy to understand, we strictly enforced that there is only one mask character per position for the InputMask. But clearly, one character is not enough in some cases. So we also allow you to define several other masks for other purposes. In addition to the Input Mask, we also have a separate Conversion Mask which will automatically convert the entered character to another character. This mask is optional. It can be set using setConversionMask(String mask). If not set, there will be no conversion. If you ever set the mask, please make sure they have the exact same length as the InputMask, and have a valid conversion mask character at the exact position where there is an InputMask character.
- U CONVERSION_MASK_UPPER_CASE Uppercase required. If user enters a lowercase letter, it will be automatically converted to the corresponding uppercase letter.
- L CONVERSION_MASK_LOWER_CASE Lowercase required. If user enters an uppercase letter, it will be automatically converted to the corresponding lowercase letter.
- Any other undefined chars CONVERSION_MASK_IGNORE No conversion
RequiredMask
The RequiredMask is to indicate whether the character on a particular position is required. It is again optional. It can be set using setRequiredMask(String mask). If not set, a valid non-space character is required on all the positions. If you ever set the mask, please make sure they have the same length as the InputMask, and have a valid required mask character at the exact position where there is an InputMask character.
- R REQUIRED_MASK_REQUIRED Required. Users must enter a valid character that matches with the mask on this position.
- Any other undefined chars REQUIRED_MASK_NOT_REQUIRED Not required. User can enter a space at this position.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.BooleanProperty`	`autoAdvance`
`javafx.beans.property.BooleanProperty`	`clearButtonVisible`
`javafx.beans.property.StringProperty`	`conversionMask`
`javafx.beans.property.StringProperty`	`initialText`
`javafx.beans.property.StringProperty`	`inputMask`
`javafx.beans.property.StringProperty`	`invalidCharacters`
`javafx.beans.property.ObjectProperty<java.lang.Character>`	`placeholderCharacter`
`javafx.beans.property.StringProperty`	`requiredMask`
`javafx.beans.property.StringProperty`	`validCharacters`

Properties inherited from class javafx.scene.control.TextField
alignmentProperty, onActionProperty, prefColumnCountProperty

Properties inherited from class javafx.scene.control.TextInputControl
anchorProperty, caretPositionProperty, editableProperty, fontProperty, lengthProperty, promptTextProperty, selectedTextProperty, selectionProperty, textProperty

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent
impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node
blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary
- Nested classes/interfaces inherited from class javafx.scene.control.TextInputControl
  javafx.scene.control.TextInputControl.Content

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`CONVERSION_MASK_IGNORE`
`static char`	`CONVERSION_MASK_LOWER_CASE`
`static char`	`CONVERSION_MASK_UPPER_CASE`
`static char`	`INPUT_MASK_ANY_NON_SPACE`
`static char`	`INPUT_MASK_DIGIT`
`static char`	`INPUT_MASK_DIGIT_0_TO_1`
`static char`	`INPUT_MASK_DIGIT_0_TO_2`
`static char`	`INPUT_MASK_DIGIT_0_TO_3`
`static char`	`INPUT_MASK_DIGIT_0_TO_4`
`static char`	`INPUT_MASK_DIGIT_0_TO_5`
`static char`	`INPUT_MASK_DIGIT_0_TO_6`
`static char`	`INPUT_MASK_DIGIT_0_TO_7`
`static char`	`INPUT_MASK_DIGIT_0_TO_8`
`static char`	`INPUT_MASK_DIGIT_NON_ZERO`
`static char`	`INPUT_MASK_DIGIT_OR_LETTER`
`static char`	`INPUT_MASK_DIGIT_ZERO`
`static char`	`INPUT_MASK_HAX`
`static char`	`INPUT_MASK_LETTER`
`static char`	`REQUIRED_MASK_NOT_REQUIRED`
`static char`	`REQUIRED_MASK_REQUIRED`

Fields inherited from class javafx.scene.control.TextField
DEFAULT_PREF_COLUMN_COUNT

Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors
Constructor and Description

MaskTextField()

MaskTextField(java.lang.String text)

Constructors
Constructor and Description
`MaskTextField()`
`MaskTextField(java.lang.String text)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.beans.property.BooleanProperty`	`autoAdvanceProperty()`
`void`	`clear()` Clears the text if any.
`javafx.beans.property.BooleanProperty`	`clearButtonVisibleProperty()`
`javafx.beans.property.StringProperty`	`conversionMaskProperty()`
`static MaskTextField`	`createCanadaPostalCodeField()` A static method which will create a MaskTextField for the Zip Code + 4 in US.
`static MaskTextField`	`createDateField()` A static method which will create a MaskTextField for the Date in US standard format (in the order of month/day/year).
`static MaskTextField`	`createIPv6Field()` A static method which will create a MaskTextField for IPv6 address.
`static MaskTextField`	`createMacAddressField()` A static method which will create a MaskTextField for MAC address.
`static MaskTextField`	`createPhoneNumberField()` A static method which will create a MaskTextField for Phone Number in US and Canada.
`static MaskTextField`	`createSerialNumberField()` A static method which will create a MaskTextField for serial number.
`static MaskTextField`	`createSSNField()` A static method which will create a MaskTextField for SSN (social security number, a 9-digit id number used in United States for tax purposes).
`static MaskTextField`	`createTime12Field()` A static method which will create a MaskTextField for the Time in the 12-hour format (in the order of hour/minute/second AM/PM).
`static MaskTextField`	`createTime24Field()` A static method which will create a MaskTextField for the Time in the 24-hour format (in the order of hour/minute/second).
`static MaskTextField`	`createZipCodeField()` A static method which will create a MaskTextField for the Zip Code in US.
`static MaskTextField`	`createZipCodePlus4Field()` A static method which will create a MaskTextField for the Zip Code + 4 in US.
`java.lang.String`	`getConversionMask()` Gets the conversion mask.
`javafx.collections.ObservableMap<java.lang.Character,javafx.util.Callback<java.lang.Character,java.lang.Character>>`	`getConversions()` Gets the conversions.
`java.lang.String`	`getInitialText()` Gets the initial text.
`java.lang.String`	`getInputMask()` Gets the input mask.
`javafx.collections.ObservableMap<java.lang.Character,javafx.util.Callback<java.lang.Character,java.lang.Boolean>>`	`getInputMaskVerifiers()` Gets the verifiers for the InputMask.
`java.lang.String`	`getInvalidCharacters()` Gets the invalid characters.
`char`	`getPlaceholderCharacter()` Gets the placeholder character.
`java.lang.String`	`getRequiredMask()` Gets the required mask.
`java.lang.String`	`getValidCharacters()` Gets the valid characters.
`protected void`	`initializeConversions()`
`protected void`	`initializeInputMaskVerifiers()`
`protected void`	`initializeStyle()` Adds or removes style from the getStyleClass.
`protected void`	`initializeTextField()` Initializes the text field.
`javafx.beans.property.StringProperty`	`initialTextProperty()`
`javafx.beans.property.StringProperty`	`inputMaskProperty()`
`javafx.beans.property.StringProperty`	`invalidCharactersProperty()`
`boolean`	`isAutoAdvance()` Checks if the auto-advance flag.
`boolean`	`isClearButtonVisible()` Checsk if the clear button is visible.
`javafx.beans.property.ObjectProperty<java.lang.Character>`	`placeholderCharacterProperty()`
`protected void`	`registerListeners()`
`void`	`replaceSelection(java.lang.String replacement)`
`void`	`replaceText(int start, int end, java.lang.String text)`
`javafx.beans.property.StringProperty`	`requiredMaskProperty()`
`void`	`setAutoAdvance(boolean autoAdvance)` Sets the auto-advance flag.
`void`	`setClearButtonVisible(boolean clearButtonVisible)` Shows or hides the clear button.
`void`	`setConversionMask(java.lang.String mask)` Sets the conversion mask.
`void`	`setInitialText(java.lang.String mask)` Sets the initial text.
`void`	`setInputMask(java.lang.String inputMask)` Sets the input mask.
`void`	`setInvalidCharacters(java.lang.String invalidCharacters)` Sets the invalid characters.
`void`	`setPlaceholderCharacter(char placeholderCharacter)` Sets the placeholder character.
`void`	`setRequiredMask(java.lang.String requiredMask)` Sets the required mask.
`void`	`setValidCharacters(java.lang.String validCharacters)` Sets the valid characters.
`javafx.beans.property.StringProperty`	`validCharactersProperty()`

Methods inherited from class javafx.scene.control.TextField
alignmentProperty, createDefaultSkin, getAlignment, getCharacters, getClassCssMetaData, getControlCssMetaData, getOnAction, getPrefColumnCount, onActionProperty, prefColumnCountProperty, setAlignment, setOnAction, setPrefColumnCount

Methods inherited from class javafx.scene.control.TextInputControl
anchorProperty, appendText, backward, caretPositionProperty, copy, cut, deleteNextChar, deletePreviousChar, deleteText, deleteText, deselect, editableProperty, end, endOfNextWord, extendSelection, fontProperty, forward, getAnchor, getCaretPosition, getContent, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, home, insertText, isEditable, lengthProperty, nextWord, paste, positionCaret, previousWord, promptTextProperty, replaceText, selectAll, selectBackward, selectedTextProperty, selectEnd, selectEndOfNextWord, selectForward, selectHome, selectionProperty, selectNextWord, selectPositionCaret, selectPreviousWord, selectRange, setEditable, setFont, setPromptText, setText, textProperty

Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, getUserAgentStylesheet, impl_cssGetFocusTraversableInitialValue, impl_getAccessible, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPGNode, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePG, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout

Methods inherited from class javafx.scene.Node
addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPGNode, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPGNode, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - placeholderCharacter
```
public javafx.beans.property.ObjectProperty<java.lang.Character> placeholderCharacterProperty
```
    See Also:
    
    getPlaceholderCharacter(), setPlaceholderCharacter(char)
  - inputMask
```
public javafx.beans.property.StringProperty inputMaskProperty
```
    See Also:
    
    getInputMask(), setInputMask(String)
  - requiredMask
```
public javafx.beans.property.StringProperty requiredMaskProperty
```
    See Also:
    
    getRequiredMask(), setRequiredMask(String)
  - conversionMask
```
public javafx.beans.property.StringProperty conversionMaskProperty
```
    See Also:
    
    getConversionMask(), setConversionMask(String)
  - validCharacters
```
public javafx.beans.property.StringProperty validCharactersProperty
```
    See Also:
    
    getValidCharacters(), setValidCharacters(String)
  - invalidCharacters
```
public javafx.beans.property.StringProperty invalidCharactersProperty
```
    See Also:
    
    getInvalidCharacters(), setInvalidCharacters(String)
  - initialText
```
public javafx.beans.property.StringProperty initialTextProperty
```
    See Also:
    
    getInitialText(), setInitialText(String)
  - autoAdvance
```
public javafx.beans.property.BooleanProperty autoAdvanceProperty
```
    See Also:
    
    isAutoAdvance(), setAutoAdvance(boolean)
  - clearButtonVisible
```
public javafx.beans.property.BooleanProperty clearButtonVisibleProperty
```
    See Also:
    
    isClearButtonVisible(), setClearButtonVisible(boolean)
- Field Detail
  - INPUT_MASK_LETTER
```
public static final char INPUT_MASK_LETTER
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_OR_LETTER
```
public static final char INPUT_MASK_DIGIT_OR_LETTER
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_ANY_NON_SPACE
```
public static final char INPUT_MASK_ANY_NON_SPACE
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_HAX
```
public static final char INPUT_MASK_HAX
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_NON_ZERO
```
public static final char INPUT_MASK_DIGIT_NON_ZERO
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT
```
public static final char INPUT_MASK_DIGIT
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_8
```
public static final char INPUT_MASK_DIGIT_0_TO_8
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_7
```
public static final char INPUT_MASK_DIGIT_0_TO_7
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_6
```
public static final char INPUT_MASK_DIGIT_0_TO_6
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_5
```
public static final char INPUT_MASK_DIGIT_0_TO_5
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_4
```
public static final char INPUT_MASK_DIGIT_0_TO_4
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_3
```
public static final char INPUT_MASK_DIGIT_0_TO_3
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_2
```
public static final char INPUT_MASK_DIGIT_0_TO_2
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_0_TO_1
```
public static final char INPUT_MASK_DIGIT_0_TO_1
```
    See Also:
    
    Constant Field Values
  - INPUT_MASK_DIGIT_ZERO
```
public static final char INPUT_MASK_DIGIT_ZERO
```
    See Also:
    
    Constant Field Values
  - CONVERSION_MASK_UPPER_CASE
```
public static final char CONVERSION_MASK_UPPER_CASE
```
    See Also:
    
    Constant Field Values
  - CONVERSION_MASK_LOWER_CASE
```
public static final char CONVERSION_MASK_LOWER_CASE
```
    See Also:
    
    Constant Field Values
  - CONVERSION_MASK_IGNORE
```
public static final char CONVERSION_MASK_IGNORE
```
    See Also:
    
    Constant Field Values
  - REQUIRED_MASK_REQUIRED
```
public static final char REQUIRED_MASK_REQUIRED
```
    See Also:
    
    Constant Field Values
  - REQUIRED_MASK_NOT_REQUIRED
```
public static final char REQUIRED_MASK_NOT_REQUIRED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MaskTextField
```
public MaskTextField()
```
  - MaskTextField
```
public MaskTextField(java.lang.String text)
```
- Method Detail
  - initializeStyle
```
protected void initializeStyle()
```
    Adds or removes style from the getStyleClass. Subclass should call super if you want to keep the existing styles.
  - initializeTextField
```
protected void initializeTextField()
```
    Initializes the text field. We will initialize the inputMaskVerifiers and conversions in this method.
  - initializeInputMaskVerifiers
```
protected void initializeInputMaskVerifiers()
```
  - getInputMaskVerifiers
```
public javafx.collections.ObservableMap<java.lang.Character,javafx.util.Callback<java.lang.Character,java.lang.Boolean>> getInputMaskVerifiers()
```
    Gets the verifiers for the InputMask. The verifier is a callback which will verify the input char and return true or false. True means the input char is valid at the position, false means invalid.
    
    Returns:
    
    the verifiers for the InputMask.
  - initializeConversions
```
protected void initializeConversions()
```
  - getConversions
```
public javafx.collections.ObservableMap<java.lang.Character,javafx.util.Callback<java.lang.Character,java.lang.Character>> getConversions()
```
    Gets the conversions. The conversion is a callback which will convert an input char to another char.
    
    Returns:
    
    the conversions.
  - registerListeners
```
protected void registerListeners()
```
  - clear
```
public void clear()
```
    Clears the text if any.
    
    Overrides:
    
    clear in class javafx.scene.control.TextInputControl
  - placeholderCharacterProperty
```
public javafx.beans.property.ObjectProperty<java.lang.Character> placeholderCharacterProperty()
```
    See Also:
    
    getPlaceholderCharacter(), setPlaceholderCharacter(char)
  - getPlaceholderCharacter
```
public char getPlaceholderCharacter()
```
    Gets the placeholder character. This is used fill in the spaces for the masks when the text is not entered yet. By default, we will use whitespaces.
    
    Returns:
    
    the placeholder character.
  - setPlaceholderCharacter
```
public void setPlaceholderCharacter(char placeholderCharacter)
```
    Sets the placeholder character.
    
    Parameters:
    
    placeholderCharacter - a new placeholder character.
  - inputMaskProperty
```
public javafx.beans.property.StringProperty inputMaskProperty()
```
    See Also:
    
    getInputMask(), setInputMask(String)
  - getInputMask
```
public java.lang.String getInputMask()
```
    Gets the input mask.
    
    Returns:
    
    the input mask.
  - setInputMask
```
public void setInputMask(java.lang.String inputMask)
```
    Sets the input mask.
    
    Parameters:
    
    inputMask - a new input mask
  - requiredMaskProperty
```
public javafx.beans.property.StringProperty requiredMaskProperty()
```
    See Also:
    
    getRequiredMask(), setRequiredMask(String)
  - getRequiredMask
```
public java.lang.String getRequiredMask()
```
    Gets the required mask.
    
    Returns:
    
    the required mask.
  - setRequiredMask
```
public void setRequiredMask(java.lang.String requiredMask)
```
    Sets the required mask.
    
    Parameters:
    
    requiredMask - a new required mask
  - conversionMaskProperty
```
public javafx.beans.property.StringProperty conversionMaskProperty()
```
    See Also:
    
    getConversionMask(), setConversionMask(String)
  - getConversionMask
```
public java.lang.String getConversionMask()
```
    Gets the conversion mask.
    
    Returns:
    
    the conversion mask.
  - setConversionMask
```
public void setConversionMask(java.lang.String mask)
```
    Sets the conversion mask.
    
    Parameters:
    
    mask - a new conversion mask
  - validCharactersProperty
```
public javafx.beans.property.StringProperty validCharactersProperty()
```
    See Also:
    
    getValidCharacters(), setValidCharacters(String)
  - getValidCharacters
```
public java.lang.String getValidCharacters()
```
    Gets the valid characters.
    
    Returns:
    
    the valid characters.
  - setValidCharacters
```
public void setValidCharacters(java.lang.String validCharacters)
```
    Sets the valid characters.
    
    Parameters:
    
    validCharacters - a new set of valid characters
  - invalidCharactersProperty
```
public javafx.beans.property.StringProperty invalidCharactersProperty()
```
    See Also:
    
    getInvalidCharacters(), setInvalidCharacters(String)
  - getInvalidCharacters
```
public java.lang.String getInvalidCharacters()
```
    Gets the invalid characters.
    
    Returns:
    
    the invalid characters.
  - setInvalidCharacters
```
public void setInvalidCharacters(java.lang.String invalidCharacters)
```
    Sets the invalid characters.
    
    Parameters:
    
    invalidCharacters - a new set of invalid characters
  - initialTextProperty
```
public javafx.beans.property.StringProperty initialTextProperty()
```
    See Also:
    
    getInitialText(), setInitialText(String)
  - getInitialText
```
public java.lang.String getInitialText()
```
    Gets the initial text. It will be used at the initial text on the field if setText was never called.
    
    Returns:
    
    the initial text.
  - setInitialText
```
public void setInitialText(java.lang.String mask)
```
    Sets the initial text.
    
    Parameters:
    
    mask - the initial text.
  - autoAdvanceProperty
```
public javafx.beans.property.BooleanProperty autoAdvanceProperty()
```
    See Also:
    
    isAutoAdvance(), setAutoAdvance(boolean)
  - isAutoAdvance
```
public boolean isAutoAdvance()
```
    Checks if the auto-advance flag. If true, the caret will move to the next position if the typed letter is not valid at the current position. We will check the next position to find out if the typed letter is valid. If not, we will continue util finding a valid position for the letter, or reaching the end.
    
    Returns:
    
    the auto-advance flag. Default is true.
  - setAutoAdvance
```
public void setAutoAdvance(boolean autoAdvance)
```
    Sets the auto-advance flag.
    
    Parameters:
    
    autoAdvance - a new auto-advance flag
  - replaceText
```
public void replaceText(int start,
                        int end,
                        java.lang.String text)
```
    Overrides:
    
    replaceText in class javafx.scene.control.TextInputControl
  - replaceSelection
```
public void replaceSelection(java.lang.String replacement)
```
    Overrides:
    
    replaceSelection in class javafx.scene.control.TextInputControl
  - createSSNField
```
public static MaskTextField createSSNField()
```
    A static method which will create a MaskTextField for SSN (social security number, a 9-digit id number used in United States for tax purposes). The InputMask for it is "999-99-9999". The ConversionMask and the RequiredMask are not set which means no conversion and all positions are required.
    
    Returns:
    
    a MaskTextField for SSN.
  - createPhoneNumberField
```
public static MaskTextField createPhoneNumberField()
```
    A static method which will create a MaskTextField for Phone Number in US and Canada. The InputMask for it is "(999) 999-9999". The ConversionMask and the RequiredMask are not set which means no conversion and all positions are required.
    
    Returns:
    
    a MaskTextField for a Phone Number in US and Canada.
  - createZipCodeField
```
public static MaskTextField createZipCodeField()
```
    A static method which will create a MaskTextField for the Zip Code in US. The InputMask for it is "99999". The ConversionMask and the RequiredMask are not set which means no conversion and all positions are required.
    
    Returns:
    
    a MaskTextField for a Phone Number in US and Canada.
  - createZipCodePlus4Field
```
public static MaskTextField createZipCodePlus4Field()
```
    A static method which will create a MaskTextField for the Zip Code + 4 in US. The InputMask for it is "99999-9999". The ConversionMask and the RequiredMask are not set which means no conversion and all positions are required.
    
    Returns:
    
    a MaskTextField for a Phone Number in US and Canada.
  - createCanadaPostalCodeField
```
public static MaskTextField createCanadaPostalCodeField()
```
    A static method which will create a MaskTextField for the Zip Code + 4 in US. The InputMask for it is "99999-9999". The ConversionMask and the RequiredMask are not set which means no conversion and all positions are required.
    
    Returns:
    
    a MaskTextField for a Phone Number in US and Canada.
  - createSerialNumberField
```
public static MaskTextField createSerialNumberField()
```
    A static method which will create a MaskTextField for serial number. This particular one is commonly used by Microsoft's recent products. The InputMask for it is "NNNNN-NNNNN-NNNNN-NNNNN-NNNNN". The ConversionMask is "UUUUU_UUUUU_UUUUU_UUUUU_UUUUU". The RequiredMask are not set which means all positions are required.
    
    Returns:
    
    a MaskTextField for a serial number.
  - createIPv6Field
```
public static MaskTextField createIPv6Field()
```
    A static method which will create a MaskTextField for IPv6 address. The InputMask for it is "HHHH:HHHH:HHHH:HHHH:HHHH:HHHH:HHHH:HHHH". The ConversionMask is "LLLL_LLLL_LLLL_LLLL_LLLL_LLLL_LLLL_LLLL" so that only lower case letters will be used, although according to the standard, the case shouldn't matter. The RequiredMask are not set which means all positions are required.
    
    Returns:
    
    a MaskTextField for IPv6 address.
  - createMacAddressField
```
public static MaskTextField createMacAddressField()
```
    A static method which will create a MaskTextField for MAC address. The InputMask for it is "HH:HH:HH:HH:HH:HH". The ConversionMask is "LL:LL:LL:LL:LL:LL" so that only lower case letters will be used, although according to the standard, the case shouldn't matter. The RequiredMask are not set which means all positions are required.
    
    Returns:
    
    a MaskTextField for MAC address.
  - createDateField
```
public static MaskTextField createDateField()
```
    A static method which will create a MaskTextField for the Date in US standard format (in the order of month/day/year). The InputMask for it is "19/39/9999". The ConversionMask is "_x/_y/____" and we defined conversion callbacks for both 'x' and 'y' to make sure the month is between 1 and 12, the day of the month is between 1 and 31.
    The initial text was set to the today's date.
    
    Returns:
    
    a MaskTextField for Date.
  - createTime12Field
```
public static MaskTextField createTime12Field()
```
    A static method which will create a MaskTextField for the Time in the 12-hour format (in the order of hour/minute/second AM/PM). The InputMask for it is "19:59:59 xm". The InputMask 'x' and 'm' were defined to make sure the entered letter is 'A' or 'P', and 'M' respectively. The ConversionMask is "_x:__:__ UU" and we defined conversion callbacks for the conversion mask 'x' to make sure the hour is between 1 and 12.
    The initial text was set to the current time.
    
    Returns:
    
    a MaskTextField for Date.
  - createTime24Field
```
public static MaskTextField createTime24Field()
```
    A static method which will create a MaskTextField for the Time in the 24-hour format (in the order of hour/minute/second). The InputMask for it is "29/59/59". The ConversionMask is "_x/__/__" and we defined conversion callbacks for the conversion mask named 'x' to make sure the hour is between 0 and 23.
    The initial text was set to the current time.
    
    Returns:
    
    a MaskTextField for Date.
  - clearButtonVisibleProperty
```
public javafx.beans.property.BooleanProperty clearButtonVisibleProperty()
```
    See Also:
    
    isClearButtonVisible(), setClearButtonVisible(boolean)
  - isClearButtonVisible
```
public boolean isClearButtonVisible()
```
    Checsk if the clear button is visible. The clear button will clear the text on the field.
    
    Returns:
    
    true or false.
  - setClearButtonVisible
```
public void setClearButtonVisible(boolean clearButtonVisible)
```
    Shows or hides the clear button.
    
    Parameters:
    
    clearButtonVisible - true or false.

Class MaskTextField

Property Summary

Properties inherited from class javafx.scene.control.TextField

Properties inherited from class javafx.scene.control.TextInputControl

Properties inherited from class javafx.scene.control.Control

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.TextInputControl

Field Summary

Fields inherited from class javafx.scene.control.TextField

Fields inherited from class javafx.scene.layout.Region

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.TextField

Methods inherited from class javafx.scene.control.TextInputControl

Methods inherited from class javafx.scene.control.Control

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Property Detail

placeholderCharacter

inputMask

requiredMask

conversionMask

validCharacters

invalidCharacters

initialText

autoAdvance

clearButtonVisible

Field Detail

INPUT_MASK_LETTER

INPUT_MASK_DIGIT_OR_LETTER

INPUT_MASK_ANY_NON_SPACE

INPUT_MASK_HAX

INPUT_MASK_DIGIT_NON_ZERO

INPUT_MASK_DIGIT

INPUT_MASK_DIGIT_0_TO_8

INPUT_MASK_DIGIT_0_TO_7

INPUT_MASK_DIGIT_0_TO_6

INPUT_MASK_DIGIT_0_TO_5

INPUT_MASK_DIGIT_0_TO_4

INPUT_MASK_DIGIT_0_TO_3

INPUT_MASK_DIGIT_0_TO_2

INPUT_MASK_DIGIT_0_TO_1

INPUT_MASK_DIGIT_ZERO

CONVERSION_MASK_UPPER_CASE

CONVERSION_MASK_LOWER_CASE

CONVERSION_MASK_IGNORE

REQUIRED_MASK_REQUIRED

REQUIRED_MASK_NOT_REQUIRED

Constructor Detail

MaskTextField

MaskTextField

Method Detail

initializeStyle

initializeTextField

initializeInputMaskVerifiers

getInputMaskVerifiers

initializeConversions

getConversions

registerListeners

clear

placeholderCharacterProperty

getPlaceholderCharacter

setPlaceholderCharacter

inputMaskProperty

getInputMask

setInputMask

requiredMaskProperty

getRequiredMask

setRequiredMask

conversionMaskProperty

getConversionMask

setConversionMask

validCharactersProperty

getValidCharacters

setValidCharacters