WODisplayGroup (WebObjects 5.4 Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

WebObjects 5.4.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.webobjects.appserver
Class WODisplayGroup

java.lang.Object
  com.webobjects.appserver.WODisplayGroup

All Implemented Interfaces:: EOKeyValueArchiving, EOKeyValueArchiving.Awaking, NSDisposable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, Serializable

public class WODisplayGroup
extends Object
implements NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSDisposable, EOKeyValueArchiving, EOKeyValueArchiving.Awaking, Serializable
extends Object
implements NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSDisposable, EOKeyValueArchiving, EOKeyValueArchiving.Awaking, Serializable

A WODisplayGroup is the basic user interface manager for a WebObjects application that accesses a database. It collects objects from an EODataSource, filters and sorts them, and maintains a selection in the filtered subset. WebObjects dynamic elements are bound to WODisplayGroup attributes and methods to display information from the database on the web page.

A WODisplayGroup manipulates its EODataSource by invoking fetchObjects, insertObject and other methods, and registers itself as an editor and message handler of the EODataSource's EOEditingContext. The EOEditingContext then monitors the WODisplayGroup for changes to objects.

WODisplayGroup interacts mostly with its EODataSource and its EOEditingContext.

The WODisplayGroup delegate offers a number of methods, and WODisplayGroup invokes them as appropriate. Besides displayGroupDisplayArrayForObjects, there are methods that inform the delegate that the WODisplayGroup has fetched, created -- or failed to create -- an object, inserted or deleted an object, changed the selection, or set a value for a property. There are also methods that request permission from the delegate to perform most of these same actions. The delegate can return true to permit the action or false to deny it.

See Also:: EODataSource, EOEditingContext, WODisplayGroup.Delegate, WODisplayGroup.Delegate.displayGroupDisplayArrayForObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSArray), Serialized Form

Nested Class Summary
`static interface`	`WODisplayGroup.Delegate` The WODisplayGroup delegate offers a number of methods, and WODisplayGroup invokes them as appropriate.

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding
`NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor`

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving
`EOKeyValueArchiving.Awaking, EOKeyValueArchiving.FinishInitialization, EOKeyValueArchiving.Support`

Field Summary
`static String`	`DisplayGroupWillFetchNotification` The name for the notification posted during any invocation of WODisplayGroup's `fetch` method.

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
`NullValue`

Constructor Summary
`WODisplayGroup()` Creates and returns a new WODisplayGroup.

