public Interface ViewActions<PS, SEG, S>

Maps a paragraph index from TextEditingArea#getParagraphs() into the index system of getVisibleParagraphs().

The estimated scrollX value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.

The estimated scrollY value. This can be set in order to scroll the content. Value is only accurate when area does not wrap lines and uses the same font size throughout the entire area.

Returns the index of the first visible paragraph in the index system of TextEditingArea#getParagraphs().

Gets the style applicator.

Using the paragraph index of the "all paragraph" index system, returns the bounds of a caret on the given paragraph or Optional#empty() if no caret is on that paragraph or the pragraph is not visible.

Gets the character bounds on screen

Parameters

from:int

the start position

to:int

the end position

Returns:Optional<Bounds>

the bounds or Optional#empty() if line is not visible or the range is only a newline character.

Gets the ContextMenu for the area, which is by default null.

Gets the horizontal amount in pixels by which to offset the getContextMenu() when it is shown, which has a default value of 2.

Gets the vertical amount in pixels by which to offset the getContextMenu() when it is shown, which has a default value of 2.

Defines how long the mouse has to stay still over the text before a MouseOverTextEvent of type MOUSE_OVER_TEXT_BEGIN is fired on this text area. When set to null, no MouseOverTextEvents are fired on this text area.

Default value is null.

Runs the consumer when the mouse is dragged in this scenario: the user has pressed the mouse over some unselected text, and dragged the mouse to a new location within the area, but has not yet released the mouse. Each time the user drags the mouse without releasing it, this hook's consumer gets called.

By default, this will create a new selection or NavigationActions.SelectionPolicy#ADJUST the current one to be bigger or smaller via the code:

    e -> {
        CharacterHit hit = hit(e.getX(), e.getY());
        moveTo(hit.getInsertionIndex(), SelectionPolicy.ADJUST);
    }

Runs the consumer when the mouse is dragged in this scenario: the user has selected some text, pressed the mouse on top of the selection, dragged it to a new location within the area, but has not yet released the mouse. Each time the user drags the mouse without releasing it, this hook's consumer gets called.

By default, this will displace the caret to that position within the area via the code:

    p -> {
        CharacterHit hit = hit(p.getX(), p.getY());
        displaceCaret(hit.getInsertionIndex());
    }

Returns the bounds of the paragraph if it is visible or Optional#empty() if it's not. The returned bounds object will always be within the bounds of the area. In other words, it takes scrolling into account.

Parameters

paragraphIndex:int

the index in area's list of paragraphs (visible and invisible).

Gets the function that maps a line index to a node that is positioned to the left of the first character in a paragraph's text. Useful for toggle points or indicating the line's number via LineNumberFactory.

Gets the number of lines a paragraph spans when isWrapText() is true, or otherwise returns 1.

Gets the height of the viewport and ignores the padding values added to the area.

Returns the bounds of the paragraph if it is visible or Optional#empty() if it's not. The returned bounds object will always be within the bounds of the area. In other words, it takes scrolling into account.

Parameters

visibleParagraphIndex:int

the index in area's list of visible paragraphs.

Gets the visible paragraphs, even the ones that are barely displayed.

Hides the area's context menu if it is not null and it is showing.

