javax.swing.text
クラス NavigationFilter

java.lang.Object
  |
  +--javax.swing.text.NavigationFilter

public class NavigationFilter

extends Object

NavigationFilter は、カーソルを配置する場所を限定するために使用されます。デフォルトのカーソル配置処理がカーソルの再配置を行うとき、JTextComponent には null 以外の NavigationFilter セットがあることを前提にして、NavigationFilter を呼び出します。この方法では、NavigationFilter によりカーソル位置が効果的に限定されます。同様に、ユーザが選択範囲を変更しているときにも DefaultCaret は NavigationFilter を呼び出し、カーソル位置がより厳密に限定されます。

サブクラスは、条件付きでスーパークラスの実装を呼び出してカーソル位置を限定するか、直接 FilterBypass を呼び出します。

導入されたバージョン:

1.4

関連項目:

Caret, DefaultCaret, View

入れ子クラスの概要

static class

NavigationFilter.FilterBypass カーソルを配置するキャレットのコールバックを回避する方法として使用されます。

コンストラクタの概要

NavigationFilter()

メソッドの概要

int	getNextVisualPositionFrom(JTextComponent text, int pos, Position.Bias bias, int direction, Position.Bias[] biasRet) 既存の位置からキャレットを置くことのできる、次の可視位置を返します。
void	moveDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias) ドットを移動する Caret の前に呼び出されます。
void	setDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias) ドットを設定する Caret の前に呼び出されます。

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

NavigationFilter

public NavigationFilter()

メソッドの詳細

setDot

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

ドットを設定する Caret の前に呼び出されます。デフォルトの実装では、渡された引数を使用して FilterBypass を直接呼び出します。サブクラスは、条件付きで別の位置を持つスーパークラスを呼び出すか、FilterBypass で必要なメソッドを呼び出します。

パラメータ:

fb - キャレット位置の変更に使用する FilterBypass

dot - 位置 >= 0

bias - ドットを配置するバイアス

moveDot

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

ドットを移動する Caret の前に呼び出されます。デフォルトの実装では、渡された引数を使用して FilterBypass を直接呼び出します。サブクラスは、条件付きで別の位置を持つスーパークラスを呼び出すか、FilterBypass で必要なメソッドを呼び出します。

パラメータ:

fb - キャレット位置の変更に使用する FilterBypass

dot - 位置 >= 0

bias - 新しい位置のバイアス

getNextVisualPositionFrom

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

既存の位置からキャレットを置くことのできる、次の可視位置を返します。デフォルトの実装では、単にメソッドがルート View に転送されるだけです。サブクラスは追加された基準に基づいて、位置をより厳密に限定します。

パラメータ:

text - テキストを含む JtextComponent

pos - 次の位置の決定に使用される位置

bias - 次の位置の決定に使用されるバイアス

direction - 現在位置からの方向。これは、キーボード上に通常ある矢印キーと見なすことができ、

• SwingConstants.WEST
• SwingConstants.EAST
• SwingConstants.NORTH
• SwingConstants.SOUTH

のどれかになる

biasRet - 結果として得られる次の位置の Bias を返すために使用される

戻り値:

次の可視の位置をもっともよく表すモデル内の位置

例外:

BadLocationException

IllegalArgumentException - direction が上記の適正値のどれでもない場合