java.awt
クラス ContainerOrderFocusTraversalPolicy

java.lang.Object
  |
  +--java.awt.FocusTraversalPolicy
        |
        +--java.awt.ContainerOrderFocusTraversalPolicy

すべての実装インタフェース:

Serializable

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

DefaultFocusTraversalPolicy

public class ContainerOrderFocusTraversalPolicy

extends FocusTraversalPolicy

implements Serializable

コンテナの子コンポーネントの順序を基準に、トラバーサル順序を決定する FocusTraversalPolicy です。特定のフォーカスサイクルルートから、コンポーネント階層のトラバーサルを事前に決定し、Container.getComponents() で返された配列の順序に従ってコンテナの子をトラバースします。階層の非表示部分は検索されません。

デフォルトでは、ContainerOrderFocusTraversalPolicy はフォーカスをダウンサイクル転送します。つまり通常のフォワードフォーカストラバーサルでは、フォーカスサイクルルートの後でトラバースされるコンポーネントが、フォーカスサイクルルートのデフォルトフォーカスコンポーネントになります。この動作は setImplicitDownCycleTraversal メソッドで無効化できます。

デフォルトでは、このクラスのメソッドは、コンポーネントが表示状態であり、有効化されており、フォーカス設定可能な場合だけ返されます。サブクラスで accept メソッドをオーバーライドするとこの動作を変更できます。

導入されたバージョン:

1.4

関連項目:

Container.getComponents(), 直列化された形式

コンストラクタの概要

ContainerOrderFocusTraversalPolicy()

メソッドの概要

protected boolean	accept(Component aComponent) コンポーネントが新しいフォーカス所有者として適切かどうかを判定します。
Component	getComponentAfter(Container focusCycleRoot, Component aComponent) aComponent の後にフォーカスを取得するコンポーネントを返します。
Component	getComponentBefore(Container focusCycleRoot, Component aComponent) aComponent の前にフォーカスを取得するコンポーネントを返します。
Component	getDefaultComponent(Container focusCycleRoot) フォーカス対象のデフォルトコンポーネントを返します。
Component	getFirstComponent(Container focusCycleRoot) トラバーサルサイクルの最初のコンポーネントを返します。
boolean	getImplicitDownCycleTraversal() この ContainerOrderFocusTraversalPolicy が、フォーカスダウンサイクルを暗黙に転送するかどうかを返します。
Component	getLastComponent(Container focusCycleRoot) トラバーサルサイクルの最後のコンポーネントを返します。
void	setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal) この ContainerOrderFocusTraversalPolicy が、フォーカスダウンサイクルを暗黙に転送するかどうかを設定します。

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

getInitialComponent

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

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

コンストラクタの詳細

ContainerOrderFocusTraversalPolicy

public ContainerOrderFocusTraversalPolicy()

メソッドの詳細

getComponentAfter

public Component getComponentAfter(Container focusCycleRoot,
                                   Component aComponent)

aComponent の後にフォーカスを取得するコンポーネントを返します。FocusCycleRoot は aComponent のフォーカスサイクルルートである必要があります。

デフォルトでは、ContainerOrderFocusTraversalPolicy はフォーカスをダウンサイクル転送します。つまり通常のフォワードフォーカストラバーサルでは、フォーカスサイクルルートの後でトラバースされるコンポーネントが、フォーカスサイクルルートのデフォルトフォーカスコンポーネントになります。この動作は setImplicitDownCycleTraversal メソッドで無効化できます。

定義:

クラス FocusTraversalPolicy 内の getComponentAfter

パラメータ:

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

aComponent - focusCycleRoot の子 (間接的な子の場合あり)、または focusCycleRoot 自身

戻り値:

aComponent の後でフォーカスを取得するコンポーネント。適切なコンポーネントが見つからない場合は null

例外:

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

getComponentBefore

public Component getComponentBefore(Container focusCycleRoot,
                                    Component aComponent)

aComponent の前にフォーカスを取得するコンポーネントを返します。FocusCycleRoot は aComponent のフォーカスサイクルルートである必要があります。

定義:

クラス FocusTraversalPolicy 内の getComponentBefore

パラメータ:

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

aComponent - focusCycleRoot の子 (間接的な子の場合あり)、または focusCycleRoot 自身

戻り値:

