ERD2WListPage Class Reference

Inherits er::directtoweb::pages::ERD2WPage, er::directtoweb::interfaces::ERDListPageInterface, com::webobjects::directtoweb::SelectPageInterface, and er::extensions::appserver::ERXComponentActionRedirector::Restorable.

Inherited by AjaxLookListPage, ERD2WCSVListPageTemplate, ERExcelListPage, ERD2WCalendarPage, ERD2WEditableListPage, ERD2WGroupingListPage, ERD2WListComparePage, ERD2WPickListPage, ERD2WCompactListPageTemplate, ERD2WListPageTemplate, ERD2WPrinterFriendlyListTemplate, ERD2WListXMLPage, ERDIVListPage, ERLITListPage, ERLITTablePage, and ERNEUListPage.

Collaboration diagram for ERD2WListPage:

[legend]

List of all members.

Public Member Functions
String	alternatingColorForRow ()
boolean	alwaysRefetchList ()
void	appendToResponse (WOResponse r, WOContext c)
WOComponent	backAction ()
String	backgroundColorForRow ()
boolean	checkSortOrderingKeys ()
String	colorForRow ()
String	defaultSortKey ()
WOComponent	deleteObjectAction ()
String	descriptionForResponse (WOResponse aResponse, WOContext aContext)
WODisplayGroup	displayGroup ()
void	editingContextDidSaveChanges (NSNotification notif)
WOComponent	editObjectAction ()
	ERD2WListPage (WOContext c)
String	formTargetJavaScriptUrl ()
WOComponent	inspectObjectAction ()
WOActionResults	invokeAction (WORequest r, WOContext c)
boolean	isEntityEditable ()
boolean	isEntityInspectable ()
boolean	isEntityPrintable ()
boolean	isEntityReadOnly ()
boolean	isListEmpty ()
boolean	isSelecting ()
boolean	isSelectingNotTopLevel ()
int	listSize ()
int	numberOfObjectsPerBatch ()
WOComponent	printerFriendlyVersion ()
NSArray	referenceEOs ()
EOEnterpriseObject	selectedObject ()
NSArray	selectedObjects ()
WOComponent	selectObjectAction ()
String	sessionID ()
void	setBackgroundColorForRow (String value)
void	setDataSource (EODataSource eodatasource)
void	setSelectedObject (EOEnterpriseObject eo)
void	setSelectedObjects (NSArray eos)
boolean	shouldShowBatchNavigation ()
boolean	shouldShowSelectAll ()
boolean	showCancel ()
NSArray< EOSortOrdering >	sortOrderings ()
void	takeValuesFromRequest (WORequest r, WOContext c)
String	targetString ()
String	urlForCurrentState ()
boolean	useBatchingDisplayGroup ()
boolean	userPreferencesCanSpecifySorting ()
void	warmUpForDisplay ()
Static Public Member Functions
static WOComponent	printerFriendlyVersion (D2WContext d2wContext, WOSession session, EODataSource dataSource, WODisplayGroup displayGroup)
Public Attributes
boolean	_hasToUpdate = false
EOEnterpriseObject	referenceEO
Static Public Attributes
static final Logger	log = Logger.getLogger(ERD2WListPage.class)
Protected Member Functions
void	_fetchDisplayGroup (WODisplayGroup dg)
void	createDisplayGroup ()
void	didUpdate ()
void	fetchIfNecessary ()
boolean	isValidSortKey (NSArray displayPropertyKeys, String sortKey)
EOEnterpriseObject	localInstanceOfObject ()
void	setSortOrderingsOnDisplayGroup (NSArray sortOrderings, WODisplayGroup dg)
void	setupPhase ()
void	willUpdate ()
Protected Attributes
WODisplayGroup	_displayGroup
boolean	_rowFlip = false
String	_sessionID
boolean	_shouldRefetch
Object	dataSourceState
Private Member Functions
ERDEditObjectDelegate	editObjectDelegateInstance ()
Private Attributes
Number	_batchSize = null
String	_formTargetJavaScriptUrl
boolean	_hasBeenInitialized = false
NSArray	_referenceEOs

---

Detailed Description

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

Author:

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

---

Constructor & Destructor Documentation

ERD2WListPage

(

WOContext

c

)

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

Parameters:

c

current context

---

Member Function Documentation

void _fetchDisplayGroup

(

WODisplayGroup

dg

)

[protected]

String alternatingColorForRow

(

)

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

boolean alwaysRefetchList

(

)

void appendToResponse	(	WOResponse	response,
		WOContext	context
	)

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

Reimplemented from ERD2WPage.

