er.directtoweb.components.relationships
Class ERDList

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.components.ERXComponent
              er.extensions.components.ERXNonSynchronizingComponent
                  er.directtoweb.components.ERDCustomComponent
                      er.directtoweb.components.ERDCustomEditComponent
                          er.directtoweb.components.relationships.ERDList

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, ERXExceptionHolder, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ERDEditableList

public class ERDList
extends ERDCustomEditComponent

Used to edit a toMany relationship by allowing the user to pick the eos that belong in the relationship.

See Also:

Serialized Form

Bindings

object	object
key	key
emptyListMessage	emptyListMessage
listPageConfiguration	listPageConfiguration
list	list

D2W Keys

createButtonComponentName	createButtonComponentName
useNestedEditingContext	useNestedEditingContext

Nested Class Summary

static interface	ERDList.CreateObjectDelegate Interface that all createObjectDelegate classes should implement
class	ERDList.DefaultCreateObjectDelegate Default creation delegate class.

Nested classes/interfaces inherited from class er.directtoweb.components.ERDCustomEditComponent

ERDCustomEditComponent.Keys

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

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

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

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

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

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

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

protected com.webobjects.foundation.NSArray

list

Fields inherited from class er.directtoweb.components.ERDCustomEditComponent

editingContext

Fields inherited from class er.directtoweb.components.ERDCustomComponent

extraBindings, FALSE, TRUE

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

ERDList(com.webobjects.appserver.WOContext context)

Method Summary

com.webobjects.appserver.WOComponent	createObjectAction()
ERDList.CreateObjectDelegate	createObjectDelegate()
java.lang.String	emptyListMessage()
boolean	erD2WListOmitCenterTag()
java.lang.Boolean	hasCreationDelegate()
com.webobjects.foundation.NSArray	list()
com.webobjects.eocontrol.EOEnterpriseObject	masterObjectKeyPathForCreationDelegate()
java.lang.String	relationshipName()
void	reset() Used by stateless subclasses.
com.webobjects.foundation.NSDictionary	settings()
boolean	synchronizesVariablesWithBindings() Overridden from superclass to turn on component synching, which is the default.
java.lang.Boolean	useCreationDelegate()
java.lang.Object	valueForBinding(java.lang.String key) Fetches an object from the bindings.
java.lang.Object	valueForKey(java.lang.String key)

Methods inherited from class er.directtoweb.components.ERDCustomEditComponent

defaultSortOrderingsForDestinationEntity, destinationEntity, isStateless, object, objectKeyPathValue, objectPropertyValue, permissionToEdit, resetCachedBindingsInStatefulComponent, setObject, setObjectKeyPathValue, setObjectPropertyValue

Methods inherited from class er.directtoweb.components.ERDCustomComponent

appendToResponse, booleanForBinding, clearValidationFailed, d2wComponentNameDebuggingEnabled, d2wContext, d2wContextFromBindings, d2wContextValueForBinding, d2wDebuggingEnabled, d2wPage, d2wPropertyKeyDebuggingEnabled, extraBindings, extraBindingsValueForBinding, hasBinding, integerBooleanForBinding, key, localContext, logDebugInfo, originalValueForBinding, parentValueForBinding, setD2wContext, setExtraBindings, setKey, setLocalContext, task, taskIsEdit, taskIsInspect, taskIsList, validationFailedWithException

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

_associationWithName, _childTemplate, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Field Detail

list

protected com.webobjects.foundation.NSArray list

Constructor Detail

ERDList

public ERDList(com.webobjects.appserver.WOContext context)

Method Detail

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Description copied from class: ERDCustomComponent

Overridden from superclass to turn on component synching, which is the default.

Overrides:

synchronizesVariablesWithBindings in class ERDCustomEditComponent

reset

public void reset()

Description copied from class: ERDCustomComponent

Used by stateless subclasses.

Overrides:

reset in class ERDCustomEditComponent

settings

public com.webobjects.foundation.NSDictionary settings()

createObjectAction

public com.webobjects.appserver.WOComponent createObjectAction()

list

public com.webobjects.foundation.NSArray list()

erD2WListOmitCenterTag

public boolean erD2WListOmitCenterTag()

valueForKey

public java.lang.Object valueForKey(java.lang.String key)

Specified by:

valueForKey in interface com.webobjects.foundation.NSKeyValueCoding

Overrides:

valueForKey in class com.webobjects.appserver.WOComponent

valueForBinding

public java.lang.Object valueForBinding(java.lang.String key)

Description copied from class: ERDCustomComponent

Fetches an object from the bindings. Tries the actual supplied bindings, the supplied d2wContext, the parent and finally the extra bindings dictionary.

Overrides:

valueForBinding in class ERDCustomComponent

emptyListMessage

public java.lang.String emptyListMessage()

createObjectDelegate

public ERDList.CreateObjectDelegate createObjectDelegate()

Returns:

ERDList.CreateObjectDelegate instance from the rule file/bindings. this is responsible for creating the object and displaying the appropriate page.

Note: if this is binding is present, then the usual method of figuring out what to create from destinationEntityName and object binding doesn't happen.

hasCreationDelegate

public java.lang.Boolean hasCreationDelegate()

Returns:

true, if createObjectDelegate resolved to a valid object. false, otherwise

useCreationDelegate

public java.lang.Boolean useCreationDelegate()

Returns:

Boolean if true, createObjectAction method will use delegate (either the one that is provided or the default one.

masterObjectKeyPathForCreationDelegate

public com.webobjects.eocontrol.EOEnterpriseObject masterObjectKeyPathForCreationDelegate()

Returns:

the keyPath to be used to compute the master object used by ERDList.CreateObjectDelegate. whatever this keypath resolves to will be used to attach the newly created object.

relationshipName

public java.lang.String relationshipName()

Returns:

String relationshipName to connect masterObj and the newly created object. this will be used to add the newly createdObjects to both sides of relationship.