com.raritantechnologies.searchApp.taglibrary
Interface IPageLinkRenderer

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

BasicPageLinkRenderer, BasicPageSizeLinkRenderer, VCRPageSizeRenderer

public interface IPageLinkRenderer

extends IConfigurable

Interface for all result display page data renderers, including page link (next/previous) and page size (number of results per page) renderers.

Similar to IDisplayFormRenderer except that this interface does not provide access to underlying Result Renderers.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String

TEMPLATE

Method Summary

void	addParameters(java.lang.String paramName, java.lang.String paramValue)
java.lang.String	getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext)
void	initialize(org.w3c.dom.Element elem) Initialize the search form renderer from the configuration XML.
void	initialize(java.util.Map renderParams)
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) Add an OnClick handler if this set method is called.
void	setPageNumParam(java.lang.String pageNumParam)

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE

See Also:

Constant Field Values

Method Detail

initialize

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

Initialize the search form renderer from the configuration XML.

Specified by:

initialize in interface IConfigurable

initialize

public void initialize(java.util.Map renderParams)

getBody

public java.lang.String getBody(IResultSet resultSet,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

setAction

public void setAction(java.lang.String action)

IPageLinkRenderer should use an href= attribute if an action is specified.

setAddContext

public void setAddContext(boolean addContext)

setAddPersistentParams

public void setAddPersistentParams(boolean addPersistentParams)

addParameters

public void addParameters(java.lang.String paramName,
                          java.lang.String paramValue)

setOnClickHandler

public void setOnClickHandler(IPageLinkClickHandler onClickHandler)

Add an OnClick handler if this set method is called.

setIgnoreFormTypes

public void setIgnoreFormTypes(java.lang.String ignoreFormTypes)

set the formType request values that will be ignored when creating the paging URL.

setCacheURLName

public void setCacheURLName(java.lang.String cacheURLName)

setPageNumParam

public void setPageNumParam(java.lang.String pageNumParam)