er.modern.directtoweb.components

Class ERMDAjaxNotificationCenter

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.directtoweb.components.ERDCustomComponent

er.modern.directtoweb.components.ERMDAjaxNotificationCenter

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERXExceptionHolder, Serializable, Cloneable

public class ERMDAjaxNotificationCenter
extends ERDCustomComponent

ERMDAjaxNotificationCenter makes it easy to observe properties for changes and update dependent property keys. You just specify a dependency structure via the propertyDependencies D2W key. It takes a dictionary with property keys to be observed as keys and an array of the dependents to be updated as the value. Example:

 100 : ((task = 'create' or task = 'edit') and entity.name = 'Person') => propertyDependencies = {"isFemale" = ("salutation"); "dateOfBirth" = ("discount", "parentEmail"); } [com.webobjects.directtoweb.Assignment]
 

This will observe the property keys "isFemale" and "dateOfBirth". If "isFemale" changes, the "salutation" property will be updated. If "dateOfBirth" changes, the "discount" and "parentEmail" properties will be updated. You can then hide and show properties on the fly by using the displayVariant key:

 100 : ((task = 'create' or task = 'edit') and entity.name = 'Person' and propertyKey = 'parentEmail' and object.isAdult = '1') => displayVariant = "omit" [com.webobjects.directtoweb.Assignment]
 

By default, ERMDAjaxNotificationCenter will be included in the aboveDisplayPropertyKeys repetition when propertyDependencies is not null. If you set aboveDisplayPropertyKeys yourself, you have to include the "ajaxNotificationCenter" property key. Unlike the original version by Ramsey, this implementation depends on ERMDInspectPageRepetition to insert AjaxObserveField and AjaxUpdateContainer components where required.

See Also:

Serialized Form

Author:

rgurley@mac.com, fpeters

D2W Keys

Name	Description
ajaxNotificationCenter	ajaxNotificationCenter
propertyDependencies	propertyDependencies

Nested Class Summary

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

ERDCustomComponent.Keys

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

WOComponent._EventLoggingEnabler, WOComponent.Event

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._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

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

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
static ERXKey<String>	AJAX_NOTIFICATION_CENTER_ID
static ERXKey<NSDictionary<String,NSArray<String>>>	PROPERTY_DEPENDENCIES
static ERXKey<String>	PROPERTY_KEY
static ERXKey<String>	PROPERTY_OBSERVER_ID
static String	PropertyChangedNotification
static String	RegisterPropertyObserverIDNotification

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

Constructors

Constructor and Description
ERMDAjaxNotificationCenter(WOContext context)

Method Summary

Modifier and Type	Method and Description
Object	handleQueryWithUnboundKey(String key) Since this component uses synchronization to update observers when the d2wContext changes, it cannot be non-synchronizing.
void	handleTakeValueForUnboundKey(Object value, String key) Since this component uses synchronization to update observers when the d2wContext changes, it cannot be non-synchronizing.
String	id()
NSArray<String>	propertyChanged(com.webobjects.directtoweb.D2WContext context)
void	propertyChanged(NSNotification n)
NSDictionary<String,NSArray<String>>	propertyDependencies(com.webobjects.directtoweb.D2WContext context)
void	setD2wContext(com.webobjects.directtoweb.D2WContext context) Sets the D2WContext.
NSMutableArray<String>	updateContainerIDs()

Methods inherited from class er.directtoweb.components.ERDCustomComponent

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

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, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, shouldCheckAccess, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _childTemplate, _cleanUpStatelessComponent, _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, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Field Detail

AJAX_NOTIFICATION_CENTER_ID

public static final ERXKey<String> AJAX_NOTIFICATION_CENTER_ID

PROPERTY_OBSERVER_ID

public static final ERXKey<String> PROPERTY_OBSERVER_ID

PROPERTY_KEY

public static final ERXKey<String> PROPERTY_KEY

PROPERTY_DEPENDENCIES

public static final ERXKey<NSDictionary<String,NSArray<String>>> PROPERTY_DEPENDENCIES

PropertyChangedNotification

public static final String PropertyChangedNotification

See Also:

Constant Field Values

RegisterPropertyObserverIDNotification

public static final String RegisterPropertyObserverIDNotification

See Also:

Constant Field Values

Constructor Detail

ERMDAjaxNotificationCenter

public ERMDAjaxNotificationCenter(WOContext context)

Method Detail

id

public String id()

setD2wContext

public void setD2wContext(com.webobjects.directtoweb.D2WContext context)

Description copied from class: ERDCustomComponent

Sets the D2WContext. Applies when used inside a property key repetition.

Overrides:

setD2wContext in class ERDCustomComponent

updateContainerIDs

public NSMutableArray<String> updateContainerIDs()

propertyChanged

public void propertyChanged(NSNotification n)

propertyDependencies

public NSDictionary<String,NSArray<String>> propertyDependencies(com.webobjects.directtoweb.D2WContext context)

propertyChanged

public NSArray<String> propertyChanged(com.webobjects.directtoweb.D2WContext context)

Parameters:

context - The d2wContext of the changed property level component

Returns:

a list of property keys to be updated

handleQueryWithUnboundKey

public Object handleQueryWithUnboundKey(String key)

Since this component uses synchronization to update observers when the d2wContext changes, it cannot be non-synchronizing. However, if we want to be able to drop this component anywhere, it needs to be able to accept any binding value. So this method simply returns value for key from the dynamicBindings dictionary.

Specified by:

handleQueryWithUnboundKey in interface NSKeyValueCoding.ErrorHandling

Overrides:

handleQueryWithUnboundKey in class WOComponent

handleTakeValueForUnboundKey

public void handleTakeValueForUnboundKey(Object value,
                                         String key)

Since this component uses synchronization to update observers when the d2wContext changes, it cannot be non-synchronizing. However, if we want to be able to drop this component anywhere, it needs to be able to accept any binding value. So this method simply adds value for key to the dynamicBindings dictionary.

Specified by:

handleTakeValueForUnboundKey in interface NSKeyValueCoding.ErrorHandling

Overrides:

handleTakeValueForUnboundKey in class WOComponent