Class UIComponentTagBase
- All Implemented Interfaces:
JspTag
- Direct Known Subclasses:
UIComponentClassicTagBase
UIComponentTagBase
is the base class
for all JSP tags that correspond to a UIComponent
instance in the view. This base
class allows a single view to be described in a JSP page consisting
of both UIComponentELTag
and UIComponentTag
instances.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
addChild
(UIComponent child) Add the component identifier of the specifiedUIComponent
to the list of component identifiers created or located by nestedUIComponentTag
s processing this request.protected abstract void
Add the facet name of the specified facet to the list of facet names created or located by nestedUIComponentTag
s processing this request.abstract UIComponent
Return theUIComponent
instance that is associated with this tag instance.abstract String
Return the component type for the component that is or will be bound to this tag.abstract boolean
Returntrue
if we dynamically created a new component instance during execution of this tag.protected ELContext
Return theELContext
for theFacesContext
for this request.protected abstract FacesContext
Return theFacesContext
instance for the current request.protected abstract int
Return the index of the next child to be added as a child of this tag.abstract String
Return therendererType
property that selects theRenderer
to be used for encoding this component, ornull
to ask the component to render itself directly.abstract void
Set the component identifier for the component corresponding to this tag instance.
-
Field Details
-
log
-
-
Constructor Details
-
UIComponentTagBase
public UIComponentTagBase()
-
-
Method Details
-
getFacesContext
Return the
FacesContext
instance for the current request. This value will be non-null
only from the beginning ofdoStartTag()
through the end ofdoEndTag()
for each tag instance. -
getELContext
Return the
ELContext
for theFacesContext
for this request.This is a convenience for
getFacesContext().getELContext()
. -
addChild
Add the component identifier of the specified
UIComponent
to the list of component identifiers created or located by nestedUIComponentTag
s processing this request.- Parameters:
child
- New child whose identifier should be added
-
addFacet
Add the facet name of the specified facet to the list of facet names created or located by nested
UIComponentTag
s processing this request.- Parameters:
name
- Facet name to be added
-
setId
Set the component identifier for the component corresponding to this tag instance. If the argument begins with
UIViewRoot.UNIQUE_ID_PREFIX
throw anIllegalArgumentException
- Parameters:
id
- The new component identifier. This may not start withUIViewRoot.UNIQUE_ID_PREFIX
.- Throws:
IllegalArgumentException
- if the argument is non-null
and starts withUIViewRoot.UNIQUE_ID_PREFIX
.
-
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 theUIComponent
instance for this tag. Subclasses must override this method to return the appropriate value. -
getRendererType
Return the
rendererType
property that selects theRenderer
to be used for encoding this component, ornull
to ask the component to render itself directly. Subclasses must override this method to return the appropriate value. -
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 ofdoStartTag()
anddoEndTag()
on this tag instance. -
getCreated
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 ofdoStartTag()
anddoEndTag()
on this tag instance. -
getIndexOfNextChildTag
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.
-