Class UIComponentTag
- All Implemented Interfaces:
BodyTag
,IterationTag
,JspIdConsumer
,JspTag
,Tag
- Direct Known Subclasses:
UIComponentBodyTag
UIComponentTag
is the base class for all JSP custom
actions that correspond to user interface components in a page that is
rendered by JavaServer Faces.
In this version of the specification, UIComponentTag
extends UIComponentClassicTagBase
to add properties that use
the Faces 1.1 Expression Language.
-
Field Summary
Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase
bodyContent, pageContext, UNIQUE_ID_PREFIX
Fields inherited from class javax.faces.webapp.UIComponentTagBase
log
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected UIComponent
createComponent
(FacesContext context, String newId) Deprecated.ImplementcreateComponent
using Faces 1.1 EL API.static UIComponentTag
getParentUIComponentTag
(PageContext context) Deprecated.Locate and return the nearest enclosingUIComponentTag
if any; otherwise, returnnull
.protected boolean
Deprecated.Returntrue
if this component has a non-null
binding attribute.protected boolean
Deprecated.static boolean
isValueReference
(String value) Deprecated.Returntrue
if the specified value conforms to the syntax requirements of a value binding expression.void
release()
Deprecated.Release any resources allocated during the execution of this tag handler.void
setBinding
(String binding) Deprecated.Set the value binding expression for our component.protected void
setProperties
(UIComponent component) Deprecated.Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set.void
setRendered
(String rendered) Deprecated.Set an override for the rendered attribute.Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
Methods inherited from class javax.faces.webapp.UIComponentTagBase
getComponentType, getELContext, getRendererType
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, setPageContext, setParent
-
Constructor Details
-
UIComponentTag
public UIComponentTag()Deprecated.
-
-
Method Details
-
setBinding
Deprecated.Set the value binding expression for our component.
- Parameters:
binding
- The new value binding expression- Throws:
IllegalArgumentException
- if the specified binding is not a valid value binding expression.JspException
-
hasBinding
protected boolean hasBinding()Deprecated.Description copied from class:UIComponentClassicTagBase
Return
true
if this component has a non-null
binding attribute. This method is necessary to allow subclasses that expose thebinding
property as an Faces 1.1 style EL property as well as subclasses that expose it as an EL API property.- Specified by:
hasBinding
in classUIComponentClassicTagBase
-
setRendered
Deprecated.Set an override for the rendered attribute.
- Parameters:
rendered
- The new value for rendered attribute
-
isSuppressed
protected boolean isSuppressed()Deprecated. -
isValueReference
Deprecated.Return
true
if the specified value conforms to the syntax requirements of a value binding expression. Such expressions ` * may be used on most component tag attributes to signal a desire for deferred evaluation of the attribute or property value to be set on the underlyingUIComponent
.- Parameters:
value
- The value to evaluate- Throws:
NullPointerException
- ifvalue
isnull
-
release
public void release()Deprecated.Release any resources allocated during the execution of this tag handler.
- Specified by:
release
in interfaceTag
- Overrides:
release
in classUIComponentClassicTagBase
-
setProperties
Deprecated.Description copied from class:UIComponentClassicTagBase
Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified
UIComponent
was in fact created during the execution of this tag handler instance, and this call will occur BEFORE theUIComponent
is added to the view.Tag subclasses that want to support additional set properties must ensure that the base class
setProperties()
method is still called. A typical implementation that supports extra propertiesfoo
andbar
would look something like this:protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } }
The default implementation overrides the following properties:
rendered
- Set if a value for therendered
property is specified for this tag handler instance.rendererType
- Set if thegetRendererType()
method returns a non-null value.
- Specified by:
setProperties
in classUIComponentClassicTagBase
- Parameters:
component
-UIComponent
whose properties are to be overridden
-
createComponent
Deprecated.Implement
createComponent
using Faces 1.1 EL API.- Specified by:
createComponent
in classUIComponentClassicTagBase
- Parameters:
context
-FacesContext
for the current requestnewId
- id of the component
-
getParentUIComponentTag
Deprecated.Locate and return the nearest enclosing
UIComponentTag
if any; otherwise, returnnull
.- Parameters:
context
-PageContext
for the current page
-
UIComponentELTag
, which extendsUIComponentClassicTagBase
to add properties that use the EL API introduced as part of JSP 2.1.