WebObjects 5.2.3

com.webobjects.directtoweb
Class D2WInspectPage

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.D2WInspectPage
All Implemented Interfaces:
Cloneable, com.webobjects.directtoweb.generation.DTWGeneration, EditPageInterface, InspectPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults
Direct Known Subclasses:
BASInspectPage, D2WTabInspectPage, NEUInspectPage, WOLInspectPage

public class D2WInspectPage
extends D2WPage
implements com.webobjects.directtoweb.generation.DTWGeneration, InspectPageInterface, EditPageInterface

The D2WInspectPage class provides behavior for the inspect page and edit page Direct to Web templates, specifically BASInspectPage, NEUInspectPage, and WOLInspectPage. The classes for these pages inherit directly from D2WInspectPage and define no additional methods or variables. Most methods are accessed, via the EOKeyValueCoding interface defined in the EOControl framework, from the Direct to Web template bindings (.wod) file. If you create a Direct to Web template from an error 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
 String errorMessage
          Contains an error message displayed on the inspect page.
 
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
D2WInspectPage(WOContext aContext)
          Constructs a D2WInspectPage with the specified context.
 
Method Summary
 void awake()
          This method is intentionally undocumented.
 WOComponent cancelAction()
          Is invoked when the user clicks Cancel.
 WOComponent deleteAction()
          Is invoked when the user clicks Delete.
 WOComponent editAction()
          This action method executes when the user clicks Edit in an inspect page.
 String implementedInterface()
          This method is intentionally undocumented.
 WOComponent nextPage()
          Is invoked when the user clicks Return in an inspect page.
 EOEnterpriseObject object()
          Returns the Object displayed by the inspect or edit page.
 WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, com.webobjects.directtoweb.generation.DTWTemplate aTemplate, WOContext aContext)
          This method is intentionally undocumented.
 void setEditingContext(EOEditingContext newEditingContext)
          This method is intentionally undocumented.
 void setObject(EOEnterpriseObject eo)
          Sets the object displayed by the inspect or edit page.
 void sleep()
          This method is intentionally undocumented.
 WOComponent submitAction()
          This action method executes when the user clicks Save on the edit page.
 void validationFailedWithException(Throwable theException, Object theValue, String theKeyPath)
          This method is intentionally undocumented.
 
Methods inherited from class com.webobjects.directtoweb.D2WPage
alternateRowColor, dataSource, descriptionForResponse, extraBindings, finalize, 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, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setLocalContext, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames
 
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, 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, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForKey, valueForKeyPath
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.webobjects.directtoweb.InspectPageInterface
setNextPage, setNextPageDelegate
 

Field Detail

errorMessage

public String errorMessage
Contains an error message displayed on the inspect page.

Constructor Detail

D2WInspectPage

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

Parameters:
aContext - - the WOContext.
Method Detail

awake

public void awake()
This method is intentionally undocumented. You should never have to invoke or customize it.

Overrides:
awake in class WOComponent
See Also:
WOComponent.ensureAwakeInContext(WOContext aContext), WOComponent.sleep()

cancelAction

public WOComponent cancelAction()
Is invoked when the user clicks Cancel. It discards the edits on the page. You can specify the component this displays by overriding nextPage. You can also specify custom behavior for this action by overriding nextPageDelegate; in this case, nextPage is ignored.

Returns:
the next page WOComponent.
See Also:
D2WPage.nextPage(), D2WPage.nextPageDelegate()

deleteAction

public WOComponent deleteAction()
                         throws Throwable
Is invoked when the user clicks Delete. Dletes the object that the page is inspecting or editing. 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.
Throws:
Throwable
See Also:
D2WPage.nextPage(), D2WPage.nextPageDelegate()

editAction

public WOComponent editAction()
This action method executes when the user clicks Edit in an inspect page. It creates an edit page for the inspected object.


implementedInterface

public String implementedInterface()
This method is intentionally undocumented. You should never have to invoke or customize it.


nextPage

public WOComponent nextPage()
Is invoked when the user clicks Return in an inspect page. Override this method to specify the component this action displays. You can also specify custom behavior for this action by overriding nextPageDelegate instead.

Overrides:
nextPage in class D2WPage
Returns:
the next page.
See Also:
D2WPage.nextPageDelegate()

object

public EOEnterpriseObject object()
Returns the Object displayed by the inspect or edit page.

Overrides:
object in class D2WComponent
Returns:
the EOEnterpriseObject to display or edit.

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation,
                                                          String oldBinding,
                                                          com.webobjects.directtoweb.generation.DTWTemplate aTemplate,
                                                          WOContext aContext)
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

setEditingContext

public void setEditingContext(EOEditingContext newEditingContext)
This method is intentionally undocumented. You should never have to invoke or customize it.


setObject

public void setObject(EOEnterpriseObject eo)
Sets the object displayed by the inspect or edit page.

Specified by:
setObject in interface InspectPageInterface
Overrides:
setObject in class D2WComponent
Parameters:
eo - - the EOEnterpriseObject to display or edit.

sleep

public void sleep()
This method is intentionally undocumented. You should never have to invoke or customize it.

Overrides:
sleep in class WOComponent
See Also:
WOComponent.awake()

submitAction

public WOComponent submitAction()
                         throws Throwable
This action method executes when the user clicks Save on the edit page. It saves the edits to the database.

Throws:
Throwable

validationFailedWithException

public void validationFailedWithException(Throwable theException,
                                          Object theValue,
                                          String theKeyPath)
This method is intentionally undocumented. You should never have to invoke or customize it.

Overrides:
validationFailedWithException in class WOComponent
Parameters:
theException - the exception thrown during validation
theValue - the given value to be validated
theKeyPath - the key path associated with this value, identifies the property of an object

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

Copyright © 2004 Apple Computer, Inc.