JavaFX 25 · com.sun.jfx.incubator.scene.control.richtext.RichTextAreaBehavior

Modifier and Type	Field and Description
private final Duration	autoScrollPeriod
private final Timeline	autoScrollTimer
private boolean	autoScrollUp
private ContextMenu	contextMenu
private boolean	fastAutoScroll
private double	phantomX horizontal cursor position preserved during up/down movement, in vflow.content coordinates
private boolean	scrollStarted
private VFlow	vflow

Access	Constructor and Description
public	RichTextAreaBehavior(RichTextArea control)

Method Summary

Modifier and Type	Method and Description
protected void	autoScroll(double delta)
protected void	autoScroll()
public void	backspace()
protected boolean	canEdit() returns true if both control and model are editable
private TextPos	clamp(TextPos p)
public void	clearPhantomX()
public void	contextMenuRequested(ContextMenuEvent ev)
public void	copy()
protected void	copyWithCut(boolean cut)
public void	copyWithFormat(DataFormat f)
public void	cut()
public void	delete()
private void	deleteIgnoreSelection(BiFunction<RichTextArea, TextPos, TextPos> getter)
public void	deleteParagraph()
public void	deleteParagraphStart()
protected void	deleteSelection()
public void	deleteWordNextBeg()
public void	deleteWordNextEnd()
public void	deleteWordPrevious()
protected void	deselect()
protected DataFormat	findFormatForPaste() returns a format that can be imported by a model, based on the clipboard content and model being editable.
private Bidi	getBidi()
protected String	getPlainText(int modelIndex)
private String	getTextAtCaret()
protected TextPos	getTextPosition(MouseEvent ev)
protected String	getValidKeyTyped(KeyEvent ev)
protected void	handleKeyTyped(KeyEvent ev)
protected void	handleMouseClicked(MouseEvent ev)
protected void	handleMouseDragged(MouseEvent ev)
protected void	handleMousePressed(MouseEvent ev)
protected void	handleMouseReleased(MouseEvent ev)
private void	handleScrollEvent(ScrollEvent ev)
private void	handleScrollEventFinished(ScrollEvent ev)
private void	handleScrollEventStarted(ScrollEvent ev)
protected boolean	handleTypedChar(String typed)
public void	insertLineBreak()
public boolean	insertTab()
private boolean	isMixed()
protected boolean	isRTL()
private boolean	isRTLText()
public void	leftWord() moves the caret to the beginning of the previos word (LTR) or next word (RTL)
private void	moveCaret(boolean extSelection, BiFunction<RichTextArea, TextPos, TextPos> h)
protected void	moveCaret(TextPos text position p, boolean specifies whether to clear (false) or extend (true) any existing selection extendSelection) Moves the caret and anchor to the new position, unless `extendSelection` is true, in which case extend selection from the existing anchor to the newly set caret position.
protected void	moveCharacter(boolean moveRight, boolean extendSelection)
public void	moveDocumentEnd() Moves the caret to after the last character of the text, also clearing the selection.
public void	moveDocumentStart() Moves the caret to before the first character of the text, also clearing the selection.
public void	moveDown()
protected void	moveHorizontally(boolean start, boolean extendSelection)
public void	moveLeft()
protected void	moveLineEnd()
protected void	moveLineStart()
public void	moveParagraphDown()
public void	moveParagraphEnd()
public void	moveParagraphStart()
public void	moveParagraphUp()
public void	moveRight()
public void	moveUp()
protected void	moveVertically(double the number of pixels to move deltaPixels, boolean whether to extend selection extendSelection) Moves the caret `deltaPixels` up (negative) or down (positive) from its current position.
protected TextPos	nextCharacterVisually(TextPos start, boolean moveRight)
public void	nextWord() Moves the caret to the beginning of next word.
protected TextPos	nextWordBeg(RichTextArea control, TextPos pos)
public void	nextWordEnd() Moves the caret to the end of the next word.
public void	pageDown()
public void	pageUp()
private TextPos	paragraphDown(RichTextArea control, TextPos caret)
private TextPos	paragraphEnd(RichTextArea control, TextPos caret)
private TextPos	paragraphStart(RichTextArea control, TextPos caret)
public TextPos	paragraphUp(RichTextArea control, TextPos caret)
public void	paste()
private void	pasteLocal(DataFormat f)
public void	pastePlainText()
public void	pasteWithFormat(DataFormat f)
protected void	populateContextMenu()
protected void	populateSkinInputMap() Implements abstract com.sun.jfx.incubator.scene.control.input.BehaviorBase.populateSkinInputMap. In this method, which is called by `javafx.scene.control.Skin#install()`, the child class populates the `SkinInputMap` by registering key mappings and event handlers.
public void	previousWord() Moves the caret to the beginning of previous word.
public void	redo()
public void	rightWord() moves the caret to the beginning of the next word (LTR) or previous word (RTL)
private SelInfo	sel()
public void	selectAll()
public void	selectDocumentEnd() selects from the anchor position to the document end
public void	selectDocumentStart() selects from the anchor position to the document start
public void	selectDown()
public void	selectLeft()
protected void	selectLineEnd()
protected void	selectLineStart()
public void	selectNextWordEnd() Moves the caret to the end of the next word.
public void	selectPageDown()
public void	selectPageUp()
public void	selectParagraph()
public void	selectParagraphDown()
public void	selectParagraphEnd()
public void	selectParagraphStart()
public void	selectParagraphUp()
public void	selectRight()
public void	selectUp()
public void	selectWord()
public void	selectWordLeft() Moves the caret to the beginning of previous word (LTR) or next word (LTR).
public void	selectWordNext() Moves the caret to the beginning of next word.
public void	selectWordPrevious() Moves the caret to the beginning of previous word.
public void	selectWordRight() Moves the caret to the beginning of next word (LTR) or previous word (RTL).
protected void	stopAutoScroll()
protected void	toLeftWord(boolean extendSelection)
protected TextPos	toPreviousWord(RichTextArea control, TextPos pos)
protected void	toRightWord(boolean extendSelection)
protected TextPos	toWordEnd(RichTextArea control, TextPos pos)
public void	undo()

