Top Description Fields Methods
jakarta.faces.component

public @Interface FacesComponent

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@Inherited
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME

The presence of this annotation on a class that extends UIComponent must cause the runtime to register this class as a component suitable for inclusion in a view. If the createTag attribute is true, the runtime must create a corresponding Facelet tag handler according to the rules specified in the attributes of this annotation.

Field Summary

Modifier and TypeField and Description
public static final String
NAMESPACE

Components that declare a createTag = true attribute will be placed into this tag namespace if the namespace attribute is omitted.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true to create the Facelet tag handler, false otherwise.
createTag()

If the value of this attribute is true, the runtime must create a Facelet tag handler, that extends from jakarta.faces.view.facelets.ComponentHandler, suitable for use in pages under the tag library with namespace given by the value of the namespace attribute.

public String

Returns:

the namespace.
namespace()

If the value of the createTag attribute is true, the value of this attribute is taken to be the tag library namespace into which this component is placed.

public String

Returns:

the tag name.
tagName()

If the value of the createTag attribute is true, the runtime must use this value as the tag name for including an instance of the component annotated with this annotation in a view.

public String

Returns:

the component type.
value()

The value of this annotation attribute is taken to be the component-type with which instances of this class of component can be instantiated by calling jakarta.faces.application.Application#createComponent(java.lang.String).

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Field Detail

NAMESPACEback to summary
public static final String NAMESPACE

Components that declare a createTag = true attribute will be placed into this tag namespace if the namespace attribute is omitted.

Method Detail

createTagback to summary
public boolean createTag()

If the value of this attribute is true, the runtime must create a Facelet tag handler, that extends from jakarta.faces.view.facelets.ComponentHandler, suitable for use in pages under the tag library with namespace given by the value of the namespace attribute.

Returns:boolean

true to create the Facelet tag handler, false otherwise.

namespaceback to summary
public String namespace()

If the value of the createTag attribute is true, the value of this attribute is taken to be the tag library namespace into which this component is placed.

Returns:String

the namespace.

tagNameback to summary
public String tagName()

If the value of the createTag attribute is true, the runtime must use this value as the tag name for including an instance of the component annotated with this annotation in a view. If this attribute is not specified on a usage of this annotation, the simple name of the class on which this annotation is declared, with the first character lowercased, is taken to be the value.

Returns:String

the tag name.

valueback to summary
public String value()

The value of this annotation attribute is taken to be the component-type with which instances of this class of component can be instantiated by calling jakarta.faces.application.Application#createComponent(java.lang.String). If no value is specified, or the value is null, the value is taken to be the return of calling getSimpleName on the class to which this annotation is attached and lowercasing the first character. If more than one component with this derived name is found, the results are undefined.

Returns:String

the component type.