com.webobjects.eogeneration
Class EOListController

java.lang.Object
  |
  +--com.webobjects.eoapplication.EOController
        |
        +--com.webobjects.eoapplication.EOComponentController
              |
              +--com.webobjects.eoapplication.EOArchiveController
                    |
                    +--com.webobjects.eoapplication.EOEntityController
                          |
                          +--com.webobjects.eoapplication.EODocumentController
                                |
                                +--com.webobjects.eogeneration.EOEditingController
                                      |
                                      +--com.webobjects.eogeneration.EOListController

All Implemented Interfaces:

EOAction.Enabling, EOAssociationConnector, EOComponentController.EndEditing, EOControllerFactory.List, EOControllerFactory.Select, EODocument, EOEditable, EOModalDialogController.ModalActions, EOObjectDisplay, EOObjectDisplayDocument, EOObserving, EOWidgetController.DefaultAction, NSDisposable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions

public class EOListController

extends EOEditingController

implements EOModalDialogController.ModalActions, EOWidgetController.DefaultAction, EOControllerFactory.Select, EOControllerFactory.List

Nested Class Summary

Nested classes inherited from class com.webobjects.eoapplication.EOComponentController

EOComponentController.ActionCollector, EOComponentController.Activation, EOComponentController.EndEditing, EOComponentController.Modal, EOComponentController.ResetUserInterface

Nested classes inherited from class com.webobjects.eoapplication.EOController

EOController.Enumeration

Nested classes inherited from class com.webobjects.eogeneration.EOWidgetController.DefaultAction

EOWidgetController.DefaultAction.CommonWidgetHandler

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Field Summary

Fields inherited from class com.webobjects.eoapplication.EOEntityController

NestedEditingContextProviderMethodName, NewDisplayGroupProviderMethodName, NewDisplayGroupUsingOptimisticRefreshProviderMethodName, NewEditingContextProviderMethodName

Fields inherited from class com.webobjects.eoapplication.EOComponentController

Bottom, BottomLeft, BottomRight, Center, Left, Right, Top, TopLeft, TopRight

Fields inherited from class com.webobjects.eoapplication.EOController

ControllerAndSubcontrollersEnumeration, ControllerAndSupercontrollersEnumeration, SubcontrollersEnumeration, SupercontrollersEnumeration

Fields inherited from interface com.webobjects.eoapplication.EOEditable

AlwaysEditable, IfSupercontrollerEditable, NeverEditable

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

EOListController()

EOListController(EOXMLUnarchiver unarchiver)

Method Summary

