パッケージ jakarta.faces.context

クラス PartialViewContext

  • 既知の直属サブクラス
    PartialViewContextWrapper
    public abstract class PartialViewContext
extends ObjectSE

    PartialViewContext には、ビューでの部分的なリクエスト処理と部分的なレスポンスレンダリングに関連するメソッドとプロパティが含まれています。

    PartialViewContext インスタンスは、現在のリクエストが partial processing および / または partial rendering を実行するための要件を示しているかどうかを判別するために使用されます。部分処理は、リクエスト処理ライフサイクルの execute 部分を介した選択されたコンポーネントの処理です。部分レンダリングは、リクエスト処理ライフサイクルの Render Response Phase で指定されたコンポーネントのレンダリングです。

    • フィールドの詳細

      • PARTIAL_EVENT_PARAM_NAME

        public static final StringSE PARTIAL_EVENT_PARAM_NAME

        リクエストパラメーター値が部分イベントの型を識別するリクエストパラメーター名。

        導入:
        2.3
        関連事項:
        定数フィールド値

      • PARTIAL_RENDER_PARAM_NAME

        public static final StringSE PARTIAL_RENDER_PARAM_NAME

        リクエストパラメーター値が、リクエスト処理ライフサイクルのレンダリングレスポンスフェーズ中に処理する必要のあるコンポーネントを識別するクライアント ID の Collection であるリクエストパラメーター名。

        導入:
        2.0
        関連事項:
        定数フィールド値

      • PARTIAL_EXECUTE_PARAM_NAME

        public static final StringSE PARTIAL_EXECUTE_PARAM_NAME

        リクエストパラメーター値が、リクエスト処理ライフサイクルの「リクエスト値の適用」、「プロセス検証」、「モデル値の更新」フェーズで処理する必要のあるコンポーネントを識別するクライアント ID の Collection であるリクエストパラメーター名。

        導入:
        2.0
        関連事項:
        定数フィールド値

      • RESET_VALUES_PARAM_NAME

        public static final StringSE RESET_VALUES_PARAM_NAME

        この定数の値で指定されたリクエストパラメーターのパラメーター値が true の場合、実装は isResetValues() から true を返す必要があります。

        導入:
        2.2
        関連事項:
        定数フィールド値

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

      • PartialViewContext

        public PartialViewContext()

    • メソッドの詳細

      • getExecuteIds

        public abstract CollectionSE<StringSE> getExecuteIds()

        リクエストパラメーター名 PARTIAL_EXECUTE_PARAM_NAME を使用して、現在のリクエストからクライアント ID の Collection を返します。そのようなリクエストパラメーターがない場合は、空の Collection を返します。これらのクライアント ID は、リクエスト処理ライフサイクルの execute フェーズ中に処理されるコンポーネントを識別するために使用されます。返された Collection は変更可能です。

        戻り値:
        ライフサイクルの実行部分の ID
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • getRenderIds

        public abstract CollectionSE<StringSE> getRenderIds()

        リクエストパラメーター名 PARTIAL_RENDER_PARAM_NAME を使用して、現在のリクエストからクライアント ID の Collection を返します。そのようなリクエストパラメーターがない場合は、空の Collection を返します。これらのクライアント ID は、リクエスト処理ライフサイクルの render フェーズ中に処理されるコンポーネントを識別するために使用されます。返された Collection は変更可能です。

        戻り値:
        ライフサイクルのレンダリング部分の ID
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • getEvalScripts

        public abstract ListSE<StringSE> getEvalScripts()

        ajax リクエストの完了時にクライアント側で評価されるスクリプトの可変 List を返します。

        戻り値:
        ajax リクエストの完了時にクライアント側で評価されるスクリプトの可変 List。
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合。
        導入:
        2.3

      • getPartialResponseWriter

        public abstract PartialResponseWriter getPartialResponseWriter()

        コンポーネントが部分ビューレンダリングのために出力を送信する必要がある ResponseWriter を返します。特定のレスポンス内で、コンポーネントは ResponseStream または ResponseWriter のいずれかを使用できますが、両方を使用することはできません。

        戻り値:
        出力用の ResponseWriter 
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • isAjaxRequest

        public abstract boolean isAjaxRequest()

        リクエストヘッダー Faces-Request が値 partial/ajax で存在する場合、true を返します。それ以外の場合は、false を返します。

        戻り値:
        これが ajax リクエストかどうか
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • isPartialRequest

        public abstract boolean isPartialRequest()

        true を返す isAjaxRequest() は true を返すか、リクエストヘッダー Faces-Request が値 partial/process で存在する場合に返します。それ以外の場合は、false を返します。

        戻り値:
        このリクエストが部分的かどうか
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • isExecuteAll

        public abstract boolean isExecuteAll()

        isAjaxRequest() が true を返し、PARTIAL_EXECUTE_PARAM_NAME が現在のリクエストに値 ALL_PARTIAL_PHASE_CLIENT_IDS で存在する場合、true を返します。それ以外の場合は、false を返します。

        戻り値:
        これがすべて実行リクエストかどうか
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • isRenderAll

        public abstract boolean isRenderAll()

        isAjaxRequest() が true を返し、PARTIAL_RENDER_PARAM_NAME が現在のリクエストに値 ALL_PARTIAL_PHASE_CLIENT_IDS で存在する場合、true を返します。それ以外の場合は、false を返します。

        戻り値:
        これがすべてレンダリングリクエストかどうか
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • isResetValues

        public boolean isResetValues()

        受信リクエストに RESET_VALUES_PARAM_NAME の値で指定されたパラメーターがあり、その値が true である場合、true を返します。このクラスの以前のバージョンから拡張された可能性のあるカスタム実装との下位互換性を維持するために、false を返す実装が提供されています。準拠した実装は、指定されたアクションを実行するためにこのメソッドをオーバーライドする必要があります。

        戻り値:
        これが値のリセットリクエストかどうか
        導入:
        2.2

      • setRenderAll

        public abstract void setRenderAll​(boolean renderAll)

        renderAll が true の場合、ビュー全体をレンダリングする必要があることを示します。

        パラメーター:
        renderAll - 値 true は、ビュー全体をレンダリングする必要があることを示します。
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • setPartialRequest

        public abstract void setPartialRequest​(boolean isPartialRequest)

        これが部分的なリクエストであることを動的に示します。

        パラメーター:
        isPartialRequest - 値 true は、これが部分的なリクエストであることを示します。
        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合
        導入:
        2.0

      • release

        public abstract void release()

        この PartialViewContext インスタンスに関連付けられたすべてのリソースを解放します。

        例外:
        IllegalStateExceptionSE - このインスタンスが解放された後にこのメソッドが呼び出された場合