Mojarra 2.4.0 · com.sun.faces.taglib.html_basic.ColumnTag

Modifier and Type	Field and Description
private ValueExpression	footerClass
private ValueExpression	headerClass
private static final Logger	logger
private ValueExpression	rowHeader

Access	Constructor and Description
public	ColumnTag()

Method Summary

Modifier and Type	Method and Description
public int	doEndTag() Overrides javax.faces.webapp.UIComponentClassicTagBase.doEndTag. Implements javax.servlet.jsp.tagext.Tag.doEndTag. Process the end tag for this instance.
public int	doStartTag() Overrides javax.faces.webapp.UIComponentClassicTagBase.doStartTag. Implements javax.servlet.jsp.tagext.Tag.doStartTag. Process the start tag for this instance.
public String	getComponentType() Implements abstract javax.faces.webapp.UIComponentTagBase.getComponentType. Return the component type for the component that is or will be bound to this tag.
public String	getDebugString()
public String	getRendererType() Implements abstract javax.faces.webapp.UIComponentTagBase.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.
public void	release() Overrides javax.faces.webapp.UIComponentELTag.release. Implements javax.servlet.jsp.tagext.Tag.release. Release any resources allocated during the execution of this tag handler.
public void	setFooterClass(ValueExpression footerClass)
public void	setHeaderClass(ValueExpression headerClass)
protected void	setProperties(UIComponent `UIComponent` whose properties are to be overridden component) Overrides javax.faces.webapp.UIComponentELTag.setProperties. Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set.
public void	setRowHeader(ValueExpression rowHeader)

Inherited from javax.faces.webapp.UIComponentELTag:: createComponent getELContext hasBinding setBinding setRendered

footerClass	back to summary
private ValueExpression footerClass

headerClass	back to summary
private ValueExpression headerClass

logger	back to summary
private static final Logger logger

rowHeader	back to summary
private ValueExpression rowHeader

ColumnTag	back to summary
public ColumnTag()

Method Detail

doEndTag	back to summary
public int doEndTag() throws JspException Overrides javax.faces.webapp.UIComponentClassicTagBase.doEndTag. Implements javax.servlet.jsp.tagext.Tag.doEndTag. Doc from javax.servlet.jsp.tagext.Tag.doEndTag. Process the end tag for this instance. This method is invoked by the JSP page implementation object on all Tag handlers. This method will be called after returning from doStartTag. The body of the action may or may not have been evaluated, depending on the return value of doStartTag. If this method returns EVAL_PAGE, the rest of the page continues to be evaluated. If this method returns SKIP_PAGE, the rest of the page is not evaluated, the request is completed, and the doEndTag() methods of enclosing tags are not invoked. If this request was forwarded or included from another page (or Servlet), only the current page evaluation is stopped. The JSP container will resynchronize the values of any AT_BEGIN and AT_END variables (defined by the associated TagExtraInfo or TLD) after the invocation of doEndTag(). Returns:int indication of whether to continue evaluating the JSP page. Annotations @Override Exceptions JspException: if an error occurred while processing this tag

doEndTag

back to summary

public int doEndTag() throws JspException

Overrides javax.faces.webapp.UIComponentClassicTagBase.doEndTag.

Implements javax.servlet.jsp.tagext.Tag.doEndTag.

Doc from javax.servlet.jsp.tagext.Tag.doEndTag.

Process the end tag for this instance. This method is invoked by the JSP page implementation object on all Tag handlers.

This method will be called after returning from doStartTag. The body of the action may or may not have been evaluated, depending on the return value of doStartTag.

If this method returns EVAL_PAGE, the rest of the page continues to be evaluated. If this method returns SKIP_PAGE, the rest of the page is not evaluated, the request is completed, and the doEndTag() methods of enclosing tags are not invoked. If this request was forwarded or included from another page (or Servlet), only the current page evaluation is stopped.

The JSP container will resynchronize the values of any AT_BEGIN and AT_END variables (defined by the associated TagExtraInfo or TLD) after the invocation of doEndTag().

Returns:int

indication of whether to continue evaluating the JSP page.

Annotations

@Override

Exceptions

JspException:: if an error occurred while processing this tag

doStartTag	back to summary
public int doStartTag() throws JspException Overrides javax.faces.webapp.UIComponentClassicTagBase.doStartTag. Implements javax.servlet.jsp.tagext.Tag.doStartTag. Doc from javax.servlet.jsp.tagext.Tag.doStartTag. Process the start tag for this instance. This method is invoked by the JSP page implementation object. The doStartTag method assumes that the properties pageContext and parent have been set. It also assumes that any properties exposed as attributes have been set too. When this method is invoked, the body has not yet been evaluated. This method returns Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED to indicate that the body of the action should be evaluated or SKIP_BODY to indicate otherwise. When a Tag returns EVAL_BODY_INCLUDE the result of evaluating the body (if any) is included into the current "out" JspWriter as it happens and then doEndTag() is invoked. BodyTag.EVAL_BODY_BUFFERED is only valid if the tag handler implements BodyTag. The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated TagExtraInfo or TLD) after the invocation of doStartTag(), except for a tag handler implementing BodyTag whose doStartTag() method returns BodyTag.EVAL_BODY_BUFFERED. Returns:int EVAL_BODY_INCLUDE if the tag wants to process body, SKIP_BODY if it does not want to process it. Annotations @Override Exceptions JspException: if an error occurred while processing this tag

doStartTag

back to summary

public int doStartTag() throws JspException

Overrides javax.faces.webapp.UIComponentClassicTagBase.doStartTag.

Implements javax.servlet.jsp.tagext.Tag.doStartTag.

Doc from javax.servlet.jsp.tagext.Tag.doStartTag.

Process the start tag for this instance. This method is invoked by the JSP page implementation object.

The doStartTag method assumes that the properties pageContext and parent have been set. It also assumes that any properties exposed as attributes have been set too. When this method is invoked, the body has not yet been evaluated.

This method returns Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED to indicate that the body of the action should be evaluated or SKIP_BODY to indicate otherwise.

When a Tag returns EVAL_BODY_INCLUDE the result of evaluating the body (if any) is included into the current "out" JspWriter as it happens and then doEndTag() is invoked.

BodyTag.EVAL_BODY_BUFFERED is only valid if the tag handler implements BodyTag.

The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated TagExtraInfo or TLD) after the invocation of doStartTag(), except for a tag handler implementing BodyTag whose doStartTag() method returns BodyTag.EVAL_BODY_BUFFERED.

Returns:int

EVAL_BODY_INCLUDE if the tag wants to process body, SKIP_BODY if it does not want to process it.

Annotations

@Override

Exceptions

JspException:: if an error occurred while processing this tag

getComponentType back to summary

getComponentType	back to summary
public String getComponentType() Implements abstract javax.faces.webapp.UIComponentTagBase.getComponentType. Doc from javax.faces.webapp.UIComponentTagBase.getComponentType. Return the component type for the component that is or will be bound to this tag. This value can be passed to `javax.faces.application.Application#createComponent` to create the `UIComponent` instance for this tag. Subclasses must override this method to return the appropriate value. Returns:String the component type Annotations @Override

public String getComponentType()

Implements abstract javax.faces.webapp.UIComponentTagBase.getComponentType.

Doc from javax.faces.webapp.UIComponentTagBase.getComponentType.

Return the component type for the component that is or will be bound to this tag. This value can be passed to javax.faces.application.Application#createComponent to create the UIComponent instance for this tag. Subclasses must override this method to return the appropriate value.

Returns:String

the component type

Annotations

@Override

getDebugString	back to summary
public String getDebugString()

getRendererType back to summary

getRendererType	back to summary
public String getRendererType() Implements abstract javax.faces.webapp.UIComponentTagBase.getRendererType. Doc from javax.faces.webapp.UIComponentTagBase.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. Returns:String the renderer type Annotations @Override

public String getRendererType()

Implements abstract javax.faces.webapp.UIComponentTagBase.getRendererType.

Doc from javax.faces.webapp.UIComponentTagBase.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.

Returns:String

the renderer type

Annotations

@Override

release	back to summary
public void release() Overrides javax.faces.webapp.UIComponentELTag.release. Implements javax.servlet.jsp.tagext.Tag.release. Doc from javax.faces.webapp.UIComponentELTag.release. Release any resources allocated during the execution of this tag handler. Annotations @Override

release

back to summary

public void release()

Overrides javax.faces.webapp.UIComponentELTag.release.

Implements javax.servlet.jsp.tagext.Tag.release.

Doc from javax.faces.webapp.UIComponentELTag.release.

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

Annotations

@Override

setFooterClass	back to summary
public void setFooterClass(ValueExpression footerClass)

setHeaderClass	back to summary
public void setHeaderClass(ValueExpression headerClass)

setProperties back to summary

setProperties	back to summary
protected void setProperties(UIComponent component) Overrides javax.faces.webapp.UIComponentELTag.setProperties. Doc from javax.faces.webapp.UIComponentELTag.setProperties. 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. Parameters component:UIComponent `UIComponent` whose properties are to be overridden Annotations @Override

protected void setProperties(UIComponent component)

Overrides javax.faces.webapp.UIComponentELTag.setProperties.

Doc from javax.faces.webapp.UIComponentELTag.setProperties.

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.

Parameters

component:UIComponent: UIComponent whose properties are to be overridden

Annotations

@Override

setRowHeader	back to summary
public void setRowHeader(ValueExpression rowHeader)

public Class ColumnTag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail