Modifier and Type	Class and Description
private static class	TextInputControlSkin.CaretBlinking
public static enum	TextInputControlSkin.Direction Direction names for caret movement.
private static class	TextInputControlSkin.StyleableProperties
public static enum	TextInputControlSkin.TextUnit Unit names for caret movement.

Modifier and Type	Field and Description
private BooleanProperty	blink
private TextInputControlSkin.CaretBlinking	caretBlinking
pack-priv StackPane	caretHandle
pack-priv final Path	caretPath A path, provided by the textNode, which represents the caret.
private ObservableBooleanValue	caretVisible
private final BooleanProperty	displayCaret
pack-priv final ObservableObjectValue<FontMetrics>	fontMetrics
private BooleanProperty	forwardBias Caret bias in the content.
private final ObjectProperty<Paint>	highlightFill The fill to use for the text when highlighted.
private final ObjectProperty<Paint>	highlightTextFill The fill `Paint` used for the foreground of selected text.
private List<Shape>	imattrs
private int	imlength
private int	imstart
private InputMethodRequests	inputMethodRequests
private final EventHandler<InputMethodEvent>	inputMethodTextChangedHandler
private static final boolean	IS_FXVK_SUPPORTED
private static final boolean	preload
private final ObjectProperty<Paint>	promptTextFill The fill `Paint` used for the foreground of prompt text.
pack-priv StackPane	selectionHandle1
pack-priv StackPane	selectionHandle2
pack-priv static final boolean	SHOW_HANDLES Specifies whether we ought to show handles.
private final ObjectProperty<Paint>	textFill The fill to use for the text under normal conditions

