2.17.2: 2011-06-17

net.sf.basedb.clients.web.taglib.table
Class Navigator

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by net.sf.basedb.clients.web.taglib.table.Navigator
All Implemented Interfaces:
Serializable, IterationTag, JspTag, Tag

public class Navigator
extends TagSupport

This tag is used to display a navigator for a pageable table of items. A pageable table is a table where only a limited (for example 30) items are show at once. The navigator makes it possible to step forwards and backwards among the pages. This tag must appear inside a <tbl:table> tag.

Syntax:

   <tbl:navigator
      id=...
      clazz=...
      style=...
      page=...
      rowsperpage=...
      totalrows=...
      visible=true|false
   >

Attribute Default value Required Description
id - no The ID of the navigator. The value of this attribute goes directly into the standard id attribute. This means that if you need a reference to the object in your own JavaScript code, you may for example use the following code:

navigator = document.getElementById('<id>');

clazz panel no The value if this attribute goes directly into the standard HTML class attribute. This allows you to apply different styles to different tables.
style - no The value if this attribute goes directly into the standard HTML style attribute. This allows you to apply different styles to different tables.
page 0 no The current page, starting from 0.
rowsperpage 30 no The number of rows on a single page.
totalrows - yes The total number of rows.
visible true no If the navigator bar should be visible or not.

This tag has no subtags.

Version:
2.0
Author:
Nicklas
See Also:
Serialized Form

Field Summary
private  String clazz
          Optional class attribute
private  int currentPage
          The current page.
private  boolean locked
           
private  int rowsPerPage
          The number of rows to display on a single page.
private static long serialVersionUID
           
private  String style
          Optional style attribute
private  Table table
          The parent <tbl:table> tag.
private  int totalRows
          The total number of rows.
private  boolean visible
          If the navigator bar should be visible or not.
 
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
Navigator()
           
 
Method Summary
 int doEndTag()
           
 String getClazz()
           
 int getPage()
           
 int getRowsperpage()
           
 String getStyle()
           
 int getTotalrows()
           
 boolean isLocked()
           
 boolean isVisible()
           
 void setClazz(String clazz)
           
 void setLocked(boolean locked)
           
 void setPage(int page)
           
 void setPage(String page)
           
 void setRowsperpage(int rowsPerPage)
           
 void setRowsperpage(String rowsPerPage)
           
 void setStyle(String style)
           
 void setTotalrows(int totalRows)
           
 void setTotalrows(long totalRows)
           
 void setTotalrows(String totalRows)
           
 void setVisible(boolean visible)
           
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doStartTag, 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
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

table

private Table table
The parent <tbl:table> tag.


clazz

private String clazz
Optional class attribute


style

private String style
Optional style attribute


currentPage

private int currentPage
The current page.


rowsPerPage

private int rowsPerPage
The number of rows to display on a single page.


totalRows

private int totalRows
The total number of rows.


visible

private boolean visible
If the navigator bar should be visible or not.


locked

private boolean locked
Constructor Detail

Navigator

public Navigator()
Method Detail

setClazz

public void setClazz(String clazz)

getClazz

public String getClazz()

setStyle

public void setStyle(String style)

getStyle

public String getStyle()

setPage

public void setPage(String page)

setPage

public void setPage(int page)

getPage

public int getPage()

setRowsperpage

public void setRowsperpage(String rowsPerPage)

setRowsperpage

public void setRowsperpage(int rowsPerPage)

getRowsperpage

public int getRowsperpage()

setTotalrows

public void setTotalrows(String totalRows)

setTotalrows

public void setTotalrows(int totalRows)

setTotalrows

public void setTotalrows(long totalRows)

getTotalrows

public int getTotalrows()

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

setLocked

public void setLocked(boolean locked)

isLocked

public boolean isLocked()

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class TagSupport
Throws:
JspException

2.17.2: 2011-06-17