FormattedTextField (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.FormattedTextField<T>

Type Parameters:

T - the data type of the value in the FormattedTextField

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable, Editor<T>

Direct Known Subclasses:

DoubleField, NumberField, PopupField
```
public class FormattedTextField<T>
extends javafx.scene.control.TextField
implements Editor<T>
```
FormattedTextField is a TextField that can restrict the user input by applying a pattern to separate the input string into groups, then define PatternVerifiers to verify/restrict the input for each group.
Let's start by looking an example for an IPv4 address field.
```
 FormattedTextField&lt;String&gt; field = new FormattedTextField&lt;&gt;();
 field.setPattern("h.h.h.h");
 field.getPatternVerifiers().put('h', new IntegerRangeGroupVerifier(0, 255));
 
```
The pattern is "h.h.h.h", it means there are four groups, separated by dots. It doesn?t really matter which letter or letters you use here because it is just a name for the group. In this case, four groups have the same name "h". Then in the PatternVerifiers map, we added a verifier for the group named "h". The verifier will enforce the input string for the group is a number and it must be between 0 and 255.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.BooleanProperty`	`autoAdvance`
`javafx.beans.property.BooleanProperty`	`autoReformat`
`javafx.beans.property.BooleanProperty`	`autoSelectAll`
`javafx.beans.property.BooleanProperty`	`clearButtonVisible`
`javafx.beans.property.BooleanProperty`	`comboBoxLike`
`javafx.beans.property.ObjectProperty<T>`	`defaultValue`
`javafx.beans.property.StringProperty`	`pattern`
`javafx.beans.property.StringProperty`	`regularExpression`
`javafx.beans.property.ObjectProperty<SpinnerStyle>`	`spinnerStyle`
`javafx.beans.property.BooleanProperty`	`spinnersVisible`
`javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>>`	`stringConverter`
`javafx.beans.property.ObjectProperty<T>`	`value`

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 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
`FormattedTextField()` Creates a `FormattedTextField` with a null value.
`FormattedTextField(T value)` Creates a `FormattedTextField` with an initial value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.scene.Node`	`asSpinner()` Return a node which can be used as a spinner control.
`javafx.scene.Node`	`asSpinner(SpinnerStyle style)` Return a node which can be used as a spinner control.
`javafx.beans.property.BooleanProperty`	`autoAdvanceProperty()`
`javafx.beans.property.BooleanProperty`	`autoReformatProperty()`
`javafx.beans.property.BooleanProperty`	`autoSelectAllProperty()`
`boolean`	`cancelEdit()` Cancels the edit to reset the text using the previous value.
`void`	`clear()` Set the value to the default value or null if the default value was not set.
`javafx.beans.property.BooleanProperty`	`clearButtonVisibleProperty()`
`javafx.beans.property.BooleanProperty`	`comboBoxLikeProperty()`
`boolean`	`commitEdit()` Commits the edit and set the value.
`protected javafx.scene.control.Button`	`createDecreaseSpinnerButton()`
`protected jidefx.scene.control.decoration.Decorator<javafx.scene.control.Button>`	`createDecreaseSpinnerDecorator()` Creates the decorator for the decrease button.
`protected javafx.scene.control.Button`	`createIncreaseSpinnerButton()`
`protected jidefx.scene.control.decoration.Decorator<javafx.scene.control.Button>`	`createIncreaseSpinnerDecorator()` Creates the decorator for the increase button.
`static FormattedTextField<java.lang.String>`	`createIPv4Field()` A static method which will create a FormattedTextField for IPv4 address.
`void`	`decreaseValue()` Decreases the value of the current group by a unit.
`javafx.beans.property.ObjectProperty<T>`	`defaultValueProperty()`
`protected void`	`enableAutoRepeat(javafx.scene.control.Button button)` Installs the <code>AutoRepeatButtonUtils</code> to the spinner buttons.
`void`	`endOfNextWord()` Moves the caret to the end of the current group or beginning of next group.
`protected T`	`fromString(java.lang.String text)`
`T`	`getDefaultValue()` Gets the default value.
`protected java.util.regex.Matcher`	`getGroupMatcher(java.lang.String newText)`
`java.lang.String`	`getGroupText(int groupIndex)` Gets the text of the group at the specified index.
`java.lang.String`	`getGroupText(java.lang.String groupName)` Gets the text of the group with the specified name.
`java.lang.String`	`getPattern()` Gets the pattern.
`javafx.collections.ObservableMap<java.lang.String,javafx.util.Callback<java.lang.String,java.lang.Boolean>>`	`getPatternVerifiers()` Gets the verifiers for the group.
`java.lang.String`	`getRegularExpression()` Gets the regular expression pattern.
`SpinnerStyle`	`getSpinnerStyle()` Gets the SpinnerStyle.
`javafx.util.StringConverter<T>`	`getStringConverter()` Gets the StringConverter.
`T`	`getValue()` Gets the value represented by this `FormattedTextField`.
`void`	`increaseValue()` Increases the value of the current group by a unit.
`protected void`	`initializePattern()` Subclass can override this method to initializes the pattern, pattern verifiers and the StringConverter.
`protected void`	`initializeStyle()` Adds or removes style from the getStyleClass.
`protected void`	`initializeTextField()` Do some initialization of the text field, such as set the PopupContentFactory.
`void`	`installAdjustmentMouseHandler(javafx.scene.Node node)` Installs a mouse handler to the node so that when user drags the node, the value in the FormattedTextField will be adjusted.
`void`	`installAdjustmentMouseHandler(javafx.scene.Node node, int units)` Installs a mouse handler to the node so that when user drags the node, the value in the FormattedTextField will be adjusted.
`void`	`installAdjustmentMouseHandler(javafx.scene.Node node, int units, double threshold)` Installs a mouse handler to the node so that when user drags the node, the value in the FormattedTextField will be adjusted.
`boolean`	`isAutoAdvance()` Checks if the auto-advance flag.
`boolean`	`isAutoReformat()` Checks if the auto-reformat flag.
`boolean`	`isAutoSelectAll()` Checks whether the text will be all selected after setValue is called.
`boolean`	`isClearButtonVisible()` Checsk if the clear button is visible.
`boolean`	`isComboBoxLike()` Gets the value of the property comboBoxLike.
`boolean`	`isSpinnersVisible()` Checks if the spinner buttons are visible.
`void`	`nextWord()` Moves the caret to the end of the current group or beginning of next group.
`javafx.beans.value.ObservableValue<T>`	`observableValue()` An observable value of the editor so that one can listen to the value change.
`javafx.beans.property.StringProperty`	`patternProperty()`
`void`	`previousWord()` Moves the caret to the beginning of the current group or the end of the previous group.
`boolean`	`processKeyCode(javafx.scene.input.KeyEvent event)` Increases or decreases the value in the current group.
`protected void`	`registerListeners()`
`javafx.beans.property.StringProperty`	`regularExpressionProperty()`
`void`	`replaceSelection(java.lang.String replacement)`
`void`	`replaceText(int start, int end, java.lang.String text)`
`boolean`	`selectCurrentGroup()` Selects the group.
`void`	`selectEndOfNextWord()` For the grouped-based field, it will move the caret to the end of current group or the beginning of the next group.
`boolean`	`selectNextGroup()` Selects the next group.
`void`	`selectNextWord()` For the grouped-based field, it will move the caret to the end of current group or the beginning of the next group.
`boolean`	`selectPreviousGroup()` Selects the next group.
`void`	`selectPreviousWord()` Moves the caret to the beginning of current group or the end of the previous group.
`void`	`setAutoAdvance(boolean autoAdvance)` Sets the auto-advance flag.
`void`	`setAutoReformat(boolean autoReformat)` Sets the auto-reformat flag.
`void`	`setAutoSelectAll(boolean autoSelectAll)` Sets the flag whether to select all after the setValue is called.
`void`	`setClearButtonVisible(boolean clearButtonVisible)` Shows or hides the clear button.
`void`	`setComboBoxLike(java.lang.Boolean comboBoxLie)` Sets the value of the property comboBoxLike.
`void`	`setDefaultValue(T value)` Sets the default value.
`void`	`setPattern(java.lang.String pattern)` Sets the pattern.
`void`	`setRegularExpression(java.lang.String regex)` Sets the regular expression pattern.
`void`	`setSpinnerStyle(SpinnerStyle spinnerStyle)` Sets the SpinnerStyle.
`void`	`setSpinnersVisible(boolean spinnersVisible)` Sets the spinner buttons visible.
`void`	`setStringConverter(javafx.util.StringConverter<T> stringConverter)` Sets the StringConverter that will convert the value from/to String.
`void`	`setValue(T value)` Sets the value represented by this `FormattedTextField`.
`javafx.beans.property.ObjectProperty<SpinnerStyle>`	`spinnerStyleProperty()`
`javafx.beans.property.BooleanProperty`	`spinnersVisibleProperty()`
`javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>>`	`stringConverterProperty()`
`protected boolean`	`supportFromString()`
`protected java.lang.String`	`toString(T value)`
`void`	`uninstallAdjustmentMouseHandler(javafx.scene.Node node)` Uninstalls the mouse handler added by `installAdjustmentMouseHandler(Node)`.
`javafx.beans.property.ObjectProperty<T>`	`valueProperty()`

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, extendSelection, fontProperty, forward, getAnchor, getCaretPosition, getContent, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, home, insertText, isEditable, lengthProperty, paste, positionCaret, promptTextProperty, replaceText, selectAll, selectBackward, selectedTextProperty, selectEnd, selectForward, selectHome, selectionProperty, selectPositionCaret, 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

Methods inherited from interface jidefx.scene.control.editor.Editor
createEditor

- Property Detail
  - pattern
```
public javafx.beans.property.StringProperty patternProperty
```
    See Also:
    
    getPattern(), setPattern(String)
  - regularExpression
```
public javafx.beans.property.StringProperty regularExpressionProperty
```
    See Also:
    
    getRegularExpression(), setRegularExpression(String)
  - stringConverter
```
public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>> stringConverterProperty
```
    See Also:
    
    getStringConverter(), setStringConverter(StringConverter)
  - value
```
public javafx.beans.property.ObjectProperty<T> valueProperty
```
    See Also:
    
    getValue(), setValue(T)
  - defaultValue
```
public javafx.beans.property.ObjectProperty<T> defaultValueProperty
```
    See Also:
    
    getDefaultValue(), setDefaultValue(T)
  - autoAdvance
```
public javafx.beans.property.BooleanProperty autoAdvanceProperty
```
    See Also:
    
    isAutoAdvance(), setAutoAdvance(boolean)
  - autoReformat
```
public javafx.beans.property.BooleanProperty autoReformatProperty
```
    See Also:
    
    isAutoReformat(), setAutoReformat(boolean)
  - autoSelectAll
```
public javafx.beans.property.BooleanProperty autoSelectAllProperty
```
    See Also:
    
    isAutoSelectAll(), setAutoSelectAll(boolean)
  - spinnersVisible
```
public javafx.beans.property.BooleanProperty spinnersVisibleProperty
```
    See Also:
    
    isSpinnersVisible(), setSpinnersVisible(boolean)
  - clearButtonVisible
```
public javafx.beans.property.BooleanProperty clearButtonVisibleProperty
```
    See Also:
    
    isClearButtonVisible(), setClearButtonVisible(boolean)
  - comboBoxLike
```
public javafx.beans.property.BooleanProperty comboBoxLikeProperty
```
    See Also:
    
    isComboBoxLike(), setComboBoxLike(Boolean)
  - spinnerStyle
```
public javafx.beans.property.ObjectProperty<SpinnerStyle> spinnerStyleProperty
```
    See Also:
    
    getSpinnerStyle(), setSpinnerStyle(SpinnerStyle)
- Constructor Detail
  - FormattedTextField
```
public FormattedTextField()
```
    Creates a FormattedTextField with a null value. This constrcutor will call initializePattern(), initializeTextField(), initializeStyle(), registerListeners() in order, at last, the setValue(null) method. Subclass can override those methods to do its own initialization.
  - FormattedTextField
```
public FormattedTextField(T value)
```
    Creates a FormattedTextField with an initial value. This constrcutor will call initializeStyle(), initializePattern(), initializeTextField(), registerListeners() in order, at last, the setValue method. Subclass can override those methods to do its own initialization.
    
    Parameters:
    
    value - the initial value.
- 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()
```
    Do some initialization of the text field, such as set the PopupContentFactory. Subclass should call supper first.
  - initializePattern
```
protected void initializePattern()
```
    Subclass can override this method to initializes the pattern, pattern verifiers and the StringConverter. Subclass should call supper first.
  - getPatternVerifiers
```
public javafx.collections.ObservableMap<java.lang.String,javafx.util.Callback<java.lang.String,java.lang.Boolean>> getPatternVerifiers()
```
    Gets the verifiers for the group. The verifier is a callback which will verify the input String and return true or false. True means the input String is valid for the group, false means invalid.
    
    Returns:
    
    the verifiers for the group.
  - registerListeners
```
protected void registerListeners()
```
  - clear
```
public void clear()
```
    Set the value to the default value or null if the default value was not set.
    
    Overrides:
    
    clear in class javafx.scene.control.TextInputControl
  - cancelEdit
```
public boolean cancelEdit()
```
    Cancels the edit to reset the text using the previous value.
    
    Returns:
    
    true if canceled. False if not canceled because the previous value is null or the current value is the same as the previous cancel (or you can think it as the value was just canceled and now you cancel it again).
  - commitEdit
```
public boolean commitEdit()
```
    Commits the edit and set the value.
    
    Returns:
    
    true if commited. False if not commited because the text format is incorrect.
  - toString
```
protected java.lang.String toString(T value)
```
  - fromString
```
protected T fromString(java.lang.String text)
```
  - supportFromString
```
protected boolean supportFromString()
```
  - previousWord
```
public void previousWord()
```
    Moves the caret to the beginning of the current group or the end of the previous group. This function also has the effect of clearing the selection.
    
    Overrides:
    
    previousWord in class javafx.scene.control.TextInputControl
  - nextWord
```
public void nextWord()
```
    Moves the caret to the end of the current group or beginning of next group. This function also has the effect of clearing the selection.
    
    Overrides:
    
    nextWord in class javafx.scene.control.TextInputControl
  - endOfNextWord
```
public void endOfNextWord()
```
    Moves the caret to the end of the current group or beginning of next group. This function also has the effect of clearing the selection. It is the same as nextWord().
    
    Overrides:
    
    endOfNextWord in class javafx.scene.control.TextInputControl
  - selectPreviousWord
```
public void selectPreviousWord()
```
    Moves the caret to the beginning of current group or the end of the previous group. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved.
    
    Overrides:
    
    selectPreviousWord in class javafx.scene.control.TextInputControl
  - selectNextWord
```
public void selectNextWord()
```
    For the grouped-based field, it will move the caret to the end of current group or the beginning of the next group. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved.
    For position-based field, it will simply call super.
    
    Overrides:
    
    selectNextWord in class javafx.scene.control.TextInputControl
  - selectEndOfNextWord
```
public void selectEndOfNextWord()
```
    For the grouped-based field, it will move the caret to the end of current group or the beginning of the next group. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved. It is the same as selectNextWord().
    For position-based field, it will simply call super.
    
    Overrides:
    
    selectEndOfNextWord in class javafx.scene.control.TextInputControl
  - selectPreviousGroup
```
public boolean selectPreviousGroup()
```
    Selects the next group. Commits the edit before selecting.
    Valid only for the group-based field.
    
    Returns:
    
    true if succeed, false if not selected.
  - selectNextGroup
```
public boolean selectNextGroup()
```
    Selects the next group. Commits the edit before selecting.
    Valid only for the group-based field.
    
    Returns:
    
    true if succeed, false if not selected.
  - selectCurrentGroup
```
public boolean selectCurrentGroup()
```
    Selects the group.
    
    Returns:
    
    true if succeed, false if not selected.
  - processKeyCode
```
public boolean processKeyCode(javafx.scene.input.KeyEvent event)
```
    Increases or decreases the value in the current group. The current group text will be selected.
    
    Parameters:
    
    event - the KeyEvent.
    
    Returns:
    
    true if the value is adjusted, otherwise false. If the text in the current group is not number, it will return false.
  - increaseValue
```
public void increaseValue()
```
    Increases the value of the current group by a unit. Only valid for the group-based field.
  - decreaseValue
```
public void decreaseValue()
```
    Decreases the value of the current group by a unit. Only valid for the group-based field.
  - patternProperty
```
public javafx.beans.property.StringProperty patternProperty()
```
    See Also:
    
    getPattern(), setPattern(String)
  - getPattern
```
public java.lang.String getPattern()
```
    Gets the pattern.
    
    Returns:
    
    the pattern.
  - setPattern
```
public void setPattern(java.lang.String pattern)
```
    Sets the pattern.
    
    Parameters:
    
    pattern - a new pattern
  - regularExpressionProperty
```
public javafx.beans.property.StringProperty regularExpressionProperty()
```
    See Also:
    
    getRegularExpression(), setRegularExpression(String)
  - getRegularExpression
```
public java.lang.String getRegularExpression()
```
    Gets the regular expression pattern.
    
    Returns:
    
    the regex.
  - setRegularExpression
```
public void setRegularExpression(java.lang.String regex)
```
    Sets the regular expression pattern. This regular expression pattern will be used to parse a string and separate it into groups.
    In most cases, you don't need to call this method because we will automatically create the regular expression using the pattern from the setPattern method. If the groups are separated by a non-group characters, we should have no problem figuring out. Even if the groups are adjacent, we will check if the verifier implements PatternVerifier.Length. If yes, we will use the min/maxLength as additional information to help us figuring it out. If none of the efforts works, we will at last throw an IllegalStateException in the runtime. When you saw this exception, you can then call this method to help us with the regular expression, or you can improve the pattern or the verifier.
    
    Parameters:
    
    regex - a new regular expression pattern with the group information.
  - stringConverterProperty
```
public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>> stringConverterProperty()
```
    See Also:
    
    getStringConverter(), setStringConverter(StringConverter)
  - getStringConverter
```
public javafx.util.StringConverter<T> getStringConverter()
```
    Gets the StringConverter.
    
    Returns:
    
    the StringConverter.
  - setStringConverter
```
public void setStringConverter(javafx.util.StringConverter<T> stringConverter)
```
    Sets the StringConverter that will convert the value from/to String.
    
    Parameters:
    
    stringConverter - the new StringConverter.
  - valueProperty
```
public javafx.beans.property.ObjectProperty<T> valueProperty()
```
    See Also:
    
    getValue(), setValue(T)
  - getValue
```
public T getValue()
```
    Gets the value represented by this FormattedTextField. The value is only used by the group-based field.
    
    Specified by:
    
    getValue in interface Editor<T>
    
    Returns:
    
    the value if it is the group-based field.
  - setValue
```
public void setValue(T value)
```
    Sets the value represented by this FormattedTextField. The value is only used by the group-based field. Usually if you set a value, you also want to set a format. For the non-group-based field, setValue would behave the same as the setText method.
    
    Specified by:
    
    setValue in interface Editor<T>
    
    Parameters:
    
    value - the new value.
  - observableValue
```
public javafx.beans.value.ObservableValue<T> observableValue()
```
    Description copied from interface: Editor
    
    An observable value of the editor so that one can listen to the value change.
    
    Specified by:
    
    observableValue in interface Editor<T>
    
    Returns:
    
    An observable value.
  - defaultValueProperty
```
public javafx.beans.property.ObjectProperty<T> defaultValueProperty()
```
    See Also:
    
    getDefaultValue(), setDefaultValue(T)
  - getDefaultValue
```
public T getDefaultValue()
```
    Gets the default value. The default value is used when the clear method is called.
    
    Returns:
    
    the default value.
  - setDefaultValue
```
public void setDefaultValue(T value)
```
    Sets the default value. The default value is used when the clear method is called.
    
    Parameters:
    
    value - the new default value.
  - 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
  - autoReformatProperty
```
public javafx.beans.property.BooleanProperty autoReformatProperty()
```
    See Also:
    
    isAutoReformat(), setAutoReformat(boolean)
  - isAutoReformat
```
public boolean isAutoReformat()
```
    Checks if the auto-reformat flag. If true, the text will be automatically reformat using the StringConverter for every char typed. The value will be as well for each reformat.
    
    Returns:
    
    the auto-reformat flag. Default is false.
  - setAutoReformat
```
public void setAutoReformat(boolean autoReformat)
```
    Sets the auto-reformat flag.
    
    Parameters:
    
    autoReformat - a new auto-reformat flag
  - autoSelectAllProperty
```
public javafx.beans.property.BooleanProperty autoSelectAllProperty()
```
    See Also:
    
    isAutoSelectAll(), setAutoSelectAll(boolean)
  - isAutoSelectAll
```
public boolean isAutoSelectAll()
```
    Checks whether the text will be all selected after setValue is called.
    
    Returns:
    
    true to select all after the setValue is called.
  - setAutoSelectAll
```
public void setAutoSelectAll(boolean autoSelectAll)
```
    Sets the flag whether to select all after the setValue is called.
    
    Parameters:
    
    autoSelectAll - true to select all after the setValue is called. Otherwise false.
  - getGroupMatcher
```
protected java.util.regex.Matcher getGroupMatcher(java.lang.String newText)
```
  - getGroupText
```
public java.lang.String getGroupText(int groupIndex)
```
    Gets the text of the group at the specified index.
    
    Parameters:
    
    groupIndex - the group index.
    
    Returns:
    
    the text that belongs to the group.
  - getGroupText
```
public java.lang.String getGroupText(java.lang.String groupName)
```
    Gets the text of the group with the specified name. You should only use this method if each group has a unique name. Otherwise it will return the first group that matches with the name.
    
    Parameters:
    
    groupName - the group name.
    
    Returns:
    
    the text that belongs to the group.
  - 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
  - enableAutoRepeat
```
protected void enableAutoRepeat(javafx.scene.control.Button button)
```
    Installs the <code>AutoRepeatButtonUtils</code> to the spinner buttons. Subclass can override this method to disable auto-repeat feature or install your own one with different initial delay and interval.
    
    Parameters:
    
    button - one of the two spinner buttons.
  - createIncreaseSpinnerDecorator
```
protected jidefx.scene.control.decoration.Decorator<javafx.scene.control.Button> createIncreaseSpinnerDecorator()
```
    Creates the decorator for the increase button. Subclass can override it to create a different decorator.
    
    Returns:
    
    the decorator for the increase button
  - createIncreaseSpinnerButton
```
protected javafx.scene.control.Button createIncreaseSpinnerButton()
```
  - createDecreaseSpinnerDecorator
```
protected jidefx.scene.control.decoration.Decorator<javafx.scene.control.Button> createDecreaseSpinnerDecorator()
```
    Creates the decorator for the decrease button. Subclass can override it to create a different decorator.
    
    Returns:
    
    the decorator for the decrease button
  - createDecreaseSpinnerButton
```
protected javafx.scene.control.Button createDecreaseSpinnerButton()
```
  - spinnersVisibleProperty
```
public javafx.beans.property.BooleanProperty spinnersVisibleProperty()
```
    See Also:
    
    isSpinnersVisible(), setSpinnersVisible(boolean)
  - isSpinnersVisible
```
public boolean isSpinnersVisible()
```
    Checks if the spinner buttons are visible.
    
    Returns:
    
    true or false.
  - setSpinnersVisible
```
public void setSpinnersVisible(boolean spinnersVisible)
```
    Sets the spinner buttons visible. The spinner buttons are two buttons with up and down arrows. Clicking them will increase and decrease the values in a group-based FormattedTextField. For position-based one, the spinners have no effect.
    
    Parameters:
    
    spinnersVisible - true or false.
  - 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.
  - comboBoxLikeProperty
```
public javafx.beans.property.BooleanProperty comboBoxLikeProperty()
```
    See Also:
    
    isComboBoxLike(), setComboBoxLike(Boolean)
  - isComboBoxLike
```
public boolean isComboBoxLike()
```
    Gets the value of the property comboBoxLike.
  - setComboBoxLike
```
public void setComboBoxLike(java.lang.Boolean comboBoxLie)
```
    Sets the value of the property comboBoxLike.
  - installAdjustmentMouseHandler
```
public void installAdjustmentMouseHandler(javafx.scene.Node node)
```
    Installs a mouse handler to the node so that when user drags the node, the value in the FormattedTextField will be adjusted. Pressing on the adjustment node will make the field getting focus and select the current group. Dragging the node will adjust the value. Also when the SHIFT key is pressed during dragging, we will adjust the value 10 times for each mouse dragged event (the same as steps x 10). If the ALT key is pressed during dragging, it will take a 10 times longer dragging distance in order to trigger the value adjustment (the same as threshold x 10). Furthermore, if the field has multiple groups, A double-click will select the next group, A shift-double-click will select the previous group.
    Because the singleton nature of this feature, we only support one adjustment node per field. Installing the mouse handler for another node will remove the previous mouse handler.
    
    Parameters:
    
    node - the node. It is usually the label node for the field. For example, you have a Label("Opacity") then a field for the opacity value. The node here would be the label.
  - installAdjustmentMouseHandler
```
public void installAdjustmentMouseHandler(javafx.scene.Node node,
                                          int units)
```
    Installs a mouse handler to the node so that when user drags the node, the value in the FormattedTextField will be adjusted. Pressing on the adjustment node will make the field getting focus and select the current group. Dragging the node will adjust the value. Also when the SHIFT key is pressed during dragging, we will adjust the value 10 times for each mouse dragged event (the same as units x 10). If the ALT key is pressed during dragging, it will take a 10 times longer dragging distance in order to trigger the value adjustment (the same as threshold x 10). Furthermore, if the field has multiple groups, A double-click will select the next group, A shift-double-click will select the previous group.
    Because the singleton nature of this feature, we only support one adjustment node per field. Installing the mouse handler for another node will remove the previous mouse handler.
    
    Parameters:
    
    node - the node. It is usually the label node for the field. For example, you have a Label("Opacity") then a field for the opacity value. The node here would be the label.
    
    units - how many times the value will be adjusted when there is a mouse dragged event. It should be a value greater than or equal to 1.
  - installAdjustmentMouseHandler
```
public void installAdjustmentMouseHandler(javafx.scene.Node node,
                                          int units,
                                          double threshold)
```
    Installs a mouse handler to the node so that when user drags the node, the value in the FormattedTextField will be adjusted. Pressing on the adjustment node will make the field getting focus and select the current group. Dragging the node will adjust the value. Also when the SHIFT key is pressed during dragging, we will adjust the value 10 times for each mouse dragged event (the same as units x 10). If the ALT key is pressed during dragging, it will take a 10 times longer dragging distance in order to trigger the value adjustment (the same as threshold x 10). Furthermore, if the field has multiple groups, A double-click will select the next group, A shift-double-click will select the previous group.
    Because the singleton nature of this feature, we only support one adjustment node per field. Installing the mouse handler for another node will remove the previous mouse handler.
    
    Parameters:
    
    node - the node. It is usually the label node for the field. For example, you have a Label("Opacity") then a field for the opacity value. The node here would be the label.
    
    units - how many units the value will be adjusted when there is a mouse dragged event. It should be a value greater than or equal to 1.
    
    threshold - it will determine how far the mouse movement will trigger a value adjustment. The default value is 1. Larger means longer distance. The larger the value, the longer distance the mouse has to travel before a value adjustment is triggered.
  - uninstallAdjustmentMouseHandler
```
public void uninstallAdjustmentMouseHandler(javafx.scene.Node node)
```
    Uninstalls the mouse handler added by installAdjustmentMouseHandler(Node).
    
    Parameters:
    
    node - the node where the mouse handler was added.
  - asSpinner
```
public javafx.scene.Node asSpinner()
```
    Return a node which can be used as a spinner control. If you use this node, you don't need to add the field to a DecorationPane to show the spinner buttons because the node itself is a DecorationPane. In addition to that, this node also provides a better support for the setSpinnerStyle(SpinnerStyle) call especially when the spinner buttons are outside the field.
    
    Returns:
    
    a node that can be used as a spinner control.
  - asSpinner
```
public javafx.scene.Node asSpinner(SpinnerStyle style)
```
    Return a node which can be used as a spinner control. If you use this node, you don't need to add the field to a DecorationPane to show the spinner buttons because the node itself is a DecorationPane. In addition to that, this node also provides a better support for the setSpinnerStyle(SpinnerStyle) call especially when the spinner buttons are outside the field.
    
    Parameters:
    
    style - the SpinnerStyle
    
    Returns:
    
    a node that can be used as a spinner control.
  - createIPv4Field
```
public static FormattedTextField<java.lang.String> createIPv4Field()
```
    A static method which will create a FormattedTextField for IPv4 address. The InputMask for it is "G.G.G.G". The Pattern "h.h.h.h". A GroupVerifier is defined for the group name 'h' to limit the number entered for the group is from 0 to 255.
    
    Returns:
    
    a FormattedTextField for IPv4 address.
  - spinnerStyleProperty
```
public javafx.beans.property.ObjectProperty<SpinnerStyle> spinnerStyleProperty()
```
    See Also:
    
    getSpinnerStyle(), setSpinnerStyle(SpinnerStyle)
  - getSpinnerStyle
```
public SpinnerStyle getSpinnerStyle()
```
    Gets the SpinnerStyle.
    
    Returns:
    
    the SpinnerStyle.
  - setSpinnerStyle
```
public void setSpinnerStyle(SpinnerStyle spinnerStyle)
```
    Sets the SpinnerStyle. It allows you to customize the location of the spinner buttons. If you are using any SpinnerStyles that start with "OUTSIDE_", we recommand you add the field to its parent by adding field.asSpinner() to a pane instead of the field itself.
    
    Parameters:
    
    spinnerStyle - the new SpinnerStyle.
    
    See Also:
    
    asSpinner()

Class FormattedTextField<T>

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

Methods inherited from interface jidefx.scene.control.editor.Editor

Property Detail

pattern

regularExpression

stringConverter

value

defaultValue

autoAdvance

autoReformat

autoSelectAll

spinnersVisible

clearButtonVisible

comboBoxLike

spinnerStyle

Constructor Detail

FormattedTextField

FormattedTextField

Method Detail

initializeStyle

initializeTextField

initializePattern

getPatternVerifiers

registerListeners

clear

cancelEdit

commitEdit

toString

fromString

supportFromString

previousWord

nextWord

endOfNextWord

selectPreviousWord

selectNextWord

selectEndOfNextWord

selectPreviousGroup

selectNextGroup

selectCurrentGroup

processKeyCode

increaseValue

decreaseValue

patternProperty

getPattern

setPattern

regularExpressionProperty

getRegularExpression

setRegularExpression

stringConverterProperty

getStringConverter

setStringConverter

valueProperty

getValue

setValue

observableValue

defaultValueProperty

getDefaultValue

setDefaultValue

autoAdvanceProperty