WebObjects 5.2.3

com.webobjects.directtoweb
Class D2WConfirmPage

java.lang.Object
  extended bycom.webobjects.appserver.WOElement
      extended bycom.webobjects.appserver.WOComponent
          extended bycom.webobjects.directtoweb.D2WComponent
              extended bycom.webobjects.directtoweb.D2WPage
                  extended bycom.webobjects.directtoweb.D2WConfirmPage
All Implemented Interfaces:
Cloneable, ConfirmPageInterface, com.webobjects.directtoweb.generation.DTWGeneration, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults
Direct Known Subclasses:
BASConfirmPage, NEUConfirmPage, WOLConfirmPage

public class D2WConfirmPage
extends D2WPage
implements com.webobjects.directtoweb.generation.DTWGeneration, ConfirmPageInterface

The D2WConfirmPage class provides the behavior for the confirm page Direct to Web templates, specifically BASConfirmPage, NEUConfirmPage, and WOLConfirmPage. The classes for these pages inherit directly from D2WConfirmPage and define no additional methods or variables.

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 confirm 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.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Nested classes inherited from class com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Field Summary
 
Fields inherited from class com.webobjects.directtoweb.D2WComponent
currentObjectKey
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
D2WConfirmPage(WOContext aContext)
          Constructs a D2WConfirmPage with the specified context.
 
Method Summary
 WOComponent cancelAction()
          Is invoked when the user clicks Cancel.
 WOComponent confirmAction()
          Executes when the user clicks Confirm.
 String message()
          Returns the message displayed by the confirm page.
 WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, com.webobjects.directtoweb.generation.DTWTemplate aTemplate, WOContext aContext)
          This method is intentionally undocumented.
 void setCancelDelegate(NextPageDelegate nextPage)
          Sets the cancel delegate of the receiver.
 void setConfirmDelegate(NextPageDelegate nextPage)
          Sets the confirm delegate of the receiver.
 void setMessage(String aMessage)
          Sets the message displayed by the confirm page.
 
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, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

D2WConfirmPage

public D2WConfirmPage(WOContext aContext)
Constructs a D2WConfirmPage with the specified context.

Parameters:
aContext - - the WOContext.
Method Detail

cancelAction

public WOComponent cancelAction()
                         throws Throwable
Is invoked when the user clicks Cancel. If you need this method to execute custom code, use the cancel delegate.

Returns:
the confirm page.
Throws:
Throwable
See Also:
setCancelDelegate(com.webobjects.directtoweb.NextPageDelegate)

confirmAction

public WOComponent confirmAction()
                          throws Throwable
Executes when the user clicks Confirm. To specify the confirm behavior, use the confirm delegate.

Returns:
the confirm page.
Throws:
Throwable
See Also:
setConfirmDelegate(com.webobjects.directtoweb.NextPageDelegate)

message

public String message()
Returns the message displayed by the confirm page.

Returns:
the message displayed by the confirm page.

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation,
                                                          String oldBinding,
                                                          com.webobjects.directtoweb.generation.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 com.webobjects.directtoweb.generation.DTWGeneration
Overrides:
replacementAssociationForAssociation in class D2WPage

setCancelDelegate

public void setCancelDelegate(NextPageDelegate nextPage)
Sets the cancel delegate of the receiver. When the user clicks No in the confirm page, Direct to Web invokes the nextPage method on the cancel delegate.

Specified by:
setCancelDelegate in interface ConfirmPageInterface
Parameters:
nextPage - - the next page delegate.

setConfirmDelegate

public void setConfirmDelegate(NextPageDelegate nextPage)
Sets the confirm delegate of the receiver. When the user clicks Yes in the confirm page, Direct to Web invokes the nextPage method on the confirm delegate.

Specified by:
setConfirmDelegate in interface ConfirmPageInterface
Parameters:
nextPage - - the next page delegate.

setMessage

public void setMessage(String aMessage)
Sets the message displayed by the confirm page.

Specified by:
setMessage in interface ConfirmPageInterface
Parameters:
aMessage - - the message displayed by the confirm page.

Last updated Thu Oct 21 15:04:16 PDT 2004.

Copyright © 2004 Apple Computer, Inc.