javafx.scene.control.skin

Class TextAreaSkin

java.lang.Object

<any>

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

javafx.scene.control.skin.TextAreaSkin

public class TextAreaSkin
extends TextInputControlSkin<TextArea>

Default skin implementation for the TextArea control.

Since:

9

See Also:

TextArea

Property Summary

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

caretVisibleProperty, forwardBiasProperty, highlightFillProperty, highlightTextFillProperty, promptTextFillProperty, textFillProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TextAreaSkin.ContentView Support classes

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 TextAreaBehavior	behavior
private ObservableIntegerValue	caretPosition
private Path	characterBoundingPath
private double	characterWidth
private double	computedMinHeight
private double	computedMinWidth
private double	computedPrefHeight
private double	computedPrefWidth
private TextAreaSkin.ContentView	contentView
private boolean	handlePressed
private double	lineHeight
private Bounds	oldViewportBounds
private Group	paragraphNodes
private double	pressX
private double	pressY
private Text	promptNode
private VerticalDirection	scrollDirection
private ScrollPane	scrollPane
private <any>	scrollSelectionHandler
private Timeline	scrollSelectionTimeline
private Group	selectionHighlightGroup
(package private) double	targetCaretX Remembers horizontal position when traversing up / down.
private TextArea	textArea Private fields
private static Path	tmpCaretPath A shared helper object, used only by downLines().
private static boolean	USE_MULTIPLE_NODES
private ObservableBooleanValue	usePromptText
private double	widthForComputedPrefHeight

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

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

Constructor Summary

Constructors

Constructor and Description
TextAreaSkin(TextArea control) Creates a new TextAreaSkin 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.
private void	addParagraphNode(int i, java.lang.String string)
double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)
private void	createPromptNode()
void	dispose()
private void	downLines(int nLines, boolean select, boolean extendSelection)
(package private) TextAreaBehavior	getBehavior() Private implementation
Bounds	getCaretBounds() Gets the Bounds of the caret of the skinned TextArea.
private char	getCharacter(int index)
Rectangle2D	getCharacterBounds(int index) Returns the bounds of the character at a given index.
HitInfo	getIndex(double x, double y) Performs a hit test, mapping point to index in the content.
protected int	getInsertionPoint(double x, double y) Returns the insertion point for a given location.
private int	getInsertionPoint(Text paragraphNode, double x, double y)
Point2D	getMenuPosition() Returns the position to be used for a context menu, based on the location of the caret handle or selection handles.
private int	getNextInsertionPoint(Text paragraphNode, double x, int from, VerticalDirection scrollDirection)
protected PathElement[]	getRangeShape(int start, int end)
private double	getScrollLeftMax()
private double	getScrollTopMax()
private double	getTextLeft()
private Text	getTextNode()
private double	getTextTranslateX()
private double	getTextTranslateY()
protected PathElement[]	getUnderlineShape(int start, int end)
protected void	invalidateMetrics() Invalidates cached min and pref sizes for the TextInputControl.
protected void	layoutChildren(double contentX, double contentY, double contentWidth, double contentHeight)
private void	lineEnd(boolean select, boolean extendSelection)
private void	lineStart(boolean select, boolean extendSelection)
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)
private void	nextLine(boolean select)
private void	nextPage(boolean select)
private void	paragraphEnd(boolean goPastInitialNewline, boolean select)
private void	paragraphStart(boolean previousIfAtStart, boolean select)
void	positionCaret(HitInfo hit, boolean select) Moves the caret to the specified position.
private void	positionCaret(int pos, boolean leading, boolean select, boolean extendSelection)
private void	previousLine(boolean select)
private void	previousPage(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.
private void	scrollBoundsToVisible(Rectangle2D bounds)
private void	scrollCaretToVisible()
protected void	scrollCharacterToVisible(int index) Ensures that the character at a given index is visible.
private Point2D	translateCaretPosition(Point2D p)
private void	updateFontMetrics()
protected void	updateHighlightFill() Called when highlightFill property changes.
private void	updatePrefViewportHeight()
private void	updatePrefViewportWidth()
private void	updateTextNodeCaretPos(int pos)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

tmpCaretPath

private static final Path tmpCaretPath

A shared helper object, used only by downLines().

textArea

private final TextArea textArea

Private fields

USE_MULTIPLE_NODES

private static final boolean USE_MULTIPLE_NODES

See Also:

Constant Field Values

behavior

private final TextAreaBehavior behavior

computedMinWidth

private double computedMinWidth

computedMinHeight

private double computedMinHeight

computedPrefWidth

private double computedPrefWidth

computedPrefHeight

private double computedPrefHeight

widthForComputedPrefHeight

private double widthForComputedPrefHeight

characterWidth

private double characterWidth

lineHeight

private double lineHeight

contentView

private TextAreaSkin.ContentView contentView

paragraphNodes

private Group paragraphNodes

promptNode

private Text promptNode

usePromptText

private ObservableBooleanValue usePromptText

caretPosition

private ObservableIntegerValue caretPosition

selectionHighlightGroup

private Group selectionHighlightGroup

scrollPane

private ScrollPane scrollPane

oldViewportBounds

private Bounds oldViewportBounds

scrollDirection

private VerticalDirection scrollDirection

characterBoundingPath

private Path characterBoundingPath

scrollSelectionTimeline

private Timeline scrollSelectionTimeline

scrollSelectionHandler

private <any> scrollSelectionHandler

pressX

private double pressX

pressY

private double pressY

handlePressed

private boolean handlePressed

targetCaretX

double targetCaretX

Remembers horizontal position when traversing up / down.

Constructor Detail

TextAreaSkin

public TextAreaSkin(TextArea control)

Creates a new TextAreaSkin 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

invalidateMetrics

protected void invalidateMetrics()

Invalidates cached min and pref sizes for the TextInputControl.

Overrides:

invalidateMetrics in class TextInputControlSkin<TextArea>

layoutChildren

protected void layoutChildren(double contentX,
                              double contentY,
                              double contentWidth,
                              double contentHeight)

updateHighlightFill

protected void updateHighlightFill()

Called when highlightFill property changes.

Overrides:

updateHighlightFill in class TextInputControlSkin<TextArea>

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.

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<TextArea>

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)

