er.directtoweb.pages

Class ERD2WInspectPage

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

com.webobjects.directtoweb.D2WComponent

com.webobjects.directtoweb.D2WPage

er.directtoweb.pages.ERD2WPage

er.directtoweb.pages.ERD2WInspectPage

All Implemented Interfaces:

WOActionResults, com.webobjects.directtoweb.EditPageInterface, com.webobjects.directtoweb.generation.DTWGeneration, com.webobjects.directtoweb.InspectPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERDBranchInterface, ERDEditPageInterface, ERDFollowPageInterface, ERDObjectSaverInterface, ERDUserInfoInterface, ERXComponentActionRedirector.Restorable, ERXExceptionHolder, Serializable, Cloneable

Direct Known Subclasses:

ERD2WCompactInspectPageTemplate, ERD2WInspectPageTemplate, ERD2WPrinterFriendlyInspectPageTemplate, ERD2WTabInspectPage, ERNEUInspectPage

public class ERD2WInspectPage
extends ERD2WPage
implements com.webobjects.directtoweb.InspectPageInterface, ERDEditPageInterface, ERDObjectSaverInterface, ERDFollowPageInterface, ERXComponentActionRedirector.Restorable

Superclass for all inspecting/editing ERD2W templates.

See Also:

Serialized Form

D2W Keys

Name	Description
inspectConfirmConfigurationName	inspectConfirmConfigurationName
object	object
editConfigurationName	editConfigurationName
useNestedEditingContext	useNestedEditingContext
shouldRenderBorder	shouldRenderBorder
shouldShowActionButtons	shouldShowActionButtons
shouldShowCancelButtons	shouldShowCancelButtons
shouldShowSubmitButton	shouldShowSubmitButton
hasForm	hasForm
validationKeys	validationKeys
shouldRevertChanges	shouldRevertChanges
shouldSaveChanges	shouldSaveChanges
shoudlvalidateBeforeSave	shoudlvalidateBeforeSave
shouldCollectValidationExceptions	shouldCollectValidationExceptions
shouldRecoverFromOptimisticLockingFailure	shouldRecoverFromOptimisticLockingFailure
shouldRevertUponSaveFailure	shouldRevertUponSaveFailure
firstResponder	firstResponder

Nested Class Summary

Nested classes/interfaces inherited from class er.directtoweb.pages.ERD2WPage

ERD2WPage.Keys, ERD2WPage.ValidationDelegate

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

WOComponent._EventLoggingEnabler, 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.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

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

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_objectWasSaved
protected static String	firstResponderContainerName
static org.apache.log4j.Logger	log logging support
static org.apache.log4j.Logger	validationCat

Fields inherited from class er.directtoweb.pages.ERD2WPage

_allConfigurations, _branch, _context, _nextPage, _nextPageDelegate, _pageController, _userInfo, errorKeyOrder, errorMessage, errorMessages, keyPathsWithValidationExceptions, validationDelegate, validationDelegateInited, validationLog

Fields inherited from class com.webobjects.directtoweb.D2WComponent

_eo, _localContext, currentObjectKey

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERD2WInspectPage(WOContext context) Public constructor

Method Summary

Modifier and Type	Method and Description
WOComponent	cancelAction()
WOComponent	deleteAction()
boolean	doesNotHaveForm()
WOComponent	editAction()
boolean	hasPropertyName()
WOComponent	nextPage()
WOComponent	nextPage(boolean doConfirm)
boolean	objectWasSaved()
String	otherTagStringsForPropertyKeyComponentCell() Generates other strings to be included in the WOGenericContainer tag for the propertyKey component cell.
void	performAdditionalValidations()
WOComponent	previousPage()
WOComponent	printerFriendlyVersion()
String	saveButtonFileName()
String	scriptForFirstResponderActivation() Constructs a JavaScript string to include in the WOComponent that will give a particular field focus when the page is loaded, if the key firstResponderKey from the d2wContext resolves.
void	setObject(EOEnterpriseObject eoenterpriseobject) Implementation of the InspectPageInterface
void	setPreviousPage(WOComponent existingPageName)
boolean	shouldCollectValidationExceptions() Should exceptions also be handled here or only handled by the parent.
boolean	shouldRecoverFromOptimisticLockingFailure()
boolean	shouldRenderBorder()
boolean	shouldRevertChanges()
boolean	shouldRevertUponSaveFailure()
boolean	shouldSaveChanges()
boolean	shouldShowActionButtons()
boolean	shouldShowCancelButton()
boolean	shouldShowSubmitButton()
boolean	shouldValidateBeforeSave()
boolean	showCancel()
WOComponent	submitAction()
String	tabScriptString() Constructs a JavaScript string that will give a particular field focus when the page is loaded.
void	takeValuesFromRequest(WORequest request, WOContext context) Overridden from the parent for better logging.
boolean	tryToSaveChanges(boolean validateObject)
String	urlForCurrentState() Implementation of the ERXComponentActionRedirector.Restorable interface.