Method Summary
`NSArray`	`allObjects()` Provides all of the objects collected by the WODisplayGroup.
`NSArray`	`allQualifierOperators()` Provides all of the EOQualifier operators plus those that work exclusively on Strings (such as `like` and `contains`).
`void`	`awakeFromKeyValueUnarchiver(EOKeyValueUnarchiver unarchiver)` Notifies the receiver that the EOKeyValueUnarchiver `unarchiver` has unarchived all objects from an archive.
`int`	`batchCount()` Provides the number of batches to display.
`boolean`	`clearSelection()` Clears the selection of any objects from `allObjects`.
`int`	`currentBatchIndex()` Provides the index of the batch currently being displayed.
`EODataSource`	`dataSource()` Provides the last EODataSource given to the WODisplayGroup via `setDataSource`.
`static Object`	`decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver unarchiver)` Intentionally Undocumented
`String`	`defaultStringMatchFormat()` If a key in the `queryMatch` dictionary does not have an associated value in the `queryOperator` dictionary, then its value is matched using operator pattern matching, and the format string returned by this method specifies how it will be matched.
`String`	`defaultStringMatchOperator()` Provides a default operator for matching strings against string values in the `queryMatch` dictionary for the objects in the WODisplayGroup.
`Object`	`delegate()` Provides the last delegate object given to the WODisplayGroup via `setDelegate`.
`Object`	`delete()` Invokes `deleteSelection` and `displayBatchContainingSelectedObject`.
`boolean`	`deleteObjectAtIndex(int anIndex)` Deletes the object at `anIndex` in `allObjects`.
`boolean`	`deleteSelection()` Deletes the `selectedObjects` from the WODisplayGroup's `dataSource`.
`String`	`detailKey()` For detail display groups, returns the key to the master object that specifies what this detail display group represents.
`Object`	`displayBatchContainingSelectedObject()` Displays the batch containing the selection and sets the `currentBatchIndex` to that batch's index.
`NSArray`	`displayedObjects()` Provides the objects to be displayed or otherwise made available to the client (web browser).
`Object`	`displayNextBatch()` Increments the current batch index, displays that batch of objects, and clears the selection.
`Object`	`displayPreviousBatch()` Decrements the current batch index, displays that batch of objects, and clears the selection.
`void`	`dispose()` Invoked when the receiver should prepare itself for destruction.
`void`	`editingContextPresentErrorMessage(EOEditingContext editingContext, String message)` Deprecated. Use NSLog instead. No user code should implement or depend upon this.
`void`	`encodeWithCoder(NSCoder coder)`
`void`	`encodeWithKeyValueArchiver(EOKeyValueArchiver archiver)` Asks the receiver to archive its state into the EOKeyValueArchiver `archiver`.
`boolean`	`endEditing()` Deprecated. No longer important for WebObjects applications. No user code should depend upon this, and any references to this method may be eliminated freely.
`Object`	`fetch()` Invokes the `fetchObjects` method of the `dataSource` and passes the result to `setObjectArray`.
`boolean`	`fetchesOnLoad()` Indicates whether the WODisplayGroup, whenever it is loaded, should fetch from its `dataSource`.
`protected void`	`finishInitialization()` Invoked from the WODisplayGroup constructor to finish initializing a newly created instance.
`static boolean`	`globalDefaultForValidatesChangesImmediately()` Indicates the class default behavior controlling whether submitted changes are immediately validated.
`static String`	`globalDefaultStringMatchFormat()` Provides the default string match format for the class.
`static String`	`globalDefaultStringMatchOperator()` Provides the default string match operator for the class.
`Object`	`handleQueryWithUnboundKey(String key)` Invoked from `valueForKey` when it finds no property binding for `key`.
`void`	`handleTakeValueForUnboundKey(Object value, String key)` Invoked from `takeValueForKey` when it finds no property binding for `key`.
`boolean`	`hasDetailDataSource()` If a to-many relationship is dragged from EOModeler to an open component in WebObjects Builder, a display group is created that has an EODetailDataSource.
`boolean`	`hasMultipleBatches()` Indicates whether the WODisplayGroup paginates display, using `batchCount`.
`int`	`indexOfFirstDisplayedObject()` Provides the index into `displayedObjects` of the first object in the current batch.
`int`	`indexOfLastDisplayedObject()` Provides the index into `displayedObjects` of the last object in the current batch.
`Object`	`initWithCoder(NSCoder coder)`
`boolean`	`inQueryMode()` Deprecated. No longer important for WebObjects applications. No user code should implement or depend upon this, and any implementations or references to this method may be eliminated freely.
`Object`	`insert()` Invokes `insertNewObjectAtIndex` with an index just past the first index in the selection, or at the end if there's no selection.
`NSDictionary`	`insertedObjectDefaultValues()` Provides the dictionary of default values added to empty objects that are inserted into the WODisplayGroup's `dataSource`.
`Object`	`insertNewObjectAtIndex(int newIndex)` Invokes the `createObject` method of the `dataSource` and inserts the new object into the `dataSource` (and into `allObjects` at `newIndex`) using `insertObjectAtIndex`.
`void`	`insertObjectAtIndex(Object createObject, int newIndex)` Inserts `createObject` into the WODisplayGroup's `dataSource` and into `allObjects` and `displayedObjects` at `newIndex`, if possible.
`NSArray`	`localKeys()` Provides the additional keys to which WOAssociations may be bound for this WODisplayGroup.
`Object`	`masterObject()` Provides the master object for a detail display group (a display group that represents a detail in a master-detail relationship).
`int`	`numberOfObjectsPerBatch()` You can set the batch size using `setNumberOfObjectsPerBatch` or using WebObjects Builder's Display Group Options panel.
`void`	`objectsChangedInEditingContext(NSNotification notification)` Redisplays the changed objects in the WODisplayGroup.
`void`	`objectsInvalidatedInEditingContext(NSNotification notification)` Refetches all objects from the `dataSource` of the WODisplayGroup after some or all of them have been invalidated.
`EOQualifier`	`qualifier()` Provides the last qualifier given to the WODisplayGroup via `setQualifier` or `qualifyDisplayGroup`.
`EOQualifier`	`qualifierFromQueryValues()` Builds a qualifier constructed from entries in these query dictionaries: `queryMatch, queryMax, queryMin`, and `queryOperator`.
`void`	`qualifyDataSource()` Takes the result of `qualifierFromQueryValues` and applies to the WODisplayGroup's data source.
`void`	`qualifyDisplayGroup()` Takes the result of the `qualifierFromQueryValues` and applies it to the WODisplayGroup using `setQualifier`.
`NSMutableDictionary`	`queryBindings()` You use this method to perform a query stored in the EOModel file.
`NSMutableDictionary`	`queryMatch()` The `qualifierFromQueryValues` method uses this dictionary along with the `queryMax` and `queryMin` dictionaries to construct qualifiers.
`NSMutableDictionary`	`queryMax()` Provides a dictionary of "less than" query values.
`NSMutableDictionary`	`queryMin()` Provides a dictionary of "greater than" query values.
`NSMutableDictionary`	`queryOperator()` If a key in the `queryMatch` dictionary also exists in `queryOperator`, that operator for that key is used.
`void`	`redisplay()` Deprecated. Invoke `willChange` directly.
`NSArray`	`relationalQualifierOperators()` Provides all of the EOQualifier operators excepts that work exclusively on strings (such as `like` and `contains`).
`Object`	`selectedObject()` Provides the first object from `selectedObjects`.
`NSArray`	`selectedObjects()` Provides the last selection given to the WODisplayGroup via `setSelectedObjects`.
`NSArray`	`selectionIndexes()` Provides the last selection given to the WODisplayGroup via `setSelectionIndexes`.
`Object`	`selectNext()` Attempts to select the object just after the currently selected one.
`boolean`	`selectObject(Object object)` Attempts to select the object equal to `object` in the WODisplayGroup's `displayedObjects`, returning `true` if successful and `false` otherwise.
`boolean`	`selectObjectsIdenticalTo(NSArray objectSelection)` Attempts to select the objects in the WODisplayGroup's `displayedObjects` array whose addresses are equal to those of objects, returning `true` if successful and `false` otherwise.
`boolean`	`selectObjectsIdenticalToSelectFirstOnNoMatch(NSArray objectSelection, boolean selectFirstOnNoMatch)` Selects the objects in the WODisplayGroup's displayed `objectSelection` array whose addresses are equal to those of `objectSelection`, returning `true` if successful and `false` otherwise.
`Object`	`selectPrevious()` Attempts to select the object just before the presently selected one.
`boolean`	`selectsFirstObjectAfterFetch()` Indicates whether the WODisplayGroup should select the first object from its `displayedObjects` after a `fetch` when there were no selections before the `fetch`.
`void`	`setCurrentBatchIndex(int batchIndex)` Displays the `batchIndex` batch of objects.
`void`	`setDataSource(EODataSource ds)` Changes the WODisplayGroup's EODataSource to `ds`.
`void`	`setDefaultStringMatchFormat(String format)` Changes how pattern matching will be performed on String values in the `queryMatch` dictionary.
`void`	`setDefaultStringMatchOperator(String op)` Changes the operator used to perform pattern matching for String values in the `queryMatch` dictionary.
`void`	`setDelegate(Object anObject)` Changes the WODisplayGroup's delegate to `anObject`.
`void`	`setDetailKey(String detailKey)` Changes the detail key to `detailKey` for a detail display group.
`void`	`setFetchesOnLoad(boolean yn)` Changes whether the WODisplayGroup automatically fetches its objects after being loaded.
`static void`	`setGlobalDefaultForValidatesChangesImmediately(boolean yn)` Changes the class default behavior controlling whether submitted changes are immediately validated.
`static void`	`setGlobalDefaultStringMatchFormat(String format)` Changes the default string match format for the class.
`static void`	`setGlobalDefaultStringMatchOperator(String op)` Changes the default string match operator for the class.
`void`	`setInQueryMode(boolean yn)` Deprecated. No longer important for WebObjects applications. No user code should implement or depend upon this, and any implementations or references to this method may be eliminated freely.
`void`	`setInsertedObjectDefaultValues(NSDictionary defaultValues)` Changes the dictionary of default values added to empty objects that are inserted into the WODisplayGroup.
`void`	`setLocalKeys(NSArray newKeySet)` Changes the additional keys to which WOAssociations for the objects in this WODisplayGroup may be bound to the Strings in `newKeySet`.
`void`	`setMasterObject(Object masterObject)` Changes the master object to `masterObject` for detail display groups and then performs a fetch if the display group is set to fetch on load.
`void`	`setNumberOfObjectsPerBatch(int count)` Changes the number of objects the WODisplayGroup displays at a time.
`void`	`setObjectArray(NSArray array)` Changes the WODisplayGroup's array of `allObjects` to `array`, regardless of what its `dataSource` provides.
`void`	`setQualifier(EOQualifier qualifier)` Changes the EOQualifier used by the WODisplayGroup to filter its `displayedObjects`.
`void`	`setSelectedObject(Object anObject)` Changes the WODisplayGroup's `selectedObjects` to an array containing only `anObject`.
`void`	`setSelectedObjects(NSArray objects)` Changes the WODisplayGroup's selection from `displayedObjects` to `objects`.
`boolean`	`setSelectionIndexes(NSArray s)` Changes the selection from `allObjects`.
`void`	`setSelectsFirstObjectAfterFetch(boolean yn)` Changes whether the WODisplayGroup should select the first object from its `displayedObjects` after a `fetch` when there were no selections before the `fetch`.
`void`	`setSortOrderings(NSArray<EOSortOrdering> keySortOrderArray)` Changes the EOQualifier used by the WODisplayGroup to filter its objects.
`void`	`setValidatesChangesImmediately(boolean yn)` Changes whether the WODisplayGroup immediately validates submitted changes.
`NSArray<EOSortOrdering>`	`sortOrderings()` Provides the last array of EOSortOrdering objects given to the WODisplayGroup via `setSortOrderings`.
`NSArray`	`stringQualifierOperators()` Provides an array containing all of the relational operators supported by EOQualifier that work exclusively on Strings: "starts with", "contains", "ends with", "is", and "like".
`void`	`takeValueForKey(Object value, String key)` Sets the value for the property identified by `key` to `value`.
`String`	`toString()`
`void`	`unableToSetNullForKey(String key)` Invoked from `takeValueForKey` when it is given a `null` value for a scalar property (such as an `int` or a `float`).
`NSUndoManager`	`undoManager()` Provides the NSUndoManager used by the WODisplayGroup's `dataSource`'s EOEditingContext.
`void`	`updateDisplayedObjects()` Recalculates the WODisplayGroup's `displayedObjects` from `allObjects` and redisplays them.
`boolean`	`validatesChangesImmediately()` Indicates whether the WODisplayGroup immediately validates submitted changes.
`Object`	`valueForKey(String key)` Retrieves the value of the property named by `key`.
`void`	`willChange()` Notifies observers that the WODisplayGroup will change.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

