public class NavigationFilter extends Object
NavigationFilter
can be used to restrict where the cursor can be positioned. When the default cursor positioning actions attempt to reposition the cursor they will call into the NavigationFilter
, assuming the JTextComponent
has a non-null NavigationFilter
set. In this manner the NavigationFilter
can effectively restrict where the cursor can be positioned. Similarly DefaultCaret
will call into the NavigationFilter
when the user is changing the selection to further restrict where the cursor can be positioned. Subclasses can conditionally call into supers implementation to restrict where the cursor can be placed, or call directly into the FilterBypass
.
Modifier and Type | Class | Description |
---|---|---|
static class |
NavigationFilter.FilterBypass |
Used as a way to circumvent calling back into the caret to position the cursor. |
Constructor | Description |
---|---|
NavigationFilter() |
Constructs a NavigationFilter . |
Modifier and Type | Method | Description |
---|---|---|
int |
getNextVisualPositionFrom |
Returns the next visual position to place the caret at from an existing position. |
void |
moveDot |
Invoked prior to the Caret moving the dot. |
void |
setDot |
Invoked prior to the Caret setting the dot. |
public NavigationFilter()
NavigationFilter
.public int getNextVisualPositionFrom(JTextComponent text, int pos, Position.Bias bias, int direction, Position.Bias[] biasRet) throws BadLocationException
text
- JTextComponent containing textpos
- Position used in determining next positionbias
- Bias used in determining next positiondirection
- the direction from the current position that can be thought of as the arrow keys typically found on a keyboard. This will be one of the following values: biasRet
- Used to return resulting Bias of next positionBadLocationException
- for a bad location within a document modelIllegalArgumentException
- if direction
doesn't have one of the legal values above
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/NavigationFilter.html