javax.faces.webapp: abstract public class: UIComponentTag

javax.faces.webapp
abstract public class: UIComponentTag [javadoc | source]

java.lang.Object
   javax.faces.webapp.UIComponentTagBase
      javax.faces.webapp.UIComponentClassicTagBase
         javax.faces.webapp.UIComponentTag

All Implemented Interfaces:
Tag, javax.servlet.jsp.tagext.JspIdConsumer, BodyTag, JspTag

Direct Known Subclasses:
UIComponentBodyTag, UIComponentTagAdapter

Deprecated! Use - of this class has been replaced with UIComponentELTag , which extends UIComponentClassicTagBase to add properties that use the EL API introduced as part of JSP 2.1.

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.

Fields inherited from javax.faces.webapp.UIComponentClassicTagBase:
UNIQUE_ID_PREFIX, bodyContent, pageContext

Fields inherited from javax.faces.webapp.UIComponentTagBase:
log

Method from javax.faces.webapp.UIComponentTag Summary:
createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setProperties, setRendered

Methods from javax.faces.webapp.UIComponentClassicTagBase:
addChild, addChildToComponentAndTag, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createComponent, 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, hasBinding, release, setBodyContent, setId, setJspId, setPageContext, setParent, setProperties, setupResponseWriter

Methods from javax.faces.webapp.UIComponentClassicTagBase:

addChild, addChildToComponentAndTag, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createComponent, 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, hasBinding, release, setBodyContent, setId, setJspId, setPageContext, setParent, setProperties, setupResponseWriter

Methods from javax.faces.webapp.UIComponentTagBase:
addChild, addFacet, getComponentInstance, getComponentType, getCreated, getELContext, getFacesContext, getIndexOfNextChildTag, getRendererType, setId

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.webapp.UIComponentTag Detail:
protected UIComponent createComponent(FacesContext context, String newId) { UIComponent component; Application application = context.getApplication(); if (binding != null) { ValueBinding vb = application.createValueBinding(binding); component = application.createComponent(vb, context, getComponentType()); component.setValueBinding("binding", vb); } else { component = application.createComponent(getComponentType()); } component.setId(newId); setProperties(component); return component; } Deprecated! Implement `createComponent` using Faces 1.1 EL API.
public static UIComponentTag getParentUIComponentTag(PageContext context) { UIComponentClassicTagBase result = getParentUIComponentClassicTagBase(context); if (!(result instanceof UIComponentTag)) { return new UIComponentTagAdapter(result); } return ((UIComponentTag) result); } Deprecated! Locate and return the nearest enclosing UIComponentTag if any; otherwise, return `null`.
protected boolean hasBinding() { return null != binding; } Deprecated!
protected boolean isSuppressed() { return (suppressed); } Deprecated!
public static boolean isValueReference(String value) { if (value == null) { throw new NullPointerException(); } int start = value.indexOf("#{"); if ((start != -1) && (start < value.indexOf('}', start))) { return true; } return false; } 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 underlying UIComponent .
public void release() { this.suppressed = false; this.binding = null; this.rendered = null; super.release(); } Deprecated! Release any resources allocated during the execution of this tag handler.
public void setBinding(String binding) throws JspException { if (!isValueReference(binding)) { throw new IllegalArgumentException(); } this.binding = binding; } Deprecated! Set the value binding expression for our component.
protected void setProperties(UIComponent component) { // The "id" property is explicitly set when components are created // so it does not need to be set here if (rendered != null) { if (isValueReference(rendered)) { ValueBinding vb = getFacesContext().getApplication().createValueBinding(rendered); component.setValueBinding("rendered", vb); } else { component.setRendered(Boolean.valueOf(rendered).booleanValue()); } } if (getRendererType() != null) { component.setRendererType(getRendererType()); } } Deprecated!
public void setRendered(String rendered) { this.rendered = rendered; } Deprecated! Set an override for the rendered attribute.

Method from javax.faces.webapp.UIComponentTag Detail:

 protected UIComponent createComponent(FacesContext context,
    String newId) {
        UIComponent component;
        Application application = context.getApplication();
        if (binding != null) {
            ValueBinding vb = application.createValueBinding(binding);
            component = application.createComponent(vb, context,
                                                    getComponentType());
	    component.setValueBinding("binding", vb);
        } else {
            component = application.createComponent(getComponentType());
        }
        component.setId(newId);
        setProperties(component);
        return component;
}

Deprecated!

Implement createComponent using Faces 1.1 EL API.

 public static UIComponentTag getParentUIComponentTag(PageContext context) {
        UIComponentClassicTagBase result =
             getParentUIComponentClassicTagBase(context);
        if (!(result instanceof UIComponentTag)) {
            return new UIComponentTagAdapter(result);
        }
        return ((UIComponentTag) result);
}

Deprecated!

Locate and return the nearest enclosing UIComponentTag if any; otherwise, return null.

 protected boolean hasBinding() {
	return null != binding;
}

Deprecated!

 protected boolean isSuppressed() {
        return (suppressed);
}

Deprecated!

 public static boolean isValueReference(String value) {
	if (value == null) {
	    throw new NullPointerException();
	}
	int start = value.indexOf("#{");
	if ((start != -1) && (start <  value.indexOf('}', start))) {
            return true;
        }
        return false;
}

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 underlying UIComponent .

 public  void release() {
	
	this.suppressed = false;
	this.binding = null;
        this.rendered = null;
	super.release();
}

Deprecated!

Release any resources allocated during the execution of this tag handler.

 public  void setBinding(String binding) throws JspException {
	if (!isValueReference(binding)) {
	    throw new IllegalArgumentException();
        }
	this.binding = binding;
}

Deprecated!

Set the value binding expression for our component.

 protected  void setProperties(UIComponent component) {
        // The "id" property is explicitly set when components are created
        // so it does not need to be set here
        if (rendered != null) {
	    if (isValueReference(rendered)) {
		ValueBinding vb =
		    getFacesContext().getApplication().createValueBinding(rendered);
		component.setValueBinding("rendered", vb);
	    } else {
		component.setRendered(Boolean.valueOf(rendered).booleanValue());
	    }
        }
	if (getRendererType() != null) {
	    component.setRendererType(getRendererType());
	}
}

Deprecated!

 public  void setRendered(String rendered) {
        this.rendered = rendered;
}

Deprecated!

Set an override for the rendered attribute.