|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.webapp.UIComponentTagBase
javax.faces.webapp.UIComponentClassicTagBase
javax.faces.webapp.UIComponentTag
UIComponentELTag, which extends
UIComponentClassicTagBase to add properties that use the
EL API introduced as part of JSP 2.1.
public abstract class UIComponentTag
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.Tag |
|---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
| 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 |
| Constructor Summary | |
|---|---|
UIComponentTag()
Deprecated. |
|
| Method Summary | |
|---|---|
protected UIComponent |
createComponent(FacesContext context,
String newId)
Deprecated. Implement createComponent using Faces 1.1 EL
API. |
static UIComponentTag |
getParentUIComponentTag(PageContext context)
Deprecated. Locate and return the nearest enclosing UIComponentTag
if any; otherwise, return null. |
protected boolean |
hasBinding()
Deprecated. Return true if this component has a
non-null binding attribute. |
protected boolean |
isSuppressed()
Deprecated. |
static boolean |
isValueReference(String value)
Deprecated. Return true 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.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 Detail |
|---|
public UIComponentTag()
| Method Detail |
|---|
public void setBinding(String binding)
throws JspException
Set the value binding expression for our component.
binding - The new value binding expression
IllegalArgumentException - if the specified binding is not a
valid value binding expression.
JspExceptionprotected boolean hasBinding()
UIComponentClassicTagBaseReturn true if this component has a
non-null binding attribute. This method is
necessary to allow subclasses that expose the
binding property as an Faces 1.1 style EL property
as well as subclasses that expose it as an EL API property.
hasBinding in class UIComponentClassicTagBasepublic void setRendered(String rendered)
Set an override for the rendered attribute.
rendered - The new value for rendered attributeprotected boolean isSuppressed()
public static boolean isValueReference(String value)
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 underlying UIComponent.
value - The value to evaluate
NullPointerException - if value is
nullpublic void release()
Release any resources allocated during the execution of this tag handler.
release in interface Tagrelease in class UIComponentClassicTagBaseprotected void setProperties(UIComponent component)
UIComponentClassicTagBaseOverride 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 the UIComponent 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 properties foo and bar 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 the
rendered property is specified for
this tag handler instance.rendererType - Set if the getRendererType()
method returns a non-null value.
setProperties in class UIComponentClassicTagBasecomponent - UIComponent whose properties are to be
overridden
protected UIComponent createComponent(FacesContext context,
String newId)
Implement createComponent using Faces 1.1 EL
API.
createComponent in class UIComponentClassicTagBasecontext - FacesContext for the current requestnewId - id of the componentpublic static UIComponentTag getParentUIComponentTag(PageContext context)
Locate and return the nearest enclosing UIComponentTag
if any; otherwise, return null.
context - PageContext for the current page
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.