Methods inherited from class er.directtoweb.pages.ERD2WPage

aggregateEventDurationForCurrentPropertyKey, allConfigurationNames, appendToResponse, awake, branch, branchChoices, branchName, clearTabSectionsContents, clearValidationFailed, clickToOpenEnabled, cssClassForPageContainerElement, cssClassForPropertyKey, cssClassForPropertyName, currentSection, currentSectionKeys, currentTab, d2wComponentNameDebuggingEnabled, d2wContext, d2wCurrentComponentName, d2wDebuggingEnabled, descriptionForResponse, displayVariant, editingContext, errorKeyOrder, errorMessage, errorMessageForPropertyKey, errorMessages, hasActualChanges, hasBranchChoices, hasErrors, hasValidationExceptionForPropertyKey, inlineStyleDeclarationForPropertyKey, inlineStyleDeclarationForPropertyName, invokeAction, isEmbedded, isEntityEditable, isEntityReadOnly, isKeyOmitted, isObjectDeleteable, isObjectEditable, isObjectInspectable, isTopLevelPage, latestEntryForCurrentPropertyKey, makeStatsKey, nextPageDelegate, nextPageFromDelegate, now, object, pageController, pageWithName, pageWrapperName, sectionsContents, sectionsForCurrentTab, self, setBranch, setCurrentSection, setCurrentTab, setD2wContext, setDataSource, setEditingContext, setErrorMessage, setErrorMessages, setLocalContext, setNextPage, setNextPageDelegate, setPageController, settings, setValidationDelegate, shouldDisplayDetailedPageMetrics, shouldDisplayPageMetricsSummary, shouldPropagateExceptions, shouldSetFailedValidationValue, sleep, statsForPage, statsKeyForCurrentPropertyKey, statsKeyPrefix, tabSectionsContents, tabSectionsContentsFromRuleResult, userInfo, userPreferencesValueForKey, userPreferencesValueForPageConfigurationKey, validationDelegate, validationFailedWithException

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, dataSource, extraBindings, replacementAssociationForAssociation, setExtraBindings

Methods inherited from class com.webobjects.directtoweb.D2WComponent

allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, 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, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.directtoweb.interfaces.ERDEditPageInterface

object

Methods inherited from interface com.webobjects.directtoweb.InspectPageInterface

setNextPage, setNextPageDelegate

Field Detail

log

public static final org.apache.log4j.Logger log

logging support

validationCat

public static final org.apache.log4j.Logger validationCat

firstResponderContainerName

protected static final String firstResponderContainerName

See Also:

Constant Field Values

_objectWasSaved

protected boolean _objectWasSaved

Constructor Detail

ERD2WInspectPage

public ERD2WInspectPage(WOContext context)

Public constructor

Parameters:

context - current context

Method Detail

urlForCurrentState

public String urlForCurrentState()

Description copied from class: ERD2WPage

Implementation of the ERXComponentActionRedirector.Restorable interface. This implementation creates an URL with the name of the current pageConfiguration as a direct action, which assumes a ERD2WDirectAction as the default direct action. Subclasses need to implement more sensible behaviour.

Specified by:

urlForCurrentState in interface ERXComponentActionRedirector.Restorable

