パッケージ jakarta.faces.application

クラス NavigationHandlerWrapper

java.lang.ObjectSE
jakarta.faces.application.NavigationHandler
jakarta.faces.application.NavigationHandlerWrapper
実装されたすべてのインターフェース:
FacesWrapper<NavigationHandler>
public abstract class NavigationHandlerWrapper extends NavigationHandler implements FacesWrapper<NavigationHandler>

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

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

導入:
2.2

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

    • NavigationHandlerWrapper

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

    • NavigationHandlerWrapper

      public NavigationHandlerWrapper(NavigationHandler wrapped)

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

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

  • メソッドの詳細

    • getWrapped

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

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

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

    • handleNavigation

      public void handleNavigation(FacesContext context, StringSE fromAction, StringSE outcome)
      クラスからコピーされた説明: NavigationHandler

      指定された FacesContext の状態情報に加えて実行されるアプリケーションのアクションによって返された結果の文字列に基づいて、ナビゲーション処理を実行します。

      実装クラスも ConfigurableNavigationHandler を継承する場合、実装は、正しいナビゲーションを決定するために、ConfigurableNavigationHandler.getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) の呼び出しで使用されるロジックがこのメソッドで使用されることを保証する必要があります。

      アプリケーションアクションの結果としてビュー識別子が変更された場合（Ajax requests を考慮に入れるため）、このメソッドはレンダーターゲット（部分的なレンダリングで使用される）を render all  （PartialViewContext.setRenderAll(boolean) を呼び出す）に設定する必要があります。

      次で指定:
      クラス NavigationHandler の handleNavigation 
      パラメーター:
      context - 現在のリクエストの FacesContext
      fromAction - 指定された結果を取得するために評価されたアクションバインディング式、または結果が他の手段で取得された場合は null 
      outcome - 以前に呼び出されたアプリケーションアクションによって返された論理結果 (null かもしれません)

    • handleNavigation

      public void handleNavigation(FacesContext context, StringSE fromAction, StringSE outcome, StringSE toFlowDocumentId)
      クラスからコピーされた説明: NavigationHandler

      呼び出し元がこのナビゲーションによって入力されるフローの定義ドキュメント ID を提供できるようにする NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) のオーバーロードされたバリアント。以前のバージョンの仕様に準拠する装飾された NavigationHandler 実装との下位互換性のために、toFlowDocumentId パラメーターを無視して NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) を呼び出す実装が提供されています。

      オーバーライド:
      クラス NavigationHandler の handleNavigation 
      パラメーター:
      context - 現在のリクエストの FacesContext
      fromAction - 指定された結果を取得するために評価されたアクションバインディング式、または結果が他の手段で取得された場合は null 
      outcome - 以前に呼び出されたアプリケーションアクションによって返された論理結果 (null かもしれません)
      toFlowDocumentId - このナビゲーションによってエントリが発生するフローの定義ドキュメント ID。