com.webobjects.directtoweb
Class D2WMasterDetailPage

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.directtoweb.D2WComponent
              com.webobjects.directtoweb.D2WPage
                  com.webobjects.directtoweb.D2WMasterDetailPage

All Implemented Interfaces:

WOActionResults, DTWGeneration, ListPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

Direct Known Subclasses:

BASMasterDetailPage, NEUMasterDetailPage, WOLMasterDetailPage

public class D2WMasterDetailPage
extends D2WPage
implements ListPageInterface

The D2WMasterDetailPage class provides the behavior for the master-detail page Direct to Web templates, specifically BASMasterDetailPage, NEUMasterDetailPage, and WOLMasterDetailPage. The classes for these pages inherit directly from D2WMasterDetailPage and define no additional methods or variables.

Most methods are accessed, via the EOKeyValueCoding interface defined in the EOControl framework, from the bindings (.wod) file of the Direct to Web template. If you create a Direct to Web template from a master-detail page, you can invoke the methods in this class in the same way.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

EOEnterpriseObject

selectedObject

Fields inherited from class com.webobjects.directtoweb.D2WComponent

currentObjectKey

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

D2WMasterDetailPage(WOContext aContext)
Constructs a D2WMasterDetailPage with the specified context.

Method Summary

WOComponent	backAction() Deprecated. Use listReturnAction instead.
boolean	isObjectSelected() Returns whether the user has selected an object in the select component of the master-detail page.
WOComponent	listReturnAction() Is invoked when the user clicks Return in the master-detail page.
NextPageDelegate	masterDetailPageDelegate() Returns the next page delegate for the edit component on the master-detail page.
WOAssociation	replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, DTWTemplate aTemplate, WOContext aContext) This method is intentionally undocumented.
NextPageDelegate	selectPageDelegate() Returns the next page delegate, an object implementing the NextPageDelegate interface, for the select component on the master-detail page.
void	setEditPageDelegate(Object newValue) This method is intentionally undocumented.
void	setSelectPageDelegate(Object newValue) This method is intentionally undocumented.

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, dataSource, descriptionForResponse, extraBindings, finalize, nextPage, nextPageDelegate, pageWrapperName, setDataSource, setExtraBindings, setNextPage, setNextPageDelegate, showCancel

Methods inherited from class com.webobjects.directtoweb.D2WComponent

allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContext, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, isEntityReadOnly, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, localContext, logout, object, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setLocalContext, setObject, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames

Methods inherited from class com.webobjects.appserver.WOComponent

appendToResponse, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.webobjects.directtoweb.ListPageInterface

setDataSource, setNextPage, setNextPageDelegate

Field Detail

selectedObject

public EOEnterpriseObject selectedObject

Constructor Detail

D2WMasterDetailPage

public D2WMasterDetailPage(WOContext aContext)

Constructs a D2WMasterDetailPage with the specified context.

Parameters:

aContext - - the WOContext.

Method Detail

selectPageDelegate

public NextPageDelegate selectPageDelegate()

Returns the next page delegate, an object implementing the NextPageDelegate interface, for the select component on the master-detail page. Direct to Web invokes the nextPage method on this object when the user selects the record to edit.

Returns:

the next page delegate for the select component.

setSelectPageDelegate

public void setSelectPageDelegate(Object newValue)

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

masterDetailPageDelegate

public NextPageDelegate masterDetailPageDelegate()

Returns the next page delegate for the edit component on the master-detail page. Direct to Web invokes the nextPage method on this object when the user clicks Cancel in the edit component.

Returns:

the next page delegate for the edit component.

See Also:

NextPageDelegate

setEditPageDelegate

public void setEditPageDelegate(Object newValue)

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

isObjectSelected

public boolean isObjectSelected()

Returns whether the user has selected an object in the select component of the master-detail page. When this condition is true, the edit component appears in the lower half of the master-detail page.

Returns:

true if the user has selected an object; false otherwise.

backAction

@Deprecated
public WOComponent backAction()

Deprecated. Use listReturnAction instead.

Use listReturnAction instead.

See Also:

D2WMasterDetailPage.listReturnAction()

listReturnAction

public WOComponent listReturnAction()

Is invoked when the user clicks Return in the master-detail page. Override nextPage to specify the component this action displays. You can also specify custom behavior for this action by overriding nextPageDelegate; in this case, nextPage is ignored.

Returns:

the next page.

See Also:

D2WPage.nextPage(), D2WPage.nextPageDelegate()

replacementAssociationForAssociation

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

Description copied from class: D2WPage

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

Specified by:

replacementAssociationForAssociation in interface DTWGeneration

Overrides:

replacementAssociationForAssociation in class D2WPage