public abstract class VisitContextWrapper extends VisitContext implements FacesWrapper<VisitContext>
既存の VisitContext
インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができる VisitContext
の簡単な実装を提供します。すべてのメソッドのデフォルト実装は、ラップされた VisitContext
インスタンスを呼び出すことです。
使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped()
を使用してラップされているインスタンスにアクセスします。
ALL_IDS
コンストラクターと説明 |
---|
VisitContextWrapper() 使用すべきではありません。 ラップされている実装を使用する他のコンストラクターを使用します。 |
VisitContextWrapper(VisitContext wrapped) この訪問コンテキストが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。 |
修飾子と型 | メソッドと説明 |
---|---|
FacesContext | getFacesContext() 現在のリクエストの FacesContext を返します。 |
SetSE<VisitHint> | getHints() ツリー訪問の動作に影響を与えるヒントを返します。 |
CollectionSE<StringSE> | getIdsToVisit() アクセスするコンポーネントの ID を返します。 |
CollectionSE<StringSE> | getSubtreeIdsToVisit(UIComponent component)
|
VisitContext | getWrapped() このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。 |
VisitResult | invokeVisitCallback(UIComponent component, VisitCallback callback) 単一のコンポーネントを訪問するために UIComponent.visitTree() によって呼び出されます。 |
createVisitContext, createVisitContext
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
@DeprecatedSE public VisitContextWrapper()
public VisitContextWrapper(VisitContext wrapped)
この訪問コンテキストが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped()
は、ラップされている実装を返します。
wrapped
- ラップされる実装。public VisitContext getWrapped()
FacesWrapper
このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
FacesWrapper<VisitContext>
の getWrapped
public FacesContext getFacesContext()
VisitContext
現在のリクエストの FacesContext を返します。
VisitContext
の getFacesContext
public SetSE<VisitHint> getHints()
VisitContext
ツリー訪問の動作に影響を与えるヒントを返します。
UIComponent.visitTree()
実装などの関係者は、VisitContext.getHints().contains()
を呼び出して VisitHint
で定義されたヒントの 1 つを渡すことにより、特定のヒントが存在するかどうかを確認できます。
VisitContext
の getHints
public CollectionSE<StringSE> getIdsToVisit()
VisitContext
アクセスするコンポーネントの ID を返します。
完全なツリーアクセスの場合、このメソッドは ALL_IDS コレクションを返します。それ以外の場合、部分的なアクセスが実行されると、アクセスする必要があるコンポーネントのクライアント ID を含む変更可能なコレクションを返します。
VisitContext
の getIdsToVisit
public CollectionSE<StringSE> getSubtreeIdsToVisit(UIComponent component)
VisitContext
NamingContainer
コンポーネントを指定すると、アクセスする必要がある NamingContainer のすべてのコンポーネントのクライアント ID を返します。
このメソッドは、NamingContainer にアクセスするコンポーネントが含まれているかどうかを判断するために、NamingContainer visitTree() 実装によって呼び出されます。そのようなコンポーネントが存在しない場合、NamingContainer はツリーの訪問を短絡し、子サブツリーへの下降を回避できます。
さらに、UIData などの反復コンポーネントは、返された ID を使用して、どの反復状態(つまり行)にアクセスする必要があるかを判断できる場合があります。これにより、訪問トラバーサルを制約することができ、訪問ターゲットを含む行のみをトラバースする必要があります。
VisitContext
の getSubtreeIdsToVisit
component
- NamingContainer コンポーネント VisitContext.ALL_IDS
コレクションを返します。public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback)
VisitContext
単一のコンポーネントを訪問するために UIComponent.visitTree()
によって呼び出されます。
VisitContext
の invokeVisitCallback
component
- 訪問するコンポーネント callback
- 呼び出す VisitCallbackCopyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.