DisplayGroupWillFetchNotification

public static final String DisplayGroupWillFetchNotification

The name for the notification posted during any invocation of WODisplayGroup's fetch method.

See Also:: fetch(), NSNotification, Constant Field Values

Constructor Detail

WODisplayGroup

public WODisplayGroup()

Creates and returns a new WODisplayGroup. The WODisplayGroup needs to have an EODataSource. If you invoke this method explicitly, you must invoke setDataSource.

See Also:: setDataSource(com.webobjects.eocontrol.EODataSource)

Method Detail

globalDefaultStringMatchOperator

public static String globalDefaultStringMatchOperator()

Provides the default string match operator for the class.

Returns:: the default string match operator for the class
See Also:: defaultStringMatchOperator()

setGlobalDefaultStringMatchOperator

public static void setGlobalDefaultStringMatchOperator(String op)

Changes the default string match operator for the class.

Parameters:: op - the proposed default string match operator for the class
See Also:: setDefaultStringMatchOperator(java.lang.String)

globalDefaultStringMatchFormat

public static String globalDefaultStringMatchFormat()

Provides the default string match format for the class.

Returns:: the default string match format for the class
See Also:: defaultStringMatchFormat()

setGlobalDefaultStringMatchFormat

public static void setGlobalDefaultStringMatchFormat(String format)

