パッケージ jakarta.faces.lifecycle

クラス ClientWindowWrapper

java.lang.ObjectSE
jakarta.faces.lifecycle.ClientWindow
jakarta.faces.lifecycle.ClientWindowWrapper
実装されているすべてのインターフェース:
FacesWrapper<ClientWindow>
public abstract class ClientWindowWrapper extends ClientWindow implements FacesWrapper<ClientWindow>

ClientWindow のラッパー

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

導入:
2.2

  • フィールドのサマリー

    クラス jakarta.faces.lifecycle.ClientWindow から継承されたフィールド

    CLIENT_WINDOW_MODE_PARAM_NAME, NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    ClientWindowWrapper()
    使用すべきではありません。
    ラップされている実装を使用する他のコンストラクターを使用します。
    ClientWindowWrapper(ClientWindow wrapped)
    このクライアントウィンドウが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    decode(FacesContext context)
    実装は、受信リクエストを調べ、ClientWindow.getId() メソッドから返される必要がある値を抽出する必要があります。
    void
    disableClientWindowRenderMode(FacesContext context)
    生成された URL での ClientWindow の追加の使用ごとの無効化を許可するコンポーネントは、これらの URL をレンダリングする前に、まずこのメソッドを呼び出す必要があります。
    void
    enableClientWindowRenderMode(FacesContext context)
    生成された URL での ClientWindow の追加の使用ごとの無効化を許可するコンポーネントは、それらの URL をレンダリングした後、最初にこのメソッドを呼び出す必要があります。
    StringSE
    getId()
    現在のセッションのスコープ内でこの ClientWindow を一意に識別する文字列値を返します。
    MapSE<StringSE,StringSE>
    getQueryURLParameters(FacesContext context)
    このメソッドは、クライアントウィンドウ関連のパラメーターを URL に挿入する必要があるランタイムによって URL が生成されるたびに呼び出されます。
    ClientWindow
    getWrapped()
    このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
    boolean
    isClientWindowRenderModeEnabled(FacesContext context)
    生成された URL に ClientWindow を追加するメソッドは、このメソッドを呼び出して、許可されているかどうかを確認する必要があります。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

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

    • ClientWindowWrapper

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

    • ClientWindowWrapper

      public ClientWindowWrapper(ClientWindow wrapped)

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

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

  • メソッドの詳細

    • getWrapped

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

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

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

    • getId

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

      現在のセッションのスコープ内でこの ClientWindow を一意に識別する文字列値を返します。この値の導出方法の仕様については、ClientWindow.decode(jakarta.faces.context.FacesContext) を参照してください。

      次で指定:
      クラス ClientWindow の getId 
      戻り値:
      ClientWindow の ID

    • getQueryURLParameters

      public MapSE<StringSE,StringSE> getQueryURLParameters(FacesContext context)
      クラスからコピーされた説明: ClientWindow

      このメソッドは、クライアントウィンドウ関連のパラメーターを URL に挿入する必要があるランタイムによって URL が生成されるたびに呼び出されます。これにより、カスタム ClientWindow 実装が、ハイパーリンクのレンダリングなど、URL が生成される場合にクライアントウィンドウ固有の追加情報を挿入する機会が与えられることが保証されます。返されるマップは不変である必要があります。このメソッドのデフォルト実装は空のマップを返します。

      次で指定:
      クラス ClientWindow の getQueryURLParameters 
      パラメーター:
      context - このリクエストの FacesContext 
      戻り値:
      null または URL クエリ文字列に挿入するパラメーターのマップ。

    • disableClientWindowRenderMode

      public void disableClientWindowRenderMode(FacesContext context)
      クラスからコピーされた説明: ClientWindow

      生成された URL での ClientWindow の追加の使用ごとの無効化を許可するコンポーネントは、これらの URL をレンダリングする前に、まずこのメソッドを呼び出す必要があります。呼び出し元は、URL のレンダリング後に finally ブロックから ClientWindow.enableClientWindowRenderMode(jakarta.faces.context.FacesContext) を呼び出す必要があります。ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME が引用符なしの "url" の場合、GET リクエストを引き起こす生成されたすべての URL は、デフォルトで ClientWindow を追加する必要があります。コールサイトは実際の ClientWindow インスタンスにアクセスせずにアクセスする必要があるため、これは静的メソッドとして指定されています。

      オーバーライド:
      クラス ClientWindow の disableClientWindowRenderMode 
      パラメーター:
      context - このリクエストの FacesContext

    • enableClientWindowRenderMode

      public void enableClientWindowRenderMode(FacesContext context)
      クラスからコピーされた説明: ClientWindow

      生成された URL での ClientWindow の追加の使用ごとの無効化を許可するコンポーネントは、それらの URL をレンダリングした後、最初にこのメソッドを呼び出す必要があります。ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME が引用符なしの "url" の場合、GET リクエストを引き起こすすべての生成された URL は、デフォルトで ClientWindow を追加する必要があります。コールサイトは実際の ClientWindow インスタンスにアクセスせずにアクセスする必要があるため、これは静的メソッドとして指定されています。

      オーバーライド:
      クラス ClientWindow の enableClientWindowRenderMode 
      パラメーター:
      context - このリクエストの FacesContext

    • isClientWindowRenderModeEnabled

      public boolean isClientWindowRenderModeEnabled(FacesContext context)
      クラスからコピーされた説明: ClientWindow

      生成された URL に ClientWindow を追加するメソッドは、このメソッドを呼び出して、許可されているかどうかを確認する必要があります。ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME が引用符なしの "url" の場合、GET リクエストを引き起こすすべての生成された URL は、デフォルトで ClientWindow を追加する必要があります。コールサイトは実際の ClientWindow インスタンスにアクセスせずにアクセスする必要があるため、これは静的メソッドとして指定されています。

      オーバーライド:
      クラス ClientWindow の isClientWindowRenderModeEnabled 
      パラメーター:
      context - このリクエストの FacesContext
      戻り値:
      上記の結果

    • decode

      public void decode(FacesContext context)
      クラスからコピーされた説明: ClientWindow

      実装は、受信リクエストを調べ、ClientWindow.getId() メソッドから返される必要のある値を抽出する責任があります。ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME が "none" の場合、このメソッドを呼び出さないでください。ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME が "url" の場合、実装は最初に ResponseStateManager.CLIENT_WINDOW_PARAM の値で指定された名前でリクエストパラメーターを探す必要があります。値が見つからない場合は、ResponseStateManager.CLIENT_WINDOW_URL_PARAM の値で指定された名前でリクエストパラメーターを探します。値が見つからない場合は、現在のセッションのスコープ内でこの ClientWindow を一意に識別する ID を作成します。この値は、ClientWindow.getId() メソッドから返すために使用可能にする必要があります。値は、非表示フィールドまたはクエリパラメーターとして含めるのに適している必要があります。値が見つかった場合は、セッションのキーを使用して値を復号化し、ClientWindow.getId() からの戻りに使用できるようにします。

      次で指定:
      クラス ClientWindow の decode 
      パラメーター:
      context - このリクエストの FacesContext