public abstract class RendererWrapper extends Renderer implements FacesWrapper<Renderer>
既存の Renderer インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができる Renderer の簡単な実装を提供します。すべてのメソッドのデフォルト実装は、ラップされた Renderer インスタンスを呼び出すことです。
使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped() を使用してラップされているインスタンスにアクセスします。
PASSTHROUGH_RENDERER_LOCALNAME_KEY| コンストラクターと説明 |
|---|
RendererWrapper() 使用すべきではありません。 ラップされている実装を使用する他のコンストラクターを使用します。 |
RendererWrapper(Renderer wrapped)このレンダラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。 |
| 修飾子と型 | メソッドと説明 |
|---|---|
StringSE | convertClientId(FacesContext context, StringSE clientId) コンポーネントが生成したクライアント ID を、クライアントへの送信に適した形式に変換します。 |
void | decode(FacesContext context, UIComponent component) |
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()このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE@DeprecatedSE public RendererWrapper()
public RendererWrapper(Renderer wrapped)
このレンダラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped() は、ラップされている実装を返します。
wrapped - ラップされる実装。public Renderer getWrapped()
FacesWrapperこのインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
FacesWrapper<Renderer> の getWrapped public StringSE convertClientId(FacesContext context, StringSE clientId)
Rendererコンポーネントが生成したクライアント ID を、クライアントへの送信に適した形式に変換します。
デフォルトの実装では、引数 clientId が変更されずに返されます。
Renderer の convertClientId context - 現在のリクエストの FacesContextclientId - クライアント固有の形式に変換されるクライアント識別子。clientIdpublic ObjectSE getConvertedValue(FacesContext context, UIComponent component, ObjectSE submittedValue) throws ConverterException
Renderer 以前に保存された状態情報を、このコンポーネントに必要な型のオブジェクトに変換しようとします(オプションで、このコンポーネントに登録されている Converter があれば、それを使用します)。変換が成功した場合は、このメソッドから新しい値を返す必要があります。そうでない場合は、ConverterException をスローする必要があります。
Renderer の getConvertedValue context - FacesContext(処理中のリクエスト)component - デコードされる UIComponent。submittedValue - decode 中にコンポーネントに保存された値。ConverterException - 送信された値を正常に変換できない場合。public void decode(FacesContext context, UIComponent component)
Renderer 指定された FacesContext に含まれるリクエストから指定された UIComponent の新しい状態をデコードし、その状態を UIComponent に格納します。
デコード中、関連する UIComponent で queueEvent() を呼び出すことにより、(インタレストを登録したイベントリスナーによる)後の処理のためにイベントをキューに入れることができます。
Renderer の decode context - FacesContext(処理中のリクエスト)component - デコードされる UIComponent。public void encodeBegin(FacesContext context, UIComponent component) throws IOExceptionSE
Renderer 最初に指定された UIComponent を、作成中のレスポンスに関連付けられた出力ストリームまたはライターにレンダリングします。このコンポーネントの getConvertedValue() への以前の呼び出しで試行された変換が失敗した場合、decode() の実行中に保存された状態情報を使用して、誤った入力を再現する必要があります。
Renderer の encodeBegin context - FacesContext(処理中のリクエスト)component - レンダリングされる UIComponentIOExceptionSE - レンダリング中に入出力エラーが発生した場合 public void encodeChildren(FacesContext context, UIComponent component) throws IOExceptionSE
RendererencodeBegin() で説明されている規則に従って、この UIComponent の子コンポーネントをレンダリングして、レンダリングする適切な値を取得します。このメソッドは、このコンポーネントの rendersChildren プロパティが true の場合にのみ呼び出されます。
Renderer の encodeChildren context - FacesContext は作成中のレスポンス component - 子がレンダリングされる UIComponentIOExceptionSE - レンダリング中に入出力エラーが発生した場合 public void encodeEnd(FacesContext context, UIComponent component) throws IOExceptionSE
RendererencodeBegin() で説明されている規則に従って、指定された UIComponent の現在の状態の終了をレンダリングして、レンダリングする適切な値を取得します。
Renderer の encodeEnd context - FacesContext は作成中のレスポンス component - レンダリングされる UIComponentIOExceptionSE - レンダリング中に入出力エラーが発生した場合 public boolean getRendersChildren()
Renderer この Renderer が、レンダリングを要求されたコンポーネントを子にレンダリングする責任があるかどうかを示すフラグを返します。デフォルトの実装は false を返します。
Renderer の getRendersChildren Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.