public abstract class UIComponentTagBase extends Object implements javax.servlet.jsp.tagext.JspTag
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.
Constructor and Description |
---|
UIComponentTagBase() |
Modifier and Type | Method and Description |
---|---|
abstract UIComponent |
getComponentInstance()
Return the
UIComponent instance that is associated with
this tag instance. |
abstract 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. |
abstract 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(String id)
Set the component identifier for the component corresponding
to this tag instance.
|
public abstract void setId(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
.IllegalArgumentException
- if the argument is
non-null
and starts with UIViewRoot.UNIQUE_ID_PREFIX
.public abstract 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 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.