AjaxPingUpdate Class Reference

Inherits com::webobjects::appserver::WOComponent.

Collaboration diagram for AjaxPingUpdate:

[legend]

List of all members.

Public Member Functions
	AjaxPingUpdate (WOContext context)
boolean	refreshTarget ()
void	sleep ()
boolean	synchronizesVariablesWithBindings ()
String	targetContainerID ()
Private Attributes
Object	_lastCacheKey = NOT_INITIALIZED
Boolean	_refreshTarget
Static Private Attributes
static final Object	NOT_INITIALIZED = new Object()

---

Detailed Description

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.

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)

Author:

mschrag

---

Constructor & Destructor Documentation

AjaxPingUpdate

(

WOContext

context

)

---

Member Function Documentation

boolean refreshTarget

(

)

Returns whether or not the target should be refreshed.

Returns:

whether or not the target should be refreshed

void sleep

(

)

boolean synchronizesVariablesWithBindings

(

)

String targetContainerID

(

)

Returns the target container ID.

Returns:

the target container ID

---

Member Data Documentation

Object _lastCacheKey = NOT_INITIALIZED [private]

Boolean _refreshTarget [private]

final Object NOT_INITIALIZED = new Object() [static, private]

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxPingUpdate.java