TextInputControlSkin

java.lang.Object
- <any>
- - javafx.scene.control.skin.TextInputControlSkin<T>

Direct Known Subclasses:

TextAreaSkin, TextFieldSkin
```
public abstract class TextInputControlSkin<T extends TextInputControl>
extends <any>
```
Abstract base class for text input skins.

Since:

9

See Also:

TextFieldSkin, TextAreaSkin

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`(package private) ObservableBooleanValue`	`caretVisible`
`protected BooleanProperty`	`forwardBias` Caret bias in the content.
`protected <any>`	`highlightFill` The fill to use for the text when highlighted.
`protected <any>`	`highlightTextFill`
`protected <any>`	`promptTextFill`
`protected <any>`	`textFill` The fill to use for the text under normal conditions

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`TextInputControlSkin.CaretBlinking` Support classes
`static class`	`TextInputControlSkin.Direction` Direction names for caret movement.
`private static class`	`TextInputControlSkin.StyleableProperties`
`static class`	`TextInputControlSkin.TextUnit` Unit names for caret movement.

Field Summary

Fields
Modifier and Type	Field and Description
`private BooleanProperty`	`blink` Properties
`private TextInputControlSkin.CaretBlinking`	`caretBlinking`
`(package private) StackPane`	`caretHandle`
`(package private) Path`	`caretPath` A path, provided by the textNode, which represents the caret.
`private ObservableBooleanValue`	`caretVisible`
`private BooleanProperty`	`displayCaret`
`(package private) <any>`	`fontMetrics` Private fields
`private BooleanProperty`	`forwardBias` Caret bias in the content.
`private <any>`	`highlightFill` The fill to use for the text when highlighted.
`private <any>`	`highlightTextFill`
`private java.util.List<Shape>`	`imattrs`
`private int`	`imlength`
`private int`	`imstart`
`private static boolean`	`IS_FXVK_SUPPORTED`
`(package private) static boolean`	`preload`
`private <any>`	`promptTextFill`
`(package private) StackPane`	`selectionHandle1`
`(package private) StackPane`	`selectionHandle2`
`(package private) static boolean`	`SHOW_HANDLES` Specifies whether we ought to show handles.
`private <any>`	`textFill` The fill to use for the text under normal conditions

Constructor Summary

Constructors
Constructor and Description
`TextInputControlSkin(T control)` Creates a new instance of TextInputControlSkin, although note that this instance does not handle any behavior / input mappings - this needs to be handled appropriately by subclasses.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`addHighlight(java.util.List<? extends Node> nodes, int start)` Adds highlight for composed text from Input Method.
`private BooleanProperty`	`blinkProperty()`
`(package private) ObservableBooleanValue`	`caretVisibleProperty()`
`private void`	`createInputMethodAttributes(InputMethodHighlight highlight, int start, int end)`
`private BooleanProperty`	`displayCaretProperty()`
`protected void`	`executeAccessibleAction(AccessibleAction action, java.lang.Object... parameters)`
`protected BooleanProperty`	`forwardBiasProperty()` Caret bias in the content.
`(package private) TextInputControlBehavior`	`getBehavior()` Private implementation
`Rectangle2D`	`getCharacterBounds(int index)` Returns the bounds of the character at a given index.
`static java.util.List<<any>>`	`getClassCssMetaData()` Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
`java.util.List<<any>>`	`getCssMetaData()`
`protected Paint`	`getHighlightFill()` Gets the value of the property highlightFill.
`protected Paint`	`getHighlightTextFill()` Gets the value of the property highlightTextFill.
`protected int`	`getInsertionPoint(double x, double y)` Returns the insertion point for a given location.
`Point2D`	`getMenuPosition()` Returns the position to be used for a context menu, based on the location of the caret handle or selection handles.
`protected Paint`	`getPromptTextFill()` Gets the value of the property promptTextFill.
`protected abstract PathElement[]`	`getRangeShape(int start, int end)`
`protected Paint`	`getTextFill()` Gets the value of the property textFill.
`protected abstract PathElement[]`	`getUnderlineShape(int start, int end)`
`protected void`	`handleInputMethodEvent(InputMethodEvent event)`
`protected <any>`	`highlightFillProperty()` The fill to use for the text when highlighted.
`protected <any>`	`highlightTextFillProperty()`
`protected void`	`invalidateMetrics()` Invalidates cached min and pref sizes for the TextInputControl.
`private boolean`	`isBlink()`
`private boolean`	`isDisplayCaret()`
`protected boolean`	`isForwardBias()` Gets the value of the property forwardBias.
`(package private) boolean`	`isRTL()`
`protected java.lang.String`	`maskText(java.lang.String txt)` This method may be overridden by subclasses to replace the displayed characters without affecting the actual text content.
`abstract void`	`moveCaret(TextInputControlSkin.TextUnit unit, TextInputControlSkin.Direction dir, boolean select)` Moves the caret by one of the given text unit, in the given direction.
`protected <any>`	`promptTextFillProperty()`
`protected abstract void`	`removeHighlight(java.util.List<? extends Node> nodes)` Removes highlight for composed text from Input Method.
`protected void`	`scrollCharacterToVisible(int index)` Ensures that the character at a given index is visible.
`private void`	`setBlink(boolean value)`
`void`	`setCaretAnimating(boolean value)` Starts or stops caret blinking.
`private void`	`setDisplayCaret(boolean value)`
`void`	`setForwardBias(boolean isLeading)` Sets the value of the property forwardBias.
`protected void`	`setHighlightFill(Paint value)` The fill `Paint` used for the background of selected text.
`protected void`	`setHighlightTextFill(Paint value)` The fill `Paint` used for the foreground of selected text.
`protected void`	`setPromptTextFill(Paint value)` The fill `Paint` used for the foreground prompt text color.
`protected void`	`setTextFill(Paint value)` The fill `Paint` used for the foreground text color.
`protected <any>`	`textFillProperty()` The fill to use for the text under normal conditions
`protected void`	`updateHighlightFill()` Called when highlightFill property changes.
`protected void`	`updateHighlightTextFill()` Called when highlightTextFill property changes.
`protected void`	`updateTextFill()` Called when textFill property changes.

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

