Documentation Archive Developer
Search
PATH Documentation > WebObjects

Up

D2WListPage

Package: com.webobjects.directtoweb

Inherits from:D2WPage

Implements:

Subclasses:

Class Description

This class provides the behavior for the list page and select page Direct to Web templates, specifically BASListPage, NEUListPage, and WOLListPage. The classes for these components inherit directly from D2WListPage and define no additional methods or variables.

D2WPlainListPage also inherits from this class.

Most of the methods in this class are accessed (via the EOKeyValueCoding interface defined in the EOControl framework) from the Direct to Web template's bindings (.wod) file. If you create a Direct to Web template from a list page or a select page, you can invoke the methods in this class in the same way. See the "Direct to Web" chapter of WebObjects Tools and Techniques for more information about creating a Direct to Web template.

Method Types

Constructors

Actions
Key-Value Coding
Private Methods

Constructors

D2WListPage

public D2WListPage()

Standard Java no-argument constructor.
Methods


alternatingColorForRow

public String alternatingColorForRow()

This method is intentionally undocumented. You should never have to invoke or customize it.


appendToResponse

public void appendToResponse(WOResponse response, WOContext context)

This method is intentionally undocumented. You should never have to invoke or customize it.


backAction

public WOComponent backAction()

This action method is invoked when the user clicks Return in the list page. You can specify the component this action displays by overriding nextPage. You can also specify custom behavior for this action by overriding nextPageDelegate; in this case, nextPage is ignored.

See Also:
nextPage (D2WPage)
nextPageDelegate (D2WPage)


backgroundColorForRow

public String backgroundColorForRow()

This method is intentionally undocumented. You should never have to invoke or customize it.


backgroundColorForRowMethod

public String backgroundColorForRowMethod()

This method is intentionally undocumented. You should never have to invoke or customize it.


defaultSortKey

public String defaultSortKey()

This method is intentionally undocumented. You should never have to invoke or customize it.


deleteObjectAction

public WOComponent deleteObjectAction()

This action method is invoked when the user clicks the delete button next to an object on the list page.


displayGroup

public WODisplayGroup displayGroup()

Returns the receiver's display group. This display group contains the objects listed on the page.


editingContextDidSaveChanges

public void editingContextDidSaveChanges(NSNotification notification)

This method is intentionally undocumented. You should never have to invoke or customize it.


editObjectAction

public WOComponent editObjectAction()

This action method is invoked when the user clicks the edit button next to an object on the list page. It creates and returns an inspect page (a WOComponent) for the object.


finalize

public void finalize()

This method is intentionally undocumented. You should never have to invoke or customize it.


inspectObjectAction

public WOComponent inspectObjectAction()

This action method is invoked when the user clicks the inspect button next to an object on the list page. It creates and returns an inspect page (a WOComponent) for the object.


isEntityReadOnly

public boolean isEntityReadOnly()

Returns whether the entity displayed on this list page can be modified or not.


isListEmpty

public boolean isListEmpty()

Returns whether the list displayed by this page contains no objects.


isSelecting

public boolean isSelecting()

Returns true if the receiver is a select page. Returns false if it is a list page.


listSize

public int listSize()

Returns the total number of objects in the list page's display group. This is not the number of objects shown on the page, which depends on the display group's batch size.


numberOfObjectsPerBatch

public int numberOfObjectsPerBatch()

This method is intentionally undocumented. You should never have to invoke or customize it.


replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, DTWTemplate aTemplate, WOContext aContext)

This method is intentionally undocumented. You should never have to invoke or customize it.


selectedObject

public EOEnterpriseObject selectedObject()

This method is intentionally undocumented. You should never have to invoke or customize it.


selectObjectAction

public WOComponent selectObjectAction()

This action method is invoked when the user clicks Select next to one of the objects on the select page. You can specify custom behavior for this action by overriding nextPageDelegate.

See Also:
nextPageDelegate (D2WPage)


setBackgroundColorForRow

public void setBackgroundColorForRow(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setDataSource

public void setDataSource(EODataSource dataSource)

This method is intentionally undocumented. You should never have to invoke or customize it.


setLocalContext

public void setLocalContext(D2WContext context)

This method is intentionally undocumented. You should never have to invoke or customize it.


setSelectedObject

public void setSelectedObject(EOEnterpriseObject object)

This method is intentionally undocumented. You should never have to invoke or customize it.

© 2001 Apple Computer, Inc.