- java.lang.Object
-
- javax.swing.text.NavigationFilter
-
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 theNavigationFilter
, assuming theJTextComponent
has a non-nullNavigationFilter
set. In this manner theNavigationFilter
can effectively restrict where the cursor can be positioned. SimilarlyDefaultCaret
will call into theNavigationFilter
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
.- Since:
- 1.4
- See Also:
Caret
,DefaultCaret
,View
-
-
Nested Class Summary
Nested Classes 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 Summary
Constructors Constructor and Description NavigationFilter()
-
Method Summary
Methods 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.
-
-
-
Method Detail
-
setDot
public void setDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
Invoked prior to the Caret setting the dot. The default implementation calls directly into theFilterBypass
with the passed in arguments. Subclasses may wish to conditionally call super with a different location, or invoke the necessary method on theFilterBypass
- Parameters:
fb
- FilterBypass that can be used to mutate caret positiondot
- the position >= 0bias
- Bias to place the dot at
-
moveDot
public void moveDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
Invoked prior to the Caret moving the dot. The default implementation calls directly into theFilterBypass
with the passed in arguments. Subclasses may wish to conditionally call super with a different location, or invoke the necessary methods on theFilterBypass
.- Parameters:
fb
- FilterBypass that can be used to mutate caret positiondot
- the position >= 0bias
- Bias for new location
-
getNextVisualPositionFrom
public int getNextVisualPositionFrom(JTextComponent text, int pos, Position.Bias bias, int direction, Position.Bias[] biasRet) throws BadLocationException
Returns the next visual position to place the caret at from an existing position. The default implementation simply forwards the method to the root View. Subclasses may wish to further restrict the location based on additional criteria.- Parameters:
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:- SwingConstants.WEST
- SwingConstants.EAST
- SwingConstants.NORTH
- SwingConstants.SOUTH
biasRet
- Used to return resulting Bias of next position- Returns:
- the location within the model that best represents the next location visual position
- Throws:
BadLocationException
IllegalArgumentException
- ifdirection
doesn't have one of the legal values above
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/swing/text/navigationfilter.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.