Package org.deltava.taglib.format

Class NumberFormatTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.format.UserSettingsTag

org.deltava.taglib.format.NumberFormatTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

Direct Known Subclasses:

DecimalFormatTag, IntegerFormatTag, LandingScoreFormatTag

abstract class NumberFormatTag
extends UserSettingsTag

A JSP tag to support the rendering of formatted numeric values.

Since:

1.0

Version:

11.0

Author:

Luke

Field Summary

Fields

Modifier and Type	Field	Description
protected final DecimalFormat	_nF
protected Number	_value
protected String	_zeroValue

Fields inherited from class org.deltava.taglib.format.UserSettingsTag

_user

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
NumberFormatTag(String pattern)	Initializes the tag.

Method Summary

Modifier and Type	Method	Description
protected void	closeSpan()	Closes an optional formatting SPAN element.
int	doEndTag()	Formats the number and writes it to the JSP output writer.
int	doStartTag()	Checks that a non-null value has been provided.
protected StringBuilder	getClassNameBuilder()	Returns a StringBuilder with the class name to allow subclasses to modify the css classes for the SPAN element.
protected void	openSpan()	Opens an optional formatting SPAN element.
protected void	printValue()	Prints the value, or the zero value if set and the value is zero.
protected void	release(String pattern)	Releases the tag's state and resets the format pattern string.
final void	setClassName(String cName)	Updates the CSS class for this formatted number.
final void	setFmt(String pattern)	Updates the date format pattern.
void	setForceSign(boolean forceSign)	Sets whether to explicitly display a positive or negative sign before the number.
void	setPageContext(PageContext ctxt)	Updates this tag's page context and loads the user object from the request.
final void	setValue(Number value)	Sets the value to format.
final void	setZero(String v)	Updates the content used if the value is zero.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Details

_nF

protected final DecimalFormat _nF

_value

protected Number _value

_zeroValue

protected String _zeroValue

Constructor Details

NumberFormatTag

public NumberFormatTag(String pattern)

Initializes the tag.

Parameters:

pattern - the formatting pattern to use

Method Details

setClassName

public final void setClassName(String cName)

Updates the CSS class for this formatted number. This will automatically enclose the output in a <SPAN> tag.

Parameters:

cName - the class Name(s)

setFmt

public final void setFmt(String pattern)

Updates the date format pattern.

Parameters:

pattern - the format pattern string

See Also:

• DecimalFormat.applyPattern(String)

setZero

public final void setZero(String v)

Updates the content used if the value is zero.

Parameters:

v - the value

setValue

public final void setValue(Number value)

Sets the value to format.

Parameters:

value - the value to format

setForceSign

public void setForceSign(boolean forceSign)

Sets whether to explicitly display a positive or negative sign before the number.

Parameters:

forceSign - TRUE to always display the sign, otherwise FALSE

getClassNameBuilder

protected StringBuilder getClassNameBuilder()

Returns a StringBuilder with the class name to allow subclasses to modify the css classes for the SPAN element.

Returns:

a StringBuilder

release

protected void release(String pattern)

Releases the tag's state and resets the format pattern string.

Parameters:

pattern - the new format pattern

setPageContext

public void setPageContext(PageContext ctxt)

Updates this tag's page context and loads the user object from the request.

Specified by:

setPageContext in interface Tag

Overrides:

setPageContext in class UserSettingsTag

Parameters:

ctxt - the new JSP page context

doStartTag

public int doStartTag()
               throws JspException

Checks that a non-null value has been provided.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Returns:

SKIP_BODY always

Throws:

JspException - never

openSpan

protected void openSpan()
                 throws Exception

Opens an optional formatting SPAN element.

Throws:

Exception - if an I/O error occurs

closeSpan

protected void closeSpan()
                  throws Exception

Closes an optional formatting SPAN element.

Throws:

Exception - if an I/O error occurs

printValue

protected void printValue()
                   throws Exception

Prints the value, or the zero value if set and the value is zero.

Throws:

Exception - if an I/O error occurs

doEndTag

public int doEndTag()
             throws JspException

Formats the number and writes it to the JSP output writer.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class TagSupport

Returns:

TagSupport.EVAL_PAGE

Throws:

JspException - if an error occurs