javafx.scene.control.skin

Class TextFieldSkin

java.lang.Object

<any>

javafx.scene.control.skin.TextInputControlSkin<TextField>

javafx.scene.control.skin.TextFieldSkin

public class TextFieldSkin
extends TextInputControlSkin<TextField>

Default skin implementation for the TextField control.

Since:

9

See Also:

TextField

Property Summary

Properties inherited from class javafx.scene.control.skin.TextInputControlSkin

caretVisibleProperty, forwardBiasProperty, highlightFillProperty, highlightTextFillProperty, promptTextFillProperty, textFillProperty

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.skin.TextInputControlSkin

TextInputControlSkin.Direction, TextInputControlSkin.TextUnit

Field Summary

Fields

Modifier and Type	Field and Description
private TextFieldBehavior	behavior Private fields
(package private) static char	BULLET
private double	caretWidth
private Path	characterBoundingPath
private Rectangle	clip The clip, applied to the textGroup.
private Group	handleGroup
private double	pressX
private double	pressY
private Text	promptNode The node used for showing the prompt text.
private Path	selectionHighlightPath A path, provided by the textNode, which represents the area which is selected.
private Pane	textGroup This group contains the text, caret, and selection rectangle.
private Text	textNode The node actually displaying the text.
private ObservableDoubleValue	textRight Right edge of the text region sans padding
private DoubleProperty	textTranslateX
private ObservableBooleanValue	usePromptText

Fields inherited from class javafx.scene.control.skin.TextInputControlSkin

caretHandle, caretPath, fontMetrics, preload, selectionHandle1, selectionHandle2, SHOW_HANDLES

Constructor Summary

Constructors

Constructor and Description
TextFieldSkin(TextField control) Creates a new TextFieldSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Method Summary

Modifier and Type	Method and Description
protected void	addHighlight(java.util.List<? extends Node> nodes, int start) Adds highlight for composed text from Input Method.
double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
private void	createPromptNode()
void	deleteChar(boolean previous) Deletes the character that follows or precedes the current caret position from the text if there is no selection, or deletes the selection if there is one.
void	dispose()
(package private) TextInputControlBehavior	getBehavior() Private implementation
Rectangle2D	getCharacterBounds(int index) Returns the bounds of the character at a given index.
private HPos	getHAlignment()
HitInfo	getIndex(double x, double y) Performs a hit test, mapping point to index in the content.
Point2D	getMenuPosition() Returns the position to be used for a context menu, based on the location of the caret handle or selection handles.
protected PathElement[]	getRangeShape(int start, int end)
protected PathElement[]	getUnderlineShape(int start, int end)
protected void	layoutChildren(double x, double y, double w, double h)
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.
void	moveCaret(TextInputControlSkin.TextUnit unit, TextInputControlSkin.Direction dir, boolean select) Moves the caret by one of the given text unit, in the given direction.
private void	nextCharacterVisually(boolean moveRight)
void	positionCaret(HitInfo hit, boolean select) Moves the caret to the specified position.
private void	positionCaret(int pos, boolean leading, boolean select)
protected java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
protected void	removeHighlight(java.util.List<? extends Node> nodes) Removes highlight for composed text from Input Method.
void	replaceText(int start, int end, java.lang.String txt) Replaces a range of characters with the given text.
private void	scrollAfterDelete(double textMaxXOld, double caretMaxXOld)
private void	updateCaretOff()
private void	updateSelection()
private void	updateTextNodeCaretPos(int pos)
private void	updateTextPos() Updates the textTranslateX value for the Text node position.

Methods inherited from class javafx.scene.control.skin.TextInputControlSkin

caretVisibleProperty, executeAccessibleAction, forwardBiasProperty, getClassCssMetaData, getCssMetaData, getHighlightFill, getHighlightTextFill, getInsertionPoint, getPromptTextFill, getTextFill, handleInputMethodEvent, highlightFillProperty, highlightTextFillProperty, invalidateMetrics, isForwardBias, isRTL, promptTextFillProperty, scrollCharacterToVisible, setCaretAnimating, setForwardBias, setHighlightFill, setHighlightTextFill, setPromptTextFill, setTextFill, textFillProperty, updateHighlightFill, updateHighlightTextFill, updateTextFill

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

behavior

private final TextFieldBehavior behavior

Private fields

textGroup

private Pane textGroup

This group contains the text, caret, and selection rectangle. It is clipped. The textNode, selectionHighlightPath, and caret are each translated individually when horizontal translation is needed to keep the caretPosition visible.

handleGroup

private Group handleGroup

clip

private Rectangle clip

The clip, applied to the textGroup. This makes sure that any text / selection wandering off the text box is clipped

textNode

private Text textNode

The node actually displaying the text. Note that it has the ability to render both the normal fill as well as the highlight fill, to perform hit testing, fetching of the selection highlight, and other such duties.

promptNode

private Text promptNode

The node used for showing the prompt text.

selectionHighlightPath

private Path selectionHighlightPath

A path, provided by the textNode, which represents the area which is selected. The path elements which make up the selection must be updated whenever the selection changes. We don't need to keep track of text changes because those will force the selection to be updated.