autoScrollPeriod	back to summary
private final Duration autoScrollPeriod

autoScrollTimer	back to summary
private final Timeline autoScrollTimer

autoScrollUp	back to summary
private boolean autoScrollUp

contextMenu	back to summary
private ContextMenu contextMenu

fastAutoScroll	back to summary
private boolean fastAutoScroll

phantomX	back to summary
private double phantomX horizontal cursor position preserved during up/down movement, in vflow.content coordinates

scrollStarted	back to summary
private boolean scrollStarted

vflow	back to summary
private VFlow vflow

RichTextAreaBehavior	back to summary
public RichTextAreaBehavior(RichTextArea control)

Method Detail

autoScroll	back to summary
protected void autoScroll(double delta)

autoScroll	back to summary
protected void autoScroll()

backspace	back to summary
public void backspace()

canEdit	back to summary
protected boolean canEdit() returns true if both control and model are editable

clamp	back to summary
private TextPos clamp(TextPos p)

clearPhantomX	back to summary
public void clearPhantomX()

contextMenuRequested	back to summary
public void contextMenuRequested(ContextMenuEvent ev)

copy	back to summary
public void copy()

copyWithCut	back to summary
protected void copyWithCut(boolean cut)

copyWithFormat	back to summary
public void copyWithFormat(DataFormat f)

cut	back to summary
public void cut()

delete	back to summary
public void delete()

deleteIgnoreSelection	back to summary
private void deleteIgnoreSelection(BiFunction<RichTextArea, TextPos, TextPos> getter)

deleteParagraph	back to summary
public void deleteParagraph()

deleteParagraphStart	back to summary
public void deleteParagraphStart()

deleteSelection	back to summary
protected void deleteSelection()

deleteWordNextBeg	back to summary
public void deleteWordNextBeg()

deleteWordNextEnd	back to summary
public void deleteWordNextEnd()

