Documentation Archive Developer
Search
PATH  Documentation > WebObjects 4.5 > Direct to Web

D2WPage

Package: com.apple.yellow.directtoweb

Inherits from:D2WComponent

Subclasses:

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 EOKeyValueCoding interface defined in the EOControl framework) from the bindings (.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

Constructors

com.apple.yellow.directtoweb.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 EODataSource (defined in the EOControl Framework) containing the objects displayed on the page (or the objects that match the query for the query page subclasses.)


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 WOComponent) or 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 D2WPage that uses it. See the specification for the specific subclass for more information.

You can override this method to customize the D2WPage behavior when the user leaves the page.


nextPageDelegate

public NextPageDelegate nextPageDelegate()

Returns the receiver's next page delegate (an Object) or 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 D2WPage that uses it. See the specification for the specific subclass for more information.

If you do not specify a next page delegate, Direct to Web displays the WOComponent returned by the nextPage method.

You can override the nextPageDelegate method or use the setNextPageDelegate method to customize the D2WPage behavior when the user leaves the page.

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 EODataSource (defined in the EOControl Framework) containing the objects displayed on the page to 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 D2WPage that uses it. See the specification for the specific subclass for more information.


showCancel

public boolean showCancel()

Returns whether the Cancel button is displayed on the receiver's page or not.