AjaxPing Class Reference
Inherits com::webobjects::appserver::WOComponent.
Public Member Functions | |
| AjaxPing (WOContext context) | |
| Object | frequency () |
| String | id () |
| boolean | synchronizesVariablesWithBindings () |
Private Attributes | |
| String | _id |
Detailed Description
AjaxPing provides support for refreshing a large content area based on a series of periodic refreshes of a very small area. You provide a cache key that upon changing, triggers the update of another target AjaxUpdateContainer.For instance, if you have a list of blog entries, you might refresh the blog entries container with a cache key "blogEntries.count". When the count of the blog entries changes, the entire container will be refreshed.
frequency the frequency of refresh (in millis), defaults to 3000 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) id (optional) the id of the ping update container (set this if you want to attach an AjaxBusyIndicator) stop (optional) if true, the ping will stop. If false, the ping will run. It's up to you to refresh the ping's container to get it running again after the binding changes from false to true.
Constructor & Destructor Documentation
| AjaxPing | ( | WOContext | context | ) |
Member Function Documentation
| Object frequency | ( | ) |
Returns the frequency of refresh in millis.
- Returns:
- the frequency of refresh in millis
| String id | ( | ) |
Returns the ID of the ping container.
- Returns:
- the ID of the ping container
| boolean synchronizesVariablesWithBindings | ( | ) |
Member Data Documentation
The documentation for this class was generated from the following file:
- /opt/source/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxPing.java