Helpful for determining which letter is at point x, y:

    StyledTextArea area = // creation code
    area.addEventHandler(MouseEvent.MOUSE_PRESSED, (MouseEvent e) -> {
        CharacterHit hit = area.hit(e.getX(), e.getY());
        int characterPosition = hit.getInsertionIndex();

        // move the caret to that character's position
        area.moveTo(characterPosition, SelectionPolicy.CLEAR);
    }

Indicates whether area should auto scroll towards a MouseEvent#MOUSE_DRAGGED event. This can be used when additional drag behavior is added on top of the area's default drag behavior and one does not want this auto scroll feature to occur. This flag should be set to the correct value before the end of the process InputMap.

Indicates whether this text area can be edited by the user. Note that this property doesn't affect editing through the API.

When a run of text exceeds the width of the text region, then this property indicates whether the text should wrap onto another line.

Returns the index of the last visible paragraph in the index system of TextEditingArea#getParagraphs().

Move the caret to the end of either the line in a multi-line wrapped paragraph or the paragraph in a single-line / non-wrapped paragraph

Parameters

policy:NavigationActions.SelectionPolicy

use NavigationActions.SelectionPolicy#CLEAR when no selection is desired an NavigationActions.SelectionPolicy#ADJUST when a selection from starting point to the place to where the caret is moved is desired.

Returns 0 if the given paragraph displays its content across only one line, or returns the index of the line on which the given column position appears if the paragraph spans multiple lines.

Move the caret to the start of either the line in a multi-line wrapped paragraph or the paragraph in a single-line / non-wrapped paragraph

Parameters

policy:NavigationActions.SelectionPolicy

use NavigationActions.SelectionPolicy#CLEAR when no selection is desired an NavigationActions.SelectionPolicy#ADJUST when a selection from starting point to the place to where the caret is moved is desired.

Moves caret to the next page (i.e. page down)

Parameters

selectionPolicy:NavigationActions.SelectionPolicy

use NavigationActions.SelectionPolicy#CLEAR when no selection is desired and NavigationActions.SelectionPolicy#ADJUST when a selection from starting point to the place to where the caret is moved is desired.

Moves caret to the previous page (i.e. page up)

Parameters

selectionPolicy:NavigationActions.SelectionPolicy

use NavigationActions.SelectionPolicy#CLEAR when no selection is desired and NavigationActions.SelectionPolicy#ADJUST when a selection from starting point to the place to where the caret is moved is desired.

If the caret is not visible within the area's view, the area will scroll so that caret is visible in the next layout pass. Use this method when you wish to "follow the caret" (i.e. auto-scroll to caret) after making a change (add/remove/modify area's segments).

Selects the current line of a multi-line paragraph.

Runs the EventHandler when the mouse is released in this scenario: the user has selected some text and then "clicked" the mouse somewhere in that selection (the use pressed the mouse, did not drag it, and released the mouse)

By default, this will move the caret to the position where the mouse was clicked and clear out any selection via the code:

    e -> {
        CharacterHit hit = hit(e.getX(), e.getY());
        moveTo(hit.getInsertionIndex(), SelectionPolicy.CLEAR);
    }

Runs the EventHandler when the mouse is released in this scenario: the user has pressed the mouse over some unselected text, and dragged the mouse to a new location within the area, and released the mouse.

By default, this will NavigationActions.SelectionPolicy#ADJUST the current selection to be bigger or smaller via the code:

    e -> {
        CharacterHit hit = hit(e.getX(), e.getY());
        moveTo(hit.getInsertionIndex(), SelectionPolicy.ADJUST);
    }

Runs the EventHandler when the user pressed the mouse over unselected text within the area.

By default, this will move the caret to the position where the mouse was pressed and clear out any selection via the code:

    e -> {
        CharacterHit hit = hit(e.getX(), e.getY());
        moveTo(hit.getInsertionIndex(), SelectionPolicy.CLEAR);
    }

Runs the EventHandler when the mouse is released in this scenario: the user has selected some text, pressed the mouse on top of the selection, dragged it to a new location within the area, and released the mouse within the area.

By default, this will relocate the selected text to the character index where the mouse was released via the code:

    e -> {
        CharacterHit hit = hit(e.getX(), e.getY());
        moveSelectedText(hit.getInsertionIndex());
    }

Lays out the viewport so that the paragraph is the last line (bottom) displayed in the viewport.

Lays out the viewport so that the paragraph is the first line (top) displayed in the viewport.

Shows the paragraph somewhere in the viewport. If the line is already visible, no noticeable change occurs. If line is above the current view, it appears at the top of the viewport. If the line is below the current view, it appears at the bottom of the viewport.

Lays out the viewport so that the given bounds (according to the paragraph's coordinate system) within the given paragraph is visible in the viewport.

The estimated height of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.

The estimated width of the entire document. Accurate when area does not wrap lines and uses the same font size throughout the entire area. Value is only supposed to be set by the skin, not the user.

Returns an EventStream that emits a null value every time the viewport becomes dirty (e.g. the viewport's width, height, scaleX, scaleY, estimatedScrollX, or estimatedScrollY values change)

Maps a paragraph index from getVisibleParagraphs() into the index system of TextEditingArea#getParagraphs().