Changes the default string match format for the class.

Parameters:: format - the proposed string match format
See Also:: setDefaultStringMatchFormat(java.lang.String)

globalDefaultForValidatesChangesImmediately

public static boolean globalDefaultForValidatesChangesImmediately()

Indicates the class default behavior controlling whether submitted changes are immediately validated. This class default behavior acts as the default behavior for new instances of WODisplayGroup.

This behavior can be overridden for each WODisplayGroup instance using setValidatesChangesImmediately.

Unless this behavior is changed using setGlobalDefaultForValidatesChangesImmediately, this method returns false.

Returns:: true if WODisplayGroups should immediately validate changes; false if changes should be passed unvalidated to the WODisplayGroup's EOEditingContext
See Also:: setGlobalDefaultForValidatesChangesImmediately(boolean), validatesChangesImmediately(), EOEditingContext

setGlobalDefaultForValidatesChangesImmediately

public static void setGlobalDefaultForValidatesChangesImmediately(boolean yn)

Changes the class default behavior controlling whether submitted changes are immediately validated. This class default behavior acts as the default behavior for new instances of WODisplayGroup.

This behavior can be overridden for each WODisplayGroup instance using setValidatesChangesImmediately.

Parameters:: yn - the proposed behavior. true if WODisplayGroups should immediately validate changes; false if changes should be passed unvalidated to the WODisplayGroup's EOEditingContext
See Also:: globalDefaultForValidatesChangesImmediately(), setValidatesChangesImmediately(boolean), EOEditingContext

