er.directtoweb.pages

Class ERD2WListPage

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ERD2WCalendarPage, ERD2WCompactListPageTemplate, ERD2WCSVListPageTemplate, ERD2WEditableListPage, ERD2WGroupingListPage, ERD2WListComparePage, ERD2WListPageTemplate, ERD2WListXMLPage, ERD2WPickListPage, ERD2WPrinterFriendlyListTemplate, ERExcelListPage, ERNEUListPage

public class ERD2WListPage
extends ERD2WPage
implements ERDListPageInterface, com.webobjects.directtoweb.SelectPageInterface, ERXComponentActionRedirector.Restorable

Reimplementation of the D2WListPage. Descends from ERD2WPage instead of D2WList.

See Also:

Serialized Form

Author:

ak

D2W Keys

Name	Description
useBatchingDisplayGroup	useBatchingDisplayGroup
isEntityEditable	isEntityEditable
readOnly	readOnly
alwaysRefetchList	alwaysRefetchList
pageConfiguration	pageConfiguration
defaultBatchSize	defaultBatchSize
subTask	subTask
checkSortOrderingKeys	checkSortOrderingKeys
defaultSortOrdering	defaultSortOrdering
displayPropertyKeys	displayPropertyKeys
restrictingFetchSpecification	restrictingFetchSpecification
isEntityInspectable	isEntityInspectable
isEntityPrintable	isEntityPrintable
confirmDeleteConfigurationName	confirmDeleteConfigurationName
editConfigurationName	editConfigurationName
inspectConfigurationName	inspectConfigurationName
useNestedEditingContext	useNestedEditingContext
targetDictionary	targetDictionary
shouldShowSelectAll	shouldShowSelectAll
referenceRelationshipForBackgroupColor	referenceRelationshipForBackgroupColor
showBatchNavigation	showBatchNavigation

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 WODisplayGroup	_displayGroup Holds the display group.
boolean	_hasToUpdate
protected boolean	_rowFlip
protected String	_sessionID
protected boolean	_shouldRefetch
protected Object	dataSourceState
static org.apache.log4j.Logger	log logging support
EOEnterpriseObject	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
ERD2WListPage(WOContext c) Public constructor.

Method Summary

Modifier and Type	Method and Description
protected void	_fetchDisplayGroup(WODisplayGroup dg)
String	alternatingColorForRow() Utility to have alternating row colors.
boolean	alwaysRefetchList()
void	appendToResponse(WOResponse r, WOContext c) Overridden from the parent for better logging.
WOComponent	backAction()
String	backgroundColorForRow() The background color for the current row.
boolean	checkSortOrderingKeys() Returns whether or not sort orderings should be validated (based on the checkSortOrderingKeys rule).
String	colorForRow()
protected void	createDisplayGroup() Creates the display group and sets the _displayGroup instance variable
String	defaultSortKey()
WOComponent	deleteObjectAction()
String	descriptionForResponse(WOResponse aResponse, WOContext aContext) This will allow d2w pages to be listed on a per configuration basis in stats collecting.
protected void	didUpdate()
WODisplayGroup	displayGroup() Returns the display group, creating one if there is none present.
void	editingContextDidSaveChanges(NSNotification notif) Called when an EOEditingContext has changed.
WOComponent	editObjectAction()
protected void	fetchIfNecessary()
String	formTargetJavaScriptUrl()
WOComponent	inspectObjectAction()
WOActionResults	invokeAction(WORequest r, WOContext c) Overridden from the parent for better logging.
boolean	isEntityEditable() If the key isEntityEditable is set, then this value is used, otherwise the value from the super implementation, which checks if the entity is not in the list of readOnlyEntityNames.
boolean	isEntityInspectable()
boolean	isEntityPrintable()
boolean	isEntityReadOnly() Checks if the entity is read only, meaning that you can't edit it's objects.
boolean	isListEmpty() Checks if the current list is empty.
boolean	isSelecting() Checks if the current task is select.
boolean	isSelectingNotTopLevel() Returns true of we are selecting, but not the top-level page.
protected boolean	isValidSortKey(NSArray<String> displayPropertyKeys, String sortKey) Validates the given sort key (is it a display key, an attribute, or a valid attribute path).
int	listSize() The number of objects in the list.
protected EOEnterpriseObject	localInstanceOfObject()
int	numberOfObjectsPerBatch()
WOComponent	printerFriendlyVersion()
static WOComponent	printerFriendlyVersion(com.webobjects.directtoweb.D2WContext d2wContext, WOSession session, EODataSource dataSource, WODisplayGroup displayGroup)
NSArray	referenceEOs()
EOEnterpriseObject	selectedObject() The currently selected object.
NSArray	selectedObjects() The currently selected objects.
WOComponent	selectObjectAction() Action method to select an object.
String	sessionID() Cached session ID, so we don't need to awake.
void	setBackgroundColorForRow(String value) Does nothing and exists only for KeyValueCoding.
void	setDataSource(EODataSource eodatasource)
void	setSelectedObject(EOEnterpriseObject eo) Sets currently selected object.
void	setSelectedObjects(NSArray eos) Sets currently selected objects.
protected void	setSortOrderingsOnDisplayGroup(NSArray sortOrderings, WODisplayGroup dg)
protected void	setupPhase()
boolean	shouldShowBatchNavigation() Determines if the batch navigation should be shown.
boolean	shouldShowSelectAll()
boolean	showCancel() Should we show the cancel button? It's only visible when we have a nextPage set up.
NSArray<EOSortOrdering>	sortOrderings()
void	takeValuesFromRequest(WORequest r, WOContext c) Overridden from the parent for better logging.
String	targetString()
String	urlForCurrentState() end of reimplementation
boolean	useBatchingDisplayGroup() Checks the d2wContext for useBatchingDisplayGroup and returns it.
boolean	userPreferencesCanSpecifySorting()
void	warmUpForDisplay()
protected void	willUpdate()

