pt.moredata.taglibs.filter
Class PaginatorTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      pt.moredata.taglibs.filter.PaginatorTag

All Implemented Interfaces:

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

public class PaginatorTag

extends javax.servlet.jsp.tagext.TagSupport

implements javax.servlet.jsp.tagext.TryCatchFinally

PaginatorTag.java Company MoreData

Version:

$Revision: 1.4 $

Author:

pcarmo

See Also:

Serialized Form

Field Summary

static java.lang.String	ACTION_KEY Chave usada para transmitir a accao que o PaginatorController deve tomar.
static java.lang.String	CHANGE_NUM_OF_RECORDS_COMMAND Chave usada para transmitir ao controlador o número de registos a serem visualizados por página.
static java.lang.String	GOTO_COMMAND Accao dada ao controlador para passar para uma determinada pagina.
static java.lang.String	GOTO_KEY Chave usada para transmitir ao controlador qual a pagina que devera ser visualizada.
static java.lang.String	NEXT_COMMAND Accao dada ao controlador para passar para a pagina seguinte.
static java.lang.String	NUMBER_RECORDS_KEY Chave usada para guardar o o número de registos visualizados em cada página.
static java.lang.String	PREVIOUS_COMMAND Accao dada ao controlador para passar para a pagina anterior.
static java.lang.String	URI_KEY Chave usada para guardar o uri da pagina para a qual o controlador devera reencaminhar o request depois de ter alterado a pagina.

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

PaginatorTag()

Method Summary

static void	clearPaginatorInfo(javax.servlet.http.HttpSession session, java.lang.String uri) limpa a informacao do paginador na sessao.
void	doCatch(java.lang.Throwable t) Invoked if a Throwable occurs while evaluating the BODY inside a tag or in any of the following methods: Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody().
int	doEndTag() Processa o fim da tag.
void	doFinally() Invoked in all cases after doEndTag() for any class implementing Tag, IterationTag or BodyTag.
int	doStartTag() Processa o inicio da tag.
static java.lang.String	getPaginatorInfoKey(java.lang.String uri) Devolve a chave usada para guardar a informacao do paginador na sessao.
void	setPageLength(int pageLength) Setter for property pageLength.
void	setPageLength(java.lang.String pageLength) Setter for property pageLength.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

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

ACTION_KEY

public static final java.lang.String ACTION_KEY

Chave usada para transmitir a accao que o PaginatorController deve tomar.

See Also:

Constant Field Values

PREVIOUS_COMMAND

public static final java.lang.String PREVIOUS_COMMAND

Accao dada ao controlador para passar para a pagina anterior.

See Also:

Constant Field Values

NEXT_COMMAND

public static final java.lang.String NEXT_COMMAND

Accao dada ao controlador para passar para a pagina seguinte.

See Also:

Constant Field Values

GOTO_COMMAND

public static final java.lang.String GOTO_COMMAND

Accao dada ao controlador para passar para uma determinada pagina.

See Also:

Constant Field Values

CHANGE_NUM_OF_RECORDS_COMMAND

public static final java.lang.String CHANGE_NUM_OF_RECORDS_COMMAND

Chave usada para transmitir ao controlador o número de registos a serem visualizados por página.

See Also:

Constant Field Values

GOTO_KEY

public static final java.lang.String GOTO_KEY

Chave usada para transmitir ao controlador qual a pagina que devera ser visualizada.

See Also:

Constant Field Values

URI_KEY

public static final java.lang.String URI_KEY

Chave usada para guardar o uri da pagina para a qual o controlador devera reencaminhar o request depois de ter alterado a pagina.

See Also:

Constant Field Values

NUMBER_RECORDS_KEY

public static final java.lang.String NUMBER_RECORDS_KEY

Chave usada para guardar o o número de registos visualizados em cada página.

See Also:

Constant Field Values

Constructor Detail

PaginatorTag

public PaginatorTag()

Method Detail

doStartTag

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

Processa o inicio da tag.

Specified by:

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

Returns:

A accao que deve ser tomada pelo servidor de .jsp apos ler o inicio da tag.

Throws:

javax.servlet.jsp.JspTagException - Caso ocorra um erro a processar a tag.

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspTagException

Processa o fim da tag.

Specified by:

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

Returns:

a accao que deve ser tomada pelo servidor de .jsp apos ler a tag.

Throws:

javax.servlet.jsp.JspTagException - Caso ocorra um erro a processar a tag.

doCatch

public void doCatch(java.lang.Throwable t)
             throws java.lang.Throwable

Invoked if a Throwable occurs while evaluating the BODY inside a tag or in any of the following methods: Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody(). This method is not invoked if the Throwable occurs during one of the setter methods. This method may throw an exception (the same or a new one) that will be propagated further up the nest chain. If an exception is thrown, doFinally() will be invoked. This method is intended to be used to respond to an exceptional condition.

Specified by:

doCatch in interface javax.servlet.jsp.tagext.TryCatchFinally

Parameters:

t - - The throwable exception navigating through this tag.

Throws:

java.lang.Throwable - - if the exception is to be rethrown further up the nest chain.

doFinally

public void doFinally()

Invoked in all cases after doEndTag() for any class implementing Tag, IterationTag or BodyTag. This method is invoked even if an exception has occurred in the BODY of the tag, or in any of the following methods: Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody(). This method is not invoked if the Throwable occurs during one of the setter methods. This method should not throw an Exception. This method is intended to maintain per-invocation data integrity and resource management actions.

Specified by:

doFinally in interface javax.servlet.jsp.tagext.TryCatchFinally

setPageLength

public void setPageLength(int pageLength)

Setter for property pageLength.

Parameters:

pageLength - New value of property pageLength.

setPageLength

public void setPageLength(java.lang.String pageLength)

Setter for property pageLength.

Parameters:

pageLength - New value of property pageLength.

getPaginatorInfoKey

public static java.lang.String getPaginatorInfoKey(java.lang.String uri)

Devolve a chave usada para guardar a informacao do paginador na sessao.

Parameters:

uri - URI da pagina para a qual se pretende obter a informacao de paginacao.

Returns:

A chave usada para guardar a informacao do paginador na sessao.

clearPaginatorInfo

public static void clearPaginatorInfo(javax.servlet.http.HttpSession session,
                                      java.lang.String uri)

limpa a informacao do paginador na sessao.

Parameters:

session - uri Sessão e URI para os quais se pretende limpar a informação de paginação