com.sun.javafx.scene.control.skin

Class TextFieldSkin

java.lang.Object

javafx.scene.control.SkinBase<C>

com.sun.javafx.scene.control.skin.BehaviorSkinBase<T,B>

com.sun.javafx.scene.control.skin.TextInputControlSkin<TextField,TextFieldBehavior>

com.sun.javafx.scene.control.skin.TextFieldSkin

All Implemented Interfaces:

Skin<TextField>

public class TextFieldSkin
extends TextInputControlSkin<TextField,TextFieldBehavior>

Text field skin.

Field Summary

Fields

Modifier and Type	Field and Description
static char	BULLET
protected ObservableDoubleValue	textRight Right edge of the text region sans padding

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

caretHandle, caretPath, caretVisible, displayCaret, fontMetrics, highlightFill, highlightTextFill, promptTextFill, selectionHandle1, selectionHandle2, SHOW_HANDLES, textFill

Fields inherited from class com.sun.javafx.scene.control.skin.BehaviorSkinBase

IS_TOUCH_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
TextFieldSkin(TextField textField) Create a new TextFieldSkin.
TextFieldSkin(TextField textField, TextFieldBehavior behavior)

Method Summary

Modifier and Type	Method and Description
protected void	addHighlight(List<? extends Node> nodes, int start)
double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset) Calculates the baseline offset based on the first managed child.
protected double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) Computes the maximum allowable height of the Skin, based on the provided width.
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) Calculates the preferred height of this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) Calculates the preferred width of this SkinBase.
void	deleteChar(boolean previous) Use this implementation instead of the one provided on TextInputControl Simply calls into TextInputControl.deletePrevious/NextChar and responds appropriately based on the return value.
Rectangle2D	getCharacterBounds(int index) Returns the bounds of the character at a given index.
protected HPos	getHAlignment()
HitInfo	getIndex(double x, double y)
Point2D	getMenuPosition()
protected PathElement[]	getRangeShape(int start, int end)
protected PathElement[]	getUnderlineShape(int start, int end)
protected void	handleControlPropertyChanged(String propertyReference) Skin subclasses will override this method to handle changes in corresponding control's properties.
protected void	layoutChildren(double x, double y, double w, double h) Called during the layout pass of the scenegraph.
protected String	maskText(String txt)
void	nextCharacterVisually(boolean moveRight)
void	positionCaret(HitInfo hit, boolean select)
protected Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)
protected void	removeHighlight(List<? extends Node> nodes)
void	replaceText(int start, int end, String txt) Use this implementation instead of the one provided on TextInputControl.
void	scrollAfterDelete(double textMaxXOld, double caretMaxXOld)
protected int	translateCaretPosition(int cp) Function to translate the text control's "dot" into the caret position in the Text node.
protected Point2D	translateCaretPosition(Point2D p)
protected void	updateCaretOff()

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

executeAccessibleAction, forwardBiasProperty, getCharacter, getClassCssMetaData, getCssMetaData, getInsertionPoint, handleInputMethodEvent, invalidateMetrics, isForwardBias, isRTL, populateContextMenu, scrollCharacterToVisible, setCaretAnimating, setForwardBias, toggleUseVK, updateHighlightFill, updateHighlightTextFill, updateTextFill

Methods inherited from class com.sun.javafx.scene.control.skin.BehaviorSkinBase

dispose, getBehavior, registerChangeListener, unregisterChangeListener

Methods inherited from class javafx.scene.control.SkinBase

computeMaxWidth, computeMinWidth, consumeMouseEvents, getChildren, getNode, getSkinnable, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace

Methods inherited from class java.lang.Object

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

Field Detail

textRight

protected ObservableDoubleValue textRight

Right edge of the text region sans padding

BULLET

public static final char BULLET

See Also:

Constant Field Values

Constructor Detail

TextFieldSkin

public TextFieldSkin(TextField textField)

Create a new TextFieldSkin.

Parameters:

textField - not null

TextFieldSkin

public TextFieldSkin(TextField textField,
                     TextFieldBehavior behavior)

Method Detail

translateCaretPosition

protected int translateCaretPosition(int cp)

Function to translate the text control's "dot" into the caret position in the Text node. This is possibly only meaningful for the PasswordField where the echoChar could be more than one character.

