com.webobjects.eogeneration.client.assistant
Class EOAssistant

java.lang.Object
  |
  +--com.webobjects.eoapplication.EOController
        |
        +--com.webobjects.eoapplication.EOComponentController
              |
              +--com.webobjects.eogeneration.client.assistant.EOAssistant

All Implemented Interfaces:

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

public class EOAssistant

extends EOComponentController

Inner Class Summary

static interface

EOAssistant.Editor

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

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

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

EOController.Enumeration

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

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

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

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Field Summary

static String	ControllerTypeKey
static String	EnumerationEntityNamesKey
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, SubcontrollersEnumeration, SupercontrollersEnumeration

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Constructor Summary

EOAssistant()

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) Conformance to EOAction.Enabling.
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

addComponentOfSubcontroller, alignmentWidth, alignsComponents, canBeTransient, canResizeHorizontally, canResizeVertically, component, componentDidBecomeInvisible, componentDidBecomeVisible, defaultComponentSize, ensureMinimumComponentSizeWithoutSubcontrollers, ensureMinimumSubcontrollerAreaSize, generateComponent, handleTakeValueForUnboundKey, hideInSupercontroller, hideSubcontroller, icon, integrationComponent, integrationComponentDidBecomeInvisible, integrationComponentDidBecomeVisible, isComponentPrepared, isRootComponentController, isVisible, label, makeInvisible, makeVisible, minimumComponentSize, minimumComponentSizeWithoutSubcontrollers, minimumIntegrationComponentSize, minimumSubcontrollerAreaSize, prefersIconOnly, prepareComponent, removeComponentOfSubcontroller, removeTransientSubcontroller, setAlignmentWidth, setAlignsComponents, setCanResizeHorizontally, setCanResizeVertically, setComponent, setDefaultComponentSize, setIcon, setLabel, setPrefersIconOnly, setSubcontrollerArea, setUsesHorizontalLayout, setVisible, showInSupercontroller, showSubcontroller, subcontrollerArea, subcontrollerMinimumSizeDidChange, subcontrollerWasAdded, subcontrollerWasRemoved, usesHorizontalLayout

Methods inherited from class com.webobjects.eoapplication.EOController

actionNames, actions, actionWithName, 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, 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

ControllerTypeKey

public static final String ControllerTypeKey

EnumerationEntityNamesKey

public static final String EnumerationEntityNamesKey

KeysKey

public static final String KeysKey

MainEntityNamesKey

public static final String MainEntityNamesKey

PropertyKeyKey

public static final String PropertyKeyKey

WidgetControllerKey

public static final String WidgetControllerKey

Constructor Detail

EOAssistant

public EOAssistant()

Method Detail

activeWindowDidChange

public void activeWindowDidChange(NSNotification notification)

addEditor

public void addEditor(EOAssistant.Editor editor)

addRule

protected void addRule(EOAssistantRule rule)

allEntityNames

public NSArray allEntityNames()

allPrimitivePropertyKeyTaskNames

public NSArray allPrimitivePropertyKeyTaskNames()

allPropertyKeyTaskNames

public NSArray allPropertyKeyTaskNames()

allQuestionNames

public NSArray allQuestionNames()

allValuesForKey

public NSArray allValuesForKey(String key)

allValuesForValueKey

public NSArray allValuesForValueKey(String key)

apply

public boolean apply()

canPerformActionNamed

public boolean canPerformActionNamed(String actionName)

Description copied from class: EOController

Conformance to EOAction.Enabling. See the method description of canPerformActionNamed in the interface specification for EOAction.Enabling.

Overrides:

canPerformActionNamed in class EOController

Following copied from class: com.webobjects.eoapplication.EOController

Parameters:

actionName - the action method name

Returns:

true if the action should be enabled; false otherwise

See Also:

EOAction.Enabling

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

Following copied from class: com.webobjects.eoapplication.EOController

Returns:

an array of the receiver's default actions

See Also:

EOController.actions(), EOController.resetActions()

defaultValue

public Object defaultValue(String key,
                           NSDictionary specification)

dispose

public void dispose()

Description copied from class: EOComponentController

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

Overrides:

dispose in class EOComponentController

editorSpecificationValueForKey

public String editorSpecificationValueForKey(String key)

editors

public NSArray editors()

hasRuleValueOtherThanDefault

public boolean hasRuleValueOtherThanDefault(String key,
                                            NSDictionary specification)

removeRule

protected void removeRule(EOAssistantRule rule)

resetRuleValueToDefault

public void resetRuleValueToDefault(String key,
                                    NSDictionary specification)

restart

public void restart()

revert

public void revert()

ruleValue

public Object ruleValue(String key,
                        NSDictionary specification)

ruleValue

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

rules

public NSArray rules()

save

public boolean save()

setEditorSpecificationValueForKey

public void setEditorSpecificationValueForKey(String value,
                                              String key)

setRuleValue

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

sharedAssistant

public static EOAssistant sharedAssistant()

startAssistant

public static void startAssistant(NSArray assistantEditorClassNames)

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

Following copied from class: com.webobjects.eoapplication.EOComponentController

Returns:

the String representation of the receiver