finishInitialization

protected void finishInitialization()

Invoked from the WODisplayGroup constructor to finish initializing a newly created instance. This includes:

Setting the new instances's EOEditingContext to its dataSource's editing context (if available)
Registering the new display group for NSNotifications named EOEditingContext.ObjectsChangedInEditingContextNotification and EOObjectStore.InvalidatedAllObjectsInStoreNotification
Establishing the new instance as an editor for the its editing context
Establishing the new instance as its editing context's message handler (unless the editing context already has a message handler)

None of your other methods should ever invoke finishInitialization. If you override finishInitialization in a subclass, ensure that you invoke super.finishInitialization().

See Also:: EOEditingContext.ObjectsChangedInEditingContextNotification, EOObjectStore.InvalidatedAllObjectsInStoreNotification, NSNotification

dispose

public void dispose()

Description copied from interface: NSDisposable

Invoked when the receiver should prepare itself for destruction. Implementations of this method should break connections that other objects have to the receiver, including unregistering for notifications, resigning as other objects' delegates, release locks and system resources, close files, and any other clean up operations.

Specified by:: dispose in interface NSDisposable

initWithCoder

public Object initWithCoder(NSCoder coder)

encodeWithCoder

public void encodeWithCoder(NSCoder coder)

selectsFirstObjectAfterFetch

public boolean selectsFirstObjectAfterFetch()

Indicates whether the WODisplayGroup should select the first object from its displayedObjects after a fetch when there were no selections before the fetch.

Returns:: true indicates automatically selection of the first displayed object after a fetch if there was no previous selection; false indicates leaving an empty selection as-is
See Also:: displayedObjects(), fetch(), setSelectsFirstObjectAfterFetch(boolean)

setSelectsFirstObjectAfterFetch

public void setSelectsFirstObjectAfterFetch(boolean yn)

Changes whether the WODisplayGroup should select the first object from its displayedObjects after a fetch when there were no selections before the fetch.

By default, a WODisplayGroup will select the first object after a fetch when there was no previous selection.

Parameters:: yn - true indicates automatic selection of the first displayed object after a fetch if there was no previous selection, false indicates leaving an empty selection as-is
See Also:: displayedObjects(), fetch(), selectsFirstObjectAfterFetch()

setValidatesChangesImmediately

public void setValidatesChangesImmediately(boolean yn)

Changes whether the WODisplayGroup immediately validates submitted changes.

This behavior can be overridden class-wide (affecting WODisplayGroup instances created after the class change) using setGlobalDefaultForValidatesChangesImmediately.

Parameters:: yn - the proposed behavior. true if the WODisplayGroup should immediately validate changes; false if changes should be passed unvalidated to the WODisplayGroup's EOEditingContext
See Also:: setGlobalDefaultForValidatesChangesImmediately(boolean), validatesChangesImmediately(), EOEditingContext.saveChanges(), EOEditingContext.tryToSaveChanges()

validatesChangesImmediately

public boolean validatesChangesImmediately()

Indicates whether the WODisplayGroup immediately validates submitted changes.

Unless this behavior is overridden for this WODisplayGroup instance using setValidatesChangesImmediately, the value returned is the same as that currently returned by globalDefaultForValidatesChangesImmediately.

Returns:: true if the WODisplayGroup should immediately validate changes; false if changes should be passed unvalidated to the WODisplayGroup's EOEditingContext
See Also:: globalDefaultForValidatesChangesImmediately(), setValidatesChangesImmediately(boolean)

setFetchesOnLoad

public void setFetchesOnLoad(boolean yn)

Changes whether the WODisplayGroup automatically fetches its objects after being loaded. This behavior may also be set in WebObjects Builder using the Display Group Options panel.

Parameters:: yn - the proposed change. true if the WODisplayGroup, when it is loaded, should automatically fetch from the database; false if the WODisplayGroup should wait until fetch is invoked explicitly
See Also:: fetch(), fetchesOnLoad()

fetchesOnLoad

public boolean fetchesOnLoad()

Indicates whether the WODisplayGroup, whenever it is loaded, should fetch from its dataSource. A fetch on load typically occurs each time the WOComponent containing the WODisplayGroup is loaded by the client (web browser).

This method is invoked by:

awakeFromKeyValueUnarchiver
setMasterObject
the default WODisplayGroup constructor

Unless explicitly changed via setFetchesOnLoad, returns false.

