パッケージ jakarta.faces.application

クラス ConfigurableNavigationHandlerWrapper

java.lang.ObjectSE
jakarta.faces.application.NavigationHandler
jakarta.faces.application.ConfigurableNavigationHandler
jakarta.faces.application.ConfigurableNavigationHandlerWrapper
実装済みのインターフェース一覧:
FacesWrapper<ConfigurableNavigationHandler>
public abstract class ConfigurableNavigationHandlerWrapper extends ConfigurableNavigationHandler implements FacesWrapper<ConfigurableNavigationHandler>

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

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

導入:
2.2

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

    • ConfigurableNavigationHandlerWrapper

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

    • ConfigurableNavigationHandlerWrapper

      public ConfigurableNavigationHandlerWrapper(ConfigurableNavigationHandler wrapped)

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

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

  • 方法の詳細

    • getWrapped

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

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

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

    • getNavigationCase

      public NavigationCase getNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome)
      クラスからコピーされた説明: ConfigurableNavigationHandler

      同じ引数で NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) が呼び出された場合にとられるナビゲーションを表す NavigationCase を返します。そのようなケースがない場合は null を返します。

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

    • getNavigationCases

      public MapSE<StringSE,SetSE<NavigationCase>> getNavigationCases()
      クラスからコピーされた説明: ConfigurableNavigationHandler

      キーが <from-view-id> 値であり、値が Set<NavigationCase> である Map<String, Set<NavigationCase>> を返します。ここで、セット内の各要素は、その <from-view-id> に適用される NavigationCase です。実装は、この Map へのライブ変更をサポートする必要があります。

      次で指定:
      クラス ConfigurableNavigationHandler の getNavigationCases 
      戻り値:
      ナビゲーションケース付きの地図。

    • getNavigationCase

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

      NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) が同じ引数で呼び出された場合に実行されるナビゲーションを表す NavigationCase を返します。そのような場合がない場合は、null を返します。このメソッドが導入された仕様のバージョンに準拠する実装は、このメソッドをオーバーライドする必要があります。以前のバージョンの仕様に準拠する装飾された実装との互換性のために、toFlowDocumentId パラメーターを無視して ConfigurableNavigationHandler.getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) を呼び出すだけの実装が提供されています。

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

    • 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 かもしれません)

    • performNavigation

      public void performNavigation(StringSE outcome)
      クラスからコピーされた説明: ConfigurableNavigationHandler

      提供された結果を使用してナビゲーションを実行するように Jakarta Faces 実装に通知する便利なメソッド。NavigationHandler が呼び出されると、現在の viewId は "from viewId" として扱われ、「from アクション」は null になります。

      オーバーライド:
      クラス ConfigurableNavigationHandler の performNavigation 
      パラメーター:
      outcome - 提供された結果。

    • inspectFlow

      public void inspectFlow(FacesContext context, Flow flow)
      クラスからコピーされた説明: ConfigurableNavigationHandler

      フローシステムによって呼び出され、フローのナビゲーションルールがインスペクションされます。以前の実装との下位互換性のために、空のメソッドが提供されています。

      オーバーライド:
      クラス ConfigurableNavigationHandler の inspectFlow 
      パラメーター:
      context - Faces コンテキスト。
      flow - 流れ。