net.mlw.vlh.web.tag
Class ValueListSpaceTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          net.mlw.vlh.web.tag.ValueListSpaceTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, ParamAddable, Serializable, javax.servlet.jsp.tagext.Tag

public class ValueListSpaceTag

extends javax.servlet.jsp.tagext.BodyTagSupport

implements ParamAddable

Version:

$Revision: 1.29 $ $Date: 2005/11/23 14:47:51 $

Author:

Matthew L. Wilson, Andrej Zachar, Luciano Cunha

See Also:

Serialized Form

Field Summary

protected ValueListConfigBean	config
protected String	excludeParameters
protected TableInfo	tableInfo
protected ValueList	valueList
protected String	valueListName
protected String	valueListScope

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_BUFFERED, EVAL_BODY_TAG

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

ValueListSpaceTag()

Method Summary

void	addParam(String key, String value) Add params to url.
int	doAfterBody() Write the bodyContent.
int	doEndTag()
int	doStartTag()
void	excludeParameters() Exclude parameters.
ValueListConfigBean	getConfig()
ValueListSpaceTag	getParentRootTag() Parent root tag in case of nested valuelist
TableInfo	getTableInfo()
ValueList	getValueList() If is your retrieved ValueList null or you forgot to send a valueList it returns the ValueListNullSpacer.
void	release() Called on a Tag handler to release state.
void	setConfigName(String configName)
void	setExcludeParameters(String excludedParameters) Setter for the excluded properties
void	setId(String id)
void	setIncludeParameters(String forwardParams) Setter for the included properties
void	setScope(String valueListScope)
void	setUrl(String url) Setter for the base URL.
void	setValue(String name) Sets the name of the ValueList
void	setValueList(ValueList valueList)

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

doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, 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

Field Detail

config

protected ValueListConfigBean config

valueList

protected ValueList valueList

tableInfo

protected TableInfo tableInfo

valueListName

protected String valueListName

valueListScope

protected String valueListScope

excludeParameters

protected String excludeParameters

Constructor Detail

ValueListSpaceTag

public ValueListSpaceTag()

Method Detail

getParentRootTag

public ValueListSpaceTag getParentRootTag()

Parent root tag in case of nested valuelist

Returns:

parent root tag

doStartTag

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

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

excludeParameters

public void excludeParameters()

Exclude parameters.

doAfterBody

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

Write the bodyContent.

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Throws:

javax.servlet.jsp.JspException

See Also:

IterationTag.doAfterBody()

doEndTag

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

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doEndTag()

setUrl

public void setUrl(String url)

Setter for the base URL.

Parameters:

url - New value of property url.

setIncludeParameters

public void setIncludeParameters(String forwardParams)

Setter for the included properties

Parameters:

forwardParams - The included properties

setExcludeParameters

public void setExcludeParameters(String excludedParameters)

Setter for the excluded properties

Parameters:

excludedParameters - The excluded properties

setValue

public void setValue(String name)

Sets the name of the ValueList

Parameters:

name - The name to set of the ValueList.

getValueList

public ValueList getValueList()

If is your retrieved ValueList null or you forgot to send a valueList it returns the ValueListNullSpacer.

Returns:

Returns the valueList. NEVER RETURN NULL

setValueList

public void setValueList(ValueList valueList)

Parameters:

valueList - The valueList to set.

getTableInfo

public TableInfo getTableInfo()

Returns:

Returns the tableInfo.

setId

public void setId(String id)

Parameters:

id - The id to set.

getConfig

public ValueListConfigBean getConfig()

Returns:

Returns the config.

setConfigName

public void setConfigName(String configName)

Parameters:

configName - The config to set.

setScope

public void setScope(String valueListScope)

Parameters:

valueListScope - The valueListScope to set.

addParam

public void addParam(String key,
                     String value)

Add params to url.

Specified by:

addParam in interface ParamAddable

Parameters:

value - The value of the pram.

See Also:

ParamAddable.addParam(java.lang.String, java.lang.String)

release

public void release()

Called on a Tag handler to release state. The page compiler guarantees that JSP page implementation objects will invoke this method on all tag handlers, but there may be multiple invocations on doStartTag and doEndTag in between.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

See Also:

Tag.release()