リファレンス: JSF構成要素

このリファレンスでは、JSF構成ファイルに設定可能なすべての要素を説明します。次のトピックが含まれます。

ファイル構造

JSF構成ファイルのXML DTDは、web-facesconfig_1_x.dtdです。このDTDは、DOCTYPE宣言で指定する必要があります。

JSF構成ファイルのルート要素は次のとおりです。
<faces-config xmlns="http://java.sun.com/JSF/Configuration">

他のすべての最上位要素は、任意の順序でルート要素内に配置できます。特に指示がないかぎり、要素の複数のインスタンスを含めることができます。

次の例は、構成ファイルの最上位構文を示しています。

<?xml version="1.0" encoding="windows-1252"?>
<!DOCTYPE faces-config PUBLIC
  "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.1//EN"
  "http://java.sun.com/dtd/web-facesconfig_1_1.dtd">
<faces-config xmlns="http://java.sun.com/JSF/Configuration">

...

</faces-config>    

構文に関する注意

最上位要素には子要素が含まれます。たとえば、managed-beanには、子要素managed-bean-nameが含まれます。子要素は必ず、構文の説明にリストされている順に組み込んでください。

大カッコ([ ])内の子要素はオプションです。縦線( | )で区切られた子要素は相互に排他的です。ネストされた要素の末尾にあるアスタリスク(*)は、複数の要素を使用できることを意味します。

イタリック体の値は、ユーザーが指定する値を表します。

最上位の構成要素

要素 構文
<application>
<application>
  [<action-listener>actionListener</action-listener>]
  [<default-render-kit-id>defRenderKit</default-render-kit-id>]
  [<message-bundle>msgBundle</message-bundle>]
  [<navigation-handler>navHandler</navigation-handler>]
  [<view-handler>viewHandler</view-handler>]
  [<state-manager>stManager</state-manager>]
  [<property-resolver>propResolver</property-resolver>]	
  [<variable-resolver>varResolver</variable-resolver>]	
  [<locale-config>
    [<default-locale>defLocale</default-locale>]
    [<supported-locale>supLocale</supported-locale>]*
	  <locale-config>]
</application>          
<component>
<component>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <component-type>comType</component-type>
  <component-class>comClass</component-class>
  [<facet> 
    [<description/>]* 
    [<display-name/>]* 
    [<icon/>]* 
    <facet-name>facetName</facet-name> 
    [<facet-extension>facetextension</facet-extension>]* 
  </facet>]*
  [<attribute/>]*
  [<property/>]*
  [<component-extension>componentExtension</component-extension>
</component>          
<converter>
<converter>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <converter-id>converterID</converter-id> | 
  <converter-for-class>targetClassName</converter-for-class>
  <converter-class>className</converter-class>
  [<attribute/>]*
  [<property/>]*
</converter>          
<factory>
<factory>
  [<application-factory>appFactory</application-factory>]
  [<faces-context-factory>fcFactory</faces-context-factory>]
  [<lifecycle-factory>lifeFactory</lifecycle-factory>]
  [<render-kit-factory>rkitFactory</render-kit-factory>]
</factory>          
<lifecycle>
<lifecycle>
  <phase-listener>phaseListener</phase-listener>
</lifecycle>          
<managed-bean>
<managed-bean>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <managed-bean-name>beanName</managed-bean-name> 
  <managed-bean-class>beanClass</managed-bean-class>
  <managed-bean-scope>
    none | request | session | application 
  </managed-bean-scope>
  [<ManagedProperty>*|<MapEntries>|<ListEntries>]
</managed-bean>          
ManagedProperty ::=
<managed-property>
   [<description/>]*
   [<display-name/>]*
   [<icon/>]*
   <property-name>propertyName</property-name>
   [<property-class>propertyClass</property-class>
   [<Value>|<MapEntries>|<ListEntries>|<null-value/>]
</managed-property>          
 Value ::= 

<value>simplevalue</value>          
 MapEntries ::=
 
<map-entries>
  [<key-class>KeyClass</key-class>]
  [<value-class>valueClass</value-class>]
  <map-entry>
    <key>key</key>
    <value>value</value> |null-value/>
  </map-entry>*
</map-entries>          
 ListEntries ::=

<list-entries>
  [<value-class>valueClass</value-class>]
  <value>value</value>|<null-value/>* 
</list-entries>          
<navigation-rule>
<navigation-rule>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  [<from-view-id>viewId</from-view-id>]
  [<navigation-case>
    [<description/>]*
    [<display-name/>]*
    [<icon/>]*
    [<from-action>fromActionBinding</from-action>]
    [<from-outcome>fromOutcome</from-outcome>]
    <to-view-id>viewId</to-view-id>
    [<redirect/>]
  </navigation-case>]*
</navigation-rule>          
<referenced-bean>
<referenced-bean>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <referenced-bean-name>beanName</referenced-bean-name> 
  <referenced-bean-class>beanClass</referenced-bean-class>
</referenced-bean>          
<render-kit>
<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>
       renextension
     </renderer-extension>]*
   </renderer>]*
</render-kit>          
<validator>
<validator>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <validator-id>validatorID</validator-id>
  <validator-class>className</validator-class>
  [<attribute>]*
  [<property>]*
</validator>          

メタデータ要素

要素 構文
<description>
<description[xml:lang="lang"]>descriptive_metadata</description>          
<display-name>
<display-name[xml:lang="lang"]>displayed_metadata</display-name>          
<icon>
<icon[xml:lang="lang"]>
  [<small-icon>iconPath</small-icon>]
  [<large-icon>iconPath</large-icon>]
</icon>          
<attribute>
<attribute>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <attribute-name>attributeName</attribute-name>
  <attribute-class>attributeClass</attribute-class>
  [<default-value>defaultValue</default-value>]
  [<suggested-value>suggestedValue</suggested-value>]
  [<attribute-extension>
    attrExtension
   </attribute-extension>]
</attribute>          
<property>
<property>
  [<description/>]*
  [<display-name/>]*
  [<icon/>]*
  <property-name>propertyName</property-name>
  <property-class>propertyClass</property-class>
  [<default-value>defaultValue</default-value>]
  [<suggested-value>suggestedValue</suggested-value>]
  [<property-extension>propExtension</property-extension>]
</property>          

<application>要素
<factory>要素
<component>要素
<converter>要素
<managed-bean>要素
<navigation-rule>要素
<referenced-bean>要素
<render-kit>要素
<lifecycle>要素
<validator>要素
<description>要素
<display-name>要素
<icon>要素
<attribute>要素
<property>要素