パッケージ jakarta.faces.render

クラス RendererWrapper

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

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

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

導入:
2.2

  • フィールドのサマリー

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

    PASSTHROUGH_RENDERER_LOCALNAME_KEY

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

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

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    StringSE
    convertClientId(FacesContext context, StringSE clientId)
    コンポーネントが生成したクライアント ID を、クライアントへの送信に適した形式に変換します。
    void
    decode(FacesContext context, UIComponent component)
    指定された FacesContext に含まれるリクエストから指定された UIComponent の新しい状態をデコードし、その状態を UIComponent に格納します。
    void
    encodeBegin(FacesContext context, UIComponent component)
    最初に指定された UIComponent を、作成中のレスポンスに関連付けられた出力ストリームまたはライターにレンダリングします。
    void
    encodeChildren(FacesContext context, UIComponent component)
    encodeBegin() で説明されている規則に従って、この UIComponent の子コンポーネントをレンダリングして、レンダリングする適切な値を取得します。
    void
    encodeEnd(FacesContext context, UIComponent component)
    encodeBegin() で説明されている規則に従って、指定された UIComponent の現在の状態の終了をレンダリングして、レンダリングする適切な値を取得します。
    ObjectSE
    getConvertedValue(FacesContext context, UIComponent component, ObjectSE submittedValue)
    以前に格納された状態情報を、このコンポーネントに必要な型のオブジェクトに変換しようとします（オプションで、このコンポーネントに登録されている Converter がある場合は、それを使用します）。
    boolean
    getRendersChildren()
    この Renderer が、レンダリングを要求されたコンポーネントの子をレンダリングする責任があるかどうかを示すフラグを返します。
    Renderer
    getWrapped()
    このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。

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

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

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

    • RendererWrapper

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

    • RendererWrapper

      public RendererWrapper(Renderer wrapped)

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

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

  • メソッドの詳細

    • getWrapped

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

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

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

    • convertClientId

      public StringSE convertClientId(FacesContext context, StringSE clientId)
      クラスからコピーされた説明: Renderer

      コンポーネントが生成したクライアント ID を、クライアントへの送信に適した形式に変換します。

      デフォルトの実装では、引数 clientId が変更されずに返されます。

      オーバーライド:
      クラス Renderer の convertClientId 
      パラメーター:
      context - 現在のリクエストの FacesContext
      clientId - クライアント固有の形式に変換されるクライアント識別子。
      戻り値:
      変換された clientId

    • getConvertedValue

      public ObjectSE getConvertedValue(FacesContext context, UIComponent component, ObjectSE submittedValue) throws ConverterException
      クラスからコピーされた説明: Renderer

      以前に保存された状態情報を、このコンポーネントに必要な型のオブジェクトに変換しようとします（オプションで、このコンポーネントに登録されている Converter があれば、それを使用します）。変換が成功した場合は、このメソッドから新しい値を返す必要があります。そうでない場合は、ConverterException をスローする必要があります。

      オーバーライド:
      クラス Renderer の getConvertedValue 
      パラメーター:
      context - FacesContext（処理中のリクエスト）
      component - デコードされる UIComponent。
      submittedValue - decode 中にコンポーネントに保存された値。
      戻り値:
      変換された値
      例外:
      ConverterException - 送信された値を正常に変換できない場合。

    • decode

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

      指定された FacesContext に含まれるリクエストから指定された UIComponent の新しい状態をデコードし、その状態を UIComponent に格納します。

      デコード中、関連する UIComponent で queueEvent() を呼び出すことにより、（インタレストを登録したイベントリスナーによる）後の処理のためにイベントをキューに入れることができます。

      オーバーライド:
      クラス Renderer の decode 
      パラメーター:
      context - FacesContext（処理中のリクエスト）
      component - デコードされる UIComponent。

    • encodeBegin

      public void encodeBegin(FacesContext context, UIComponent component) throws IOExceptionSE
      クラスからコピーされた説明: Renderer

      最初に指定された UIComponent を、作成中のレスポンスに関連付けられた出力ストリームまたはライターにレンダリングします。このコンポーネントの getConvertedValue() への以前の呼び出しで試行された変換が失敗した場合、decode() の実行中に保存された状態情報を使用して、誤った入力を再現する必要があります。

      オーバーライド:
      クラス Renderer の encodeBegin 
      パラメーター:
      context - FacesContext（処理中のリクエスト）
      component - レンダリングされる UIComponent
      例外:
      IOExceptionSE - レンダリング中に入出力エラーが発生した場合

    • encodeChildren

      public void encodeChildren(FacesContext context, UIComponent component) throws IOExceptionSE
      クラスからコピーされた説明: Renderer

      encodeBegin() で説明されている規則に従って、この UIComponent の子コンポーネントをレンダリングして、レンダリングする適切な値を取得します。このメソッドは、このコンポーネントの rendersChildren プロパティが true の場合にのみ呼び出されます。

      オーバーライド:
      クラス Renderer の encodeChildren 
      パラメーター:
      context - FacesContext は作成中のレスポンス
      component - 子がレンダリングされる UIComponent
      例外:
      IOExceptionSE - レンダリング中に入出力エラーが発生した場合

    • encodeEnd

      public void encodeEnd(FacesContext context, UIComponent component) throws IOExceptionSE
      クラスからコピーされた説明: Renderer

      encodeBegin() で説明されている規則に従って、指定された UIComponent の現在の状態の終了をレンダリングして、レンダリングする適切な値を取得します。

      オーバーライド:
      クラス Renderer の encodeEnd 
      パラメーター:
      context - FacesContext は作成中のレスポンス
      component - レンダリングされる UIComponent
      例外:
      IOExceptionSE - レンダリング中に入出力エラーが発生した場合

    • getRendersChildren

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

      この Renderer が、レンダリングを要求されたコンポーネントを子にレンダリングする責任があるかどうかを示すフラグを返します。デフォルトの実装は false を返します。

      オーバーライド:
      クラス Renderer の getRendersChildren 
      戻り値:
      フラグの現在の値