com.sun.faces.taglib.html_basic

Class OutputFormatTag

java.lang.Object

javax.faces.webapp.UIComponentTagBase

javax.faces.webapp.UIComponentClassicTagBase

javax.faces.webapp.UIComponentELTag

com.sun.faces.taglib.html_basic.OutputFormatTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class OutputFormatTag
extends UIComponentELTag

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

Constructors

Constructor and Description
OutputFormatTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag() Perform any processing necessary to handle the content implications of CASE 3 in the class description.
int	doStartTag() Perform any processing necessary to find (or create) the UIComponent instance in the view corresponding to this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper location as expected by the page author.
String	getComponentType() Return the component type for the component that is or will be bound to this tag.
String	getDebugString()
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.
void	release() Release any resources allocated during the execution of this tag handler.
void	setConverter(javax.el.ValueExpression converter)
void	setDir(javax.el.ValueExpression dir)
void	setEscape(javax.el.ValueExpression escape)
void	setLang(javax.el.ValueExpression lang)
protected void	setProperties(UIComponent component) Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set.
void	setRole(javax.el.ValueExpression role)
void	setStyle(javax.el.ValueExpression style)
void	setStyleClass(javax.el.ValueExpression styleClass)
void	setTitle(javax.el.ValueExpression title)
void	setValue(javax.el.ValueExpression value)

Methods inherited from class javax.faces.webapp.UIComponentELTag

createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doInitBody, 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

OutputFormatTag

public OutputFormatTag()

Method Detail

setConverter

public void setConverter(javax.el.ValueExpression converter)

setValue

public void setValue(javax.el.ValueExpression value)

setDir

public void setDir(javax.el.ValueExpression dir)

setEscape

public void setEscape(javax.el.ValueExpression escape)

setLang

public void setLang(javax.el.ValueExpression lang)

setRole

public void setRole(javax.el.ValueExpression role)

setStyle

public void setStyle(javax.el.ValueExpression style)

setStyleClass

public void setStyleClass(javax.el.ValueExpression styleClass)

setTitle

public void setTitle(javax.el.ValueExpression title)

getRendererType

public String getRendererType()

Description copied from class: UIComponentTagBase

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.

Specified by:

getRendererType in class UIComponentTagBase

Returns:

the renderer type

getComponentType

public String getComponentType()

Description copied from class: UIComponentTagBase

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.

Specified by:

getComponentType in class UIComponentTagBase

Returns:

the component type

setProperties

protected void setProperties(UIComponent component)

Description copied from class: UIComponentELTag

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

Overrides:

setProperties in class UIComponentELTag

Parameters:

component - UIComponent whose properties are to be overridden

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Description copied from class: UIComponentClassicTagBase

Perform any processing necessary to find (or create) the UIComponent instance in the view corresponding to this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper location as expected by the page author. Secondarily, cause a transient UIOutput component to be created and placed in the tree before the UIComponent instance for this tag. The value of this UIOutput component must include anything covered by CASE 1 or CASE 2 in the class description.

The default implementation, which is intended to be sufficient for most components, implements this secondary requirement by calling UIComponentClassicTagBase.getParentUIComponentClassicTagBase(javax.servlet.jsp.PageContext), and calling UIComponentClassicTagBase.createVerbatimComponentFromBodyContent() on the result. It then adds the returned component to the tree before the actual component for this tag instance instance by calling UIComponentClassicTagBase.addVerbatimBeforeComponent(javax.faces.webapp.UIComponentClassicTagBase, javax.faces.component.UIComponent, javax.faces.component.UIComponent).

Before returning, the component is pushed onto the component stack for this response to enable the UIComponentClassicTagBase.getParentUIComponentClassicTagBase(javax.servlet.jsp.PageContext) method to work properly.

The flag value to be returned is acquired by calling the getDoStartValue() method, which tag subclasses may override if they do not want the default value.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class UIComponentClassicTagBase

Throws:

javax.servlet.jsp.JspException - if an error occurs

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Description copied from class: UIComponentClassicTagBase

Perform any processing necessary to handle the content implications of CASE 3 in the class description.

The default implementation, which is intended to be sufficient for most components, calls UIComponentClassicTagBase.createVerbatimComponentFromBodyContent() on this instance and adds it as a child of the component for this tag's component at the end of the child list. In addition, the following housekeeping steps are taken.

• Retrieve from the UIComponent the set of component ids of child components created by UIComponentTag instances the last time this page was processed (if any). Compare it to the list of children created during this page processing pass, and remove all children present in the old list but not the new. Save the new list as a component attribute so that it gets saved as part of the component's state.
• Retrieve from the UIComponent the set of facet names of facets created by UIComponentTag instances the last time this page was processed (if any). Compare it to the list of facets created during this page processing pass, and remove all facets present in the old list but not the new. Save the new list as a component attribute so that it gets saved as part of the component's state.
• Release all references to the component, and pop it from the component stack for this response, removing the stack if this was the outermost component.

The flag value to be returned is acquired by calling the getDoEndValue() method, which tag subclasses may override if they do not want the default value.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class UIComponentClassicTagBase

Throws:

javax.servlet.jsp.JspException - if an error occurs

release

public void release()

Description copied from class: UIComponentELTag

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

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class UIComponentELTag

getDebugString

public String getDebugString()