Returns:: true if the WODisplayGroup fetches automatically after the component that contains it is loaded, false if it must be told explicitly to fetch
See Also:: awakeFromKeyValueUnarchiver(com.webobjects.eocontrol.EOKeyValueUnarchiver), dataSource(), fetch(), setFetchesOnLoad(boolean), setMasterObject(java.lang.Object), WODisplayGroup, WOComponent

allObjects

public NSArray allObjects()

Provides all of the objects collected by the WODisplayGroup. This collection differs from that provided by displayedObjects. Typically this collection will comprise the results of the last fetch from the WODisplayGroup's dataSource.

However, this collection may be modified via several methods:

deleteObjectAtIndex
insertObjectAtIndex
objectsChangedInEditingContext
setInQueryMode
setObjectArray
updateDisplayedObjects

Returns:: an array of all the objects collected by the WODisplayGroup. Will never be null, though it may be empty.
See Also:: deleteObjectAtIndex(int), displayedObjects(), fetch(), insertObjectAtIndex(java.lang.Object, int), objectsChangedInEditingContext(com.webobjects.foundation.NSNotification), setInQueryMode(boolean), setObjectArray(com.webobjects.foundation.NSArray), updateDisplayedObjects()

displayedObjects

public NSArray displayedObjects()

Provides the objects to be displayed or otherwise made available to the client (web browser). Typically this collection represents a filtered version of allObjects.

If the WODisplayGroup has a delegate that responds to displayGroupDisplayArrayForObjects, the WODisplayGroup uses this method to filter allObjects. Otherwise, the WODisplayGroup filters via a combination of its qualifier and its sortOrderings.

displayedObjects changes each time allObjects changes, as well whenever updateDisplayedObjects is invoked. If display batching is enabled (numberOfObjectsPerBatch() > 0), displayedObjects provides the current batch of objects. Consequently, displayedObjects may be also changed whenever any of the following methods are invoked:

setNumberOfObjectsPerBatch
displayNextBatch
displayPreviousBatch
displayBatchContainingSelectedObject

Returns:: the objects that should be displayed
See Also:: allObjects(), delegate(), displayNextBatch(), displayPreviousBatch(), displayBatchContainingSelectedObject(), numberOfObjectsPerBatch(), qualifier(), setNumberOfObjectsPerBatch(int), setQualifier(com.webobjects.eocontrol.EOQualifier), setSortOrderings(com.webobjects.foundation.NSArray), sortOrderings(), updateDisplayedObjects(), WODisplayGroup.Delegate.displayGroupDisplayArrayForObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSArray)

setQualifier

public void setQualifier(EOQualifier qualifier)

Changes the EOQualifier used by the WODisplayGroup to filter its displayedObjects. Typically invoked in conjunction with setSortOrderings.

Use updateDisplayedObjects to apply a new qualifier to the WODisplayGroup (filter allObjects into displayedObjects).

The WODisplayGroup's qualifier may also be changed via qualifyDisplayGroup or from WebObjects Builder using the Display Group Options panel.

Parameters:: qualifier - the proposed qualifier
See Also:: allObjects(), displayedObjects(), qualifier(), qualifyDisplayGroup(), setSortOrderings(com.webobjects.foundation.NSArray), updateDisplayedObjects(), WODisplayGroup.Delegate.displayGroupDisplayArrayForObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSArray)

qualifier

public EOQualifier qualifier()

Provides the last qualifier given to the WODisplayGroup via setQualifier or qualifyDisplayGroup. The WODisplayGroup uses this qualifier, in conjunction with its sortOrderings, to filter allObjects into displayedObjects.

If the WODisplayGroup has a delegate that responds to displayGroupDisplayArrayForObjects, the WODisplayGroup uses this method to filter allObjects instead of using its qualifier and sortOrderings.

Returns:: the WODisplayGroup's qualifier. May be null.
See Also:: allObjects(), delegate(), displayedObjects(), qualifyDisplayGroup(), setQualifier(com.webobjects.eocontrol.EOQualifier), sortOrderings(), updateDisplayedObjects(), WODisplayGroup.Delegate.displayGroupDisplayArrayForObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSArray)

setSortOrderings

public void setSortOrderings(NSArray<EOSortOrdering> keySortOrderArray)

Changes the EOQualifier used by the WODisplayGroup to filter its objects. Typically invoked in conjunction with setQualifier.

Use updateDisplayedObjects to apply the new sort orderings to the WODisplayGroup (filter allObjects into displayedObjects).

The WODisplayGroup's sortOrderings may also be changed from WebObjects Builder using the Display Group Options panel.

Parameters:: keySortOrderArray - the proposed EOSortOrdering objects
See Also:: allObjects(), displayedObjects(), qualifyDisplayGroup(), setQualifier(com.webobjects.eocontrol.EOQualifier), updateDisplayedObjects(), sortOrderings(), EOSortOrdering

