com.acsinet_solutions.cetia4.tags.pager
Class PagerTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.acsinet_solutions.cetia4.tags.support.LogBodyTagSupport
              com.acsinet_solutions.cetia4.tags.pager.PagerTag

All Implemented Interfaces:

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

public final class PagerTag
extends LogBodyTagSupport
implements ParameterAppender

Pager tag class parent of all other pager tags. initializes the paged results variable.

Author:

Santiago Arriaga

See Also:

PagedResults, PagingUtils, Serialized Form

Field Summary

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

PagerTag()

Method Summary

void	addParameter(java.lang.String key, java.lang.String value) Append a parameter
int	doEndTag()
int	doStartTag()
protected URLLink	getLink() Get a reference to the internal generated link.
protected PagedResults	getPagedResults() Get a reference to the results object.
void	removeParameter(java.lang.String key) Remove a parameter
void	setAction(java.lang.String action) Sets the relative or absolute action string
void	setMethod(java.lang.String method) Set the method to be executed by the current action.
void	setResults(PagedResults results) set the not-null results instance over which the pagination will be performed

Methods inherited from class com.acsinet_solutions.cetia4.tags.support.LogBodyTagSupport

doCatch, doFinally, fillDynamicValues, fillDynamicValues, getConfiguration, getDynamicAttributes, getLocale, getLogger, getPortalPath, getRequest, getServletContext, getSession, setDynamicAttribute

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

PagerTag

public PagerTag()

Method Detail

setResults

public final void setResults(PagedResults results)
                      throws javax.servlet.jsp.JspException

set the not-null results instance over which the pagination will be performed

Throws:

javax.servlet.jsp.JspException

setAction

public final void setAction(java.lang.String action)

Sets the relative or absolute action string

setMethod

public final void setMethod(java.lang.String method)

Set the method to be executed by the current action.

addParameter

public void addParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: ParameterAppender

Append a parameter

Specified by:

addParameter in interface ParameterAppender

Parameters:

key - A not-null String instance

value - A not-null String instance

removeParameter

public final void removeParameter(java.lang.String key)

Description copied from interface: ParameterAppender

Remove a parameter

Specified by:

removeParameter in interface ParameterAppender

getPagedResults

protected final PagedResults getPagedResults()

Get a reference to the results object. Meant to be used from nested tags.

getLink

protected final URLLink getLink()

Get a reference to the internal generated link.

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

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 LogBodyTagSupport

Throws:

javax.servlet.jsp.JspException