characterBoundingPath

private Path characterBoundingPath

usePromptText

private ObservableBooleanValue usePromptText

textTranslateX

private DoubleProperty textTranslateX

caretWidth

private double caretWidth

textRight

private ObservableDoubleValue textRight

Right edge of the text region sans padding

pressX

private double pressX

pressY

private double pressY

BULLET

static final char BULLET

See Also:

Constant Field Values

Constructor Detail

TextFieldSkin

public TextFieldSkin(TextField control)

Creates a new TextFieldSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Parameters:

control - The control that this skin should be installed onto.

Method Detail

dispose

public void dispose()

computePrefWidth

protected double computePrefWidth(double height,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

computeMinHeight

protected double computeMinHeight(double width,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

computePrefHeight

protected double computePrefHeight(double width,
                                   double topInset,
                                   double rightInset,
                                   double bottomInset,
                                   double leftInset)

computeMaxHeight

protected double computeMaxHeight(double width,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

computeBaselineOffset

public double computeBaselineOffset(double topInset,
                                    double rightInset,
                                    double bottomInset,
                                    double leftInset)

replaceText

public void replaceText(int start,
                        int end,
                        java.lang.String txt)

Replaces a range of characters with the given text. Call this implementation from behavior classes instead of the one provided on TextInputControl to ensure that the text scrolls as needed.

Parameters:

start - The starting index in the range, inclusive. This must be >= 0 and < the end.

end - The ending index in the range, exclusive. This is one-past the last character to delete (consistent with the String manipulation methods). This must be > the start, and <= the length of the text.

txt - The text that is to replace the range. This must not be null.

See Also:

TextField#replaceText(int, int, String)

deleteChar

public void deleteChar(boolean previous)

Deletes the character that follows or precedes the current caret position from the text if there is no selection, or deletes the selection if there is one. Call this implementation from behavior classes instead of the one provided on TextInputControl to ensure that the text scrolls as needed.

Parameters:

previous - whether to delete the preceding character.

getIndex

public HitInfo getIndex(double x,
                        double y)

Performs a hit test, mapping point to index in the content.

Parameters:

x - the x coordinate of the point.

y - the y coordinate of the point.

Returns:

a HitInfo object describing the index and forward bias.

positionCaret

public void positionCaret(HitInfo hit,
                          boolean select)

Moves the caret to the specified position.

Parameters:

hit - the new position and forward bias of the caret.

select - whether to extend selection to the new position.

positionCaret

private void positionCaret(int pos,
                           boolean leading,
                           boolean select)

getCharacterBounds

public Rectangle2D getCharacterBounds(int index)

Returns the bounds of the character at a given index.

Overrides:

getCharacterBounds in class TextInputControlSkin<TextField>

Parameters:

index - the index

Returns:

the bounds of the character at a given index

getUnderlineShape

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

Specified by:

getUnderlineShape in class TextInputControlSkin<TextField>

Parameters:

start - the start

end - the end

Returns:

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

getRangeShape

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

Specified by:

getRangeShape in class TextInputControlSkin<TextField>

Parameters:

start - the start

end - the end

Returns:

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

addHighlight

protected void addHighlight(java.util.List<? extends Node> nodes,
                            int start)

Adds highlight for composed text from Input Method.

Specified by:

addHighlight in class TextInputControlSkin<TextField>

Parameters:

nodes - the list of nodes

start - the start

removeHighlight

protected void removeHighlight(java.util.List<? extends Node> nodes)

Removes highlight for composed text from Input Method.

Specified by:

removeHighlight in class TextInputControlSkin<TextField>

Parameters:

nodes - the list of nodes

moveCaret

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

Specified by:

moveCaret in class TextInputControlSkin<TextField>

Parameters:

unit - the unit of text to move by.

dir - the direction of movement.

select - whether to extends the selection to the new posititon.

nextCharacterVisually

private void nextCharacterVisually(boolean moveRight)

layoutChildren

protected void layoutChildren(double x,
                              double y,
                              double w,
                              double h)

getHAlignment

private HPos getHAlignment()

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.

Overrides:

getMenuPosition in class TextInputControlSkin<TextField>

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.

Overrides:

maskText in class TextInputControlSkin<TextField>

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.

queryAccessibleAttribute

protected java.lang.Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                                    java.lang.Object... parameters)

getBehavior

TextInputControlBehavior getBehavior()

Private implementation

Overrides:

getBehavior in class TextInputControlSkin<TextField>

updateTextNodeCaretPos

private void updateTextNodeCaretPos(int pos)

createPromptNode

private void createPromptNode()

updateSelection

private void updateSelection()

updateTextPos

private void updateTextPos()

Updates the textTranslateX value for the Text node position. This is done for general layout, but care is taken to avoid resetting the position when there's a need to scroll the text due to caret movement, or when editing text that overflows on either side.

updateCaretOff

private void updateCaretOff()

scrollAfterDelete

private void scrollAfterDelete(double textMaxXOld,
                               double caretMaxXOld)