com.webobjects.directtoweb
Interface ListPageInterface

All Known Implementing Classes:

BASListPage, BASMasterDetailPage, BASPlainListPage, D2WListPage, D2WMasterDetailPage, D2WPlainListPage, NEUListPage, NEUMasterDetailPage, NEUPlainListPage, WOLListPage, WOLMasterDetailPage, WOLPlainListPage

public interface ListPageInterface

This interface is implemented by pages returned by the D2W method listPageForEntityNamed. Use methods defined in this interface to initialize a newly created list page.

Method Summary

void	setDataSource(EODataSource aDataSource) Sets data source containing objects to display.
void	setNextPage(WOComponent nextPage) Sets page to display when the user clicks 'Return' in the list page.
void	setNextPageDelegate(NextPageDelegate nextPageDelegate) Sets delegate object that receives call to nextPage method.

Method Detail

setDataSource

void setDataSource(EODataSource aDataSource)

Sets data source containing objects to display.

Parameters:

aDataSource - data source that contains the group of objects listed on the page

setNextPage

void setNextPage(WOComponent nextPage)

Sets page to display when the user clicks 'Return' in the list page. If the new page needs to be initialized, use the method setNextPageDelegate instead.

Parameters:

nextPage - page returned when 'Return' button is clicked in the page

setNextPageDelegate

void setNextPageDelegate(NextPageDelegate nextPageDelegate)

Sets delegate object that receives call to nextPage method. When the user clicks 'Return' in the list page, Direct to Web invokes the nextPage method on nextPageDelegate. The page returned by that method call is the next page displayed. One normally uses this delegate mechanism to initialize the next page.

Parameters:

nextPageDelegate - delegate object that receives the call to nextPage when the user clicks 'Return' in the list page