com.raritantechnologies.quickstart.taglibrary
Class PageLinkForm

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.quickstart.taglibrary.PageLinkForm

All Implemented Interfaces:

IConfigurable, ICustomTag

Direct Known Subclasses:

AjaxPageFormRenderer

public class PageLinkForm

extends BodyTagSupport

implements ICustomTag, IConfigurable

JSP Custom tag that renders a result paging control.

Acquires the current set of results either from session cache for its search form or by forcing the search to be executed if its "isFirst" flag is set. The current ResultSet is needed to determine the total number of documents which in turn is needed to compute the page links. The current page number and page size are determined from the current http request. Finally, the page link control is rendered by an IPageLinkRenderer. The rendering class to be used can be set from the "rendererClass" JSP parameter - if not set, the BasicPageLinkRenderer is used.

Use of request parameters:
• If the "formType" parameter is set to "search", page link control will reset to page 1.
  
• If the "formType" parameter is set to "reset" or "clear" the page link control will return the no results string.
  
• If the "pageNum" parameter is set the page link control will go to the page given.
  

JSP Tag Configuration:

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

See Also:

Serialized Form

Field Summary

protected java.lang.String	pageNumParam
protected boolean	requiresFormType

Constructor Summary

PageLinkForm()

Method Summary

int	doAfterBody()
int	doStartTag()
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
java.lang.String	getCategory(RaritanPageContext rpc)
java.lang.String	getExcludeParams()
protected IResultSet	getResultSet(int pageNum, RaritanPageContext rpc)
java.lang.String	getSourceType(RaritanPageContext rpc)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map initParams)
void	setAction(java.lang.String action)
void	setActiveDisplayKey(java.lang.String displayKey)
void	setActiveDisplayParam(java.lang.String displayParam)
void	setAddPersistentParams(java.lang.String addPersistSt)
void	setAlwaysShow(java.lang.String alwaysShow)
void	setCacheURLName(java.lang.String cacheURLName)
void	setCategory(java.lang.String category)
void	setCategoryParam(java.lang.String categoryParam)
void	setDisplayFormClass(java.lang.String displayFormClass)
void	setExcludeParams(java.lang.String excludeParams)
void	setFieldDelimiter(java.lang.String fieldDelimiter) sets the field delimiter used by the setRendererParams( ) method (the default is "|" )
void	setFormName(java.lang.String formName)
void	setIgnoreFormTypes(java.lang.String ignoreFormTypes)
void	setIsFirst(java.lang.String aboveDisplayForm) Determines if this paging control is first on the page - and therefore should cause a search to be executed in the getBody( ) method before rendering the page control.
void	setName(java.lang.String name)
void	setNoResultsMessage(java.lang.String noResultsMess)
void	setPageNumParam(java.lang.String pageNumParam)
void	setPageSize(int pageSize)
void	setPageSize(java.lang.String pageSize)
void	setRendererClass(java.lang.String pageLinkRendererClass) Sets the IPageLinkRenderer class to be used to render the paging control.
void	setRendererParams(java.lang.String rendererParameters) Sets the parameters that should be used by the renderer.
void	setResultSetKey(java.lang.String resultSetKey)
void	setSourceType(java.lang.String sourceType)
void	setSourceTypeParam(java.lang.String sourceTypeParam)
void	setUserQueryParameters(java.lang.String userQueryParams)
void	setValueDelimiter(java.lang.String valueDelimiter) sets the value delimiter used by the setRendererParams( ) method (the default is "=" )

Methods inherited from class java.lang.Object

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

Field Detail

pageNumParam

protected java.lang.String pageNumParam

requiresFormType

protected boolean requiresFormType

Constructor Detail

PageLinkForm

public PageLinkForm()

Method Detail

setAction

public void setAction(java.lang.String action)

setPageSize

public void setPageSize(java.lang.String pageSize)

setPageSize

public void setPageSize(int pageSize)

setRendererClass

public void setRendererClass(java.lang.String pageLinkRendererClass)

Sets the IPageLinkRenderer class to be used to render the paging control.

setRendererParams

public void setRendererParams(java.lang.String rendererParameters)

Sets the parameters that should be used by the renderer.

Parameters:

rendererParameters - A packed string containing a set of name=value pairs. Format is name1=value | name2=value2 | name3=value3 ...

setFieldDelimiter

public void setFieldDelimiter(java.lang.String fieldDelimiter)

sets the field delimiter used by the setRendererParams( ) method (the default is "|" )

Parameters:

fieldDelimiter - The delimiter used to separate name/value pairs in the string passed to the setRendererParams( ) method. If the fieldDelimiter is ":" for example, the rendererParameters attribute should be formatted like "name1=value1:name2=value2"

setValueDelimiter

public void setValueDelimiter(java.lang.String valueDelimiter)

sets the value delimiter used by the setRendererParams( ) method (the default is "=" )

Parameters:

valueDelimiter - The delimiter used to separate name/value pairs in the string passed to the setRendererParams( ) method. If the valueDelimiter is "," for example, the rendererParameters attribute should be formatted like "name1,value1|name2,value2"

setDisplayFormClass

public void setDisplayFormClass(java.lang.String displayFormClass)

setName

public void setName(java.lang.String name)

setFormName

public void setFormName(java.lang.String formName)

setCategory

public void setCategory(java.lang.String category)

setCategoryParam

public void setCategoryParam(java.lang.String categoryParam)

setSourceType

public void setSourceType(java.lang.String sourceType)

setSourceTypeParam

public void setSourceTypeParam(java.lang.String sourceTypeParam)

setNoResultsMessage

public void setNoResultsMessage(java.lang.String noResultsMess)

setUserQueryParameters

public void setUserQueryParameters(java.lang.String userQueryParams)

setIsFirst

public void setIsFirst(java.lang.String aboveDisplayForm)

Determines if this paging control is first on the page - and therefore should cause a search to be executed in the getBody( ) method before rendering the page control.

Parameters:

aboveDisplayForm - "true" if is first, "false" if not.

setAddPersistentParams

public void setAddPersistentParams(java.lang.String addPersistSt)

setIgnoreFormTypes

public void setIgnoreFormTypes(java.lang.String ignoreFormTypes)

setCacheURLName

public void setCacheURLName(java.lang.String cacheURLName)

setActiveDisplayKey

public void setActiveDisplayKey(java.lang.String displayKey)

setActiveDisplayParam

public void setActiveDisplayParam(java.lang.String displayParam)

setPageNumParam

public void setPageNumParam(java.lang.String pageNumParam)

setResultSetKey

public void setResultSetKey(java.lang.String resultSetKey)

setAlwaysShow

public void setAlwaysShow(java.lang.String alwaysShow)

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag

doStartTag

public int doStartTag()
               throws JspException

Throws:

JspException

getBody

public java.lang.String getBody(RaritanPageContext rpc)

Description copied from interface: ICustomTag

Returns the tag body.

Specified by:

getBody in interface ICustomTag

Parameters:

rpc - Platform-neutral page context ( can be used in non J2EE environments such as ASP).

Returns:

The tag body text string.

getResultSet

protected IResultSet getResultSet(int pageNum,
                                  RaritanPageContext rpc)

getCategory

public java.lang.String getCategory(RaritanPageContext rpc)

getSourceType

public java.lang.String getSourceType(RaritanPageContext rpc)

doAfterBody

public int doAfterBody()
                throws JspException

Throws:

JspException

getExcludeParams

public java.lang.String getExcludeParams()

setExcludeParams

public void setExcludeParams(java.lang.String excludeParams)