net.wotonomy.ui
Class DisplayGroup

java.lang.Object
  java.util.Observable
      net.wotonomy.ui.EODisplayGroup
          net.wotonomy.ui.DisplayGroup

All Implemented Interfaces:

net.wotonomy.control.EOEditingContext.Editor, net.wotonomy.control.EOObserving

public class DisplayGroup
extends EODisplayGroup

DisplayGroup provides an abstraction of a user interface, comprising of an ordered collection of data objects, some of which are displayed, and of those some are selected. This class extends EODisplayGroup to provide java-friendly convenience methods.

Version:

$Revision: 904 $

Author:

michael@mpowers.net, $Author: cgruber $

Nested Class Summary

Nested classes/interfaces inherited from class net.wotonomy.ui.EODisplayGroup

EODisplayGroup.Delegate

Field Summary

Fields inherited from class net.wotonomy.ui.EODisplayGroup

allObjects, allObjectsProxy, displayedObjects, displayedObjectsProxy, DisplayGroupWillFetchNotification, selectedIndexes, selectedObjects, selectedObjectsProxy

Constructor Summary

DisplayGroup()

Method Summary

java.util.List	getAllObjects() Returns a List containing all objects managed by the display group.
net.wotonomy.control.EODataSource	getDataSource() Returns the current data source backing this display group, or null if no dataSource is currently used.
java.lang.String	getDefaultStringMatchFormat() Returns the current string matching format.
java.lang.String	getdefaultStringMatchOperator() Returns the current string matching operator.
java.lang.Object	getDelegate() Returns the current delegate for this display group, or null if no delegate is currently set.
java.util.List	getDisplayedObjects() Returns a List of all objects in the display group that are currently displayed by the associations.
EOAssociation	getEditingAssociation() Returns the association that is currently being edited, or null if no editing is taking place.
java.util.Map	getEqualToQueryValues() Returns a Map containing the mappings of keys to query values that will be used to test for equality.
static java.lang.String	getGlobalDefaultStringMatchFormat() Specifies the default string matching format for all display groups.
static java.lang.String	getGlobalDefaultStringMatchOperator() Specifies the default string matching operator for all display groups.
java.util.Map	getGreaterThanQueryValues() Returns a Map containing the mappings of keys to query values that will be used to test for greater value.
java.util.Map	getInsertedObjectDefaultValues() Returns a Map of default values that are applied to new objects that are inserted into the list.
java.util.Map	getLessThanQueryValues() Returns a Map containing the mappings of keys to query values that will be used to test for lesser value.
java.util.List	getLocalKeys() Returns the keys that were declared when read from an external resource file.
java.util.List	getObservingAssociations() Returns a List of associations that are observing this display group.
net.wotonomy.control.EOQualifier	getQualifier() Returns a qualifier that will be applied all the objects in this display group to determine which objects will be displayed.
net.wotonomy.control.EOQualifier	getQualifierFromQueryValues() Returns a new qualifier built from the three query value maps: greater than, equal to, and less than.
java.util.Map	getQueryBindingValues() Returns a Map containing the mappings of keys to binding query values.
java.util.Map	getQueryOperatorValues() Returns a Map containing the mappings of keys to operator values.
java.lang.Object	getSelectedObject() Returns the currently selected object, or null if there is no selection.
java.util.List	getSelectedObjects() Returns a List containing all selected objects, if any.
java.lang.Object	getSelectedObjectValueForKey(java.lang.String aKey) Returns a value on the selected object for the specified key.
java.util.List	getSelectionIndexes() Returns a List containing the indexes of all selected objects, if any.
java.util.List	getSortOrderings() Returns the List of sort orderings for this display group.
int	getUpdatedObjectIndex() Returns the index of the changed object.
java.lang.Object	getValueForObject(java.lang.Object anObject, java.lang.String aKey) Returns the value for the specified key on the specified object.
java.lang.Object	getValueForObjectAtIndex(int anIndex, java.lang.String aKey) Calls valueForObject() for the object at the specified index.

Methods inherited from class net.wotonomy.ui.EODisplayGroup