translateCaretPosition

protected Point2D translateCaretPosition(Point2D p)

handleControlPropertyChanged

protected void handleControlPropertyChanged(String propertyReference)

Description copied from class: BehaviorSkinBase

Skin subclasses will override this method to handle changes in corresponding control's properties.

Overrides:

handleControlPropertyChanged in class BehaviorSkinBase<TextField,TextFieldBehavior>

computePrefWidth

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

Description copied from class: SkinBase

Calculates the preferred width of this SkinBase. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths.

Overrides:

computePrefWidth in class SkinBase<TextField>

Parameters:

height - the height that should be used if preferred width depends on it

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

the calculated preferred width

computeMinHeight

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

Description copied from class: SkinBase

Computes the minimum allowable height of the Skin, based on the provided width.

Overrides:

computeMinHeight in class SkinBase<TextField>

Parameters:

width - The width of the Skin, in case this value might dictate the minimum height.

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

A double representing the minimum height of this Skin.

computePrefHeight

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

Description copied from class: SkinBase

Calculates the preferred height of this SkinBase. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights.

Overrides:

computePrefHeight in class SkinBase<TextField>

Parameters:

width - the width that should be used if preferred height depends on it

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

the calculated preferred height

computeMaxHeight

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

Description copied from class: SkinBase

Computes the maximum allowable height of the Skin, based on the provided width.

Overrides:

computeMaxHeight in class SkinBase<TextField>

Parameters:

width - The width of the Skin, in case this value might dictate the maximum height.

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

A double representing the maximum height of this Skin.

computeBaselineOffset

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

Description copied from class: SkinBase

Calculates the baseline offset based on the first managed child. If there is no such child, returns Node.getBaselineOffset().

Overrides:

computeBaselineOffset in class SkinBase<TextField>

Parameters:

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

baseline offset

updateCaretOff

protected void updateCaretOff()

replaceText

public void replaceText(int start,
                        int end,
                        String txt)

Use this implementation instead of the one provided on TextInputControl. updateCaretOff would get called to position the caret, but the text needs to be scrolled appropriately.

deleteChar

public void deleteChar(boolean previous)

Use this implementation instead of the one provided on TextInputControl Simply calls into TextInputControl.deletePrevious/NextChar and responds appropriately based on the return value.

scrollAfterDelete

public void scrollAfterDelete(double textMaxXOld,
                              double caretMaxXOld)

getIndex

public HitInfo getIndex(double x,
                        double y)

positionCaret

public void positionCaret(HitInfo hit,
                          boolean select)

getCharacterBounds

public Rectangle2D getCharacterBounds(int index)

Description copied from class: TextInputControlSkin

Returns the bounds of the character at a given index.

Overrides:

getCharacterBounds in class TextInputControlSkin<TextField,TextFieldBehavior>

getUnderlineShape

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

Specified by:

getUnderlineShape in class TextInputControlSkin<TextField,TextFieldBehavior>

getRangeShape

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

Specified by:

getRangeShape in class TextInputControlSkin<TextField,TextFieldBehavior>

addHighlight

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

Specified by:

addHighlight in class TextInputControlSkin<TextField,TextFieldBehavior>

removeHighlight

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

Specified by:

removeHighlight in class TextInputControlSkin<TextField,TextFieldBehavior>

nextCharacterVisually

public void nextCharacterVisually(boolean moveRight)

Specified by:

nextCharacterVisually in class TextInputControlSkin<TextField,TextFieldBehavior>

layoutChildren

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

Description copied from class: SkinBase

Called during the layout pass of the scenegraph.

Overrides:

layoutChildren in class SkinBase<TextField>

getHAlignment

protected HPos getHAlignment()

getMenuPosition

public Point2D getMenuPosition()

Overrides:

getMenuPosition in class TextInputControlSkin<TextField,TextFieldBehavior>

maskText

protected String maskText(String txt)

Overrides:

maskText in class TextInputControlSkin<TextField,TextFieldBehavior>

queryAccessibleAttribute

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

Overrides:

queryAccessibleAttribute in class SkinBase<TextField>

See Also:

Node.queryAccessibleAttribute(javafx.scene.AccessibleAttribute, java.lang.Object...)