PATH |
D2WPage
Package: com.webobjects.directtowebInherits from:D2WComponent
Subclasses:
- D2WMasterDetailPage
- D2WQueryAllEntitiesPage
- D2WInspectPage
- D2WListPage
- D2WErrorPage
- D2WQueryPage
- D2WConfirmPage
- D2WEditRelationshipPage
Class Description
This class is the parent class for the Direct to Web templates. It provides support for the next page mechanism, which determines the behavior when the user leaves the page. It also provides other methods used by most or all of the Direct to Web templates, such as a data source, the page wrapper name, and a flag to indicate whether to show the cancel button or not.
Most of the methods in this class are accessed (via the .wod
) file of the Direct to Web templates. If you create your own Direct to Web template, 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
Key-Value Coding
Managing the Next Page Parameters
Private Methods
- alternateRowColor
- descriptionForResponse
- extraBindings
- replacementAssociationForAssociation
- setExtraBindings
Constructors
D2WPage
public D2WPage()
Standard Java no-argument constructor.
Methods
alternateRowColor
public boolean alternateRowColor()
This method is intentionally undocumented. You should never have to invoke or customize it.
dataSource
public EODataSource dataSource()
Returns the
descriptionForResponse
public String descriptionForResponse(WOResponse response, WOContext context)
This method is intentionally undocumented. You should never have to invoke or customize it.
extraBindings
public NSDictionary extraBindings()
This method is intentionally undocumented. You should never have to invoke or customize it.
nextPage
public WOComponent nextPage()
Returns the receiver's next page (a
null
, if no next page has been specified. Typically, this method is invoked when the user leaves the page; the exact conditions under which it is invoked depends on the subclass of
You can override this method to customize the
nextPageDelegate
public NextPageDelegate nextPageDelegate()
Returns the receiver's next page delegate (an
null
, if no next page delegate has been specified. Typically, the nextPage
method is invoked on the next page delegate (if it has been specified) when the user leaves the page; the exact conditions under which it is invoked depends on the subclass of
If you do not specify a next page delegate, Direct to Web displays the nextPage
method.
You can override the nextPageDelegate
method or use the setNextPageDelegate
method to customize the
See Also:
nextPage
setNextPageDelegate
pageWrapperName
public String pageWrapperName()
Returns the name of the page wrapper component that the receiver appears within. This key is resolved using the rule system.
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.
setDataSource
public void setDataSource(EODataSource dataSource)
Sets the
dataSource
.
setExtraBindings
public void setExtraBindings(NSMutableDictionary dictionary)
This method is intentionally undocumented. You should never have to invoke or customize it.
setNextPage
public void setNextPage(WOComponent nextPage)
Sets the page that displayed when the user clicks Return in the page.
setNextPageDelegate
public void setNextPageDelegate(NextPageDelegate delegate)
Sets the receiver's next page delegate to
delegate
. Typically, the nextPage
method is invoked on the next page delegate (if it has been specified) when the user leaves the page; the exact conditions under which it is invoked depends on the subclass of showCancel
public boolean showCancel()
Returns whether the Cancel button is displayed on the receiver's page or not.
© 2001 Apple Computer, Inc.