Access	Constructor and Description
public	TextInputControlSkin(final T The control that this skin should be installed onto. 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

Modifier and Type	Method and Description
protected abstract void	addHighlight(List<? extends Node> the list of nodes nodes, int the start start) Adds highlight for composed text from Input Method.
private final BooleanProperty	blinkProperty()
pack-priv ObservableBooleanValue	caretVisibleProperty()
private void	createInputMethodAttributes(InputMethodHighlight highlight, int start, int end)
private final BooleanProperty	displayCaretProperty()
public void	dispose() Overrides javafx.scene.control.SkinBase.dispose. Implements javafx.scene.control.Skin.dispose. Called when a previously installed skin is about to be removed from its associated control.
protected void	executeAccessibleAction(AccessibleAction the action to execute action, Object... optional list of parameters parameters) Overrides javafx.scene.control.SkinBase.executeAccessibleAction. This method is called by the assistive technology to request the action indicated by the argument should be executed.
protected final BooleanProperty	forwardBiasProperty()
pack-priv TextInputControlBehavior<T extends TextInputControl>	getBehavior()
public Rectangle2D	Returns: the bounds of the character at a given index getCharacterBounds(int the index index) Returns the bounds of the character at a given index.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the CssMetaData associated with this class, which may include the CssMetaData of its superclasses getClassCssMetaData() Hides javafx.scene.control.SkinBase.getClassCssMetaData. Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.control.SkinBase.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
protected final Paint	getHighlightFill()
protected final Paint	getHighlightTextFill()
protected int	Returns: the insertion point for a given location getInsertionPoint(double the x location x, double the y location y) Returns the insertion point for a given location.
public Point2D	Returns: the position to be used for this context menu getMenuPosition() Returns the position to be used for a context menu, based on the location of the caret handle or selection handles.
protected final Paint	getPromptTextFill()
protected abstract PathElement[]	Returns: the path elements describing the bounding rectangles for the given range of text getRangeShape(int the start start, int the end end) Gets the path elements describing the bounding rectangles for the given range of text.
protected final Paint	getTextFill()
protected abstract PathElement[]	Returns: the path elements describing the shape of the underline for the given range getUnderlineShape(int the start start, int the end end) Gets the path elements describing the shape of the underline for the given range.
protected void	handleInputMethodEvent(InputMethodEvent the `InputMethodEvent` to be handled event) Handles an input method event.
protected final ObjectProperty<Paint>	highlightFillProperty()
protected final ObjectProperty<Paint>	highlightTextFillProperty()
private static boolean	initPreload()
public void	install() Overrides default javafx.scene.control.Skin.install. Called once when `Skin` is set.
protected void	invalidateMetrics() Invalidates cached min and pref sizes for the TextInputControl.
private final boolean	isBlink()
pack-priv boolean	isCaretBlinking()
private final boolean	isDisplayCaret()
protected final boolean	isForwardBias()
pack-priv boolean	isRTL()
protected String	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. maskText(String the content that may need to be masked. txt) This method may be overridden by subclasses to replace the displayed characters without affecting the actual text content.
public abstract void	moveCaret(TextInputControlSkin.TextUnit the unit of text to move by. unit, TextInputControlSkin.Direction the direction of movement. dir, boolean whether to extends the selection to the new position. select) Moves the caret by one of the given text unit, in the given direction.
protected final ObjectProperty<Paint>	promptTextFillProperty()
protected abstract void	removeHighlight(List<? extends Node> the list of nodes nodes) Removes highlight for composed text from Input Method.
protected void	scrollCharacterToVisible(int the index index) Ensures that the character at a given index is visible.
private final void	setBlink(boolean value)
public void	setCaretAnimating(boolean whether caret should be blinking. value) Starts or stops caret blinking.
private final void	setDisplayCaret(boolean value)
public final void	setForwardBias(boolean isLeading)
protected final void	setHighlightFill(Paint the highlight fill value) The fill `Paint` used for the background of selected text.
protected final void	setHighlightTextFill(Paint the highlight text fill value) The fill `Paint` used for the foreground of selected text.
protected final void	setPromptTextFill(Paint the prompt text fill value) The fill `Paint` used for the foreground prompt text color.
protected final void	setTextFill(Paint the text fill value) The fill `Paint` used for the foreground text color.
protected final ObjectProperty<Paint>	textFillProperty()
protected void	updateHighlightFill() Called when highlightFill property changes.
protected void	updateHighlightTextFill() Called when highlightTextFill property changes.
protected void	updateTextFill() Called when textFill property changes.

Field Detail

blink	back to summary
private BooleanProperty blink

caretBlinking	back to summary
private TextInputControlSkin.CaretBlinking caretBlinking

caretHandle	back to summary
pack-priv StackPane caretHandle

caretPath	back to summary
pack-priv 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.

caretVisible	back to summary
private ObservableBooleanValue caretVisible

displayCaret	back to summary
private final BooleanProperty displayCaret

fontMetrics	back to summary
pack-priv final ObservableObjectValue<FontMetrics> fontMetrics

forwardBias	back to summary
private BooleanProperty forwardBias Caret bias in the content. true means a bias towards forward character (true=leading/false=trailing)

highlightFill	back to summary
private final ObjectProperty<Paint> highlightFill The fill to use for the text when highlighted.

highlightTextFill	back to summary
private final ObjectProperty<Paint> highlightTextFill The fill `Paint` used for the foreground of selected text.

imattrs	back to summary
private List<Shape> imattrs

imlength	back to summary
private int imlength

imstart	back to summary
private int imstart

inputMethodRequests	back to summary
private InputMethodRequests inputMethodRequests

inputMethodTextChangedHandler	back to summary
private final EventHandler<InputMethodEvent> inputMethodTextChangedHandler

IS_FXVK_SUPPORTED	back to summary
private static final boolean IS_FXVK_SUPPORTED

preload	back to summary
private static final boolean preload

promptTextFill	back to summary
private final ObjectProperty<Paint> promptTextFill The fill `Paint` used for the foreground of prompt text.

selectionHandle1	back to summary
pack-priv StackPane selectionHandle1

selectionHandle2	back to summary
pack-priv StackPane selectionHandle2

SHOW_HANDLES	back to summary
pack-priv static final boolean SHOW_HANDLES Specifies whether we ought to show handles. We should do it on touch platforms

textFill	back to summary
private final ObjectProperty<Paint> textFill The fill to use for the text under normal conditions

Constructor Detail

TextInputControlSkin	back to summary
public TextInputControlSkin(final 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:T The control that this skin should be installed onto.

TextInputControlSkin

back to summary

public TextInputControlSkin(final 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:T: The control that this skin should be installed onto.

Method Detail

addHighlight	back to summary
protected abstract void addHighlight(List<? extends Node> nodes, int start) Adds highlight for composed text from Input Method. Parameters nodes:List<? extends Node> the list of nodes start:int the start

addHighlight

back to summary

protected abstract void addHighlight(List<? extends Node> nodes, int start)

Adds highlight for composed text from Input Method.

Parameters

nodes:List<? extends Node>: the list of nodes
start:int: the start

blinkProperty	back to summary
private final BooleanProperty blinkProperty()

caretVisibleProperty	back to summary
pack-priv ObservableBooleanValue caretVisibleProperty()

createInputMethodAttributes	back to summary
private void createInputMethodAttributes(InputMethodHighlight highlight, int start, int end)

displayCaretProperty	back to summary
private final BooleanProperty displayCaretProperty()

dispose back to summary

dispose	back to summary
public void dispose() Overrides javafx.scene.control.SkinBase.dispose. Implements javafx.scene.control.Skin.dispose. Doc from javafx.scene.control.SkinBase.dispose. Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, `getSkinnable()` and `getNode()` should return `null`. Calling `dispose()` more than once has no effect. Annotations @Override

public void dispose()

Overrides javafx.scene.control.SkinBase.dispose.

Implements javafx.scene.control.Skin.dispose.

Doc from javafx.scene.control.SkinBase.dispose.

Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, getSkinnable() and getNode() should return null.

Calling dispose() more than once has no effect.

Annotations

@Override

executeAccessibleAction	back to summary
protected void executeAccessibleAction(AccessibleAction action, Object... parameters) Overrides javafx.scene.control.SkinBase.executeAccessibleAction. Doc from javafx.scene.control.SkinBase.executeAccessibleAction. This method is called by the assistive technology to request the action indicated by the argument should be executed. This method is commonly overridden by subclasses to implement action that are required for a specific role. If a particular action is not handled, the superclass implementation must be called. Parameters action:AccessibleAction the action to execute parameters:Object[] optional list of parameters Annotations @Override

executeAccessibleAction

back to summary

protected void executeAccessibleAction(AccessibleAction action, Object... parameters)

Overrides javafx.scene.control.SkinBase.executeAccessibleAction.

Doc from javafx.scene.control.SkinBase.executeAccessibleAction.

This method is called by the assistive technology to request the action indicated by the argument should be executed.

This method is commonly overridden by subclasses to implement action that are required for a specific role.
If a particular action is not handled, the superclass implementation must be called.

Parameters

action:AccessibleAction: the action to execute
parameters:Object[]: optional list of parameters

Annotations

@Override

forwardBiasProperty	back to summary
protected final BooleanProperty forwardBiasProperty()

getBehavior	back to summary
pack-priv TextInputControlBehavior<T extends TextInputControl> getBehavior()

getCharacterBounds	back to summary
public Rectangle2D getCharacterBounds(int index) Returns the bounds of the character at a given index. Parameters index:int the index Returns:Rectangle2D the bounds of the character at a given index

getCharacterBounds

back to summary

public Rectangle2D getCharacterBounds(int index)

Returns the bounds of the character at a given index.

Parameters

index:int: the index

Returns:Rectangle2D

the bounds of the character at a given index

getClassCssMetaData

back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.SkinBase.getClassCssMetaData.

Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData associated with this class, which may include the CssMetaData of its superclasses

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.control.SkinBase.getCssMetaData.

Doc from javafx.scene.control.SkinBase.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Returns:List<CssMetaData<? extends Styleable, ?>>

The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.

Annotations

@Override

getHighlightFill	back to summary
protected final Paint getHighlightFill()

getHighlightTextFill	back to summary
protected final Paint getHighlightTextFill()

getInsertionPoint	back to summary
protected int getInsertionPoint(double x, double y) Returns the insertion point for a given location. Parameters x:double the x location y:double the y location Returns:int the insertion point for a given location

getInsertionPoint

back to summary

protected int getInsertionPoint(double x, double y)

Returns the insertion point for a given location.

Parameters

x:double: the x location
y:double: the y location

Returns:int

the insertion point for a given location

getMenuPosition	back to summary
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:Point2D the position to be used for this context menu

getMenuPosition

back to summary

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:Point2D: the position to be used for this context menu

getPromptTextFill	back to summary
protected final Paint getPromptTextFill()

getRangeShape	back to summary
protected abstract PathElement[] getRangeShape(int start, int end) Gets the path elements describing the bounding rectangles for the given range of text. Parameters start:int the start end:int the end Returns:PathElement[] the path elements describing the bounding rectangles for the given range of text

getRangeShape

back to summary

protected abstract PathElement[] getRangeShape(int start, int end)

Gets the path elements describing the bounding rectangles for the given range of text.

Parameters

start:int: the start
end:int: the end

Returns:PathElement[]

the path elements describing the bounding rectangles for the given range of text

getTextFill	back to summary
protected final Paint getTextFill()

getUnderlineShape	back to summary
protected abstract PathElement[] getUnderlineShape(int start, int end) Gets the path elements describing the shape of the underline for the given range. Parameters start:int the start end:int the end Returns:PathElement[] the path elements describing the shape of the underline for the given range

getUnderlineShape

back to summary

protected abstract PathElement[] getUnderlineShape(int start, int end)

Gets the path elements describing the shape of the underline for the given range.

Parameters

start:int: the start
end:int: the end

Returns:PathElement[]

the path elements describing the shape of the underline for the given range

handleInputMethodEvent back to summary

handleInputMethodEvent	back to summary
protected void handleInputMethodEvent(InputMethodEvent event) Handles an input method event. Parameters event:InputMethodEvent the `InputMethodEvent` to be handled

protected void handleInputMethodEvent(InputMethodEvent event)

Handles an input method event.

Parameters

event:InputMethodEvent: the InputMethodEvent to be handled

highlightFillProperty	back to summary
protected final ObjectProperty<Paint> highlightFillProperty()

highlightTextFillProperty	back to summary
protected final ObjectProperty<Paint> highlightTextFillProperty()

initPreload	back to summary
private static boolean initPreload()

install back to summary

public void install()

Overrides default javafx.scene.control.Skin.install.

Doc from javafx.scene.control.Skin.install.

Called once when Skin is set. This method is called after the previous skin, if any, has been uninstalled via its dispose() method. The skin can now safely make changes to its associated control, like registering listeners, adding child nodes, and modifying properties and event handlers.

Application code must not call this method.

The default implementation of this method does nothing.

Annotations

@Override

invalidateMetrics	back to summary
protected void invalidateMetrics() Invalidates cached min and pref sizes for the TextInputControl.

isBlink	back to summary
private final boolean isBlink()

isCaretBlinking	back to summary
pack-priv boolean isCaretBlinking()

isDisplayCaret	back to summary
private final boolean isDisplayCaret()

isForwardBias	back to summary
protected final boolean isForwardBias()

isRTL	back to summary
pack-priv boolean isRTL()

maskText

back to summary

protected String maskText(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:String: the content that may need to be masked.

Returns:String

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.

moveCaret

back to summary

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:TextInputControlSkin.TextUnit: the unit of text to move by.
dir:TextInputControlSkin.Direction: the direction of movement.
select:boolean: whether to extends the selection to the new position.

promptTextFillProperty	back to summary
protected final ObjectProperty<Paint> promptTextFillProperty()

removeHighlight

back to summary

protected abstract void removeHighlight(List<? extends Node> nodes)

Removes highlight for composed text from Input Method.

Parameters

nodes:List<? extends Node>: the list of nodes

scrollCharacterToVisible

back to summary

protected void scrollCharacterToVisible(int index)

Ensures that the character at a given index is visible.

Parameters

index:int: the index

setBlink	back to summary
private final void setBlink(boolean value)

setCaretAnimating

back to summary

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:boolean: whether caret should be blinking.

setDisplayCaret	back to summary
private final void setDisplayCaret(boolean value)

setForwardBias	back to summary
public final void setForwardBias(boolean isLeading)

setHighlightFill back to summary

protected final void setHighlightFill(Paint value)

The fill Paint used for the background of selected text.

Parameters

value:Paint: the highlight fill

setHighlightTextFill back to summary

protected final void setHighlightTextFill(Paint value)

The fill Paint used for the foreground of selected text.

Parameters

value:Paint: the highlight text fill

setPromptTextFill back to summary

protected final void setPromptTextFill(Paint value)

The fill Paint used for the foreground prompt text color.

Parameters

value:Paint: the prompt text fill

setTextFill back to summary

protected final void setTextFill(Paint value)

The fill Paint used for the foreground text color.

Parameters

value:Paint: the text fill

textFillProperty	back to summary
protected final ObjectProperty<Paint> textFillProperty()

updateHighlightFill	back to summary
protected void updateHighlightFill() Called when highlightFill property changes.

updateHighlightTextFill	back to summary
protected void updateHighlightTextFill() Called when highlightTextFill property changes.

updateTextFill	back to summary
protected void updateTextFill() Called when textFill property changes.

javafx.scene.control.skin back to summary

private final Class TextInputControlSkin.CaretBlinking

Class Inheritance

extends Object

java.lang.Object
javafx.scene.control.skin.TextInputControlSkin.CaretBlinking

Field Summary

Modifier and Type	Field and Description
private final WeakReference<BooleanProperty>	blinkPropertyRef
private final Timeline	caretTimeline

Constructor Summary

Access	Constructor and Description
public	CaretBlinking(final BooleanProperty blinkProperty)

Method Summary

Modifier and Type	Method and Description
private void	setBlink(final boolean value)
public void	start()
public void	stop()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

blinkPropertyRef	back to summary
private final WeakReference<BooleanProperty> blinkPropertyRef

caretTimeline	back to summary
private final Timeline caretTimeline

Constructor Detail

CaretBlinking	back to summary
public CaretBlinking(final BooleanProperty blinkProperty)

Method Detail

setBlink	back to summary
private void setBlink(final boolean value)

start	back to summary
public void start()

stop	back to summary
public void stop()

javafx.scene.control.skin back to summary

public final Enum TextInputControlSkin.Direction

Class Inheritance

extends Enum<TextInputControlSkin.Direction>

java.lang.Object
java.lang.Enum
javafx.scene.control.skin.TextInputControlSkin.Direction

Direction names for caret movement.

See Also: moveCaret(TextUnit, Direction, boolean)

Field Summary

Modifier and Type	Field and Description
public static final TextInputControlSkin.Direction	BEGINNING Beginning
public static final TextInputControlSkin.Direction	DOWN Down Direction
public static final TextInputControlSkin.Direction	END End
public static final TextInputControlSkin.Direction	LEFT Left Direction
public static final TextInputControlSkin.Direction	RIGHT Right Direction
public static final TextInputControlSkin.Direction	UP Up Direction

Constructor Summary

Access	Constructor and Description
private	Direction()

Method Summary

Modifier and Type	Method and Description
public static TextInputControlSkin.Direction	valueOf(String name)
public static TextInputControlSkin.Direction[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BEGINNING	back to summary
public static final TextInputControlSkin.Direction BEGINNING Beginning

DOWN	back to summary
public static final TextInputControlSkin.Direction DOWN Down Direction

END	back to summary
public static final TextInputControlSkin.Direction END End

LEFT	back to summary
public static final TextInputControlSkin.Direction LEFT Left Direction

RIGHT	back to summary
public static final TextInputControlSkin.Direction RIGHT Right Direction

UP	back to summary
public static final TextInputControlSkin.Direction UP Up Direction

Constructor Detail

Direction	back to summary
private Direction()

Method Detail

valueOf	back to summary
public static TextInputControlSkin.Direction valueOf(String name)

values	back to summary
public static TextInputControlSkin.Direction[] values()

Modifier and Type	Field and Description
private static final CssMetaData<TextInputControl, Boolean>	DISPLAY_CARET
private static final CssMetaData<TextInputControl, Paint>	HIGHLIGHT_FILL
private static final CssMetaData<TextInputControl, Paint>	HIGHLIGHT_TEXT_FILL
private static final CssMetaData<TextInputControl, Paint>	PROMPT_TEXT_FILL
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES
private static final CssMetaData<TextInputControl, Paint>	TEXT_FILL

Modifier and Type	Field and Description
public static final TextInputControlSkin.TextUnit	CHARACTER Character unit
public static final TextInputControlSkin.TextUnit	LINE Line unit
public static final TextInputControlSkin.TextUnit	PAGE Page unit
public static final TextInputControlSkin.TextUnit	PARAGRAPH Paragraph unit
public static final TextInputControlSkin.TextUnit	WORD Word unit

public abstract Class TextInputControlSkin<T extends TextInputControl>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class TextInputControlSkin.CaretBlinking

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum TextInputControlSkin.Direction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TextInputControlSkin.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Enum TextInputControlSkin.TextUnit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public static TextInputControlSkin.TextUnit	valueOf(String name)
public static TextInputControlSkin.TextUnit[]	values()