Methods inherited from class er.directtoweb.pages.ERD2WPage

aggregateEventDurationForCurrentPropertyKey, allConfigurationNames, awake, branch, branchChoices, branchName, clearTabSectionsContents, clearValidationFailed, 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, nextPage, nextPageDelegate, nextPageFromDelegate, now, object, pageController, pageWithName, pageWrapperName, sectionsContents, sectionsForCurrentTab, self, setBranch, setCurrentSection, setCurrentTab, setD2wContext, setEditingContext, setErrorMessage, setErrorMessages, setLocalContext, setNextPage, setNextPageDelegate, setObject, setPageController, settings, setValidationDelegate, shouldCollectValidationExceptions, 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, 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

logging support

_shouldRefetch

protected boolean _shouldRefetch

_sessionID

protected String _sessionID

_displayGroup

protected WODisplayGroup _displayGroup

Holds the display group.

_hasToUpdate

public boolean _hasToUpdate

_rowFlip

protected boolean _rowFlip

dataSourceState

protected Object dataSourceState

referenceEO

public EOEnterpriseObject referenceEO

Constructor Detail

ERD2WListPage

public ERD2WListPage(WOContext c)

Public constructor. Registers for EOEditingContext.EditingContextDidSaveChangesNotification so that component stays informed when objects are deleted and added.

Parameters:

c - current context

Method Detail

displayGroup

public WODisplayGroup displayGroup()

Returns the display group, creating one if there is none present.

Specified by:

displayGroup in interface ERDListPageInterface

Returns:

the displayGroup for this list page

createDisplayGroup

protected void createDisplayGroup()

Creates the display group and sets the _displayGroup instance variable

useBatchingDisplayGroup

public boolean useBatchingDisplayGroup()

Checks the d2wContext for useBatchingDisplayGroup and returns it.

sessionID

public String sessionID()

Cached session ID, so we don't need to awake.

Overrides:

sessionID in class com.webobjects.directtoweb.D2WComponent

editingContextDidSaveChanges

public void editingContextDidSaveChanges(NSNotification notif)

Called when an EOEditingContext has changed. Sets _hasToUpdate which in turn lets the group refetch on the next display.

isEntityReadOnly

public boolean isEntityReadOnly()

Checks if the entity is read only, meaning that you can't edit it's objects.

Overrides:

isEntityReadOnly in class ERD2WPage

isEntityEditable

public boolean isEntityEditable()

Description copied from class: ERD2WPage

If the key isEntityEditable is set, then this value is used, otherwise the value from the super implementation, which checks if the entity is not in the list of readOnlyEntityNames.

Overrides:

isEntityEditable in class ERD2WPage

alwaysRefetchList

public boolean alwaysRefetchList()

isSelecting

public boolean isSelecting()

Checks if the current task is select. We need this because this page implements the SelectPageInterface so we can't do an instanceof test.

isListEmpty

public boolean isListEmpty()

Checks if the current list is empty.

listSize

public int listSize()

The number of objects in the list.

alternatingColorForRow

public String alternatingColorForRow()

Utility to have alternating row colors. Override this to have more than one color.

backgroundColorForRow

public String backgroundColorForRow()

The background color for the current row. Override this to have more than one color.

setBackgroundColorForRow

public void setBackgroundColorForRow(String value)

Does nothing and exists only for KeyValueCoding.

selectedObject

public EOEnterpriseObject selectedObject()

The currently selected object.

Specified by:

selectedObject in interface com.webobjects.directtoweb.SelectPageInterface

