com.raritantechnologies.quickstart.taglibrary
Class VCRPageSizeRenderer

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.VCRPageSizeRenderer

All Implemented Interfaces:

IConfigurable, IPageLinkRenderer

Direct Known Subclasses:

CompositePageLinkRenderer

public class VCRPageSizeRenderer

extends java.lang.Object

implements IPageLinkRenderer

Renders a set of page size links to change the number of results per display page.

XML Configuration Template:

 <DisplayForm rendererClass="com.raritantechnologies.quickstart.taglibrary.VCRPageSizeRenderer" 
                 break="  |  "  
                 pageSizeText="Results per page: " 
                 activeClass="[CSS class for active links]"
                 class="[alternate attribute for active links]" 
                 inactiveClass="[CSS class for inactive links - current page size]" 
                 defaultSize="10" >

     <pageSize size="10" />
     <pageSize size="20" />
     <pageSize size="50" />
     <pageSize size="100" />

 </DisplayForm>

 

Sample Display:

 Page Size: 10 | 20 | 50 |100

 

Developed by Raritan Technologies .

Author:

Alan Connell

Field Summary

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

TEMPLATE

Constructor Summary

VCRPageSizeRenderer()

Method Summary

void	addParameters(java.lang.String paramName, java.lang.String paramValue) IPageLinkRenderer should use an href= attribute if an action is specified.
java.lang.String	getAction()
boolean	getAddContext()
java.lang.String	getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext)
java.lang.String	getBreakChar()
java.lang.String	getConfigurationXML()
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getCssClass()
java.lang.String	getDefaultSize()
java.lang.String	getInactiveClass()
java.lang.String[]	getPageSizes()
java.lang.String	getPageSizeText()
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	setBreakChar(java.lang.String brk)
void	setCacheURLName(java.lang.String cacheURLName)
void	setCssClass(java.lang.String clazz)
void	setDefaultSize(java.lang.String defaultSize)
void	setIgnoreFormTypes(java.lang.String ignoreFormTypes) set the formType request values that will be ignored when creating the paging URL.
void	setInactiveClass(java.lang.String inactiveClass)
void	setOnClickHandler(IPageLinkClickHandler onClickHandler) Add an OnClick handler if this set method is called.
void	setPageNumParam(java.lang.String pageNumParam)
void	setPageSizes(java.lang.String[] pageSizes)
void	setPageSizeText(java.lang.String pageSizeText)

Methods inherited from class java.lang.Object

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

Constructor Detail

VCRPageSizeRenderer

public VCRPageSizeRenderer()

Method Detail

initialize

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

Description copied from interface: IPageLinkRenderer

Initialize the search form renderer from the configuration XML.

Specified by:

initialize in interface IPageLinkRenderer

initialize

public void initialize(java.util.Map renderParams)

Specified by:

initialize in interface IPageLinkRenderer

getBody

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

Specified by:

getBody in interface IPageLinkRenderer

addParameters

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

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

Specified by:

addParameters in interface IPageLinkRenderer

setOnClickHandler

public void setOnClickHandler(IPageLinkClickHandler onClickHandler)

Add an OnClick handler if this set method is called.

Specified by:

setOnClickHandler in interface IPageLinkRenderer

setAddPersistentParams

public void setAddPersistentParams(boolean addPersistentParams)

Specified by:

setAddPersistentParams in interface IPageLinkRenderer

setPageSizes

public void setPageSizes(java.lang.String[] pageSizes)

getPageSizes

public java.lang.String[] getPageSizes()

setPageSizeText

public void setPageSizeText(java.lang.String pageSizeText)

getPageSizeText

public java.lang.String getPageSizeText()

setBreakChar

public void setBreakChar(java.lang.String brk)

getBreakChar

public java.lang.String getBreakChar()

setAction

public void setAction(java.lang.String action)

Description copied from interface: IPageLinkRenderer

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

Specified by:

setAction in interface IPageLinkRenderer

getAction

public java.lang.String getAction()

setAddContext

public void setAddContext(boolean addContext)

Specified by:

setAddContext in interface IPageLinkRenderer

getAddContext

public boolean getAddContext()

setCssClass

public void setCssClass(java.lang.String clazz)

getCssClass

public java.lang.String getCssClass()

setInactiveClass

public void setInactiveClass(java.lang.String inactiveClass)

getInactiveClass

public java.lang.String getInactiveClass()

setDefaultSize

public void setDefaultSize(java.lang.String defaultSize)

getDefaultSize

public java.lang.String getDefaultSize()

setIgnoreFormTypes

public void setIgnoreFormTypes(java.lang.String ignoreFormTypes)

Description copied from interface: IPageLinkRenderer

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

Specified by:

setIgnoreFormTypes in interface IPageLinkRenderer

setCacheURLName

public void setCacheURLName(java.lang.String cacheURLName)

Specified by:

setCacheURLName in interface IPageLinkRenderer

setPageNumParam

public void setPageNumParam(java.lang.String pageNumParam)

Specified by:

setPageNumParam in interface IPageLinkRenderer

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()