public abstract class ConfigurableNavigationHandlerWrapper extends ConfigurableNavigationHandler implements FacesWrapper<ConfigurableNavigationHandler>
既存の ConfigurableNavigationHandler
インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができる ConfigurableNavigationHandler
の簡単な実装を提供します。すべてのメソッドのデフォルトの実装では、ラップされた ConfigurableNavigationHandler
を呼び出します。
使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped()
を使用してラップされているインスタンスにアクセスします。
コンストラクターと説明 |
---|
ConfigurableNavigationHandlerWrapper() 使用すべきではありません。 ラップされている実装を使用する他のコンストラクターを使用します。 |
ConfigurableNavigationHandlerWrapper(ConfigurableNavigationHandler wrapped) この構成可能なナビゲーションハンドラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。 |
修飾子と型 | メソッドと説明 |
---|---|
NavigationCase | getNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome) 同じ引数で |
NavigationCase | getNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome, StringSE toFlowDocumentId) 同じ引数で |
MapSE<StringSE, SetSE<NavigationCase>> | getNavigationCases() キーが |
ConfigurableNavigationHandler | getWrapped() このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。 |
void | handleNavigation(FacesContext context, StringSE fromAction, StringSE outcome) 指定された FacesContext の状態情報に加えて実行されるアプリケーションのアクションによって返された結果の文字列に基づいて、ナビゲーション処理を実行します。 |
void | inspectFlow(FacesContext context, Flow flow) フローシステムによって呼び出され、ナビゲーションルールについてフローをインスペクションします。 |
void | performNavigation(StringSE outcome) Jakarta Server Faces 実装にシグナルを送り、提供された結果でナビゲーションを実行するための便利なメソッド。 |
handleNavigation
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
@DeprecatedSE public ConfigurableNavigationHandlerWrapper()
public ConfigurableNavigationHandlerWrapper(ConfigurableNavigationHandler wrapped)
この構成可能なナビゲーションハンドラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped()
は、ラップされている実装を返します。
wrapped
- ラップされる実装。public ConfigurableNavigationHandler getWrapped()
FacesWrapper
このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
FacesWrapper<ConfigurableNavigationHandler>
の getWrapped
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
。public MapSE<StringSE,SetSE<NavigationCase>> getNavigationCases()
ConfigurableNavigationHandler
キーが <from-view-id>
値であり、値が Set<NavigationCase>
である Map<String, Set<NavigationCase>>
を返します。ここで、セット内の各要素は、その <from-view-id>
に適用される NavigationCase
です。実装は、この Map
へのライブ変更をサポートする必要があります。
ConfigurableNavigationHandler
の getNavigationCases
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
。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
かもしれません)public void performNavigation(StringSE outcome)
ConfigurableNavigationHandler
提供された結果を使用してナビゲーションを実行するように Jakarta Server Faces 実装に通知する便利なメソッド。NavigationHandler が呼び出されると、現在の viewId は "from viewId" として扱われ、「from アクション」は null になります。
ConfigurableNavigationHandler
の performNavigation
outcome
- 提供された結果。public void inspectFlow(FacesContext context, Flow flow)
ConfigurableNavigationHandler
フローシステムによって呼び出され、フローのナビゲーションルールがインスペクションされます。以前の実装との下位互換性のために、空のメソッドが提供されています。
ConfigurableNavigationHandler
の inspectFlow
context
- Faces コンテキスト。flow
- 流れ。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.