- Property Detail
  - textFill
```
protected final <any> textFillProperty
```
    The fill to use for the text under normal conditions
    
    See Also:
    
    getTextFill(), setTextFill(Paint)
  - promptTextFill
```
protected final <any> promptTextFillProperty
```
    See Also:
    
    getPromptTextFill(), setPromptTextFill(Paint)
  - highlightFill
```
protected final <any> highlightFillProperty
```
    The fill to use for the text when highlighted.
    
    See Also:
    
    getHighlightFill(), setHighlightFill(Paint)
  - highlightTextFill
```
protected final <any> highlightTextFillProperty
```
    See Also:
    
    getHighlightTextFill(), setHighlightTextFill(Paint)
  - forwardBias
```
protected final BooleanProperty forwardBiasProperty
```
    Caret bias in the content. true means a bias towards forward character (true=leading/false=trailing)
    
    See Also:
    
    isForwardBias(), setForwardBias(boolean)
  - caretVisible
```
ObservableBooleanValue caretVisibleProperty
```
- Field Detail
  - preload
```
static boolean preload
```
  - SHOW_HANDLES
```
static final boolean SHOW_HANDLES
```
    Specifies whether we ought to show handles. We should do it on touch platforms, but not iOS (and maybe not Android either?)
  - IS_FXVK_SUPPORTED
```
private static final boolean IS_FXVK_SUPPORTED
```
  - fontMetrics
```
final <any> fontMetrics
```
    Private fields
  - caretVisible
```
private ObservableBooleanValue caretVisible
```
  - caretBlinking
```
private TextInputControlSkin.CaretBlinking caretBlinking
```
  - caretPath
```
final Path caretPath
```
    A path, provided by the textNode, which represents the caret. I assume this has to be updated whenever the caretPosition changes. Perhaps more frequently (including text changes), but I'm not sure.
  - caretHandle
```
StackPane caretHandle
```
  - selectionHandle1
```
StackPane selectionHandle1
```
  - selectionHandle2
```
StackPane selectionHandle2
```
  - imstart
```
private int imstart
```
  - imlength
```
private int imlength
```
  - imattrs
```
private java.util.List<Shape> imattrs
```
  - blink
```
private BooleanProperty blink
```
    Properties
  - textFill
```
private final <any> textFill
```
    The fill to use for the text under normal conditions
  - promptTextFill
```
private final <any> promptTextFill
```
  - highlightFill
```
private final <any> highlightFill
```
    The fill to use for the text when highlighted.
  - highlightTextFill
```
private final <any> highlightTextFill
```
  - displayCaret
```
private final BooleanProperty displayCaret
```
  - forwardBias
