er.directtoweb.pages

Class ERD2WEditableListPage

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

er.directtoweb.pages.ERD2WEditableListPage

All Implemented Interfaces:

WOActionResults, com.webobjects.directtoweb.generation.DTWGeneration, com.webobjects.directtoweb.ListPageInterface, com.webobjects.directtoweb.SelectPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERDBranchInterface, ERDListPageInterface, ERDObjectSaverInterface, ERDUserInfoInterface, ERXComponentActionRedirector.Restorable, ERXExceptionHolder, Serializable, Cloneable

Direct Known Subclasses:

ERD2WEditableListTemplate, ERMODEditableListTemplate

public class ERD2WEditableListPage
extends ERD2WListPage
implements ERXExceptionHolder, ERDObjectSaverInterface

List page for editing all items in the list. Name your page EditListYourEntityName. task will be edit, subTask will be list. See Component ERD2WEditableListTemplate for html/wod example. There is a "mass change" feature that can apply a change to all displayed objects. Think of it as an "input assistant". The changes are not saved when propagated, and the rows can be updated individually after a mass change has been applied. (Note: There is a ERDMassModifyButton class that may be more appropriate depending on your needs) To enable the mass change feature on an editable list page, do the following: 1/ Add a "showMassChange" rule that returns "true" for your edit list page 2/ If you want to restrict the keys that can be "mass edited", add a displayPropertyKeys rule with a restricted set of keys with the qualifer "(massChangeEntityDisplay = 1)" Known Issues: changing the number of items per batch causes problems (the display group's batch is updated too soon in the request/response loop)

See Also:

Serialized Form

D2W Keys

Name	Description
showBanner	showBanner
object	object
isEntityInspectable	isEntityInspectable
shouldValidateBeforeSave	shouldValidateBeforeSave
shouldSaveChanges	shouldSaveChanges
shouldRecoverFromOptimisticLockingFailure	shouldRecoverFromOptimisticLockingFailure
saveLabelTemplateKey	saveLabelTemplateKey
displayNameForEntity	displayNameForEntity
showMassChange	showMassChange

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ERD2WEditableListPage.ERDMassChangeGenericRecord

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 WODisplayGroup	_massChangeDisplayGroup
protected ERD2WEditableListPage.ERDMassChangeGenericRecord	_massChangeEO
String	dummy
static org.apache.log4j.Logger	log
static String	MassChangeEntityDisplayKey

Fields inherited from class er.directtoweb.pages.ERD2WListPage

_displayGroup, _hasToUpdate, _rowFlip, _sessionID, _shouldRefetch, dataSourceState, referenceEO

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
ERD2WEditableListPage(WOContext context)

Method Summary

Modifier and Type	Method and Description
WOComponent	backAction()
WOComponent	cancel()
WOComponent	clearMassChangeEO()
void	clearValidationFailed() Clears all of the collected validation exceptions.
int	colspanForNavBar()
NSMutableDictionary	currentErrorDictionary()
com.webobjects.directtoweb.D2WContext	d2wContextForMassChangeEO()
NSMutableDictionary	errorDictionaryForObject(Object object)
protected NSMutableDictionary	errorMessagesDictionaries()
boolean	isEntityInspectable()
WODisplayGroup	massChangeDisplayGroup()
ERD2WEditableListPage.ERDMassChangeGenericRecord	massChangeEO()
WOComponent	nextPage()
int	numberOfObjectsPerBatch()
boolean	objectWasSaved()
String	propagateChangesDetails()
WOComponent	propagateChangesToVisibleObjects()
WOComponent	saveAction()
String	saveLabel()
void	setObject(EOEnterpriseObject eo) Implementation of the InspectPageInterface
boolean	shouldRecoverFromOptimisticLockingFailure()
boolean	shouldSaveChanges()
boolean	shouldShowMassChange()
boolean	shouldValidateBeforeSave()
boolean	showCancel() Should we show the cancel button? It's only visible when we have a nextPage set up.
void	takeValuesFromRequest(WORequest r, WOContext c) Overridden from the parent for better logging.
boolean	tryToSaveChanges(boolean validateObjects)
WOComponent	update()
void	validationFailedWithException(Throwable e, Object value, String keyPath) Handles validation errors.

Methods inherited from class er.directtoweb.pages.ERD2WListPage

_fetchDisplayGroup, alternatingColorForRow, alwaysRefetchList, appendToResponse, backgroundColorForRow, checkSortOrderingKeys, colorForRow, createDisplayGroup, defaultSortKey, deleteObjectAction, descriptionForResponse, didUpdate, displayGroup, editingContextDidSaveChanges, editObjectAction, fetchIfNecessary, formTargetJavaScriptUrl, inspectObjectAction, invokeAction, isEntityEditable, isEntityPrintable, isEntityReadOnly, isListEmpty, isSelecting, isSelectingNotTopLevel, isValidSortKey, listSize, localInstanceOfObject, printerFriendlyVersion, printerFriendlyVersion, referenceEOs, selectedObject, selectedObjects, selectObjectAction, sessionID, setBackgroundColorForRow, setDataSource, setSelectedObject, setSelectedObjects, setSortOrderingsOnDisplayGroup, setupPhase, shouldShowBatchNavigation, shouldShowSelectAll, sortOrderings, targetString, urlForCurrentState, useBatchingDisplayGroup, userPreferencesCanSpecifySorting, warmUpForDisplay, willUpdate

Methods inherited from class er.directtoweb.pages.ERD2WPage

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

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, 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 com.webobjects.directtoweb.ListPageInterface

setNextPage, setNextPageDelegate

Methods inherited from interface com.webobjects.directtoweb.SelectPageInterface

nextPageDelegate, setNextPageDelegate

Field Detail

log

public static final org.apache.log4j.Logger log

dummy

public String dummy

MassChangeEntityDisplayKey

public static final String MassChangeEntityDisplayKey

See Also:

Constant Field Values

_massChangeDisplayGroup

protected WODisplayGroup _massChangeDisplayGroup

_massChangeEO

protected ERD2WEditableListPage.ERDMassChangeGenericRecord _massChangeEO

Constructor Detail

ERD2WEditableListPage

public ERD2WEditableListPage(WOContext context)

Method Detail

colspanForNavBar

public int colspanForNavBar()

numberOfObjectsPerBatch

public int numberOfObjectsPerBatch()

Overrides:

numberOfObjectsPerBatch in class ERD2WListPage

objectWasSaved

public boolean objectWasSaved()

Specified by:

objectWasSaved in interface ERDObjectSaverInterface

errorMessagesDictionaries

protected NSMutableDictionary errorMessagesDictionaries()

errorDictionaryForObject

public NSMutableDictionary errorDictionaryForObject(Object object)

currentErrorDictionary

public NSMutableDictionary currentErrorDictionary()

showCancel

public boolean showCancel()

Description copied from class: ERD2WListPage

Should we show the cancel button? It's only visible when we have a nextPage set up.

Overrides:

showCancel in class ERD2WListPage

isEntityInspectable

public boolean isEntityInspectable()

Overrides:

isEntityInspectable in class ERD2WListPage

setObject

public void setObject(EOEnterpriseObject eo)

Description copied from class: ERD2WPage

Implementation of the InspectPageInterface

Overrides:

setObject in class ERD2WPage

backAction

public WOComponent backAction()

Overrides:

backAction in class ERD2WListPage

nextPage

public WOComponent nextPage()

Overrides:

nextPage in class ERD2WPage

shouldValidateBeforeSave

public boolean shouldValidateBeforeSave()

shouldSaveChanges

public boolean shouldSaveChanges()

shouldRecoverFromOptimisticLockingFailure

public boolean shouldRecoverFromOptimisticLockingFailure()

tryToSaveChanges

public boolean tryToSaveChanges(boolean validateObjects)

saveAction

public WOComponent saveAction()

cancel

public WOComponent cancel()

validationFailedWithException

public void validationFailedWithException(Throwable e,
                                          Object value,
                                          String keyPath)

Description copied from class: ERD2WPage

Handles validation errors.

Overrides:

validationFailedWithException in class ERD2WPage

clearValidationFailed

public void clearValidationFailed()

Description copied from class: ERD2WPage

Clears all of the collected validation exceptions. Implementation of the ERXExceptionHolder interface.

Specified by:

clearValidationFailed in interface ERXExceptionHolder

Overrides:

clearValidationFailed in class ERD2WPage

update

public WOComponent update()

takeValuesFromRequest

public void takeValuesFromRequest(WORequest r,
                                  WOContext c)

Description copied from class: ERD2WPage

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

Overrides:

takeValuesFromRequest in class ERD2WListPage

saveLabel

public String saveLabel()

shouldShowMassChange

public boolean shouldShowMassChange()

d2wContextForMassChangeEO

public com.webobjects.directtoweb.D2WContext d2wContextForMassChangeEO()

massChangeDisplayGroup

public WODisplayGroup massChangeDisplayGroup()

massChangeEO

public ERD2WEditableListPage.ERDMassChangeGenericRecord massChangeEO()

clearMassChangeEO

public WOComponent clearMassChangeEO()

propagateChangesToVisibleObjects

public WOComponent propagateChangesToVisibleObjects()

propagateChangesDetails

public String propagateChangesDetails()