setSelectedObject

public void setSelectedObject(EOEnterpriseObject eo)

Sets currently selected object. Pushes the value to the display group, clearing the selection if needed.

Specified by:

setSelectedObject in interface com.webobjects.directtoweb.SelectPageInterface

selectedObjects

public NSArray selectedObjects()

The currently selected objects.

setSelectedObjects

public void setSelectedObjects(NSArray eos)

Sets currently selected objects. Pushes the values to the display group, clearing the selection if needed.

selectObjectAction

public WOComponent selectObjectAction()

Action method to select an object.

backAction

public WOComponent backAction()

urlForCurrentState

public String urlForCurrentState()

end of reimplementation

Specified by:

urlForCurrentState in interface ERXComponentActionRedirector.Restorable

Overrides:

urlForCurrentState in class ERD2WPage

Returns:

url for the current page

setSortOrderingsOnDisplayGroup

protected void setSortOrderingsOnDisplayGroup(NSArray sortOrderings,
                                              WODisplayGroup dg)

printerFriendlyVersion

public static WOComponent printerFriendlyVersion(com.webobjects.directtoweb.D2WContext d2wContext,
                                                 WOSession session,
                                                 EODataSource dataSource,
                                                 WODisplayGroup displayGroup)

printerFriendlyVersion

public WOComponent printerFriendlyVersion()

descriptionForResponse

public String descriptionForResponse(WOResponse aResponse,
                                     WOContext aContext)

Description copied from class: ERD2WPage

This will allow d2w pages to be listed on a per configuration basis in stats collecting.

Overrides:

descriptionForResponse in class ERD2WPage

numberOfObjectsPerBatch

public int numberOfObjectsPerBatch()

userPreferencesCanSpecifySorting

public boolean userPreferencesCanSpecifySorting()

checkSortOrderingKeys

public boolean checkSortOrderingKeys()

Returns whether or not sort orderings should be validated (based on the checkSortOrderingKeys rule).

Returns:

whether or not sort orderings should be validated

isValidSortKey

protected boolean isValidSortKey(NSArray<String> displayPropertyKeys,
                                 String sortKey)

Validates the given sort key (is it a display key, an attribute, or a valid attribute path).

Parameters:

displayPropertyKeys - the current display properties

sortKey - the sort key to validate

Returns:

true if the sort key is valid, false if not

sortOrderings

public NSArray<EOSortOrdering> sortOrderings()

defaultSortKey

public String defaultSortKey()

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 ERD2WPage

_fetchDisplayGroup

protected void _fetchDisplayGroup(WODisplayGroup dg)

fetchIfNecessary

protected void fetchIfNecessary()

invokeAction

public WOActionResults invokeAction(WORequest r,
                                    WOContext c)

Description copied from class: ERD2WPage

Overridden from the parent for better logging.

Overrides:

invokeAction in class ERD2WPage

appendToResponse

public void appendToResponse(WOResponse r,
                             WOContext c)

Description copied from class: ERD2WPage

Overridden from the parent for better logging. Reports exceptions in the console for easier debugging.

Overrides:

appendToResponse in class ERD2WPage

setDataSource

public void setDataSource(EODataSource eodatasource)

Specified by:

setDataSource in interface com.webobjects.directtoweb.ListPageInterface

Specified by:

setDataSource in interface com.webobjects.directtoweb.SelectPageInterface

Overrides:

setDataSource in class ERD2WPage

willUpdate

protected void willUpdate()

didUpdate

protected void didUpdate()

setupPhase

protected void setupPhase()

isEntityInspectable

public boolean isEntityInspectable()

isEntityPrintable

public boolean isEntityPrintable()

deleteObjectAction

public WOComponent deleteObjectAction()

editObjectAction

public WOComponent editObjectAction()

inspectObjectAction

public WOComponent inspectObjectAction()

localInstanceOfObject

protected EOEnterpriseObject localInstanceOfObject()

showCancel

public boolean showCancel()

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

Overrides:

showCancel in class ERD2WPage

isSelectingNotTopLevel

public boolean isSelectingNotTopLevel()

Returns true of we are selecting, but not the top-level page.

formTargetJavaScriptUrl

public String formTargetJavaScriptUrl()

targetString

public String targetString()

shouldShowSelectAll

public boolean shouldShowSelectAll()

warmUpForDisplay

public void warmUpForDisplay()

colorForRow

public String colorForRow()

referenceEOs

public NSArray referenceEOs()

shouldShowBatchNavigation

public boolean shouldShowBatchNavigation()

Determines if the batch navigation should be shown. It can be explicitly disabled by setting the D2W key showBatchNavigation to false.

Returns:

true if the batch navigation should be shown