org.deltava.taglib.content
Class GetSystemDataTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.deltava.taglib.content.GetSystemDataTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class GetSystemDataTag
extends TagSupport

A JSP tag to stuff data from the SystemData singleton into the request.

Since:

1.0

Version:

3.1

Author:

Luke

See Also:

Serialized Form

Field Summary

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

GetSystemDataTag()

Method Summary

int	doEndTag() Executes the tag handler and stuffs the SystemData object into the request.
void	release() Releases the tag's state variables.
void	setDefault(Object value) Sets the default value of the attribute, if the SystemData property is not found.
void	setMapValues(boolean mapToList) If the SystemData property is a Map, save only its values to the request.
void	setName(String objName) Sets the SystemData property name.
void	setSort(boolean doSort) Sort the values.
void	setVar(String vName) Sets the request attribute name.

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

doAfterBody, doStartTag, 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

Constructor Detail

GetSystemDataTag

public GetSystemDataTag()

Method Detail

setVar

public void setVar(String vName)

Sets the request attribute name.

Parameters:

vName - the name of the request attribute to store the data in

setName

public void setName(String objName)

Sets the SystemData property name.

Parameters:

objName - the name of the SystemData property to retrieve.

setMapValues

public void setMapValues(boolean mapToList)

If the SystemData property is a Map, save only its values to the request.

Parameters:

mapToList - TRUE if only values are to be set, otherwise FALSE

setSort

public void setSort(boolean doSort)

Sort the values.

Parameters:

doSort - TRUE if the collection values should be sorted, otherwise FALSE

setDefault

public void setDefault(Object value)

Sets the default value of the attribute, if the SystemData property is not found.

Parameters:

value - the default value

release

public void release()

Releases the tag's state variables.

Specified by:

release in interface Tag

Overrides:

release in class TagSupport

doEndTag

public int doEndTag()
             throws JspException

Executes the tag handler and stuffs the SystemData object into the request.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class TagSupport

Returns:

TagSupport.EVAL_PAGE

Throws:

JspException - if an error occurs