void	cancel() The action method invoked when the user cancels the modal dialog.
boolean	canPerformActionNamed(String actionName) Overridden to handle editing-related action enabling and disabling.
void	defaultAction()
protected NSArray	defaultActions() Adds actions for handling editing (like save, revert) the default actions defined by the superclass, EOEntityController (but only if the receiver is a root document controller and if it's not used in a modal dialog.
boolean	delete()
void	finishSelecting()
boolean	insert()
boolean	insertWithTask()
boolean	isDocumentForGlobalID(EOGlobalID globalID, String entityName) Conformance to EODocument.
void	listObjectsWithFetchSpecification(EOFetchSpecification fetchSpecification)
void	listObjectsWithGlobalIDs(NSArray globalIDs)
boolean	modalDialogShouldClose() This method is invoked by the modal dialog controller on its subcontrollers when the user attempts to close the modal dialog with the dialog's close button (not the usual ok/cancel buttons).
boolean	ok() The action method invoked when the user wants to finish the modal dialog.
boolean	openWithTask()
void	prepareToSelect(boolean allowMultipleObjects, boolean allowInsertingObject)
EOGlobalID	provideSelectedObjectGlobalID()
NSArray	provideSelectedObjectsGlobalIDs()
boolean	save() Saves the receiver's editing context changes by invoking saveChanges, requesting an error dialog upon failure.

Methods inherited from class com.webobjects.eogeneration.EOEditingController

connectionWasBroken, connectionWasEstablished, dispose, disposeIfTransient, entityName, fetchesOnConnect, mandatoryRelationshipPaths, masterDetailAssociation, newDisplayGroup, relationshipPath, setEntityName, setMandatoryRelationshipPaths, setMasterDetailAssociation, setRelationshipPath, toString

Methods inherited from class com.webobjects.eoapplication.EODocumentController

canRedo, canRevert, canSave, canUndo, deleteSelectedObjects, editability, handleEditingContextNotification, insertObject, isEditable, isEdited, isRootDocumentController, prepareForNewTask, redo, revert, revertAndMakeInvisible, revertChanges, revertFailed, saveAndMakeInvisible, saveChanges, saveFailed, saveIfUserConfirms, saveIfUserConfirms, saveIfUserConfirmsAndMakeInvisible, saveIfUserConfirmsAndMakeInvisible, setEditability, setEdited, supercontrollerEditabilityDidChange, takeResponsibilityForEditabilityOfAssociation, undo, wasEdited

Methods inherited from class com.webobjects.eoapplication.EOEntityController

controllerDidLoadArchive, controllerWillLoadArchive, displayGroup, displayGroupProviderMethodName, displayGroupSortOrderings, editingContext, editingContextProviderMethodName, endEditing, establishConnection, isFetchesOnConnectEnabled, isRootEntityController, nestedEditingContext, newDataSource, newDisplayGroupUsingOptimisticRefresh, newEditingContext, objectForOutletPath, resetsEditingContextWhenPreparingForNewTask, selectedObject, selectedObjectGlobalID, selectedObjects, selectedObjectsGlobalIDs, setDisplayGroup, setDisplayGroupProviderMethodName, setEditingContext, setEditingContextProviderMethodName, setFetchesOnConnect, setFetchesOnConnectEnabled, setObjectsWithFetchSpecification, setObjectsWithGlobalIDs, setObjectWithGlobalID, setResetsEditingContextWhenPreparingForNewTask, startListeningToDisplayGroup, startListeningToEditingContext, stopListeningToDisplayGroup, stopListeningToEditingContext, takeResposibilityForConnectionOfAssociation

Methods inherited from class com.webobjects.eoapplication.EOArchiveController

archiveName, controllerDisplayGroup, hasControllerDisplayGroup, loadArchive, objectWillChange, prepareComponent, setArchiveName, setControllerDisplayGroup, willChange

Methods inherited from class com.webobjects.eoapplication.EOComponentController

activateFirstFocusComponent, addComponentOfSubcontroller, alignsComponents, canBeTransient, canResizeHorizontally, canResizeVertically, component, componentDidBecomeInvisible, componentDidBecomeVisible, defaultComponentSize, ensureMinimumComponentSizeWithoutSubcontrollers, ensureMinimumSubcontrollerAreaSize, firstFocusComponent, generateComponent, handleTakeValueForUnboundKey, hideInSupercontroller, hideSubcontroller, icon, insets, integrationComponent, integrationComponentDidBecomeInvisible, integrationComponentDidBecomeVisible, isComponentPrepared, isRootComponentController, isVisible, label, lastFocusComponent, makeInvisible, makeVisible, minimumComponentSize, minimumComponentSizeWithoutSubcontrollers, minimumIntegrationComponentSize, minimumSubcontrollerAreaSize, prefersIconOnly, removeComponentOfSubcontroller, removeTransientSubcontroller, setAlignsComponents, setCanResizeHorizontally, setCanResizeVertically, setComponent, setDefaultComponentSize, setFirstFocusComponent, setIcon, setInsets, setLabel, setLastFocusComponent, setPrefersIconOnly, setSubcontrollerArea, setToolTip, setUsesHorizontalLayout, setVisible, showInSupercontroller, showSubcontroller, subcontrollerArea, subcontrollerMinimumSizeDidChange, subcontrollerWasAdded, subcontrollerWasRemoved, toolTip, toolTipComponent, usesHorizontalLayout

Methods inherited from class com.webobjects.eoapplication.EOController

actionNames, actions, actionWithName, additionalActions, additionalKeyValuePairs, addSubcontroller, breakConnection, breakConnectionToSubcontrollers, canAccessFieldsDirectly, controllerEnumeration, controllersInEnumeration, controllersWithKeyValuePair, controllersWithKeyValuePairs, controllerWithKeyValuePair, controllerWithKeyValuePairs, disableActionNamed, disposableRegistry, enableActionNamed, enabledActions, establishConnectionToSupercontrollers, handleQueryWithUnboundKey, hierarchicalControllerForKey, hierarchicalValueForKey, invokeMethod, isActionNamedEnabled, isAncestorOfController, isConnected, isSupercontrollerOfController, isTransientExplicitlyForbidden, removeFromSupercontroller, removeSubcontroller, resetActions, setAdditionalActions, setAdditionalKeyValuePair, setAdditionalKeyValuePairs, setConnected, setSupercontroller, setTransientExplicitlyForbidden, setTypeName, subcontrollers, supercontroller, supercontroller, takeValueForKey, takeValueForKeyPath, typeName, unableToSetNullForKey, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webobjects.eoapplication.EOObjectDisplay

controllerDisplayGroup, displayGroup, editingContext, entityName

Constructor Detail

EOListController

public EOListController()

EOListController

public EOListController(EOXMLUnarchiver unarchiver)

Method Detail

canPerformActionNamed

public boolean canPerformActionNamed(String actionName)

Description copied from class: EODocumentController

Overridden to handle editing-related action enabling and disabling.

Specified by:

canPerformActionNamed in interface EOAction.Enabling

Overrides:

canPerformActionNamed in class EOEditingController

Parameters:

actionName - the action method name

Returns:

true if the action should be enabled; false otherwise

See Also:

EOAction.Enabling

cancel

public void cancel()

Description copied from interface: EOModalDialogController.ModalActions

The action method invoked when the user cancels the modal dialog.

Specified by:

cancel in interface EOModalDialogController.ModalActions

defaultAction

public void defaultAction()

Specified by:

defaultAction in interface EOWidgetController.DefaultAction

defaultActions

protected NSArray defaultActions()

Description copied from class: EODocumentController

Adds actions for handling editing (like save, revert) the default actions defined by the superclass, EOEntityController (but only if the receiver is a root document controller and if it's not used in a modal dialog.

Overrides:

defaultActions in class EOEditingController

Returns:

an array of the receiver's default actions

See Also:

EOController.actions(), EOController.resetActions()

delete

public boolean delete()

Overrides:

delete in class EOEditingController

finishSelecting

public void finishSelecting()

Specified by:

finishSelecting in interface EOControllerFactory.Select

insert

public boolean insert()

Overrides:

insert in class EOEditingController

insertWithTask

public boolean insertWithTask()

isDocumentForGlobalID

public boolean isDocumentForGlobalID(EOGlobalID globalID,
                                     String entityName)

Description copied from class: EODocumentController

Conformance to EODocument. Returns whether the receiver is a document for the enterprise object associated with globalID and entityName. See the method description of isDocumentForGlobalID in the interface specification for EODocument. EODocumentController's default implementation returns true if the receiver is a root document controller and receiver's display group displays only the specified object. Subclasses might have to override this method to return false, for example list controllers can't really be documents for a single object and should return false.

Specified by:

isDocumentForGlobalID in interface EODocument

Overrides:

isDocumentForGlobalID in class EODocumentController

Parameters:

globalID - the EOGlobalID of the enterprise object

entityName - the name of the entity of the enterprise object

Returns:

true if the receiver is a root document controller and its display group is displaying only the specified enteprise object; false otherwise

See Also:

EODocument.isDocumentForGlobalID(EOGlobalID, String)

listObjectsWithFetchSpecification

public void listObjectsWithFetchSpecification(EOFetchSpecification fetchSpecification)

Specified by:

listObjectsWithFetchSpecification in interface EOControllerFactory.List

listObjectsWithGlobalIDs

public void listObjectsWithGlobalIDs(NSArray globalIDs)

Specified by:

listObjectsWithGlobalIDs in interface EOControllerFactory.List

modalDialogShouldClose

public boolean modalDialogShouldClose()

Description copied from interface: EOModalDialogController.ModalActions

This method is invoked by the modal dialog controller on its subcontrollers when the user attempts to close the modal dialog with the dialog's close button (not the usual ok/cancel buttons). Subcontrollers return whether the dialog can be closed (which corresponds to a cancel operation) or not.

Specified by:

modalDialogShouldClose in interface EOModalDialogController.ModalActions

Returns:

true if the dialog can be closed (the operation can be cancelled); false otherwise.

ok

public boolean ok()

Description copied from interface: EOModalDialogController.ModalActions

The action method invoked when the user wants to finish the modal dialog.

Specified by:

ok in interface EOModalDialogController.ModalActions

Returns:

true if the dialog can be closed (the operation was performed successfully); false otherwise.

openWithTask

public boolean openWithTask()

Overrides:

openWithTask in class EOEditingController

prepareToSelect

public void prepareToSelect(boolean allowMultipleObjects,
                            boolean allowInsertingObject)

Specified by:

prepareToSelect in interface EOControllerFactory.Select

provideSelectedObjectGlobalID

public EOGlobalID provideSelectedObjectGlobalID()

Specified by:

provideSelectedObjectGlobalID in interface EOControllerFactory.Select

provideSelectedObjectsGlobalIDs

public NSArray provideSelectedObjectsGlobalIDs()

Specified by:

provideSelectedObjectsGlobalIDs in interface EOControllerFactory.Select

save

public boolean save()

Description copied from class: EODocumentController

Saves the receiver's editing context changes by invoking saveChanges, requesting an error dialog upon failure. Returns whether the save succeeded.

Specified by:

save in interface EODocument

Overrides:

save in class EODocumentController

Returns:

true if the save succeeded; false otherwise

See Also:

EODocumentController.saveChanges(boolean, String)