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.
Caret,
DefaultCaret,
View| Modifier and Type | Class and Description |
|---|---|
static class |
NavigationFilter.FilterBypass
Used as a way to circumvent calling back into the caret to
position the cursor.
|
| Constructor and Description |
|---|
NavigationFilter() |
| Modifier and Type | Method and Description |
|---|---|
int |
getNextVisualPositionFrom(JTextComponent text,
int pos,
Position.Bias bias,
int direction,
Position.Bias[] biasRet)
Returns the next visual position to place the caret at from an
existing position.
|
void |
moveDot(NavigationFilter.FilterBypass fb,
int dot,
Position.Bias bias)
Invoked prior to the Caret moving the dot.
|
void |
setDot(NavigationFilter.FilterBypass fb,
int dot,
Position.Bias bias)
Invoked prior to the Caret setting the dot.
|
public void setDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
FilterBypass with the passed
in arguments. Subclasses may wish to conditionally
call super with a different location, or invoke the necessary method
on the FilterBypassfb - FilterBypass that can be used to mutate caret positiondot - the position >= 0bias - Bias to place the dot atpublic void moveDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
FilterBypass with the passed
in arguments. Subclasses may wish to conditionally
call super with a different location, or invoke the necessary
methods on the FilterBypass.fb - FilterBypass that can be used to mutate caret positiondot - the position >= 0bias - Bias for new locationpublic 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 positionBadLocationExceptionIllegalArgumentException - if direction
doesn't have one of the legal values above Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138