WebObjects 5.4.2

com.webobjects.eogeneration
Class EOEditingController

java.lang.Object
  extended by com.webobjects.eoapplication.EOController
      extended by com.webobjects.eoapplication.EOComponentController
          extended by com.webobjects.eoapplication.EOArchiveController
              extended by com.webobjects.eoapplication.EOEntityController
                  extended by com.webobjects.eoapplication.EODocumentController
                      extended by com.webobjects.eogeneration.EOEditingController
All Implemented Interfaces:
EOAction.Enabling, EOAssociationConnector, EOComponentController.EndEditing, EODocument, EOEditable, EOObjectDisplay, EOObjectDisplayDocument, EOObserving, NSDisposable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions
Direct Known Subclasses:
EOFormController, EOListController

public abstract class EOEditingController
extends EODocumentController


Nested Class Summary
 
Nested classes/interfaces inherited from class com.webobjects.eoapplication.EOComponentController
EOComponentController.ActionCollector, EOComponentController.Activation, EOComponentController.EndEditing, EOComponentController.Modal, EOComponentController.ResetUserInterface
 
Nested classes/interfaces inherited from class com.webobjects.eoapplication.EOController
EOController.Enumeration
 
Nested classes/interfaces inherited from interface 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.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
EOEditingController()
           
EOEditingController(EOXMLUnarchiver unarchiver)
           
 
Method Summary
 boolean canPerformActionNamed(String actionName)
          Overridden to handle editing-related action enabling and disabling.
protected  void connectionWasBroken()
          Reacts to the connection for the receiver being broken, taking care of association disconnecting.
protected  void connectionWasEstablished()
          Reacts to the connection for the receiver being established, taking care of editability issues in addition to the superclass implementation.
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 dispose()
          Prepares the receiver so it is disposed when Java performs garbage collection.
protected  boolean disposeIfTransient()
          Disposes the receiver if it's transient, first removing it from its supercontroller with removeTransientSubcontroller If the receiver's supercontroller is non-null, this method also attempts to dispose of the supercontroller if it's transient.
 String entityName()
          Returns the name of the entity of the enterprise objects displayed in the receiver's display group.
 boolean fetchesOnConnect()
          Returns whether the receiver should fetch its display group content next time its connection is established.
 boolean insert()
           
protected  NSArray mandatoryRelationshipPaths()
           
 EOMasterDetailAssociation masterDetailAssociation()
           
 EODisplayGroup newDisplayGroup()
          Creates a new display group using a data source provided by newDataSource.
 boolean openWithTask()
           
 String relationshipPath()
           
 void setEntityName(String string)
          Sets the entity name of the enterprise objects displayed by the receiver.
 void setMandatoryRelationshipPaths(NSArray relationshipPaths)
           
 void setMasterDetailAssociation(EOMasterDetailAssociation association)
           
 void setRelationshipPath(String string)
           
 String toString()
          Returns the receiver as a string describing the state of the controller.
 
Methods inherited from class com.webobjects.eoapplication.EODocumentController
canRedo, canRevert, canSave, canUndo, deleteSelectedObjects, editability, handleEditingContextNotification, insertObject, isDocumentForGlobalID, isEditable, isEdited, isRootDocumentController, prepareForNewTask, redo, revert, revertAndMakeInvisible, revertChanges, revertFailed, save, 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
 

Constructor Detail

EOEditingController

public EOEditingController()

EOEditingController

public EOEditingController(EOXMLUnarchiver unarchiver)
Method Detail

dispose

public void dispose()
Description copied from class: EODocumentController
Prepares the receiver so it is disposed when Java performs garbage collection.

Specified by:
dispose in interface NSDisposable
Overrides:
dispose in class EODocumentController

disposeIfTransient

protected boolean disposeIfTransient()
Description copied from class: EOController
Disposes the receiver if it's transient, first removing it from its supercontroller with removeTransientSubcontroller If the receiver's supercontroller is non-null, this method also attempts to dispose of the supercontroller if it's transient. Supercontrollers can prevent a controller from becoming transient, in which case this method returns false. Subclasses should first invoke the super implementation and only continue disposing if the super implementation returns true.

Overrides:
disposeIfTransient in class EOController
Returns:
true if the receiver can be transient and has been disposed; false otherwise
See Also:
EOController.removeTransientSubcontroller(EOController)

connectionWasEstablished

protected void connectionWasEstablished()
Description copied from class: EODocumentController
Reacts to the connection for the receiver being established, taking care of editability issues in addition to the superclass implementation.

Overrides:
connectionWasEstablished in class EODocumentController
See Also:
EOController.establishConnection()

connectionWasBroken

protected void connectionWasBroken()
Description copied from class: EOEntityController
Reacts to the connection for the receiver being broken, taking care of association disconnecting.

Overrides:
connectionWasBroken in class EOEntityController
See Also:
EOController.breakConnection()

fetchesOnConnect

public boolean fetchesOnConnect()
Description copied from class: EOEntityController
Returns whether the receiver should fetch its display group content next time its connection is established. This value changes often: Whenever an entity controller prepares for a new task, it sets this flag to true. Once it retrieves objects explicitly (for example from a global ID) or actually performs the fetch while connecting, it sets this flag to false.

Overrides:
fetchesOnConnect in class EOEntityController
Returns:
true if the controller should fetch its display group content next time its connection is established; false otherwise
See Also:
EOEntityController.setFetchesOnConnect(boolean)

setRelationshipPath

public void setRelationshipPath(String string)

relationshipPath

public String relationshipPath()

setMandatoryRelationshipPaths

public void setMandatoryRelationshipPaths(NSArray relationshipPaths)

mandatoryRelationshipPaths

protected NSArray mandatoryRelationshipPaths()

setEntityName

public void setEntityName(String string)
Description copied from class: EOEntityController
Sets the entity name of the enterprise objects displayed by the receiver.

Overrides:
setEntityName in class EOEntityController
Parameters:
string - the entity name of the enterprise objects displayed by the receiver

entityName

public String entityName()
Description copied from interface: EOObjectDisplay
Returns the name of the entity of the enterprise objects displayed in the receiver's display group.

Specified by:
entityName in interface EOObjectDisplay
Overrides:
entityName in class EOEntityController
Returns:
the name of the entity of the enterprise objects displayed

newDisplayGroup

public EODisplayGroup newDisplayGroup()
Description copied from class: EOEntityController
Creates a new display group using a data source provided by newDataSource. This method can be used as display group provider method.

Overrides:
newDisplayGroup in class EOEntityController
Returns:
the new display group
See Also:
EOEntityController.newDisplayGroupUsingOptimisticRefresh(), EOEntityController.setDisplayGroupProviderMethodName(String)

setMasterDetailAssociation

public void setMasterDetailAssociation(EOMasterDetailAssociation association)

masterDetailAssociation

public EOMasterDetailAssociation masterDetailAssociation()

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 EODocumentController
Returns:
an array of the receiver's default actions
See Also:
EOController.actions(), EOController.resetActions()

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 EODocumentController
Parameters:
actionName - the action method name
Returns:
true if the action should be enabled; false otherwise
See Also:
EOAction.Enabling

insert

public boolean insert()

delete

public boolean delete()

openWithTask

public boolean openWithTask()

toString

public String toString()
Returns the receiver as a string describing the state of the controller.

Overrides:
toString in class EODocumentController
Returns:
the String representation of the receiver

Last updated June 2008

Copyright © 2000-2008 Apple Inc.