net.smartlab.web.page
Class PaginateTag

java.lang.Object
  net.smartlab.web.page.AbstractTag
      net.smartlab.web.page.PaginateTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class PaginateTag
extends AbstractTag

TODO documentation

Author:

rlogiacco

Field Summary

static java.lang.String

PARAMETER TODO documentation Comment for PARAMETER

Fields inherited from class net.smartlab.web.page.AbstractTag

context

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

PaginateTag()

Method Summary

int	doStartTag()
protected java.lang.String	getHref() Returns the href part to create an anchor.
protected Paginator	getPaginator() TODO documentation
protected boolean	isForm() Checks if the pagination involves a form.
void	setFilter(boolean filter) Requires HTML compliance on href query part.
void	setForm(java.lang.String form) Sets the name of form to use to vehicle pagination informations.
void	setHref(java.lang.String href) Sets the url where pagination actions are submitted: leave blank or not specified to use the same page.
void	setName(java.lang.String name) Sets the name of the attribute containing the paginator instance.
void	setPages(int pages) Sets the maximum number of pages displayed in a row.
void	setProperty(java.lang.String property) Sets the name of the attribute property containing the paginator instance.
void	setSize(int size) Sets the number of items per page.

Methods inherited from class net.smartlab.web.page.AbstractTag

doEndTag, getParent, release, setPageContext, setParent

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER

public static final java.lang.String PARAMETER

TODO documentation Comment for PARAMETER

See Also:

Constant Field Values

Constructor Detail

PaginateTag

public PaginateTag()

Method Detail

doStartTag

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

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

setName

public void setName(java.lang.String name)

Sets the name of the attribute containing the paginator instance.

Parameters:

name - the name of the attribute containing the paginator instance.

setProperty

public void setProperty(java.lang.String property)

Sets the name of the attribute property containing the paginator instance.

Parameters:

property - the name of the attribute property containing the paginator instance

getHref

protected java.lang.String getHref()

Returns the href part to create an anchor.

Returns:

the href part to create an anchor.

setHref

public void setHref(java.lang.String href)

Sets the url where pagination actions are submitted: leave blank or not specified to use the same page.

Parameters:

href -

setForm

public void setForm(java.lang.String form)

Sets the name of form to use to vehicle pagination informations.

Parameters:

form -

setSize

public void setSize(int size)

Sets the number of items per page.

Parameters:

size -

setPages

public void setPages(int pages)

Sets the maximum number of pages displayed in a row.

Parameters:

pages -

getPaginator

protected Paginator getPaginator()

Description copied from class: AbstractTag

TODO documentation

Overrides:

getPaginator in class AbstractTag

Returns:

See Also:

AbstractTag.getPaginator()

isForm

protected boolean isForm()

Checks if the pagination involves a form. Pagination with forms uses an hidden field to pass pagination infos, otherwise a request parameter is used.

Returns:

true if the pagination involves a form, false otherwise.

setFilter

public void setFilter(boolean filter)

Requires HTML compliance on href query part.

Parameters:

filter - true if HTML compliance on href query part is required.