パッケージ jakarta.faces.render

クラス RenderKitFactory

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

    RenderKitFactory は、RenderKit インスタンスを登録して返すファクトリオブジェクトです。Jakarta Faces の実装は、少なくとも RenderKit のデフォルトの実装を提供する必要があります。高度な実装（または外部のサードパーティライブラリ）は、同じコンポーネントに対してさまざまな型のレンダリングを実行するための追加の RenderKit 実装（レンダリングキット識別子によってキー設定）を提供する場合があります。

    Jakarta Faces を使用している Web アプリケーションごとに 1 つの RenderKitFactory インスタンスが必要です。このインスタンスは、次のコマンドを呼び出すことにより、移植可能な方法で取得できます。

     RenderKitFactory factory = (RenderKitFactory) FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);

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

    • フィールドの詳細

      • HTML_BASIC_RENDER_KIT

        public static final StringSE HTML_BASIC_RENDER_KIT

        この Jakarta Faces 実装のデフォルト RenderKit インスタンスのレンダーキット識別子。

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

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

      • RenderKitFactory

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

      • RenderKitFactory

        public RenderKitFactory​(RenderKitFactory wrapped)

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

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

    • メソッドの詳細

      • getWrapped

        public RenderKitFactory getWrapped()

        このファクトリが装飾されている場合、装飾を行う実装はこのメソッドをオーバーライドして、ラップされている実装へのアクセスを提供できます。

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

      • addRenderKit

        public abstract void addRenderKit​(StringSE renderKitId,
                                  RenderKit renderKit)

        指定された renderKitId に関連付けられた指定された RenderKit インスタンスを、この RenderKitFactory でサポートされるように登録し、以前に登録された RenderKit をこの識別子に置き換えます。

        パラメーター:
        renderKitId - 登録する RenderKit の識別子
        renderKit - 登録している RenderKit インスタンス
        例外:
        NullPointerExceptionSE - renderKitId または renderKit が null の場合

      • getRenderKit

        public abstract RenderKit getRenderKit​(FacesContext context,
                                       StringSE renderKitId)

        null でない場合は、指定された FacesContext の動的特性に基づいてカスタマイズされた、指定されたレンダーキット識別子の RenderKit インスタンスを返します。指定された識別子に登録された RenderKit がない場合は、null を返します。使用可能なレンダリングキット識別子のセットは、getRenderKitIds() メソッドを介して使用できます。

        パラメーター:
        context - 現在処理中のリクエストの場合は FacesContext、使用可能なものがない場合は null。
        renderKitId - リクエストされた RenderKit インスタンスのレンダリングキット識別子
        戻り値:
        RenderKit インスタンス
        例外:
        IllegalArgumentExceptionSE - 指定された識別子に対して RenderKit インスタンスを返すことができない場合
        NullPointerExceptionSE - renderKitId が null の場合

      • getRenderKitIds

        public abstract IteratorSE<StringSE> getRenderKitIds()

        このファクトリに登録されているレンダリングキット識別子のセットに対して Iterator を返します。このセットには、RenderKitFactory.HTML_BASIC_RENDER_KIT で指定された値が含まれている必要があります。

        戻り値:
        レンダーキット識別子のセットに対する Iterator