deleteWordPrevious	back to summary
public void deleteWordPrevious()

deselect	back to summary
protected void deselect()

findFormatForPaste	back to summary
protected DataFormat findFormatForPaste() returns a format that can be imported by a model, based on the clipboard content and model being editable.

getBidi	back to summary
private Bidi getBidi()

getPlainText	back to summary
protected String getPlainText(int modelIndex)

getTextAtCaret	back to summary
private String getTextAtCaret()

getTextPosition	back to summary
protected TextPos getTextPosition(MouseEvent ev)

getValidKeyTyped	back to summary
protected String getValidKeyTyped(KeyEvent ev)

handleKeyTyped	back to summary
protected void handleKeyTyped(KeyEvent ev)

handleMouseClicked	back to summary
protected void handleMouseClicked(MouseEvent ev)

handleMouseDragged	back to summary
protected void handleMouseDragged(MouseEvent ev)

handleMousePressed	back to summary
protected void handleMousePressed(MouseEvent ev)

handleMouseReleased	back to summary
protected void handleMouseReleased(MouseEvent ev)

handleScrollEvent	back to summary
private void handleScrollEvent(ScrollEvent ev)

handleScrollEventFinished	back to summary
private void handleScrollEventFinished(ScrollEvent ev)

handleScrollEventStarted	back to summary
private void handleScrollEventStarted(ScrollEvent ev)

handleTypedChar	back to summary
protected boolean handleTypedChar(String typed)

insertLineBreak	back to summary
public void insertLineBreak()

insertTab	back to summary
public boolean insertTab()

isMixed	back to summary
private boolean isMixed()

isRTL	back to summary
protected boolean isRTL()

isRTLText	back to summary
private boolean isRTLText()

leftWord	back to summary
public void leftWord() moves the caret to the beginning of the previos word (LTR) or next word (RTL)

moveCaret	back to summary
private void moveCaret(boolean extSelection, BiFunction<RichTextArea, TextPos, TextPos> h)

moveCaret back to summary

protected void moveCaret(TextPos p, boolean extendSelection)

Moves the caret and anchor to the new position, unless extendSelection is true, in which case extend selection from the existing anchor to the newly set caret position.

Parameters

p:TextPos: text position
extendSelection:boolean: specifies whether to clear (false) or extend (true) any existing selection

moveCharacter	back to summary
protected void moveCharacter(boolean moveRight, boolean extendSelection)

moveDocumentEnd	back to summary
public void moveDocumentEnd() Moves the caret to after the last character of the text, also clearing the selection.

moveDocumentStart	back to summary
public void moveDocumentStart() Moves the caret to before the first character of the text, also clearing the selection.

moveDown	back to summary
public void moveDown()

moveHorizontally	back to summary
protected void moveHorizontally(boolean start, boolean extendSelection)

moveLeft	back to summary
public void moveLeft()

moveLineEnd	back to summary
protected void moveLineEnd()

moveLineStart	back to summary
protected void moveLineStart()

moveParagraphDown	back to summary
public void moveParagraphDown()

moveParagraphEnd	back to summary
public void moveParagraphEnd()

moveParagraphStart	back to summary
public void moveParagraphStart()

moveParagraphUp	back to summary
public void moveParagraphUp()

moveRight	back to summary
public void moveRight()

moveUp	back to summary
public void moveUp()

moveVertically back to summary

protected void moveVertically(double deltaPixels, boolean extendSelection)

Moves the caret deltaPixels up (negative) or down (positive) from its current position. Extends existing selection when extendSelection is true. Does nothing if the current caret position is null.

Parameters

deltaPixels:double: the number of pixels to move
extendSelection:boolean: whether to extend selection

nextCharacterVisually	back to summary
protected TextPos nextCharacterVisually(TextPos start, boolean moveRight)

nextWord	back to summary
public void nextWord() Moves the caret to the beginning of next word. This function also has the effect of clearing the selection.

nextWordBeg	back to summary
protected TextPos nextWordBeg(RichTextArea control, TextPos pos)