allObjects, associationDidBeginEditing, associationDidEndEditing, associationFailedToValidateValue, clearSelection, contentsChanged, dataSource, defaultStringMatchFormat, defaultStringMatchOperator, delegate, deleteObjectAtIndex, deleteSelection, displayedObjects, editingAssociation, editingContextPresentErrorMessage, editingContextShouldContinueFetching, editingContextWillSaveChanges, editorHasChangesForEditingContext, enabledToSetSelectedObjectValueForKey, endEditing, enterQueryMode, equalToQueryValues, fetch, fetchesOnLoad, globalDefaultForValidatesChangesImmediately, globalDefaultStringMatchFormat, globalDefaultStringMatchOperator, greaterThanQueryValues, inQueryMode, insertedObjectDefaultValues, insertNewObjectAtIndex, insertObjectAtIndex, lessThanQueryValues, localKeys, objectsInvalidatedInEditingContext, objectWillChange, observingAssociations, processRecentChanges, qualifier, qualifierFromQueryValues, qualifyDataSource, qualifyDisplayGroup, queryBindingValues, queryOperatorValues, redisplay, selectedObject, selectedObjects, selectedObjectValueForKey, selectionChanged, selectionIndexes, selectNext, selectObject, selectObjectsIdenticalTo, selectPrevious, selectsFirstObjectAfterFetch, setDataSource, setDefaultStringMatchFormat, setDefaultStringMatchOperator, setDelegate, setEqualToQueryValues, setFetchesOnLoad, setGlobalDefaultForValidatesChangesImmediately, setGlobalDefaultStringMatchFormat, setGlobalDefaultStringMatchOperator, setGreaterThanQueryValues, setInQueryMode, setInsertedObjectDefaultValues, setLessThanQueryValues, setLocalKeys, setObjectArray, setQualifier, setQueryBindingValues, setQueryOperatorValues, setSelectedObject, setSelectedObjects, setSelectedObjectValue, setSelectionIndexes, setSelectsFirstObjectAfterFetch, setSortOrderings, setUsesOptimisticRefresh, setValidatesChangesImmediately, setValueForObject, setValueForObjectAtIndex, sortOrderings, toString, updateDisplayedObjects, updatedObjectIndex, usesOptimisticRefresh, validatesChangesImmediately, valueForObject, valueForObjectAtIndex, willChange

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayGroup

public DisplayGroup()

Method Detail

getDataSource

public net.wotonomy.control.EODataSource getDataSource()

Returns the current data source backing this display group, or null if no dataSource is currently used.

getDelegate

public java.lang.Object getDelegate()

Returns the current delegate for this display group, or null if no delegate is currently set.

getDefaultStringMatchFormat

public java.lang.String getDefaultStringMatchFormat()

Returns the current string matching format. If not set, defaults to "%@*".

getdefaultStringMatchOperator

public java.lang.String getdefaultStringMatchOperator()

Returns the current string matching operator. If not set, defaults to "caseInsensitiveLike".

getInsertedObjectDefaultValues

public java.util.Map getInsertedObjectDefaultValues()

Returns a Map of default values that are applied to new objects that are inserted into the list.

getLocalKeys

public java.util.List getLocalKeys()

Returns the keys that were declared when read from an external resource file.

getSortOrderings

public java.util.List getSortOrderings()

Returns the List of sort orderings for this display group.

getQualifier

public net.wotonomy.control.EOQualifier getQualifier()

Returns a qualifier that will be applied all the objects in this display group to determine which objects will be displayed.

getQualifierFromQueryValues

public net.wotonomy.control.EOQualifier getQualifierFromQueryValues()

Returns a new qualifier built from the three query value maps: greater than, equal to, and less than.

getQueryBindingValues

public java.util.Map getQueryBindingValues()

Returns a Map containing the mappings of keys to binding query values.

getQueryOperatorValues

public java.util.Map getQueryOperatorValues()

Returns a Map containing the mappings of keys to operator values.

getEqualToQueryValues

public java.util.Map getEqualToQueryValues()

Returns a Map containing the mappings of keys to query values that will be used to test for equality.

getGreaterThanQueryValues

public java.util.Map getGreaterThanQueryValues()

Returns a Map containing the mappings of keys to query values that will be used to test for greater value.

getLessThanQueryValues

public java.util.Map getLessThanQueryValues()

Returns a Map containing the mappings of keys to query values that will be used to test for lesser value.

getEditingAssociation

public EOAssociation getEditingAssociation()

Returns the association that is currently being edited, or null if no editing is taking place.

getObservingAssociations

public java.util.List getObservingAssociations()

Returns a List of associations that are observing this display group.

getAllObjects

public java.util.List getAllObjects()

Returns a List containing all objects managed by the display group. This includes those objects not visible due to disqualification.

getDisplayedObjects

public java.util.List getDisplayedObjects()

Returns a List of all objects in the display group that are currently displayed by the associations. The list is a copy of the internal displayed object list.

getSelectedObject

public java.lang.Object getSelectedObject()

Returns the currently selected object, or null if there is no selection.

getSelectedObjects

public java.util.List getSelectedObjects()

Returns a List containing all selected objects, if any. Returns an empty list if no objects are selected.

getSelectionIndexes

public java.util.List getSelectionIndexes()

Returns a List containing the indexes of all selected objects, if any. The list contains instances of java.lang.Number; call intValue() retrieve the index.

getUpdatedObjectIndex

public int getUpdatedObjectIndex()

Returns the index of the changed object. If more than one object has changed, -1 is returned.

getSelectedObjectValueForKey

public java.lang.Object getSelectedObjectValueForKey(java.lang.String aKey)

Returns a value on the selected object for the specified key.

getValueForObject

public java.lang.Object getValueForObject(java.lang.Object anObject,
                                          java.lang.String aKey)

Returns the value for the specified key on the specified object.

getValueForObjectAtIndex

public java.lang.Object getValueForObjectAtIndex(int anIndex,
                                                 java.lang.String aKey)

Calls valueForObject() for the object at the specified index.

getGlobalDefaultStringMatchFormat

public static java.lang.String getGlobalDefaultStringMatchFormat()

Specifies the default string matching format for all display groups.

getGlobalDefaultStringMatchOperator

public static java.lang.String getGlobalDefaultStringMatchOperator()

Specifies the default string matching operator for all display groups.