モジュール java.desktop

パッケージ 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が前述の正当な値のどれでもない場合