パッケージ jakarta.faces.application

クラス NavigationCaseWrapper

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

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

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

    導入:
    2.2

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

      • NavigationCaseWrapper

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

      • NavigationCaseWrapper

        public NavigationCaseWrapper​(NavigationCase wrapped)

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

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

    • メソッドの詳細

      • getWrapped

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

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

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

      • getCondition

        public BooleanSE getCondition​(FacesContext context)
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> の <if> を評価します（ある場合）。評価される式は、文字列としてコンストラクターに渡されます。式が評価されるとき、その値は通常の Jakarta Expression Language 強制ルールに従って boolean に強制変換される必要があります。

        Note は、式の評価またはその値の取得プロセス中に発生した例外をスローします。
        オーバーライド:
        クラス NavigationCase の getCondition 
        パラメーター:
        context - 現在のリクエストの FacesContext
        戻り値:
        この <navigation-case> に関連付けられている <if> 要素がない場合は null、それ以外の場合は条件の評価結果を返します

      • getFromAction

        public StringSE getFromAction()
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> の <from-action> を返します

        オーバーライド:
        クラス NavigationCase の getFromAction 
        戻り値:
        from アクション。

      • getFromOutcome

        public StringSE getFromOutcome()
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> の <from-outcome> を返します

        オーバーライド:
        クラス NavigationCase の getFromOutcome 
        戻り値:
        からの結果。

      • getFromViewId

        public StringSE getFromViewId()
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> がネストされている <navigation-rule> の <from-view-id> を返します。

        オーバーライド:
        クラス NavigationCase の getFromViewId 
        戻り値:
        viedId から。

      • getParameters

        public MapSE<StringSE,​ListSE<StringSE>> getParameters()
        クラスからコピーされた説明: NavigationCase

        リダイレクトが必要なナビゲーションケースに含めるパラメーターを返します。パラメーターが定義されていない場合、null が返されます。Map のキーはパラメーター名です。各キーの対応する値は、変換されていない値の List です。

        オーバーライド:
        クラス NavigationCase の getParameters 
        戻り値:
        パラメーターのリスト、または null

      • getToViewId

        public StringSE getToViewId​(FacesContext context)
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> の <to-view-id> を評価します

        オーバーライド:
        クラス NavigationCase の getToViewId 
        パラメーター:
        context - 現在のリクエストの FacesContext
        戻り値:
        ナビゲートするビュー ID

      • getToFlowDocumentId

        public StringSE getToFlowDocumentId()
        クラスからコピーされた説明: NavigationCase

        このナビゲーションケースがフロー呼び出しを表す場合、このプロパティは、NavigationCase.getFromOutcome() からの戻り値によって ID が指定されたフローが定義されている documentId です。実装では、このメソッドをオーバーライドして、対応するアプリケーション構成リソース要素で定義された値を返す必要があります。基本実装では、空の文字列が返されます。

        オーバーライド:
        クラス NavigationCase の getToFlowDocumentId 
        戻り値:
        toFlow ドキュメント ID。

      • hasCondition

        public boolean hasCondition()
        クラスからコピーされた説明: NavigationCase

        このナビゲーションケースに関連付けられた <if> 要素があるかどうかをテストします。

        オーバーライド:
        クラス NavigationCase の hasCondition 
        戻り値:
        この <navigation-case> に関連付けられている <if> 要素がある場合は true、それ以外の場合は false

      • isIncludeViewParams

        public boolean isIncludeViewParams()
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> の <redirect> 値を返します。ビューのパラメーターをリダイレクト URL にエンコードする必要がある場合、これは true になります。(リダイレクトの場合にのみ適用されます)

        オーバーライド:
        クラス NavigationCase の isIncludeViewParams 
        戻り値:
        ビューパラメーターを含める場合は true、それ以外の場合は false。

      • isRedirect

        public boolean isRedirect()
        クラスからコピーされた説明: NavigationCase

        この <navigation-case> の <redirect> 値を返します。新しいビューに ExternalContext.redirect(String) を介してナビゲートする必要がある場合、これは true になります。

        オーバーライド:
        クラス NavigationCase の isRedirect 
        戻り値:
        これがリダイレクトの場合は true、それ以外の場合は false。