com.webobjects.eogeneration.assistant
Class EOAssistant

java.lang.Object
  com.webobjects.eoapplication.EOController
      com.webobjects.eoapplication.EOComponentController
          com.webobjects.eogeneration.assistant.EOAssistant

All Implemented Interfaces:

EOAction.Enabling, NSDisposable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions

public class EOAssistant
extends EOComponentController

Nested Class Summary

static interface

EOAssistant.Editor

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

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Field Summary

static String	ControllerTypeKey
static String	EnumerationEntityNamesKey
static String	IsRootControllerKey
static String	KeysKey
static String	MainEntityNamesKey
static String	PropertyKeyKey
static String	WidgetControllerKey

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.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Method Summary

void	activeWindowDidChange(NSNotification notification)
void	addEditor(EOAssistant.Editor editor)
protected void	addRule(EOAssistantRule rule)
NSArray	allEntityNames()
NSArray	allPrimitivePropertyKeyTaskNames()
NSArray	allPropertyKeyTaskNames()
NSArray	allQuestionNames()
NSArray	allValuesForKey(String key)
NSArray	allValuesForValueKey(String key)
boolean	apply()
boolean	canPerformActionNamed(String actionName) Returns true if the receiver can perform the action method (sent by an EOAction object) named actionName, false otherwise.
protected NSArray	defaultActions() Returns an array of the receiver's default actions (EOAction objects).
Object	defaultValue(String key, NSDictionary specification)
void	dispose() Prepares the receiver so it is disposed when Java performs garbage collection.
NSArray	editors()
String	editorSpecificationValueForKey(String key)
boolean	hasRuleValueOtherThanDefault(String key, NSDictionary specification)
protected void	removeRule(EOAssistantRule rule)
void	resetRuleValueToDefault(String key, NSDictionary specification)
void	restart()
void	revert()
NSArray	rules()
Object	ruleValue(String key, NSDictionary specification)
Object	ruleValue(String key, NSDictionary specification, NSDictionary alternateSpecification)
boolean	save()
void	setEditorSpecificationValueForKey(String value, String key)
void	setRuleValue(String key, NSDictionary specification, Object value)
static EOAssistant	sharedAssistant()
static void	startAssistant(NSArray assistantEditorClassNames)
String	toString() Returns the receiver as a string that states the receiver's class name and type name, whether the receiver is connected, the number of subcontrollers, whether or not the receiver has been prepared, whether or not the receiver is visible, information about widget sizing and alignment behavior, and so on.

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, prepareComponent, 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, connectionWasBroken, connectionWasEstablished, controllerEnumeration, controllersInEnumeration, controllersWithKeyValuePair, controllersWithKeyValuePairs, controllerWithKeyValuePair, controllerWithKeyValuePairs, disableActionNamed, disposableRegistry, disposeIfTransient, enableActionNamed, enabledActions, establishConnection, establishConnectionToSupercontrollers, handleQueryWithUnboundKey, hierarchicalControllerForKey, hierarchicalValueForKey, invokeMethod, isActionNamedEnabled, isAncestorOfController, isConnected, isSupercontrollerOfController, isTransientExplicitlyForbidden, prepareForNewTask, 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

Field Detail

MainEntityNamesKey

public static final String MainEntityNamesKey

See Also:

Constant Field Values

EnumerationEntityNamesKey

public static final String EnumerationEntityNamesKey

See Also:

Constant Field Values

KeysKey

public static final String KeysKey

See Also:

Constant Field Values

PropertyKeyKey

public static final String PropertyKeyKey

See Also:

Constant Field Values

ControllerTypeKey

public static final String ControllerTypeKey

See Also:

Constant Field Values

WidgetControllerKey

public static final String WidgetControllerKey

See Also:

Constant Field Values

IsRootControllerKey

public static final String IsRootControllerKey

See Also:

Constant Field Values

Method Detail

startAssistant

public static void startAssistant(NSArray assistantEditorClassNames)

sharedAssistant

public static EOAssistant sharedAssistant()

dispose

public void dispose()

Description copied from class: EOComponentController

Prepares the receiver so it is disposed when Java performs garbage collection.

Specified by:

dispose in interface NSDisposable

Overrides:

dispose in class EOComponentController

addEditor

public void addEditor(EOAssistant.Editor editor)

editors

public NSArray editors()

setEditorSpecificationValueForKey

public void setEditorSpecificationValueForKey(String value,
                                              String key)

editorSpecificationValueForKey

public String editorSpecificationValueForKey(String key)

defaultActions

protected NSArray defaultActions()

Description copied from class: EOController

Returns an array of the receiver's default actions (EOAction objects). A subclass of EOController should override this method to return the actions it defines merged with the actions of its superclass. Never invoke this method directly. Instead, invoke actions, which caches the results of defaultActions and is therefore more efficient.

Overrides:

defaultActions in class EOController

Returns:

an array of the receiver's default actions

See Also:

EOController.actions(), EOController.resetActions()

canPerformActionNamed

public boolean canPerformActionNamed(String actionName)

Description copied from interface: EOAction.Enabling

Returns true if the receiver can perform the action method (sent by an EOAction object) named actionName, false otherwise. An EOController's implementation of this method generally returns false if the receiver doesn't have an action named actionName or if the actionName action is explicitly disabled.

Specified by:

canPerformActionNamed in interface EOAction.Enabling

Overrides:

canPerformActionNamed in class EOController

Parameters:

actionName - the name of the EOAction

Returns:

true if the receiver can perform the action; false otherwise

apply

public boolean apply()

save

public boolean save()

revert

public void revert()

restart

public void restart()

rules

public NSArray rules()

addRule

protected void addRule(EOAssistantRule rule)

removeRule

protected void removeRule(EOAssistantRule rule)

defaultValue

public Object defaultValue(String key,
                           NSDictionary specification)

hasRuleValueOtherThanDefault

public boolean hasRuleValueOtherThanDefault(String key,
                                            NSDictionary specification)

ruleValue

public Object ruleValue(String key,
                        NSDictionary specification)

ruleValue

public Object ruleValue(String key,
                        NSDictionary specification,
                        NSDictionary alternateSpecification)

setRuleValue

public void setRuleValue(String key,
                         NSDictionary specification,
                         Object value)

resetRuleValueToDefault

public void resetRuleValueToDefault(String key,
                                    NSDictionary specification)

allQuestionNames

public NSArray allQuestionNames()

allEntityNames

public NSArray allEntityNames()

allPropertyKeyTaskNames

public NSArray allPropertyKeyTaskNames()

allPrimitivePropertyKeyTaskNames

public NSArray allPrimitivePropertyKeyTaskNames()

allValuesForValueKey

public NSArray allValuesForValueKey(String key)

allValuesForKey

public NSArray allValuesForKey(String key)

activeWindowDidChange

public void activeWindowDidChange(NSNotification notification)

toString

public String toString()

Description copied from class: EOComponentController

Returns the receiver as a string that states the receiver's class name and type name, whether the receiver is connected, the number of subcontrollers, whether or not the receiver has been prepared, whether or not the receiver is visible, information about widget sizing and alignment behavior, and so on.

Overrides:

toString in class EOComponentController

Returns:

the String representation of the receiver