com.zentense.step2.util
Class Pager

java.lang.Object
  com.zentense.step2.util.Pager

public class Pager
extends java.lang.Object

This class generates a fully customizable pager

Version:

$Revision: 1.12 $

Author:

Jose R. Cabanes (aka Kurt)

Constructor Summary

Pager()
Default constructor

Method Summary

java.lang.String	draw(java.lang.String params)
java.lang.String	drawXML(java.lang.String name, java.lang.String params)
java.lang.String	fullRender() Renders a previously initialized pager.
java.lang.String	fullRender(int max) Initializes and renders the pager (with all buttons if visible)
java.lang.String	getBegId() Gets the URL parameter identifier for the beginning row
int	getNumPage() Return the current page being visible
int	getNumPages(int max) Return the calculated number of pages
int	getStep() Gets the number of items shown in each page.
void	hideButtons() Don't render pager first, next, previous and last buttons.
void	hideOnePage() Renders an empty string when there is only one page.
void	initRender(int begInt, int maxstr) Initializes pager for being rendered
void	initXML()
boolean	isVisible(int max) There are more than one pages?
void	loop() Make the pager looped (it shows links to several pages).
void	noloop() Makes the pager not looped (Show only current page)
java.lang.String	renderNext() Renders next and last buttons if visibl
java.lang.String	renderPager() Renders the pager without any button
java.lang.String	renderPrev() Renders previous and first buttons if visible
java.lang.String	renderXML(java.lang.String name)
void	setBegId(java.lang.String begId) Sets the name of URL parameter that will be used as the pointer to the first row to be viewed in current page.
void	setBegin(int begin) Sets the first item to be rendered in current page. 0 means that this page is the first page.
void	setHTML(java.lang.String str) Adds HTML code for rendering links to other pages.
void	setHTMLFirst(java.lang.String str) Sets the HTML code for rendering the link to first page.
void	setHTMLLast(java.lang.String str) Sets the HTML code for rendering the link to last page.
void	setHTMLNext(java.lang.String str) Sets the HTML code for rendering the link to next page.
void	setHTMLPrev(java.lang.String str) Sets the HTML code for rendering the link to previous page.
void	setHTMLSel(java.lang.String str) Adds HTML code for rendering the current page link in the pager.
void	setHTMLSeparator(java.lang.String str) Sets the HTML code for separator.
void	setLimit(int limit) Sets the maximum number of links to pages to be rendered.
void	setParams(java.lang.String params) Sets the URL params needed for constructing links to other pages.
void	setStep(int step) Sets the number of items to be shown in each page.
void	showButtons() Render pager first, next, previous and last buttons.
void	showOnePage() Renders pager even when it has a unique page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pager

public Pager()

Default constructor

Method Detail

loop

public final void loop()

Make the pager looped (it shows links to several pages). This is the default.

noloop

public final void noloop()

Makes the pager not looped (Show only current page)

initXML

public void initXML()

hideOnePage

public final void hideOnePage()

Renders an empty string when there is only one page.

showOnePage

public final void showOnePage()

Renders pager even when it has a unique page. This is the default.

hideButtons

public final void hideButtons()

Don't render pager first, next, previous and last buttons.

showButtons

public final void showButtons()

Render pager first, next, previous and last buttons. This is the default.

setBegId

public void setBegId(java.lang.String begId)

Sets the name of URL parameter that will be used as the pointer to the first row to be viewed in current page. By default this is 'beg'.

Parameters:

begId - Indentifier

getBegId

public java.lang.String getBegId()

Gets the URL parameter identifier for the beginning row

Returns:

Identifier

setHTML

public void setHTML(java.lang.String str)

Adds HTML code for rendering links to other pages. Default is <a href='<$servlet$><Params>'><Page></a> &nbsp;

Parameters:

str - Code for rendering other pages.

setHTMLSel

public void setHTMLSel(java.lang.String str)

Adds HTML code for rendering the current page link in the pager. Default is <b><Page></b> &nbsp;

Parameters:

str - Code for rendering current page

setHTMLFirst

public void setHTMLFirst(java.lang.String str)

Sets the HTML code for rendering the link to first page. Defult is <a href='<$servlet$><Params>'>&lt;&lt;&lt;</a> &nbsp;

Parameters:

str - Code for button to first page

setHTMLLast

public void setHTMLLast(java.lang.String str)

Sets the HTML code for rendering the link to last page. Default is <a href='<$servlet$><Params>'>&gt;&gt;&gt;</a>

Parameters:

str - Code for rendering button to last page

setHTMLNext

public void setHTMLNext(java.lang.String str)

Sets the HTML code for rendering the link to next page. Default is <a href='<$servlet$><Params>'>&gt;</a> &nbsp;

Parameters:

str - Code for rendering button to next page

setHTMLPrev

public void setHTMLPrev(java.lang.String str)

Sets the HTML code for rendering the link to previous page. Default is <a href='<$servlet$><Params>'>&lt;</a> &nbsp;

Parameters:

str - Code for rendering button to previous page.

setHTMLSeparator

public void setHTMLSeparator(java.lang.String str)

Sets the HTML code for separator. Default is    |   

Parameters:

str - Code for rendering separator between pages

setLimit

public void setLimit(int limit)

Sets the maximum number of links to pages to be rendered. By default: 7. If noloop is called this has no effect.

Parameters:

limit - Max number of links to pages

setParams

public void setParams(java.lang.String params)

Sets the URL params needed for constructing links to other pages.

Parameters:

params - URL params for creating links to other pages.

setStep

public void setStep(int step)

Sets the number of items to be shown in each page. Default is 10.

Parameters:

step - Number of items per page.

getStep

public final int getStep()

Gets the number of items shown in each page.

Returns:

Number of items per 'step'.

setBegin

public void setBegin(int begin)

Sets the first item to be rendered in current page. 0 means that this page is the first page.

Parameters:

begin - Number of first item.

isVisible

public final boolean isVisible(int max)

There are more than one pages?

Parameters:

max - Total number of items to be pages

Returns:

true if the the list of items needs to be paged

getNumPages

public int getNumPages(int max)

Return the calculated number of pages

Parameters:

max - Total number of items to be paged

Returns:

Estimated number of pages.

getNumPage

public final int getNumPage()

Return the current page being visible

Returns:

Current page number

fullRender

public final java.lang.String fullRender(int max)

Initializes and renders the pager (with all buttons if visible)

Parameters:

max - Total number of items to be paged

Returns:

Rendered pager

fullRender

public final java.lang.String fullRender()

Renders a previously initialized pager.

Returns:

Rendered pager

draw

public final java.lang.String draw(java.lang.String params)

initRender

public void initRender(int begInt,
                       int maxstr)

Initializes pager for being rendered

Parameters:

begInt - Number of items per page

maxstr - Total number of items to be paged

renderPager

public java.lang.String renderPager()

Renders the pager without any button

Returns:

Rendered pager without buttons

drawXML

public final java.lang.String drawXML(java.lang.String name,
                                      java.lang.String params)

renderXML

public java.lang.String renderXML(java.lang.String name)

renderPrev

public java.lang.String renderPrev()

Renders previous and first buttons if visible

Returns:

Rendered buttons

renderNext

public java.lang.String renderNext()

Renders next and last buttons if visibl

Returns:

Rendered buttons