javax.swing.text

Class NavigationFilter

java.lang.Object

javax.swing.text.NavigationFilter

public class NavigationFilter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavigationFilter.FilterBypass

Constructor Summary

Constructors

Constructor and Description
NavigationFilter()

Method Summary

Methods

Modifier and Type	Method and Description
int	getNextVisualPositionFrom(JTextComponent c, int pos, Position.Bias bias, int dir, Position.Bias[] retBias) Returns the next visual position in the specified direction at which one would place a caret.
void	moveDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
void	setDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationFilter

public NavigationFilter()

Method Detail

moveDot

public void moveDot(NavigationFilter.FilterBypass fb,
           int dot,
           Position.Bias bias)

setDot

public void setDot(NavigationFilter.FilterBypass fb,
          int dot,
          Position.Bias bias)

getNextVisualPositionFrom

public int getNextVisualPositionFrom(JTextComponent c,
                            int pos,
                            Position.Bias bias,
                            int dir,
                            Position.Bias[] retBias)
                              throws BadLocationException

Returns the next visual position in the specified direction at which one would place a caret. The default implementation forwards to the text component's root view. Subclasses may wish to restrict that more.

Parameters:

c - the text component

pos - the current model position

bias - the bias of pos

dir - the direction, one of SwingConstants.NORTH, SwingConstants.SOUTH, SwingConstants.WEST or SwingConstants.EAST

retBias - the bias of the returned position

Returns:

the next model location to place the caret

Throws:

BadLocationException - when pos is not a valid model position