JSF構成 - <render-kit>要素

アプリケーションのカスタムのJSFレンダー・キット実装を宣言します。ネストされた<renderer>要素では、コンポーネント・ファミリとレンダラ・タイプの一意の組合せに対してレンダラを宣言します。

構文

<render-kit>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  [<render-kit-id>kitId</render-kit-id>]
  [<render-kit-class>kitClass</render-kit-class>]
  [<renderer>
    [<description/>]*
    [<display-name/>]*
    [<icon/>]*
    <component-family>componentFamily</component-family>
    <renderer-type>rendererType</renderer-type>
    <renderer-class>rendererClass</renderer-class>
	 [<facet> 
      [<description/>]* 
      [<display-name/>]* 
      [<icon/>]* 
      <facet-name>facetName</facet-name> 
      [<facet-extension>facetextension</facet-extension>]* 
    </facet>]*
    [<attribute/>]*
    [<renderer-extension>rendererxtension</renderer-extension>]*
   </renderer>]*
</render-kit>    

<render-kit>の子要素

render-kit-id
使用方法: カスタム・レンダー・キットの識別子を宣言します。
値: 一意の識別子。
例: レンダー・キットの識別子に構文prefix .renderkitClassを使用すると便利です。
prefix
アプリケーションのJavaパッケージ名の部分を表します。
renderkitClass
レンダー・キットの実装クラスを表します。
たとえば、レンダー・キットcom.jsf.renderkits.SpeechRenderKitのIDをcom.renderkits.SpeechRenderKitに指定できます。
render-kit-class
使用方法: <render-kit-id>で宣言されるカスタム・レンダー・キットの実装クラスを宣言します。
値: javax.faces.render.RenderKitを実装するJavaクラスの完全修飾名。
renderer
使用方法: カスタム・レンダラを宣言します。<component-family>子要素と<renderer-type>子要素の組合せは一意である必要があります。
値: 1つの<component-family>子要素、1つの<renderer-type>子要素、1つの<renderer-class>子要素、およびその他のオプション要素。

<renderer>の子要素

<component-family>
使用方法: このレンダラを使用するコンポーネント・ファミリを宣言します。
値: 既存のコンポーネント・ファミリのID。
<renderer-type>
使用方法: レンダラのタイプを宣言します。
値: レンダラの既存タイプのID。
<renderer-class>
使用方法: レンダラの実装クラスを宣言します。
値: 完全修飾Javaクラス名。
<facet>
使用方法: コンポーネント内に格納するファセットを宣言します。詳細は、「facet要素」の項を参照してください。
値: ファセット名。
<renderer-extension>
使用方法: レンダラに適用する実装固有の要素を格納します。
値: XML要素。

次の例では、カスタム・レンダラ・キットcom.jsf.renderkits.SpeechRenderKit、およびそのカスタム・レンダラの1つであるcom.jsf.renderers.SpeechRendererを宣言します。このレンダラは、カスタム・コンポーネントのcom.components.OutputComponentsファミリで使用されます。

<render-kit>
  <render-kit-id>com.renderkit.SpeechRenderKit</render-kit-id>
  <render-kit-class>com.jsf.renderkits.SpeechRenderKit</render-kit-id>
  <renderer>
    <component-family>com.components.OutputComponents</component-family>
    <renderer-type>com.renderers.SpeechRenderer</renderer-type>
    <renderer-class>com.jsf.renderers.SpeechRenderer</renderer-class>
  </renderer>
</render-kit>    

<facet>要素
<description>要素
<display-name>要素
<icon>要素
<attribute>要素
<property>要素
リファレンス: JSF構成要素