org.apache.taglibs.datetime
Class FormatTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport
              |
              +--org.apache.taglibs.datetime.FormatTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class FormatTag

extends javax.servlet.jsp.tagext.BodyTagSupport

JSP Tag format, used to format a Date for display.

The Date as a long in milliseconds is obtained from the body of the tag.

Uses the optional attribute pattern as the time pattern string to use when formatting the Date.

The optional attribute timeZone can be set to the id of a timeZone script varaible so that the Date if adjusted for that timeZone.

If the optional attribute locale is true, the Date is formatted for the clients locale if known.

The optional attribute date can be set to a Date object using a runtime expression value. If set, date will be used instead of the tag body.

The optional attribute default can be set to a default string to output if the date object doesn't exist or the tag body is not a valid date. If no default is set, the string "Invalid Date" is output.

The optional attribute localeRef can be used to specify the name of a page, session, application, or request scope attribute of type java.util.Locale to use.

JSP Tag Lib Descriptor

 <name>format</name>
 <tagclass>org.apache.taglibs.datetime.FormatTag</tagclass>
 <bodycontent>JSP</bodycontent>
 <info>Formats a date for output.</info>
   <attribute>
     <name>pattern</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>patternId</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>timeZone</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>locale</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>                             
     <name>date</name>
     <required>false</required>
     <rtexprvalue>true</rtexprvalue>
   </attribute>
   <attribute>                             
     <name>default</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>localeRef</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
 

Author:

Glenn Nielsen, Mark Femal

See Also:

Serialized Form

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

bodyContent

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

id, pageContext

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

EVAL_BODY_TAG

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

FormatTag()

Method Summary

int	doAfterBody() Method called at end of format tag body.
int	doEndTag() Method called at end of Tag
int	doStartTag() Method called at start of tag, always returns EVAL_BODY_TAG
void	setDate(java.util.Date date) Set the date to use (overrides tag body) for formatting
void	setDefault(java.lang.String default_text) Set the default text if an invalid date or no tag body is given
void	setLocale(boolean flag) Locale flag, if set to true, format date for client's preferred locale if known.
void	setLocaleRef(java.lang.String value) Provides a key to search the page context for in order to get the java.util.Locale to use.
void	setPattern(java.lang.String str) Set the pattern to use when formatting Date.
void	setPatternId(java.lang.String str) Set the pattern to use when parsing Date using a script variable attribute.
void	setTimeZone(java.lang.String tz) Set the time zone to use when formatting date.

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

doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

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

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

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

FormatTag

public FormatTag()

Method Detail

doStartTag

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

Method called at start of tag, always returns EVAL_BODY_TAG

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

EVAL_BODY_TAG

doAfterBody

public final int doAfterBody()
                      throws javax.servlet.jsp.JspException

Method called at end of format tag body.

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

SKIP_BODY

doEndTag

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

Method called at end of Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

EVAL_PAGE

setLocale

public final void setLocale(boolean flag)

Locale flag, if set to true, format date for client's preferred locale if known.

Parameters:

boolean - use users locale, true or false

setTimeZone

public final void setTimeZone(java.lang.String tz)

Set the time zone to use when formatting date. Value must be the name of a timeZone tag script variable ID.

Parameters:

String - name of timeZone to use

setPattern

public final void setPattern(java.lang.String str)

Set the pattern to use when formatting Date.

Parameters:

String - SimpleDateFormat style time pattern format string

setPatternId

public final void setPatternId(java.lang.String str)

Set the pattern to use when parsing Date using a script variable attribute.

Parameters:

String - name of script variable attribute id

setDate

public final void setDate(java.util.Date date)

Set the date to use (overrides tag body) for formatting

Parameters:

Date - to use for formatting (could be null)

setDefault

public final void setDefault(java.lang.String default_text)

Set the default text if an invalid date or no tag body is given

Parameters:

String - to use as default text

setLocaleRef

public void setLocaleRef(java.lang.String value)

Provides a key to search the page context for in order to get the java.util.Locale to use.

Parameters:

String - name of locale attribute to use