パッケージ jakarta.faces.component.visit

クラス VisitContextWrapper

  • 実装されたすべてのインターフェース:
    FacesWrapper<VisitContext>
    public abstract class VisitContextWrapper
extends VisitContext
implements FacesWrapper<VisitContext>

    既存の VisitContext インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができる VisitContext の簡単な実装を提供します。すべてのメソッドのデフォルト実装は、ラップされた VisitContext インスタンスを呼び出すことです。

    使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped() を使用してラップされているインスタンスにアクセスします。

    導入:
    2.0

    • コンストラクターの詳細

      • VisitContextWrapper

        @DeprecatedSE
public VisitContextWrapper()
        使用すべきではありません。
        ラップされている実装を使用する他のコンストラクターを使用します。

      • VisitContextWrapper

        public VisitContextWrapper​(VisitContext wrapped)

        この訪問コンテキストが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped() は、ラップされている実装を返します。

        パラメーター:
        wrapped - ラップされる実装。
        導入:
        2.3

    • メソッドの詳細

      • getWrapped

        public VisitContext getWrapped()
        インターフェースからコピーされた説明: FacesWrapper

        このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。

        次で指定:
        インターフェース FacesWrapper<VisitContext> の getWrapped 
        戻り値:
        ラップされたインスタンス。

      • getFacesContext

        public FacesContext getFacesContext()
        クラスからコピーされた説明: VisitContext

        現在のリクエストの FacesContext を返します。

        次で指定:
        クラス VisitContext の getFacesContext 
        戻り値:
        FacesContext。

      • getHints

        public SetSE<VisitHint> getHints()
        クラスからコピーされた説明: VisitContext

        ツリー訪問の動作に影響を与えるヒントを返します。

        UIComponent.visitTree() 実装などの関係者は、VisitContext.getHints().contains() を呼び出して VisitHint で定義されたヒントの 1 つを渡すことにより、特定のヒントが存在するかどうかを確認できます。

        次で指定:
        クラス VisitContext の getHints 
        戻り値:
        空ではなく、変更できない VisitHints のコレクション

      • getIdsToVisit

        public CollectionSE<StringSE> getIdsToVisit()
        クラスからコピーされた説明: VisitContext

        アクセスするコンポーネントの ID を返します。

        完全なツリーアクセスの場合、このメソッドは ALL_IDS コレクションを返します。それ以外の場合、部分的なアクセスが実行されると、アクセスする必要があるコンポーネントのクライアント ID を含む変更可能なコレクションを返します。

        次で指定:
        クラス VisitContext の getIdsToVisit 
        戻り値:
        訪問するコンポーネントの ID

      • getSubtreeIdsToVisit

        public CollectionSE<StringSE> getSubtreeIdsToVisit​(UIComponent component)
        クラスからコピーされた説明: VisitContext

        NamingContainer コンポーネントを指定すると、アクセスする必要がある NamingContainer のすべてのコンポーネントのクライアント ID を返します。

        このメソッドは、NamingContainer にアクセスするコンポーネントが含まれているかどうかを判断するために、NamingContainer visitTree() 実装によって呼び出されます。そのようなコンポーネントが存在しない場合、NamingContainer はツリーの訪問を短絡し、子サブツリーへの下降を回避できます。

        さらに、UIData などの反復コンポーネントは、返された ID を使用して、どの反復状態（つまり行）にアクセスする必要があるかを判断できる場合があります。これにより、訪問トラバーサルを制約することができ、訪問ターゲットを含む行のみをトラバースする必要があります。

        次で指定:
        クラス VisitContext の getSubtreeIdsToVisit 
        パラメーター:
        component - NamingContainer コンポーネント
        戻り値:
        ツリーの訪問のターゲットであることがわかっている NamingContainer のコンポーネントのクライアント ID を含む変更不可能なコレクション。そのようなコンポーネントが存在しない場合は、空のコレクションを返します。NamingContainer のすべてのコンポーネントにアクセスする必要がある場合は、VisitContext.ALL_IDS コレクションを返します。

      • invokeVisitCallback

        public VisitResult invokeVisitCallback​(UIComponent component,
                                       VisitCallback callback)
        クラスからコピーされた説明: VisitContext

        単一のコンポーネントを訪問するために UIComponent.visitTree() によって呼び出されます。

        次で指定:
        クラス VisitContext の invokeVisitCallback 
        パラメーター:
        component - 訪問するコンポーネント
        callback - 呼び出す VisitCallback
        戻り値:
        コンポーネントのサブツリーへのアクセスを続行するか、コンポーネントのサブツリーへのアクセスをスキップするか、訪問を完全に中止するかを示す VisitResult 値。