nextWordEnd	back to summary
public void nextWordEnd() Moves the caret to the end of the next word. This function also has the effect of clearing the selection.

pageDown	back to summary
public void pageDown()

pageUp	back to summary
public void pageUp()

paragraphDown	back to summary
private TextPos paragraphDown(RichTextArea control, TextPos caret)

paragraphEnd	back to summary
private TextPos paragraphEnd(RichTextArea control, TextPos caret)

paragraphStart	back to summary
private TextPos paragraphStart(RichTextArea control, TextPos caret)

paragraphUp	back to summary
public TextPos paragraphUp(RichTextArea control, TextPos caret)

paste	back to summary
public void paste()

pasteLocal	back to summary
private void pasteLocal(DataFormat f)

pastePlainText	back to summary
public void pastePlainText()

pasteWithFormat	back to summary
public void pasteWithFormat(DataFormat f)

populateContextMenu	back to summary
protected void populateContextMenu()

populateSkinInputMap back to summary

protected void populateSkinInputMap()

Implements abstract com.sun.jfx.incubator.scene.control.input.BehaviorBase.populateSkinInputMap.

Doc from com.sun.jfx.incubator.scene.control.input.BehaviorBase.populateSkinInputMap.

In this method, which is called by javafx.scene.control.Skin#install(), the child class populates the SkinInputMap by registering key mappings and event handlers.

If a subclass overrides this method, it is important to call the superclass implementation.

Annotations

@Override

previousWord	back to summary
public void previousWord() Moves the caret to the beginning of previous word. This function also has the effect of clearing the selection.

redo	back to summary
public void redo()

rightWord	back to summary
public void rightWord() moves the caret to the beginning of the next word (LTR) or previous word (RTL)

sel	back to summary
private SelInfo sel()

selectAll	back to summary
public void selectAll()

selectDocumentEnd	back to summary
public void selectDocumentEnd() selects from the anchor position to the document end

selectDocumentStart	back to summary
public void selectDocumentStart() selects from the anchor position to the document start

selectDown	back to summary
public void selectDown()

selectLeft	back to summary
public void selectLeft()

selectLineEnd	back to summary
protected void selectLineEnd()

selectLineStart	back to summary
protected void selectLineStart()

selectNextWordEnd	back to summary
public void selectNextWordEnd() Moves the caret to the end of the next word. This does not cause the selection to be cleared.

selectPageDown	back to summary
public void selectPageDown()

selectPageUp	back to summary
public void selectPageUp()

selectParagraph	back to summary
public void selectParagraph()

selectParagraphDown	back to summary
public void selectParagraphDown()

selectParagraphEnd	back to summary
public void selectParagraphEnd()

selectParagraphStart	back to summary
public void selectParagraphStart()

selectParagraphUp	back to summary
public void selectParagraphUp()

selectRight	back to summary
public void selectRight()

selectUp	back to summary
public void selectUp()

selectWord	back to summary
public void selectWord()

selectWordLeft	back to summary
public void selectWordLeft() Moves the caret to the beginning of previous word (LTR) or next word (LTR). This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of previous word.

selectWordNext	back to summary
public void selectWordNext() Moves the caret to the beginning of next word. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of next word.

selectWordPrevious	back to summary
public void selectWordPrevious() Moves the caret to the beginning of previous word. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of previous word.

selectWordRight	back to summary
public void selectWordRight() Moves the caret to the beginning of next word (LTR) or previous word (RTL). This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of next word.

stopAutoScroll	back to summary
protected void stopAutoScroll()

toLeftWord	back to summary
protected void toLeftWord(boolean extendSelection)

toPreviousWord	back to summary
protected TextPos toPreviousWord(RichTextArea control, TextPos pos)

toRightWord	back to summary
protected void toRightWord(boolean extendSelection)

toWordEnd	back to summary
protected TextPos toWordEnd(RichTextArea control, TextPos pos)

undo	back to summary
public void undo()

public Class RichTextAreaBehavior

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail