net.sourceforge.stripes.tag

Class FormatTag

java.lang.Object

net.sourceforge.stripes.tag.StripesTagSupport

net.sourceforge.stripes.tag.VarTagSupport

net.sourceforge.stripes.tag.FormatTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class FormatTag
extends VarTagSupport

This tag accepts an object and formats it using an appropriate Formatter. The resulting String can be assigned in the page, request, session or application scopes by using "var" and "scope" or it can be written directly to the JSP output.

Since:

Stripes 1.5

Author:

Ben Gunter

Field Summary

Fields inherited from class net.sourceforge.stripes.tag.VarTagSupport

scope, var

Fields inherited from class net.sourceforge.stripes.tag.StripesTagSupport

pageContext, parentTag

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
FormatTag()

Method Summary

Methods

Modifier and Type	Method and Description
int	doEndTag() Abstract method from the Tag interface.
int	doStartTag() Abstract method from the Tag interface.
protected java.lang.String	format(java.lang.Object value) Attempts to format an object using an appropriate Formatter.
java.lang.String	getFormatPattern() Get the format pattern
java.lang.String	getFormatType() Get the format type
java.lang.Object	getValue() Get the object to be formatted
void	setFormatPattern(java.lang.String formatPattern) Set the format pattern
void	setFormatType(java.lang.String formatType) Set the format type
void	setValue(java.lang.Object value) Set the object to be formatted
protected void	writeOut(java.lang.Object value) Calls format(Object) and writes the resulting String to the JSP output.

Methods inherited from class net.sourceforge.stripes.tag.VarTagSupport

export, getScope, getVar, setScope, setVar

Methods inherited from class net.sourceforge.stripes.tag.StripesTagSupport

getActionBeanType, getActionBeanUrl, getPageContext, getParent, getParentTag, getTagStack, popPageContextAttributes, pushPageContextAttributes, release, setPageContext, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatTag

public FormatTag()

Method Detail

getFormatPattern

public java.lang.String getFormatPattern()

Get the format pattern

setFormatPattern

public void setFormatPattern(java.lang.String formatPattern)

Set the format pattern

getFormatType

public java.lang.String getFormatType()

Get the format type

setFormatType

public void setFormatType(java.lang.String formatType)

Set the format type

getValue

public java.lang.Object getValue()

Get the object to be formatted

setValue

public void setValue(java.lang.Object value)

Set the object to be formatted

format

protected java.lang.String format(java.lang.Object value)

Attempts to format an object using an appropriate Formatter. If no formatter is available for the object, then this method will call toString() on the object. A null value will be formatted as an empty string.

Parameters:

value - the object to be formatted

Returns:

the formatted value

writeOut

protected void writeOut(java.lang.Object value)
                 throws javax.servlet.jsp.JspException

Calls format(Object) and writes the resulting String to the JSP output.

Parameters:

value - the object to be formatted and written

Throws:

javax.servlet.jsp.JspException

doStartTag

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

Description copied from class: StripesTagSupport

Abstract method from the Tag interface. Abstract because it seems to make the child tags more readable if they implement their own do() methods, even when they just return one of the constants and do nothing else.

Specified by:

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

Specified by:

doStartTag in class StripesTagSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Description copied from class: StripesTagSupport

Abstract method from the Tag interface. Abstract because it seems to make the child tags more readable if they implement their own do() methods, even when they just return one of the constants and do nothing else.

Specified by:

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

Specified by:

doEndTag in class StripesTagSupport

Throws:

javax.servlet.jsp.JspException