javax.swing
クラス SortingFocusTraversalPolicy

java.lang.Object
  |
  +--java.awt.FocusTraversalPolicy
        |
        +--javax.swing.InternalFrameFocusTraversalPolicy
              |
              +--javax.swing.SortingFocusTraversalPolicy

直系の既知のサブクラス:

LayoutFocusTraversalPolicy

public class SortingFocusTraversalPolicy

extends InternalFrameFocusTraversalPolicy

特定の Comparator に基づいてフォーカストラバーサルサイクルの Component をソートすることによってトラバーサルの順序を判定する FocusTraversalPolicy です。Component の階層のうち、可視でも表示可能でもない部分は含まれません。

SortingFocusTraversalPolicy は、デフォルトの場合、暗黙にフォーカスをダウンサイクルで移動します。つまり、通常のフォーカストラバーサルの場合、フォーカスサイクルのルートのあとにトラバースされる Component は、フォーカスサイクルのルートがフォーカスするデフォルトの Component です。setImplicitDownCycleTraversal メソッドでこの動作を無効にすることができます。

デフォルトでは、このクラスのメソッドは、可視性、表示可能性、使用可能性、フォーカス可能性のすべてを満たす場合だけ、Component を返します。サブクラスでこの動作を変更するには、accept メソッドをオーバーライドします。

導入されたバージョン:

1.4

関連項目:

Comparator

コンストラクタの概要

protected	SortingFocusTraversalPolicy() Comparator を使わずに SortingFocusTraversalPolicy を構築します。
	SortingFocusTraversalPolicy(Comparator comparator) 指定された Comparator で SortingFocusTraversalPolicy を構築します。

メソッドの概要

protected boolean	accept(Component aComponent) Component が新しいフォーカスオーナとして適切かどうかを判定します。
protected Comparator	getComparator() フォーカストラバーサルサイクルで Components をソートするために使う Comparator を返します。
Component	getComponentAfter(Container focusCycleRoot, Component aComponent) aComponent のあとでフォーカスを受け取る Component を返します。
Component	getComponentBefore(Container focusCycleRoot, Component aComponent) aComponent の前にフォーカスを受け取る Component を返します。
Component	getDefaultComponent(Container focusCycleRoot) フォーカスするデフォルトの Component を返します。
Component	getFirstComponent(Container focusCycleRoot) トラバーサルサイクルの最初の Component を返します。
boolean	getImplicitDownCycleTraversal() この SortingFocusTraversalPolicy がフォーカスを暗黙にダウンサイクルで移動するかどうかを返します。
Component	getLastComponent(Container focusCycleRoot) トラバーサルサイクルの最後の Component を返します。
protected void	setComparator(Comparator comparator) フォーカストラバーサルサイクルで Components をソートするために使う Comparator を設定します。
void	setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal) この SortingFocusTraversalPolicy がフォーカスを暗黙にダウンサイクルで移動するかどうかを設定します。

クラス javax.swing.InternalFrameFocusTraversalPolicy から継承したメソッド

getInitialComponent

クラス java.awt.FocusTraversalPolicy から継承したメソッド

getInitialComponent

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

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

コンストラクタの詳細

SortingFocusTraversalPolicy

protected SortingFocusTraversalPolicy()

Comparator を使わずに SortingFocusTraversalPolicy を構築します。サブクラスは、フォーカスサイクルのルートまたは KeyboardFocusManager にこの FocusTraversalPolicy をインストールする前に、setComparator で Comparator を設定する必要があります。

SortingFocusTraversalPolicy

public SortingFocusTraversalPolicy(Comparator comparator)

指定された Comparator で SortingFocusTraversalPolicy を構築します。

メソッドの詳細

getComponentAfter

public Component getComponentAfter(Container focusCycleRoot,
                                   Component aComponent)

aComponent のあとでフォーカスを受け取る Component を返します。focusCycleRoot には、フォーカスサイクルのルートを指定する必要があります。

SortingFocusTraversalPolicy は、デフォルトの場合、暗黙にフォーカスをダウンサイクルで移動します。つまり、通常のフォーカストラバーサルの場合、フォーカスサイクルのルートのあとにトラバースされる Component は、フォーカスサイクルのルートがフォーカスするデフォルトの Component です。setImplicitDownCycleTraversal メソッドでこの動作を無効にすることができます。

定義:

クラス FocusTraversalPolicy 内の getComponentAfter

パラメータ:

focusCycleRoot - aComponent のフォーカスサイクルのルート

aComponent - focusCycleRoot のおそらく間接的な子または focusCycleRoot 自身

戻り値:

aComponent のあとにフォーカスを受け取る Component。適切な Component が見つからない場合は null

例外:

IllegalArgumentException - focusCycleRoot が aComponent のフォーカスサイクルのルートでない場合、あるいは focusCycleRoot または aComponent が null の場合

getComponentBefore

public Component getComponentBefore(Container focusCycleRoot,
                                    Component aComponent)

aComponent の前にフォーカスを受け取る Component を返します。focusCycleRoot には、フォーカスサイクルのルートを指定する必要があります。

