org.opensubsystems.patterns.listdata.www
Class ListDataInitTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.opensubsystems.core.www.PageElementCacheTag
              org.opensubsystems.patterns.listdata.www.ListDataInitTag

All Implemented Interfaces:

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

public class ListDataInitTag
extends org.opensubsystems.core.www.PageElementCacheTag

Custom tag to initialize the page using the list data pattern. This needs to be the first tag of all list data tags and should be placed in the page before the html tag. The in emptypage.jsp layout will take the elements put into cache by this tag and place them at correct location.

Version:

$Id: ListDataInitTag.java,v 1.2 2007/02/20 04:17:45 bastafidli Exp $

Author:

Miro Halas

See Also:

Serialized Form

Code reviewer:

Miro Halas

Code reviewed:

Initial revision

Field Summary

protected java.lang.String

m_strDataAlias Name of the attribute under which the page is expecting the data published from the ListBrowserServlet.

Fields inherited from class org.opensubsystems.core.www.PageElementCacheTag

CACHE_INDICATOR, CSS_ELEMENT, JS_ELEMENT, m_strCacheas, m_strId, PAGE_ELEMENTS_CACHE, SCRIPT_ELEMENT

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

ListDataInitTag()
Constructor for custom tag.

Method Summary

int	doEndTag()
int	doStartTag()
java.lang.String	getDataAlias() Get the name of the attribute under which the page is expecting the data published from the ListBrowserServlet.
void	setDataAlias(java.lang.String strDataAlias) Set the name of the attribute under which the page is expecting the data published from the ListBrowserServlet.

Methods inherited from class org.opensubsystems.core.www.PageElementCacheTag

cache, getCacheas, getCachedContent, getCachedContent, getCachedContent, getCachedContentElements, getId, setCacheas, setId

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

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

findAncestorWithClass, 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

m_strDataAlias

protected java.lang.String m_strDataAlias

Name of the attribute under which the page is expecting the data published from the ListBrowserServlet. ListBrowserServlet always publishes its data using PARAMETER_DATA_OBJECT_LIST_NAME name. By specifying this alias this tag will automatically create attribute with the desirect name and the value of the attribute will be the data published under PARAMETER_DATA_OBJECT_LIST_NAME or it will create attribute with the name PARAMETER_DATA_OBJECT_LIST_NAME and the value of the attribute will be the data published under the specified alias.

Constructor Detail

ListDataInitTag

public ListDataInitTag()

Constructor for custom tag.

Method Detail

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class org.opensubsystems.core.www.PageElementCacheTag

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Specified by:

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

Overrides:

doEndTag in class org.opensubsystems.core.www.PageElementCacheTag

Throws:

javax.servlet.jsp.JspException

getDataAlias

public java.lang.String getDataAlias()

Get the name of the attribute under which the page is expecting the data published from the ListBrowserServlet. ListBrowserServlet always publishes its data using PARAMETER_DATA_OBJECT_LIST_NAME name. By specifying this alias this tag will automatically create attribute with the desirect name and the value of the attribute will be the data published under PARAMETER_DATA_OBJECT_LIST_NAME.

Returns:

String - name of the attribute under which the page is expecting the data published from the ListBrowserServlet.

setDataAlias

public void setDataAlias(java.lang.String strDataAlias)

Set the name of the attribute under which the page is expecting the data published from the ListBrowserServlet. ListBrowserServlet always publishes its data using PARAMETER_DATA_OBJECT_LIST_NAME name. By specifying this alias this tag will automatically create attribute with the desirect name and the value of the attribute will be the data published under PARAMETER_DATA_OBJECT_LIST_NAME.

Parameters:

strDataAlias - - name of the attribute under which the page is expecting the data published from the ListBrowserServlet.