アノテーション型 FacesComponent
@RetentionSE(RUNTIMESE) @TargetSE(TYPESE) @InheritedSE public @interface FacesComponent
UIComponent
を継承するクラスにこのアノテーションの存在は、ランタイムがビューに含める成分の適切なように、このクラスを登録させなければなりません。createTag
属性がtrue
の場合、ランタイムは、このアノテーションの属性で指定されたルールに従って、対応する Facelet タグハンドラーを作成する必要があります。
オプション要素のサマリー
オプション要素 修飾子と型 オプションの要素 説明 boolean
createTag
この属性の値がtrue
の場合、ランタイムはComponentHandler
から拡張された Facelet タグハンドラーを作成する必要があります。これは、namespace()
属性の値で指定された名前空間を持つタグライブラリのページでの使用に適しています。StringSE
namespace
createTag()
属性の値がtrue
の場合、この属性の値は、このコンポーネントが配置されているタグライブラリの名前空間と見なされます。StringSE
tagName
createTag()
属性の値がtrue
の場合、ランタイムはこの値を、このアノテーションでアノテーションが付けられたコンポーネントのインスタンスをビューに含めるためのタグ名として使用する必要があります。StringSE
value
このアノテーション属性の 値は、Application.createComponent(java.lang.String)
を呼び出すことによってこのクラスのコンポーネントのインスタンスをインスタンス化できるコンポーネント型と見なされます。
フィールドの詳細
NAMESPACE
static final StringSE NAMESPACE
名前空間属性が省略されている場合、
createTag = true
属性を宣言するコンポーネントはこのタグ名前空間に配置されます。
要素の詳細
value
StringSE value
このアノテーション属性の 値は、
Application.createComponent(java.lang.String)
を呼び出すことによってこのクラスのコンポーネントのインスタンスをインスタンス化できるコンポーネント型と見なされます。値が指定されていない場合、または値がnull
の場合、値は、このアノテーションが付加されているクラスでgetSimpleName
を呼び出し、最初の文字を小文字にしたものと見なされます。この派生名を持つコンポーネントが複数見つかった場合、結果は未定義です。- 戻り値:
- コンポーネント型。
- デフォルト:
- ""
createTag
boolean createTag
この属性の値が
true
の場合、ランタイムはComponentHandler
から拡張された Facelet タグハンドラーを作成する必要があります。これは、namespace()
属性の値で指定された名前空間を持つタグライブラリのページでの使用に適しています。- 戻り値:
- Facelet タグハンドラーを作成する場合は
true
、それ以外の場合はfalse
。
- デフォルト:
- false
tagName
StringSE tagName
createTag()
属性の値がtrue
の場合、ランタイムはこの値を、このアノテーションでアノテーションが付けられたコンポーネントのインスタンスをビューに含めるためのタグ名として使用する必要があります。このアノテーションの使用箇所でこの属性が指定されていない場合、このアノテーションが宣言されているクラスの単純な名前(最初の文字は小文字)が値として使用されます。- 戻り値:
- タグ名。
- デフォルト:
- ""
namespace
StringSE namespace
createTag()
属性の値がtrue
の場合、この属性の値は、このコンポーネントが配置されているタグライブラリの名前空間と見なされます。- 戻り値:
- 名前空間。
- デフォルト:
- "jakarta.faces.component"