Reimplemented in AjaxLookListPage, ERDIVListPage, and ERD2WListComparePage.

WOComponent backAction

(

)

Reimplemented in ERDIVListPage, ERD2WEditableListPage, ERD2WPickListPage, and ERMODListPage.

String backgroundColorForRow

(

)

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

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

String colorForRow

(

)

void createDisplayGroup

(

)

[protected]

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.

Reimplemented from ERD2WPage.

void didUpdate

(

)

[protected]

Reimplemented in ERD2WPickListPage.

WODisplayGroup displayGroup

(

)

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

Implements ERDListPageInterface.

Reimplemented in ERD2WCalendarPage.

void editingContextDidSaveChanges

(

NSNotification

notif

)

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

WOComponent editObjectAction

(

)

ERDEditObjectDelegate editObjectDelegateInstance

(

)

[private]

Attempts to instantiate the custom edit object delegate subclass, if one has been specified.

void fetchIfNecessary

(

)

[protected]

String formTargetJavaScriptUrl

(

)

WOComponent inspectObjectAction

(

)

WOActionResults invokeAction	(	WORequest	r,
		WOContext	c
	)

Overridden from the parent for better logging.

Reimplemented from ERD2WPage.

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.

Reimplemented from ERD2WPage.

boolean isEntityInspectable

(

)

Reimplemented in ERD2WEditableListPage.

boolean isEntityPrintable

(

)

boolean isEntityReadOnly

(

)

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

Reimplemented from ERD2WPage.

boolean isListEmpty

(

)

Checks if the current list is empty.

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.

boolean isSelectingNotTopLevel

(

)

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

boolean isValidSortKey	(	NSArray	displayPropertyKeys,
		String	sortKey
	)			[protected]

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

int listSize

(

)

The number of objects in the list.

EOEnterpriseObject localInstanceOfObject

(

)

[protected]

int numberOfObjectsPerBatch

(

)

Reimplemented in ERD2WCalendarPage, ERD2WEditableListPage, and ERD2WGroupingListPage.

WOComponent printerFriendlyVersion

(

)

static WOComponent printerFriendlyVersion	(	D2WContext	d2wContext,
		WOSession	session,
		EODataSource	dataSource,
		WODisplayGroup	displayGroup
	)			[static]

NSArray referenceEOs

(

)

EOEnterpriseObject selectedObject

(

)

The currently selected object.

NSArray selectedObjects

(

)

The currently selected objects.

Reimplemented in ERD2WPickListPage.

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

)

Reimplemented from ERD2WPage.

void setSelectedObject

(

EOEnterpriseObject

eo

)

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

void setSelectedObjects

(

NSArray

eos

)

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

Reimplemented in ERD2WPickListPage.

void setSortOrderingsOnDisplayGroup	(	NSArray	sortOrderings,
		WODisplayGroup	dg
	)			[protected]

void setupPhase

(

)

[protected]

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

boolean shouldShowSelectAll

(

)

boolean showCancel

(

)

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

Reimplemented from ERD2WPage.

Reimplemented in ERD2WEditableListPage, ERD2WPickListPage, and ERMODListPage.

NSArray<EOSortOrdering> sortOrderings

(

)

void takeValuesFromRequest	(	WORequest	r,
		WOContext	c
	)

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

Reimplemented from ERD2WPage.

Reimplemented in ERD2WEditableListPage.

String targetString

(

)

String urlForCurrentState

(

)

* end of reimplementation

Reimplemented from ERD2WPage.

boolean useBatchingDisplayGroup

(

)

Checks the d2wContext for useBatchingDisplayGroup and returns it.

boolean userPreferencesCanSpecifySorting

(

)

Reimplemented in ERD2WGroupingListPage, and ERD2WListXMLPage.

void warmUpForDisplay

(

)

void willUpdate

(

)

[protected]

Reimplemented in ERD2WPickListPage.

---

Member Data Documentation

Number _batchSize = null [private]

WODisplayGroup _displayGroup [protected]

Holds the display group.

String _formTargetJavaScriptUrl [private]

boolean _hasBeenInitialized = false [private]

boolean _hasToUpdate = false

NSArray _referenceEOs [private]

boolean _rowFlip = false [protected]

String _sessionID [protected]

boolean _shouldRefetch [protected]

Object dataSourceState [protected]

final Logger log = Logger.getLogger(ERD2WListPage.class) [static]

logging support

Reimplemented from ERD2WPage.

Reimplemented in ERD2WEditableListPage, ERD2WPickListPage, and ERD2WGroupingListXMLPageTemplate.

EOEnterpriseObject referenceEO

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/pages/ERD2WListPage.java