com.dpslink.flash.servlet

Interface PagingServlet

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AdmAccountSelect, AdmCategoryProductAdd, AdmCategoryProductList, AdmCategorySelect, AdmCategorySubcatAdd, AdmCategorySubcatList, AdmCountrySelect, AdmLeadtimeSelect, AdmManufacturerSelect, AdmPendingProductEditBasic, AdmPendingProductEditDescriptions, AdmPendingProductEditImages, AdmPendingProductEditSelected, AdmPendingProductList, AdmProductAttributeAddEdit, AdmProductAttributeDescrSelect, AdmProductAttributeList, AdmProductCategoryAdd, AdmProductCategoryList, AdmProductDescriptionEdit, AdmProductEdit, AdmProductImageEdit, AdmProductImportCandidateList, AdmProductProfile, AdmProductSelect, AdmProductServlet, AdmSalesRepCustomerAdd, AdmSalesRepCustomerList, AdmSalesRepSelect, AdmSalesRepUserSelect, AdmSecurityProfileSelect, AdmShipperSelect, AdmSpecialProductAdd, AdmSpecialProductList, AdmSpecialSelect, AdmStateSelect, AdmUnitMeasureSelect, AdmVerifyProductFiles, AdmWordFixSelect, Home, MainPagingServlet, Products, ProductSearchResults, ProductSpecial, SfiAccountSelect

public interface PagingServlet
extends java.io.Serializable

Defines the publicly accessible servlet methods which are unique to paging servlet processing. Adds additional functionality to the base servlet.

For use by servlets that allow for paging through a list of records.

Method Summary

Modifier and Type	Method and Description
int	setTemplatePagingBegIndex(PagingServletContext pgCtx) Invoked by a subclass' implementation of setTemplateData to set the paging beginning index data required by the html template.
int	setTemplatePagingEndIndex(PagingServletContext pgCtx) Invoked by a subclass' implementation of setTemplateData to set the paging ending index data required by the html template.
void	setTemplatePagingLinks(PagingServletContext pgCtx, int listSize) Invoked by a subclass' implementation of setTemplateData to set the paging links data required by the html template.

Method Detail

setTemplatePagingLinks

void setTemplatePagingLinks(PagingServletContext pgCtx,
                            int listSize)

Invoked by a subclass' implementation of setTemplateData to set the paging links data required by the html template. This method assumes that the invoking servlet has set an appropriate value for the current page number context variable (ctx.pageNum) prior to invoking this method.

The template variables created by this method are $PageNum and $PageLinks. The $PageLinks variable is a collection of html link objects, where each element must be output using .toHTML().

Parameters:

pgCtx - (PagingServletContext) The current servlet context.

listSize - (int) The number of records in the list being processed.

setTemplatePagingBegIndex

int setTemplatePagingBegIndex(PagingServletContext pgCtx)

Invoked by a subclass' implementation of setTemplateData to set the paging beginning index data required by the html template. Returns the index of the first record that is to be displayed on the current page. This method assumes that prior to invoking this method, the invoking servlet has processed the setTemplatePagingLinks method.

The template variable created by this method is $BegIndex.

Parameters:

pgCtx - (PagingServletContext) The current servlet context.

Returns:

int - The index for the first record on the current page.

setTemplatePagingEndIndex

int setTemplatePagingEndIndex(PagingServletContext pgCtx)

Invoked by a subclass' implementation of setTemplateData to set the paging ending index data required by the html template. Returns the index of the last record that is to be displayed on the current page. This method assumes that prior to invoking this method, the invoking servlet has processed the setTemplatePagingLinks method.

The template variable created by this method is $EndIndex.

Parameters:

pgCtx - (PagingServletContext) The current servlet context.

Returns:

int - The index for the last record on the current page.