SortingFocusTraversalPolicy は、デフォルトの場合、暗黙にフォーカスをダウンサイクルで移動します。つまり、通常のフォーカストラバーサルの場合、フォーカスサイクルのルートのあとにトラバースされる Component は、フォーカスサイクルのルートがフォーカスするデフォルトの Component です。setImplicitDownCycleTraversal メソッドでこの動作を無効にすることができます。

定義:

クラス FocusTraversalPolicy 内の getComponentBefore

パラメータ:

focusCycleRoot - aComponent のフォーカスサイクルのルート

aComponent - focusCycleRoot のおそらく間接的な子または focusCycleRoot 自身

戻り値:

aComponent の前にフォーカスを受け取る Component。適切な Component が見つからない場合は null

例外:

IllegalArgumentException - focusCycleRoot が aComponent のフォーカスサイクルのルートでない場合、あるいは focusCycleRoot または aComponent が null の場合

getFirstComponent

public Component getFirstComponent(Container focusCycleRoot)

トラバーサルサイクルの最初の Component を返します。このメソッドは、順方向のトラバーサルがラップするときに、次にフォーカスする Component を判定するために使用します。

定義:

クラス FocusTraversalPolicy 内の getFirstComponent

パラメータ:

focusCycleRoot - 最初の Component に戻すフォーカスサイクルのルート

戻り値:

focusCycleRoot がフォーカスサイクルのルートの場合はトラバーサルサイクルの最初の Component、適切な Component が見つからない場合は null

例外:

IllegalArgumentException - focusCycleRoot が null の場合

getLastComponent

public Component getLastComponent(Container focusCycleRoot)

トラバーサルサイクルの最後の Component を返します。このメソッドは、逆方向のトラバーサルがラップするときに、次にフォーカスする Component を判定するために使用します。

定義:

クラス FocusTraversalPolicy 内の getLastComponent

パラメータ:

focusCycleRoot - 最後の Component に戻すフォーカスサイクルのルート

戻り値:

focusCycleRoot がフォーカスサイクルのルートの場合はトラバーサルサイクルの最後の Component、適切な Component が見つからない場合は null

例外:

IllegalArgumentException - focusCycleRoot が null の場合

getDefaultComponent

public Component getDefaultComponent(Container focusCycleRoot)

フォーカスするデフォルトの Component を返します。focusCycleRoot にルートがある新しいフォーカストラバーサルサイクルにトラバースするとき、この Component は最初にフォーカスを受け取ります。このメソッドのデフォルトの実装は、getFirstComponent と同じ Component を返します。

定義:

クラス FocusTraversalPolicy 内の getDefaultComponent

パラメータ:

focusCycleRoot - デフォルトの Component を返すフォーカスサイクルのルート

戻り値:

focusCycleRoot がフォーカスサイクルのルートの場合はトラバーサルサイクルのデフォルトの Component、適切な Component が見つからない場合は null

例外:

IllegalArgumentException - focusCycleRoot が null の場合

関連項目:

getFirstComponent(java.awt.Container)

setImplicitDownCycleTraversal

public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)

この SortingFocusTraversalPolicy がフォーカスを暗黙にダウンサイクルで移動するかどうかを設定します。true の場合、通常のフォーカストラバーサルでは、フォーカスサイクルのルートのあとにトラバースされる Component は、フォーカスサイクルのルートからフォーカスを受け取るデフォルトの Component です。false の場合、指定されたフォーカスサイクルのルートにルートを持つフォーカストラバーサルサイクルの次の Component が代わりにトラバースされます。このプロパティのデフォルト値は true です。

パラメータ:

implicitDownCycleTraversal - この SortingFocusTraversalPolicy が暗黙にフォーカスをダウンサイクルで移動するかどうか

関連項目:

getImplicitDownCycleTraversal(), getFirstComponent(java.awt.Container)

getImplicitDownCycleTraversal

public boolean getImplicitDownCycleTraversal()

この SortingFocusTraversalPolicy がフォーカスを暗黙にダウンサイクルで移動するかどうかを返します。true の場合、通常のフォーカストラバーサルでは、フォーカスサイクルのルートのあとにトラバースされる Component は、フォーカスサイクルのルートからフォーカスを受け取るデフォルトの Component です。false の場合、指定されたフォーカスサイクルのルートにルートを持つフォーカストラバーサルサイクルの次の Component が代わりにトラバースされます。

戻り値:

この SortingFocusTraversalPolicy が暗黙にフォーカスをダウンサイクルで移動するかどうか

関連項目:

setImplicitDownCycleTraversal(boolean), getFirstComponent(java.awt.Container)

setComparator

protected void setComparator(Comparator comparator)

フォーカストラバーサルサイクルで Components をソートするために使う Comparator を設定します。

パラメータ:

comparator - ソートに使う Comparator

getComparator

protected Comparator getComparator()

フォーカストラバーサルサイクルで Components をソートするために使う Comparator を返します。

戻り値:

ソートに使う Comparator

accept

protected boolean accept(Component aComponent)

Component が新しいフォーカスオーナとして適切かどうかを判定します。デフォルトでは、可視性、表示可能性、使用可能性、フォーカス可能性のすべてを満たす場合だけ、Component を受け入れます。

パラメータ:

aComponent - フォーカスオーナとして適切かどうかを判定する Component

戻り値:

aComponent が可視、表示可能、使用可能、フォーカス可能な場合は true、そうでない場合は false