aComponent の前にフォーカスを取得するコンポーネント。適切なコンポーネントが見つからない場合は null

例外:

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

getFirstComponent

public Component getFirstComponent(Container focusCycleRoot)

トラバーサルサイクルの最初のコンポーネントを返します。このメソッドはフォワードトラバーサルで最後のコンポーネントに到達した時に、次のコンポーネントにフォーカス設定するために使用されます。

定義:

クラス FocusTraversalPolicy 内の getFirstComponent

パラメータ:

focusCycleRoot - 最初のコンポーネントを返すフォーカスサイクルルート

戻り値:

focusCycleRoot がフォーカスサイクルルートの時はトラバーサルサイクルの最初のコンポーネント。適切なコンポーネントを検索できない時は null

例外:

IllegalArgumentException - focusCycleRoot が null の場合

getLastComponent

public Component getLastComponent(Container focusCycleRoot)

トラバーサルサイクルの最後のコンポーネントを返します。このメソッドは逆方向のトラバーサルで最初のコンポーネントに到達した時に、次のコンポーネントにフォーカス設定するために使用されます。

定義:

クラス FocusTraversalPolicy 内の getLastComponent

パラメータ:

focusCycleRoot - 最後のコンポーネントを返すフォーカスサイクルルート

戻り値:

focusCycleRoot がフォーカスサイクルルートの時はトラバーサルサイクルの最後のコンポーネント。適切なコンポーネントを検索できない時は null

例外:

IllegalArgumentException - focusCycleRoot が null の場合

getDefaultComponent

public Component getDefaultComponent(Container focusCycleRoot)

フォーカス対象のデフォルトコンポーネントを返します。このコンポーネントは focusCycleRoot を起点にした新しいフォーカストラバーサルサイクル開始時に最初にフォーカスを取得します。このメソッドのデフォルト実装では getFirstComponent と同じコンポーネントを返します。

定義:

クラス FocusTraversalPolicy 内の getDefaultComponent

パラメータ:

focusCycleRoot - デフォルトコンポーネントを返すフォーカスサイクルルート

戻り値:

focusCycleRoot がフォーカスサイクルルートの時はトラバーサルサイクルのデフォルトコンポーネント。適切なコンポーネントを検索できない時は null

例外:

IllegalArgumentException - focusCycleRoot が null の場合

関連項目:

getFirstComponent(java.awt.Container)

setImplicitDownCycleTraversal

public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)

この ContainerOrderFocusTraversalPolicy が、フォーカスダウンサイクルを暗黙に転送するかどうかを設定します。true の場合、通常のフォワードフォーカストラバーサルでは、フォーカスサイクルルートの後にトラバースされるコンポーネントは、フォーカスサイクルルートのデフォルトフォーカスコンポーネントになります。false の場合、指定されたフォーカスサイクルルートの、フォーカストラバーサルサイクルの次のコンポーネントがトラバースされます。このプロパティのデフォルト値は true です。

パラメータ:

implicitDownCycleTraversal - この ContainerOrderFocusTraversalPolicy がフォーカスダウンサイクルを暗黙に転送するかどうか

関連項目:

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

getImplicitDownCycleTraversal

public boolean getImplicitDownCycleTraversal()

この ContainerOrderFocusTraversalPolicy が、フォーカスダウンサイクルを暗黙に転送するかどうかを返します。true の場合、通常のフォワードフォーカストラバーサルでは、フォーカスサイクルルートの後にトラバースされるコンポーネントは、フォーカスサイクルルートのデフォルトフォーカスコンポーネントになります。false の場合、指定されたフォーカスサイクルルートの、フォーカストラバーサルサイクルの次のコンポーネントがトラバースされます。

戻り値:

この ContainerOrderFocusTraversalPolicy がフォーカスダウンサイクルを暗黙に転送するかどうか

関連項目:

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

accept

protected boolean accept(Component aComponent)

コンポーネントが新しいフォーカス所有者として適切かどうかを判定します。デフォルトではこのメソッドは、コンポーネントが表示状態であり、有効化されており、フォーカス設定可能な場合のみ適切とみなします。

パラメータ:

aComponent - フォーカス所有者として適切かどうかが判定されるコンポーネント

戻り値:

aComponent が表示状態であり、有効化されており、フォーカス設定可能な場合は true、そうでない場合は false