javax.swing.text
Class DefaultFormatter.DefaultNavigationFilter

java.lang.Object
  javax.swing.text.NavigationFilter
      javax.swing.text.DefaultFormatter.DefaultNavigationFilter

All Implemented Interfaces:

Serializable

Enclosing class:

DefaultFormatter

private class DefaultFormatter.DefaultNavigationFilter

extends NavigationFilter

implements Serializable

NavigationFilter implementation that calls back to methods with same name in DefaultFormatter.

Nested Class Summary

Nested classes inherited from class javax.swing.text.NavigationFilter

NavigationFilter.FilterBypass

Constructor Summary

private

DefaultFormatter.DefaultNavigationFilter()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFormatter.DefaultNavigationFilter

private DefaultFormatter.DefaultNavigationFilter()

Method Detail

setDot

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

Description copied from class: NavigationFilter

Invoked prior to the Caret setting the dot. The default implementation calls directly into the FilterBypass with the passed in arguments. Subclasses may wish to conditionally call super with a different location, or invoke the necessary method on the FilterBypass

Overrides:

setDot in class NavigationFilter

Parameters:

fb - FilterBypass that can be used to mutate caret position

dot - the position >= 0

bias - Bias to place the dot at

moveDot

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

Description copied from class: NavigationFilter

Invoked prior to the Caret moving the dot. The default implementation calls directly into the 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.

Overrides:

moveDot in class NavigationFilter

Parameters:

fb - FilterBypass that can be used to mutate caret position

dot - the position >= 0

bias - Bias for new location

getNextVisualPositionFrom

public int getNextVisualPositionFrom(JTextComponent text,
                                     int pos,
                                     Position.Bias bias,
                                     int direction,
                                     Position.Bias[] biasRet)
                              throws BadLocationException

Description copied from class: NavigationFilter

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.

Overrides:

getNextVisualPositionFrom in class NavigationFilter

Parameters:

text - JTextComponent containing text

pos - Position used in determining next position

bias - Bias used in determining next position

direction - 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