org.netbeans.spi.editor.caret

Class NavigationFilterBypass

java.lang.Object

javax.swing.text.NavigationFilter.FilterBypass

org.netbeans.spi.editor.caret.NavigationFilterBypass

public abstract class NavigationFilterBypass
extends NavigationFilter.FilterBypass

Enhanced FilterBypass which understands multicaret.

Implementations of NavigationFilter may check if the FilterBypass is instanceof this class, and if so, they can access extended information.

If the caret move operation is initiated by new caret APIs, the FilterBypass passed to NavigationFilters always satisfies this interface.

Since:

2.10

Constructor Summary

Constructors

Constructor and Description
NavigationFilterBypass()

Method Summary

Modifier and Type	Method and Description
abstract CaretInfo	getCaretItem() Returns the currently changing CaretItem.
abstract EditorCaret	getEditorCaret() Access to the entire EditorCaret abstraction
abstract MoveCaretsOrigin	getOrigin() Describes the origin / reason of the movement.

Methods inherited from class javax.swing.text.NavigationFilter.FilterBypass

getCaret, moveDot, setDot

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationFilterBypass

public NavigationFilterBypass()

Method Detail

getCaretItem

@NonNull
public abstract CaretInfo getCaretItem()

Returns the currently changing CaretItem.

Returns:

CaretItem the caret instance being changed

getEditorCaret

@NonNull
public abstract EditorCaret getEditorCaret()

Access to the entire EditorCaret abstraction

Returns:

the editor caret

getOrigin

@NonNull
public abstract MoveCaretsOrigin getOrigin()

Describes the origin / reason of the movement.

Returns:

The origin object provided by the caret movement initiator.