BasicPageLinkRenderer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.searchApp.taglibrary
Class BasicPageLinkRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicPageLinkRenderer

All Implemented Interfaces:: IConfigurable, IPageLinkRenderer

Direct Known Subclasses:: MoreFromSourceLinkRenderer, VCRPageLinkRenderer, VCRPageTotalsRenderer

public class BasicPageLinkRenderer
extends java.lang.Object
implements IPageLinkRenderer

Base implementation of a page link renderer. Renders paging links: next previous. Handles the generation of the next page and previous page hyperlinks. Subclasses can reuse the getLinkParams( ) and/or renderLink( ) methods to compute paging hyperlinks.

XML Configuration Template:

  <PageLinkRenderer class="com.raritantechnologies.searchApp.taglibrary.BasicPageLinkRenderer"
                       action="alternate method of setting action"
                       label="Records {start} to {end} of {total}"
                       previous="[ text for previous page link ]"
                       spacer="[ text between previous and next ]"
                       next="[ text for next page link ]" />
                       renderInactive="[true|false]"
                       class="css class"
                       useTable="true"
                       renderLinks="[true(default)|false] - prints next/previous link"
                       renderLabel="[true(default)|false] - prints record count label"
                       />

Developed by Raritan Technologies .

Author:: Ted Sullivan

Field Summary
`protected java.lang.String`	`action`
`protected java.util.Set`	`excludeParams`
`protected java.util.HashMap`	`extraParams`
`protected boolean`	`isParametric`
`protected java.lang.String`	`pageNumParam`

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IPageLinkRenderer

TEMPLATE

Constructor Summary
`BasicPageLinkRenderer()`

Method Summary
`void`	`addExcludeParameter(java.lang.String paramName)`
`void`	`addParameters(java.lang.String paramName, java.lang.String paramValue)`
`java.lang.String`	`getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext)`
`protected java.lang.String`	`getLinkParams(RaritanPageContext pageContext, boolean fromContext)`
`protected java.lang.String`	`getLinkParams(RaritanPageContext pageContext, boolean fromContext, java.util.Set excludeParams)`
`protected java.lang.String`	`getRequestURL(RaritanPageContext pContext)`
`java.lang.String`	`getRequestURL(RaritanPageContext pContext, java.util.Set excludeParams)`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize the search form renderer from the configuration XML.
`void`	`initialize(java.util.Map renderParams)`
`protected void`	`renderLink(int pageNum, java.lang.StringBuffer strbuf, RaritanPageContext pageContext)`
`void`	`setAction(java.lang.String action)` IPageLinkRenderer should use an href= attribute if an action is specified.
`void`	`setAddContext(boolean addContext)`
`void`	`setAddPersistentParams(boolean addPersistentParams)`
`void`	`setCacheURLName(java.lang.String cacheURLName)`
`void`	`setIgnoreFormTypes(java.lang.String ignoreFormTypes)` set the formType request values that will be ignored when creating the paging URL.
`void`	`setOnClickHandler(IPageLinkClickHandler onClickHandler)` If this is not null, use an onclick handler rather than an href attribute.
`void`	`setPageNumParam(java.lang.String pageNumParam)`

Methods inherited from class java.lang.Object

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

Field Detail

action

protected java.lang.String action

extraParams

protected java.util.HashMap extraParams

excludeParams

protected java.util.Set excludeParams

isParametric

protected boolean isParametric

pageNumParam

protected java.lang.String pageNumParam

Constructor Detail