public abstract class UIComponentTagBase extends java.lang.Object implements JspTag
UIComponentTagBase is the base class
for all Jakarta Server Pages tags that correspond to a UIComponent instance in the view. This base
class allows a single view to be described in a Jakarta Server Pages page consisting
of both UIComponentELTag and UIComponentTag
instances.
| Modifier and Type | Field and Description |
|---|---|
protected static java.util.logging.Logger |
log |
| Constructor and Description |
|---|
UIComponentTagBase() |
| Modifier and Type | Method and Description |
|---|---|
protected abstract void |
addChild(UIComponent child)
Add the component identifier of the specified
UIComponent
to the list of component identifiers created or located by nested
UIComponentTags processing this request. |
protected abstract void |
addFacet(java.lang.String name)
Add the facet name of the specified facet to the list of
facet names created or located by nested
UIComponentTags
processing this request. |
abstract UIComponent |
getComponentInstance()
Return the
UIComponent instance that is associated with
this tag instance. |
abstract java.lang.String |
getComponentType()
Return the component type for the component that is or will be
bound to this tag.
|
abstract boolean |
getCreated()
Return
true if we dynamically created a new component
instance during execution of this tag. |
protected ELContext |
getELContext()
Return the
ELContext for the FacesContext for
this request. |
protected abstract FacesContext |
getFacesContext()
Return the
FacesContext instance for the current
request. |
protected abstract int |
getIndexOfNextChildTag()
Return the index of the next child to be added as a child of
this tag.
|
abstract java.lang.String |
getRendererType()
Return the
rendererType property that selects the
Renderer to be used for encoding this component, or
null to ask the component to render itself directly. |
abstract void |
setId(java.lang.String id)
Set the component identifier for the component corresponding
to this tag instance.
|
protected abstract FacesContext getFacesContext()
Return the FacesContext instance for the current
request. This value will be non-null only from the
beginning of doStartTag() through the end of
doEndTag() for each tag instance.
FacesContext for the current request.protected ELContext getELContext()
Return the ELContext for the FacesContext for
this request.
This is a convenience for
getFacesContext().getELContext().
FacesContextprotected abstract void addChild(UIComponent child)
Add the component identifier of the specified UIComponent
to the list of component identifiers created or located by nested
UIComponentTags processing this request.
child - New child whose identifier should be addedprotected abstract void addFacet(java.lang.String name)
Add the facet name of the specified facet to the list of
facet names created or located by nested UIComponentTags
processing this request.
name - Facet name to be addedpublic abstract void setId(java.lang.String id)
Set the component identifier for the component corresponding
to this tag instance. If the argument begins with UIViewRoot.UNIQUE_ID_PREFIX throw an
IllegalArgumentException
id - The new component identifier. This may not start with
UIViewRoot.UNIQUE_ID_PREFIX.java.lang.IllegalArgumentException - if the argument is
non-null and starts with UIViewRoot.UNIQUE_ID_PREFIX.public abstract java.lang.String getComponentType()
Return the component type for the component that is or will be
bound to this tag. This value can be passed to
Application.createComponent(java.lang.String) to create
the UIComponent instance for this tag. Subclasses must
override this method to return the appropriate value.
public abstract java.lang.String getRendererType()
Return the rendererType property that selects the
Renderer to be used for encoding this component, or
null to ask the component to render itself directly.
Subclasses must override this method to return the appropriate value.
public abstract UIComponent getComponentInstance()
Return the UIComponent instance that is associated with
this tag instance. This method is designed to be used by tags nested
within this tag, and only returns useful results between the
execution of doStartTag() and doEndTag()
on this tag instance.
public abstract boolean getCreated()
Return true if we dynamically created a new component
instance during execution of this tag. This method is designed to be
used by tags nested within this tag, and only returns useful results
between the execution of doStartTag() and
doEndTag() on this tag instance.
protected abstract int getIndexOfNextChildTag()
Return the index of the next child to be added as a child of this tag. The default implementation maintains a list of created components and returns the size of the list.