Package org.deltava.taglib.format

Class EliteProgressTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.format.UserSettingsTag

org.deltava.taglib.format.EliteProgressTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class EliteProgressTag
extends UserSettingsTag

A JSP tag to display Elite level progress bars.

Since:

9.2

Version:

9.2

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

Method Summary

Modifier and Type	Method	Description
int	doEndTag()
void	release()
void	setClassName(String cn)	Sets the completed progress bar CSS class name.
void	setLevel(EliteLevel lvl)	Sets the Elite level progress to render.
void	setPageContext(PageContext ctxt)	Sets the tag's JSP context and loads the user data.
void	setPercent(boolean isPct)	Sets whether the width of the progress bar is in percent.
void	setPrev(EliteLevel lvl)	Sets the previous Elite level.
void	setProgress(int p)	Sets the Elite level progress.
void	setRemainingClassName(String cn)	Sets the remaining progress bar CSS class name.
void	setShowUnits(boolean showUnits)	Sets whether to display units in the progress bar text.
void	setUnits(String u)	Sets the units to display.
void	setWidth(int w)	Sets the progress bar width base.
void	setWidthType(String wt)	Sets the total bar width type.

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

EliteProgressTag

public EliteProgressTag()

Method Details

setProgress

public void setProgress(int p)

Sets the Elite level progress.

Parameters:

p - the progress in units

setWidth

public void setWidth(int w)

Sets the progress bar width base.

Parameters:

w - the base width

setWidthType

public void setWidthType(String wt)

Sets the total bar width type.

Parameters:

wt - P for proportional, F for fixed or L for log5

setPercent

public void setPercent(boolean isPct)

Sets whether the width of the progress bar is in percent.

Parameters:

isPct - TRUE if percent, FALSE if pixels

setShowUnits

public void setShowUnits(boolean showUnits)

Sets whether to display units in the progress bar text.

Parameters:

showUnits - TRUE if units displayed, otherwise FALSE

setUnits

public void setUnits(String u)

Sets the units to display.

Parameters:

u - an EliteUnit enumeration

setLevel

public void setLevel(EliteLevel lvl)

Sets the Elite level progress to render.

Parameters:

lvl - the EliteLevel

setPrev

public void setPrev(EliteLevel lvl)

Sets the previous Elite level.

Parameters:

lvl - the previous EliteLevel

setClassName

public void setClassName(String cn)

Sets the completed progress bar CSS class name.

Parameters:

cn - the class name

setRemainingClassName

public void setRemainingClassName(String cn)

Sets the remaining progress bar CSS class name.

Parameters:

cn - the class name

setPageContext

public 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

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class TagSupport

Throws:

JspException

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class TagSupport