Class NavigationFilter

Constructor Detail

• NavigationFilter

  public NavigationFilter()

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

  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)

  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.

  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

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

  IllegalArgumentException - if direction doesn't have one of the legal values above