sortOrderings

public NSArray<EOSortOrdering> sortOrderings()

Provides the last array of EOSortOrdering objects given to the WODisplayGroup via setSortOrderings. The WODisplayGroup uses these sort orderings, in conjunction with its qualifier, to filter allObjects into displayedObjects.

Returns:: an array of EOSortOrdering objects. May be null.
See Also:: allObjects(), delegate(), displayedObjects(), qualifier(), qualifyDisplayGroup(), setSortOrderings(com.webobjects.foundation.NSArray), updateDisplayedObjects(), EOSortOrdering, WODisplayGroup.Delegate.displayGroupDisplayArrayForObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSArray)

updateDisplayedObjects

public void updateDisplayedObjects()

Recalculates the WODisplayGroup's displayedObjects from allObjects and redisplays them. Invoked by qualifyDisplayGroup and setObjectArray.

If the WODisplayGroup has a delegate that responds to displayGroupDisplayArrayForObjects, the WODisplayGroup uses this method to filter allObjects into displayedObjects. Otherwise, the WODisplayGroup uses its qualifier and sortOrderings to do so. In either case, any objects that were previously selected remain selected in the new array of displayedObjects.

See Also:: allObjects(), delegate(), displayedObjects(), qualifier(), qualifyDisplayGroup(), redisplay(), selectedObjects(), setObjectArray(com.webobjects.foundation.NSArray), sortOrderings(), WODisplayGroup.Delegate.displayGroupDisplayArrayForObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSArray)

setObjectArray

public void setObjectArray(NSArray array)

Changes the WODisplayGroup's array of allObjects to array, regardless of what its dataSource provides. Invoked from fetch to set the array of fetched objects; should almost never need to be invoked explicitly.

Doesn't affect the dataSource's objects at all; specifically, this method results neither in inserts nor deletes of objects in the dataSource. array should contain objects with the same property names or methods as those used by the WODisplayGroup.

After changing to array, this method restores as much of any previous object selection as possible. If unable to restore any previous selection, then the first object is selected if the WODisplayGroup selectsFirstObjectAfterFetch.

Parameters:: array - the object array to be set
See Also:: fetch(), allObjects(), dataSource(), displayedObjects(), selectsFirstObjectAfterFetch()

setDataSource

public void setDataSource(EODataSource ds)

Changes the WODisplayGroup's EODataSource to ds. This also causes the WODisplayGroup to:

Unregister itself, if necessary, as an editor and message handler for the previous EODataSource's EOEditingContext
Register itself with ds's EOEditingContext, unless that EOEditingContext already has a message handler
Clear its array of objects, allObjects
Invoke WODisplayGroup.Delegate.displayGroupDidChangeDataSource

Parameters:: ds - the proposed EODataSource
See Also:: allObjects(), dataSource(), delegate(), EODataSource, EOEditingContext, WODisplayGroup.Delegate.displayGroupDidChangeDataSource(com.webobjects.appserver.WODisplayGroup)

dataSource

public EODataSource dataSource()

Provides the last EODataSource given to the WODisplayGroup via setDataSource. The WODisplayGroup will use this EODataSource to fetch and commit objects.

The EODataSource may represent a detail in a master-detail relationship.

Returns:: the WODisplayGroup's EODataSource
See Also:: fetch(), hasDetailDataSource(), setDataSource(com.webobjects.eocontrol.EODataSource), EODataSource

setDelegate

public void setDelegate(Object anObject)

Changes the WODisplayGroup's delegate to anObject.

The new delegate object may not implement WODisplayGroup.Delegate, because such implementation would require that all delegate methods be implemented. Those methods that might communicate with the delegate will take the appropriate steps to ensure that the delegate implements any method in question before attempting to invoke it.

Parameters:: anObject - the proposed delegate object
See Also:: delegate(), WODisplayGroup.Delegate

delegate

public Object delegate()

Provides the last delegate object given to the WODisplayGroup via setDelegate.

The delegate object may not implement WODisplayGroup.Delegate, because such implementation would require that all delegate methods be implemented. Those methods that might communicate with the delegate will take the appropriate steps to ensure that the delegate implements any method in question before attempting to invoke it.

Returns:: the WODisplayGroup's delegate object
See Also:: setDelegate(java.lang.Object), WODisplayGroup.Delegate

localKeys

public NSArray localKeys()

Provides the additional keys to which WOAssociations may be bound for this WODisplayGroup.

