org.hdpagination.web.taglib
Class PaginationRequiredTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.hdpagination.web.taglib.PaginationRequiredTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class PaginationRequiredTag
extends javax.servlet.jsp.tagext.TagSupport

This JSP tag is used as an outer tag of other pagination information display tags ('currentPage', 'totalPages', 'totalRecords' and 'recordScope').

The purpose of this tag is to check if search result can fit within one page. If that's the case, then its enclosed content(including what is generated by the enclosed tags) will not be rendered.

Author:
Liangfeng Ren
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
PaginationRequiredTag()
           
 
Method Summary
 int doStartTag()
           
 void setActionId(java.lang.String actionId)
          set action identifier.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, 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

PaginationRequiredTag

public PaginationRequiredTag()
Method Detail

setActionId

public void setActionId(java.lang.String actionId)
set action identifier. This property is used to retrieve a instance of Page from HttpServletSession, which contains all pagination related information (e.g. current page no, total records).

Parameters:
actionId -

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.TagSupport
Throws:
javax.servlet.jsp.JspException


Copyright © 2008 HDPagination All Rights Reserved.