er.ajax
Class AjaxPingUpdate

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.ajax.AjaxPingUpdate

All Implemented Interfaces:

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

public class AjaxPingUpdate
extends com.webobjects.appserver.WOComponent

AjaxPingUpdate is primarily for use inside of an AjaxPing tag to support ping-updating multiple containers from a single AjaxPing request. Just like AjaxPing, you provide a cache key that upon changing, triggers the update of another target AjaxUpdateContainer.

See Also:

Serialized Form

Author:

mschrag

Bindings

targetContainerID	the ID of the update container to refresh when a change is detected
cacheKey	some hash value that represents the state of the target container
onBeforeUpdate	(optional) the javascript function to call before updating (should return true if the update should happen, false if not)

Nested Class Summary

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

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

AjaxPingUpdate(com.webobjects.appserver.WOContext context)

Method Summary

boolean	refreshTarget() Returns whether or not the target should be refreshed.
void	sleep()
boolean	synchronizesVariablesWithBindings()
java.lang.String	targetContainerID() Returns the target container ID.

Methods inherited from class com.webobjects.appserver.WOComponent

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxPingUpdate

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

Method Detail

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class com.webobjects.appserver.WOComponent

refreshTarget

public boolean refreshTarget()

Returns whether or not the target should be refreshed.

Returns:

whether or not the target should be refreshed

sleep

public void sleep()

Overrides:

sleep in class com.webobjects.appserver.WOComponent

targetContainerID

public java.lang.String targetContainerID()

Returns the target container ID.

Returns:

the target container ID