```
private BooleanProperty forwardBias
```
    Caret bias in the content. true means a bias towards forward character (true=leading/false=trailing)
- Constructor Detail
  - TextInputControlSkin
```
public TextInputControlSkin(T control)
```
    Creates a new instance of TextInputControlSkin, although note that this instance does not handle any behavior / input mappings - this needs to be handled appropriately by subclasses.
    
    Parameters:
    
    control - The control that this skin should be installed onto.
- Method Detail
  - setBlink
```
private final void setBlink(boolean value)
```
  - isBlink
```
private final boolean isBlink()
```
  - blinkProperty
```
private final BooleanProperty blinkProperty()
```
  - setTextFill
```
protected final void setTextFill(Paint value)
```
    The fill Paint used for the foreground text color.
    
    Parameters:
    
    value - the text fill
  - getTextFill
```
protected final Paint getTextFill()
```
    Gets the value of the property textFill.
  - textFillProperty
```
protected final <any> textFillProperty()
```
    The fill to use for the text under normal conditions
    
    See Also:
    
    getTextFill(), setTextFill(Paint)
  - setPromptTextFill
```
protected final void setPromptTextFill(Paint value)
```
    The fill Paint used for the foreground prompt text color.
    
    Parameters:
    
    value - the prompt text fill
  - getPromptTextFill
```
protected final Paint getPromptTextFill()
```
    Gets the value of the property promptTextFill.
  - promptTextFillProperty
```
protected final <any> promptTextFillProperty()
```
    See Also:
    
    getPromptTextFill(), setPromptTextFill(Paint)
  - setHighlightFill
```
protected final void setHighlightFill(Paint value)
```
    The fill Paint used for the background of selected text.
    
    Parameters:
    
    value - the highlight fill
  - getHighlightFill
```
protected final Paint getHighlightFill()
```
    Gets the value of the property highlightFill.
  - highlightFillProperty
```
protected final <any> highlightFillProperty()
```
    The fill to use for the text when highlighted.
    
    See Also:
    
    getHighlightFill(), setHighlightFill(Paint)
  - setHighlightTextFill
```
protected final void setHighlightTextFill(Paint value)
```
    The fill Paint used for the foreground of selected text.
    
    Parameters:
    
    value - the highlight text fill
  - getHighlightTextFill
```
protected final Paint getHighlightTextFill()
```
    Gets the value of the property highlightTextFill.
  - highlightTextFillProperty
```
protected final <any> highlightTextFillProperty()
```
    See Also:
    
    getHighlightTextFill(), setHighlightTextFill(Paint)
  - setDisplayCaret
```
private final void setDisplayCaret(boolean value)
```
  - isDisplayCaret
```
private final boolean isDisplayCaret()
```
  - displayCaretProperty
```
private final BooleanProperty displayCaretProperty()
```
  - forwardBiasProperty
```
protected final BooleanProperty forwardBiasProperty()
```
    Caret bias in the content. true means a bias towards forward character (true=leading/false=trailing)
    
    See Also:
    
    isForwardBias(), setForwardBias(boolean)
  - setForwardBias
```
public final void setForwardBias(boolean isLeading)
```
    Sets the value of the property forwardBias.
  - isForwardBias
```
protected final boolean isForwardBias()
```
    Gets the value of the property forwardBias.
  - getUnderlineShape
```
protected abstract PathElement[] getUnderlineShape(int start,
                                                   int end)
```
    Parameters:
    
    start - the start
    
    end - the end
    
    Returns:
    
    the path elements describing the shape of the underline for the given range.
  - getRangeShape
```
protected abstract PathElement[] getRangeShape(int start,
                                               int end)
```
    Parameters:
    
    start - the start
    
    end - the end
    
    Returns:
    
    the path elements describing the bounding rectangles for the given range of text.
  - addHighlight
```
protected abstract void addHighlight(java.util.List<? extends Node> nodes,
                                     int start)
```
    Adds highlight for composed text from Input Method.
    
    Parameters:
    
    nodes - the list of nodes
    
    start - the start
  - removeHighlight
```
protected abstract void removeHighlight(java.util.List<? extends Node> nodes)
```
    Removes highlight for composed text from Input Method.
    
    Parameters:
    
    nodes - the list of nodes
  - moveCaret
