Class UIComponentTagBase
- java.lang.Object
-
- javax.faces.webapp.UIComponentTagBase
-
- All Implemented Interfaces:
JspTag
- Direct Known Subclasses:
UIComponentClassicTagBase
public abstract class UIComponentTagBase extends java.lang.Object implements JspTag
UIComponentTagBase
is the base class for all JSP tags that correspond to aUIComponent
instance in the view. This base class allows a single view to be described in a JSP page consisting of bothUIComponentELTag
andUIComponentTag
instances.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.util.logging.Logger
log
-
Constructor Summary
Constructors Constructor Description UIComponentTagBase()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected 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
addFacet(java.lang.String name)
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
getComponentInstance()
Return theUIComponent
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()
Returntrue
if we dynamically created a new component instance during execution of this tag.protected ELContext
getELContext()
Return theELContext
for theFacesContext
for this request.protected abstract FacesContext
getFacesContext()
Return theFacesContext
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 therendererType
property that selects theRenderer
to be used for encoding this component, ornull
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.
-
-
-
Method Detail
-
getFacesContext
protected abstract FacesContext 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.- Returns:
- the
FacesContext
for the current request.
-
getELContext
protected ELContext getELContext()
Return the
ELContext
for theFacesContext
for this request.This is a convenience for
getFacesContext().getELContext()
.- Returns:
- the {code ELContext} for this
FacesContext
-
addChild
protected abstract void addChild(UIComponent child)
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
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
UIComponentTag
s processing this request.- Parameters:
name
- Facet name to be added
-
setId
public 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 anIllegalArgumentException
- Parameters:
id
- The new component identifier. This may not start withUIViewRoot.UNIQUE_ID_PREFIX
.- Throws:
java.lang.IllegalArgumentException
- if the argument is non-null
and starts withUIViewRoot.UNIQUE_ID_PREFIX
.
-
getComponentType
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 theUIComponent
instance for this tag. Subclasses must override this method to return the appropriate value.- Returns:
- the component type
-
getRendererType
public abstract java.lang.String 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.- Returns:
- the renderer type
-
getComponentInstance
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 ofdoStartTag()
anddoEndTag()
on this tag instance.- Returns:
- the component
-
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.- Returns:
- the result as specified above
-
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.
- Returns:
- the index
-
-