Overrides:

urlForCurrentState in class ERD2WPage

Returns:

url for the current page

objectWasSaved

public boolean objectWasSaved()

Specified by:

objectWasSaved in interface ERDObjectSaverInterface

previousPage

public WOComponent previousPage()

Specified by:

previousPage in interface ERDFollowPageInterface

setPreviousPage

public void setPreviousPage(WOComponent existingPageName)

Specified by:

setPreviousPage in interface ERDFollowPageInterface

nextPage

public WOComponent nextPage()

Overrides:

nextPage in class ERD2WPage

nextPage

public WOComponent nextPage(boolean doConfirm)

editAction

public WOComponent editAction()

deleteAction

public WOComponent deleteAction()
                         throws Throwable

Throws:

Throwable

cancelAction

public WOComponent cancelAction()

shouldRenderBorder

public boolean shouldRenderBorder()

shouldShowActionButtons

public boolean shouldShowActionButtons()

shouldShowCancelButton

public boolean shouldShowCancelButton()

shouldShowSubmitButton

public boolean shouldShowSubmitButton()

showCancel

public boolean showCancel()

Overrides:

showCancel in class ERD2WPage

doesNotHaveForm

public boolean doesNotHaveForm()

setObject

public void setObject(EOEnterpriseObject eoenterpriseobject)

Description copied from class: ERD2WPage

Implementation of the InspectPageInterface

Specified by:

setObject in interface com.webobjects.directtoweb.InspectPageInterface

Overrides:

setObject in class ERD2WPage

performAdditionalValidations

public void performAdditionalValidations()

takeValuesFromRequest

public void takeValuesFromRequest(WORequest request,
                                  WOContext context)

Description copied from class: ERD2WPage

Overridden from the parent for better logging. Also clears validation errors

Overrides:

takeValuesFromRequest in class ERD2WPage

hasPropertyName

public boolean hasPropertyName()

shouldRevertChanges

public boolean shouldRevertChanges()

shouldSaveChanges

public boolean shouldSaveChanges()

shouldValidateBeforeSave

public boolean shouldValidateBeforeSave()

shouldCollectValidationExceptions

public boolean shouldCollectValidationExceptions()

Description copied from class: ERD2WPage

Should exceptions also be handled here or only handled by the parent.

Overrides:

shouldCollectValidationExceptions in class ERD2WPage

shouldRecoverFromOptimisticLockingFailure

public boolean shouldRecoverFromOptimisticLockingFailure()

shouldRevertUponSaveFailure

public boolean shouldRevertUponSaveFailure()

tryToSaveChanges

public boolean tryToSaveChanges(boolean validateObject)

submitAction

public WOComponent submitAction()
                         throws Throwable

Throws:

Throwable

saveButtonFileName

public String saveButtonFileName()

printerFriendlyVersion

public WOComponent printerFriendlyVersion()

otherTagStringsForPropertyKeyComponentCell

public String otherTagStringsForPropertyKeyComponentCell()

Generates other strings to be included in the WOGenericContainer tag for the propertyKey component cell. This is used in conjunction with the firstResponderKey to mark the cell where the propertyKey is that named by the firstResponderKey so that the "focusing" JavaScript tabScriptString can identify it.

Returns:

a String to be included in the td tag for the propertyKey component cell.

tabScriptString

public String tabScriptString()

Constructs a JavaScript string that will give a particular field focus when the page is loaded. If the key firstResponderKey from the d2wContext resolves, the script will attempt to focus on the form field belonging to the property key named by the firstResponderKey. Otherwise, the script will just focus on the first field in the form.

Note that the key useFocus must resolve to true in order for the script to be generated.

Returns:

a JavaScript string.

scriptForFirstResponderActivation

public String scriptForFirstResponderActivation()

Constructs a JavaScript string to include in the WOComponent that will give a particular field focus when the page is loaded, if the key firstResponderKey from the d2wContext resolves. The script will attempt to focus on the form field belonging to the property key named by the firstResponderKey.

Returns:

a JavaScript string to bring focus to a specific form element.