downLines

private void downLines(int nLines,
                       boolean select,
                       boolean extendSelection)

previousLine

private void previousLine(boolean select)

nextLine

private void nextLine(boolean select)

previousPage

private void previousPage(boolean select)

nextPage

private void nextPage(boolean select)

lineStart

private void lineStart(boolean select,
                       boolean extendSelection)

lineEnd

private void lineEnd(boolean select,
                     boolean extendSelection)

paragraphStart

private void paragraphStart(boolean previousIfAtStart,
                            boolean select)

paragraphEnd

private void paragraphEnd(boolean goPastInitialNewline,
                          boolean select)

getUnderlineShape

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

Specified by:

getUnderlineShape in class TextInputControlSkin<TextArea>

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<TextArea>

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<TextArea>

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<TextArea>

Parameters:

nodes - the list of nodes

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<TextArea>

Returns:

the position to be used for this context menu

getCaretBounds

public Bounds getCaretBounds()

Gets the Bounds of the caret of the skinned TextArea.

Returns:

the Bounds of the caret shape, relative to the TextArea.

queryAccessibleAttribute

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

dispose

public void dispose()

computeBaselineOffset

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

getCharacter

private char getCharacter(int index)

getInsertionPoint

protected int getInsertionPoint(double x,
                                double y)

Returns the insertion point for a given location.

Overrides:

getInsertionPoint in class TextInputControlSkin<TextArea>

Parameters:

x - the x location

y - the y location

Returns:

the insertion point for a given location

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,
                           boolean extendSelection)

getCharacterBounds

public Rectangle2D getCharacterBounds(int index)

Returns the bounds of the character at a given index.

Overrides:

getCharacterBounds in class TextInputControlSkin<TextArea>

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.

Overrides:

scrollCharacterToVisible in class TextInputControlSkin<TextArea>

Parameters:

index - the index

getBehavior

TextAreaBehavior getBehavior()

Private implementation

Overrides:

getBehavior in class TextInputControlSkin<TextArea>

createPromptNode

private void createPromptNode()

addParagraphNode

private void addParagraphNode(int i,
                              java.lang.String string)

getScrollTopMax

private double getScrollTopMax()

getScrollLeftMax

private double getScrollLeftMax()

getInsertionPoint

private int getInsertionPoint(Text paragraphNode,
                              double x,
                              double y)

getNextInsertionPoint

private int getNextInsertionPoint(Text paragraphNode,
                                  double x,
                                  int from,
                                  VerticalDirection scrollDirection)

scrollCaretToVisible

private void scrollCaretToVisible()

scrollBoundsToVisible

private void scrollBoundsToVisible(Rectangle2D bounds)

updatePrefViewportWidth

private void updatePrefViewportWidth()

updatePrefViewportHeight

private void updatePrefViewportHeight()

updateFontMetrics

private void updateFontMetrics()

getTextTranslateX

private double getTextTranslateX()

getTextTranslateY

private double getTextTranslateY()

getTextLeft

private double getTextLeft()

translateCaretPosition

private Point2D translateCaretPosition(Point2D p)

getTextNode

private Text getTextNode()

updateTextNodeCaretPos

private void updateTextNodeCaretPos(int pos)