Package org.deltava.taglib.format

Class DurationFormatTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.format.UserSettingsTag

org.deltava.taglib.format.DurationFormatTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class DurationFormatTag
extends UserSettingsTag

A JSP tag to support the display of formatted date/time values.

Since:

7.0

Version:

10.1

Author:

Luke

See Also:

• Serialized Form

Field Summary

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
DurationFormatTag()

Method Summary

Modifier and Type	Method	Description
int	doEndTag()	Formats the date/time and writes it to the JSP output writer.
void	release()
void	setClassName(String cName)	Updates the CSS class for this formatted date/time.
void	setDefault(String defaultText)	Updates the text to display if the date is null.
void	setDuration(Duration d)	Sets the duration to display.
void	setLong(boolean isLong)	Updates whether to use a text format description.
final void	setPageContext(PageContext ctxt)	Sets the tag's JSP context and loads the user data.
void	setT(String pattern)	Updates the time format pattern.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

DurationFormatTag

public DurationFormatTag()

Method Details

setPageContext

public final void setPageContext(PageContext ctxt)

Description copied from class: UserSettingsTag

Sets the tag's JSP context and loads the user data.

Specified by:

setPageContext in interface Tag

Overrides:

setPageContext in class UserSettingsTag

Parameters:

ctxt - the JSP context

setClassName

public void setClassName(String cName)

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

Parameters:

cName - the class Name(s)

setDefault

public void setDefault(String defaultText)

Updates the text to display if the date is null.

Parameters:

defaultText - the text to display

setLong

public void setLong(boolean isLong)

Updates whether to use a text format description.

Parameters:

isLong - TRUE if text description should be used, otherwise FALSE

setT

public void setT(String pattern)

Updates the time format pattern.

Parameters:

pattern - the pattern string

Throws:

IllegalArgumentException - if DateTimeFormatter cannot interpret the pattern

setDuration

public void setDuration(Duration d)

Sets the duration to display.

Parameters:

d - the duration

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class TagSupport

doEndTag

public int doEndTag()
             throws JspException

Formats the date/time 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