Typically a WODisplayGroup's basic keys are the attributes and relationships of its objects, allObjects. These keys are defined by the EOClassDescription for the objects (derived from an EOEntity in the EOModel associated with the WODisplayGroup's dataSource).

Local keys are used by WebObjects Builder to extend manually the interface of a WODisplayGroup's objects or to provide interface conveniences. Such keys may form associations with key paths, with arbitrary methods of objects or with properties of objects not associated with an EOEntity.

Returns:: an array of additional keys for WOAssociations in this WODisplayGroup. Will never be null, though it may be empty.
See Also:: allObjects(), dataSource(), WOAssociation, EOEntity, EOModel, EOClassDescription

setLocalKeys

public void setLocalKeys(NSArray newKeySet)

Changes the additional keys to which WOAssociations for the objects in this WODisplayGroup may be bound to the Strings in newKeySet.

Parameters:: newKeySet - the proposed local keys
See Also:: localKeys(), WOAssociation

objectsChangedInEditingContext

public void objectsChangedInEditingContext(NSNotification notification)

Redisplays the changed objects in the WODisplayGroup. The userInfo of notification may indicate that some objects have been deleted.

Parameters:: notification - indicates whether any objects have been deleted
See Also:: allObjects(), delegate(), NSNotification.userInfo()

objectsInvalidatedInEditingContext

public void objectsInvalidatedInEditingContext(NSNotification notification)

Refetches all objects from the dataSource of the WODisplayGroup after some or all of them have been invalidated. Refetching may be prevented by the WODisplayGroup's delegate method, displayGroupShouldRefetchForInvalidatedAllObjects.

Parameters:: notification - indicates which objects have been invalidated, for use by displayGroupShouldRefetchForInvalidatedAllObjects
See Also:: allObjects(), dataSource(), delegate(), fetch(), NSNotification, WODisplayGroup.Delegate.displayGroupShouldRefetchForInvalidatedAllObjects(com.webobjects.appserver.WODisplayGroup, com.webobjects.foundation.NSNotification)

undoManager

public NSUndoManager undoManager()

Provides the NSUndoManager used by the WODisplayGroup's dataSource's EOEditingContext.

Returns:: the undo manager that the WODisplayGroup will use to revert changes to its objects
See Also:: allObjects(), dataSource(), EOEditingContext, NSUndoManager

selectionIndexes

public NSArray selectionIndexes()

Provides the last selection given to the WODisplayGroup via setSelectionIndexes. This selection is represented by an array of Integers that indicates the indexes of the selected objects in allObjects.

Returns:: an array of Integers indicating the indexes of the selection. Will never be null, though it may be empty.
See Also:: allObjects(), selectedObject(), selectedObjects(), setSelectionIndexes(com.webobjects.foundation.NSArray)

selectedObjects

public NSArray selectedObjects()

Provides the last selection given to the WODisplayGroup via setSelectedObjects. This selection is represented by an array of objects culled from the WODisplayGroup's displayedObjects.

Returns:: an array of the objects selected from the WODisplayGroup's displayedObjects. Will never be null, though it may be empty.
See Also:: displayedObjects(), selectedObject(), selectionIndexes()

setSelectedObjects

public void setSelectedObjects(NSArray objects)

Changes the WODisplayGroup's selection from displayedObjects to objects. Invokes setSelectionIndexes to do so.

Invoked by setSelectedObject.

Parameters:: objects - the proposed selection
See Also:: allObjects(), displayedObjects(), selectedObjects(), setSelectedObject(java.lang.Object), setSelectionIndexes(com.webobjects.foundation.NSArray)

selectedObject

public Object selectedObject()

Provides the first object from selectedObjects.

Returns:: the first object in selectedObjects, or null if there's no selection
See Also:: displayedObjects(), selectedObjects(), selectionIndexes()

setSelectedObject

public void setSelectedObject(Object anObject)

Changes the WODisplayGroup's selectedObjects to an array containing only anObject. Invokes setSelectedObjects to do so.

If anObject is null, invokes clearSelection.

Parameters:: anObject - the object to become the new selectedObject and sole member of selectedObjects
See Also:: allObjects(), displayedObjects(), selectedObject(), selectedObjects(), selectionIndexes()

endEditing

@Deprecated
public boolean endEditing()

Deprecated. No longer important for WebObjects applications. No user code should depend upon this, and any references to this method may be eliminated freely.

Indicates whether any further editing should take place.

Returns:: true

setSelectionIndexes

public boolean setSelectionIndexes(NSArray s)

Changes the selection from allObjects. s contains the indexes (Integers) of some or all of the objects from allObjects.

Invoked by setSelectedObjects.

com.webobjects.appserver Class WODisplayGroup