```
public abstract void moveCaret(TextInputControlSkin.TextUnit unit,
                               TextInputControlSkin.Direction dir,
                               boolean select)
```
    Moves the caret by one of the given text unit, in the given direction. Note that only certain combinations are valid, depending on the implementing subclass.
    
    Parameters:
    
    unit - the unit of text to move by.
    
    dir - the direction of movement.
    
    select - whether to extends the selection to the new posititon.
  - getMenuPosition
```
public Point2D getMenuPosition()
```
    Returns the position to be used for a context menu, based on the location of the caret handle or selection handles. This is supported only on touch displays and does not use the location of the mouse.
    
    Returns:
    
    the position to be used for this context menu
  - maskText
```
protected java.lang.String maskText(java.lang.String txt)
```
    This method may be overridden by subclasses to replace the displayed characters without affecting the actual text content. This is used to display bullet characters in PasswordField.
    
    Parameters:
    
    txt - the content that may need to be masked.
    
    Returns:
    
    the replacement string. This may just be the input string, or may be a string of replacement characters with the same length as the input string.
  - getInsertionPoint
```
protected int getInsertionPoint(double x,
                                double y)
```
    Returns the insertion point for a given location.
    
    Parameters:
    
    x - the x location
    
    y - the y location
    
    Returns:
    
    the insertion point for a given location
  - getCharacterBounds
```
public Rectangle2D getCharacterBounds(int index)
```
    Returns the bounds of the character at a given index.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the bounds of the character at a given index
  - scrollCharacterToVisible
```
protected void scrollCharacterToVisible(int index)
```
    Ensures that the character at a given index is visible.
    
    Parameters:
    
    index - the index
  - invalidateMetrics
```
protected void invalidateMetrics()
```
    Invalidates cached min and pref sizes for the TextInputControl.
  - updateTextFill
```
protected void updateTextFill()
```
    Called when textFill property changes.
  - updateHighlightFill
```
protected void updateHighlightFill()
```
    Called when highlightFill property changes.
  - updateHighlightTextFill
```
protected void updateHighlightTextFill()
```
    Called when highlightTextFill property changes.
  - handleInputMethodEvent
```
protected void handleInputMethodEvent(InputMethodEvent event)
```
  - setCaretAnimating
```
public void setCaretAnimating(boolean value)
```
    Starts or stops caret blinking. The behavior classes use this to temporarily pause blinking while user is typing or otherwise moving the caret.
    
    Parameters:
    
    value - whether caret should be blinking.
  - getBehavior
```
TextInputControlBehavior getBehavior()
```
    Private implementation
  - caretVisibleProperty
```
ObservableBooleanValue caretVisibleProperty()
```
  - isRTL
```
boolean isRTL()
```
  - createInputMethodAttributes
```
private void createInputMethodAttributes(InputMethodHighlight highlight,
                                         int start,
                                         int end)
```
  - getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
    Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    
    Returns:
    
    the CssMetaData associated with this class, which may include the CssMetaData of its superclasses
  - getCssMetaData
```
public java.util.List<<any>> getCssMetaData()
```
  - executeAccessibleAction
```
protected void executeAccessibleAction(AccessibleAction action,
                                       java.lang.Object... parameters)
```

Class TextInputControlSkin<T extends TextInputControl>

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

textFill

promptTextFill

highlightFill

highlightTextFill

forwardBias

caretVisible

Field Detail

preload

SHOW_HANDLES

IS_FXVK_SUPPORTED

fontMetrics

caretVisible

caretBlinking

caretPath

caretHandle

selectionHandle1

selectionHandle2

imstart

imlength

imattrs

blink

textFill

promptTextFill

highlightFill

highlightTextFill

displayCaret

forwardBias

Constructor Detail

TextInputControlSkin

Method Detail

setBlink

isBlink

blinkProperty

setTextFill

getTextFill

textFillProperty

setPromptTextFill

getPromptTextFill

promptTextFillProperty

setHighlightFill

getHighlightFill

highlightFillProperty

setHighlightTextFill

getHighlightTextFill

highlightTextFillProperty

setDisplayCaret

isDisplayCaret

displayCaretProperty

forwardBiasProperty

setForwardBias

isForwardBias

getUnderlineShape

getRangeShape

addHighlight

removeHighlight

moveCaret

getMenuPosition

maskText

getInsertionPoint

getCharacterBounds

scrollCharacterToVisible

invalidateMetrics

updateTextFill

updateHighlightFill

updateHighlightTextFill

handleInputMethodEvent

setCaretAnimating

getBehavior

caretVisibleProperty

isRTL

createInputMethodAttributes

getClassCssMetaData