JSF構成 - <attribute>要素

親要素のタイプ・セーフな属性と属性拡張に関する情報を宣言します。この情報は構成に影響を与えず、メタデータとして使用されます。<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>

要素

<attribute-name>
使用方法: 属性の名前を宣言します。
値: 親要素の有効範囲内で一意の識別子。
<attribute-class>
使用方法: 属性のデータ型をJavaクラスとして宣言します。
値: 属性のデータ型の完全修飾Javaクラス名。
<default-value>
使用方法: 属性が戻す値(まだ設定されていない場合)を宣言します。
値: 属性の型に変換可能な値の文字列表現。
<suggested-value>
使用方法: 属性で使用する推奨値を宣言します。
値: 属性の型に変換可能な値の文字列表現。
<attribute-extension>
使用方法: <attribute>の親要素に適用する実装固有の要素を格納します。
値: XML要素。

次の例では、カスタムUIコンポーネントcustombannerの属性borderwidthを宣言します。

<component>
  <display-name>Banner Border Width</display-name>
  <component-type>org.comp.CustomBanner</component-type>
  <component-class>org.comp.jsf.components.CustomBanner</component-class>
  <attribute>
     <attribute-name>borderwidth</attribute-name>
     <attribute-class>java.lang.Integer</attribute-class>
     <default-value>1</default-value>
     <suggested-value>1</suggested-value>
  </attribute>
</component>

開発ツールでは、構成を読み取り、使用可能なカスタム・コンポーネントとしてcustombannerを表示し、デフォルト値と推奨値を持つ属性の1つとしてBanner Border Widthを表示します。


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