| java.lang.Object
 org.directwebremoting.proxy.io.Context
jsx3.lang.Object
jsx3.app.Cache
| Cache | | public class Cache extends jsx3.lang.Object (Code) | | Provides cached access to XML and XSL data.
Events
Cache instances publish two types of events for every operation that modifies the contents of the cache. The
schemas of the two event types are
subject - Cache.CHANGE
id or ids - the ID or array of IDs of the modified documents
action - Cache.ADD, Cache.CHANGE or Cache.REMOVE
and
subject - the cache ID of the modified document
action - Cache.ADD, Cache.CHANGE or Cache.REMOVE
Asynchronous Loading
Cache documents can be loaded asychronously with the getOrOpenAsync() method. This method returns
the corresponding document synchronously if it already exists in the cache. If the document does not exist in the
cache, then it is loaded asynchronously and the method returns a placeholder document. The namespace URI of this
placeholder document is Cache.XSDNS and its root node name is "loading".
Since the cache stores this placeholder document until the document finishes loading, subsequent calls to
synchronous APIs (getDocument(), getOrOpenDocument(), etc) may also return the
placeholder document. It is therefore important to check the namespace of the returned document when any code
uses the asynchronous APIs.
Once a document finishes loading asynchronously the placeholder document is replaced with the loaded document.
This change in value causes the cache to publish a pair of events of action Cache.CHANGE. If
loading the document fails or times out the placeholder document is instead replaced with another placeholder
document. This document also has a URI namespace of Cache.XSDNS. Its root node name may be either
"error" or "timeout". If the root node name is "error" then the root node
has an attribute, also named "error", which contains the XML error message.
author:
Joe Walker [joe at getahead dot org]
author:
DRAPGEN - Dwr Reverse Ajax Proxy GENerator |
| Field Summary | |
| final public static String | ADD
Event action. | | final public static int | ASYNC_TIMEOUT
The number of milliseconds before asynchronous document loads time out. | | final public static String | CHANGE
Event subject and action. | | final public static String | REMOVE
Event action. | | final public static String | XSDNS
|
| Method Summary | |
| public jsx3.xml.CdfDocument | clearById(String strId)
Removes the document stored in this cache under id strId. | | public T | clearById(String strId, Class<T> returnType)
Removes the document stored in this cache under id strId. | | public void | clearByTimestamp(java.util.Date intTimestamp, org.directwebremoting.proxy.Callback<Object[]> callback)
Removes all documents placed in this cache before intTimestamp. | | public void | clearByTimestamp(int intTimestamp, org.directwebremoting.proxy.Callback<Object[]> callback)
Removes all documents placed in this cache before intTimestamp. | | public void | destroy()
Removes all references to documents contained in this cache. | | public jsx3.xml.CdfDocument | getDocument(String strId)
Returns the document stored in this cache under id strId. | | public T | getDocument(String strId, Class<T> returnType)
Returns the document stored in this cache under id strId. | | public jsx3.xml.CdfDocument | getOrOpenAsync(String strURL, String strId, Class objClass)
Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public T | getOrOpenAsync(String strURL, String strId, Class objClass, Class<T> returnType)
Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public jsx3.xml.CdfDocument | getOrOpenAsync(java.net.URI strURL, String strId, Class objClass)
Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public T | getOrOpenAsync(java.net.URI strURL, String strId, Class objClass, Class<T> returnType)
Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public jsx3.xml.CdfDocument | getOrOpenDocument(String strURL, String strId, Class objClass)
Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. | | public T | getOrOpenDocument(String strURL, String strId, Class objClass, Class<T> returnType)
Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. | | public jsx3.xml.CdfDocument | getOrOpenDocument(java.net.URI strURL, String strId, Class objClass)
Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. | | public T | getOrOpenDocument(java.net.URI strURL, String strId, Class objClass, Class<T> returnType)
Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. | | public void | getTimestamp(String strId, org.directwebremoting.proxy.Callback<Integer> callback)
Returns the timestamp from when the document stored under id strId was stored in this cache. | | public void | keys(org.directwebremoting.proxy.Callback<Object[]> callback)
Returns a list of all the keys in this cache instance. | | public jsx3.xml.CdfDocument | openDocument(String strURL, String strId, Class objClass)
Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public T | openDocument(String strURL, String strId, Class objClass, Class<T> returnType)
Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public jsx3.xml.CdfDocument | openDocument(java.net.URI strURL, String strId, Class objClass)
Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public T | openDocument(java.net.URI strURL, String strId, Class objClass, Class<T> returnType)
Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. | | public void | publish(jsx3.lang.Object objEvent, org.directwebremoting.proxy.Callback<Integer> callback)
Publishes an event to all subscribed objects. | | public void | setDocument(String strId, jsx3.xml.CdfDocument objDocument)
Stores the document objDocument in this cache under id strId. | | public void | subscribe(String strEventId, jsx3.lang.Object objHandler, String objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(String strEventId, org.directwebremoting.proxy.CodeBlock objHandler, String objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(Object[] strEventId, jsx3.lang.Object objHandler, String objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(Object[] strEventId, String objHandler, String objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(Object[] strEventId, org.directwebremoting.proxy.CodeBlock objHandler, org.directwebremoting.proxy.CodeBlock objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(Object[] strEventId, org.directwebremoting.proxy.CodeBlock objHandler, String objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(String strEventId, org.directwebremoting.proxy.CodeBlock objHandler, org.directwebremoting.proxy.CodeBlock objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(String strEventId, String objHandler, org.directwebremoting.proxy.CodeBlock objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(Object[] strEventId, jsx3.lang.Object objHandler, org.directwebremoting.proxy.CodeBlock objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(String strEventId, jsx3.lang.Object objHandler, org.directwebremoting.proxy.CodeBlock objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(Object[] strEventId, String objHandler, org.directwebremoting.proxy.CodeBlock objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | subscribe(String strEventId, String objHandler, String objFunction)
Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. | | public void | unsubscribe(String strEventId, String objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribe(Object[] strEventId, jsx3.lang.Object objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribe(Object[] strEventId, String objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribe(Object[] strEventId, org.directwebremoting.proxy.CodeBlock objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribe(String strEventId, jsx3.lang.Object objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribe(String strEventId, org.directwebremoting.proxy.CodeBlock objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribeAll(String strEventId)
Unsubscribes all subscribed objects to a type of event published by this object. |
| ASYNC_TIMEOUT | | final public static int ASYNC_TIMEOUT(Code) | | The number of milliseconds before asynchronous document loads time out.
|
| CHANGE | | final public static String CHANGE(Code) | | Event subject and action.
|
| Cache | | public Cache(Context context, String extension, ScriptProxy scriptProxy)(Code) | | All reverse ajax proxies need context to work from
Parameters:
scriptProxy - The place we are writing scripts to
Parameters:
context - The script that got us to where we are now |
| Cache | | public Cache()(Code) | | Creates a new instance of this class.
|
| clearById | | public jsx3.xml.CdfDocument clearById(String strId)(Code) | | Removes the document stored in this cache under id strId.
Parameters:
strId - the remove document, if any. |
| clearById | | public T clearById(String strId, Class<T> returnType)(Code) | | Removes the document stored in this cache under id strId.
Parameters:
strId -
Parameters:
returnType - The expected return type the remove document, if any. |
| clearByTimestamp | | public void clearByTimestamp(java.util.Date intTimestamp, org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Removes all documents placed in this cache before intTimestamp.
Parameters:
intTimestamp - epoch seconds or a date object.
Parameters:
callback - the ids of the removed documents. |
| clearByTimestamp | | public void clearByTimestamp(int intTimestamp, org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Removes all documents placed in this cache before intTimestamp.
Parameters:
intTimestamp - epoch seconds or a date object.
Parameters:
callback - the ids of the removed documents. |
| destroy | | public void destroy()(Code) | | Removes all references to documents contained in this cache. This cache is no longer usable after calling this
method.
|
| getDocument | | public jsx3.xml.CdfDocument getDocument(String strId)(Code) | | Returns the document stored in this cache under id strId.
Parameters:
strId - the stored document or null if none exists. |
| getDocument | | public T getDocument(String strId, Class<T> returnType)(Code) | | Returns the document stored in this cache under id strId.
Parameters:
strId -
Parameters:
returnType - The expected return type the stored document or null if none exists. |
| getOrOpenAsync | | public jsx3.xml.CdfDocument getOrOpenAsync(String strURL, String strId, Class objClass)(Code) | | Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance. the document retrieved from the cache or a placeholder document if the documentis in the process of loading asynchronously. |
| getOrOpenAsync | | public T getOrOpenAsync(String strURL, String strId, Class objClass, Class<T> returnType)(Code) | | Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance.
Parameters:
returnType - The expected return type the document retrieved from the cache or a placeholder document if the documentis in the process of loading asynchronously. |
| getOrOpenAsync | | public jsx3.xml.CdfDocument getOrOpenAsync(java.net.URI strURL, String strId, Class objClass)(Code) | | Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance. the document retrieved from the cache or a placeholder document if the documentis in the process of loading asynchronously. |
| getOrOpenAsync | | public T getOrOpenAsync(java.net.URI strURL, String strId, Class objClass, Class<T> returnType)(Code) | | Asynchronously loads an xml document and stores it in this cache.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance.
Parameters:
returnType - The expected return type the document retrieved from the cache or a placeholder document if the documentis in the process of loading asynchronously. |
| getOrOpenDocument | | public jsx3.xml.CdfDocument getOrOpenDocument(String strURL, String strId, Class objClass)(Code) | | Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance if a new document is opened. the document retrieved from the cache or loaded. |
| getOrOpenDocument | | public T getOrOpenDocument(String strURL, String strId, Class objClass, Class<T> returnType)(Code) | | Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance if a new document is opened.
Parameters:
returnType - The expected return type the document retrieved from the cache or loaded. |
| getOrOpenDocument | | public jsx3.xml.CdfDocument getOrOpenDocument(java.net.URI strURL, String strId, Class objClass)(Code) | | Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance if a new document is opened. the document retrieved from the cache or loaded. |
| getOrOpenDocument | | public T getOrOpenDocument(java.net.URI strURL, String strId, Class objClass, Class<T> returnType)(Code) | | Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it.
Parameters:
strURL - the URI of the document.
Parameters:
strId - the id under which the document is/will be stored. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance if a new document is opened.
Parameters:
returnType - The expected return type the document retrieved from the cache or loaded. |
| getTimestamp | | public void getTimestamp(String strId, org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Returns the timestamp from when the document stored under id strId was stored in this cache.
Parameters:
strId - the id under which the document is stored.
Parameters:
callback - the timestamp as an integer (epoch seconds) or null if no such document existsin this cache. |
| openDocument | | public jsx3.xml.CdfDocument openDocument(String strURL, String strId, Class objClass)(Code) | | Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance. the loaded document object. |
| openDocument | | public T openDocument(String strURL, String strId, Class objClass, Class<T> returnType)(Code) | | Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance.
Parameters:
returnType - The expected return type the loaded document object. |
| openDocument | | public jsx3.xml.CdfDocument openDocument(java.net.URI strURL, String strId, Class objClass)(Code) | | Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance. the loaded document object. |
| openDocument | | public T openDocument(java.net.URI strURL, String strId, Class objClass, Class<T> returnType)(Code) | | Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
Parameters:
strURL - url (relative or absolute) the URI of the document to open.
Parameters:
strId - the id under which to store the document. If this parameter is not provided, thestrURL parameter is used as the id.
Parameters:
objClass - jsx3.xml.Document (default value) or one of its subclasses. Theclass with which to instantiate the new document instance.
Parameters:
returnType - The expected return type the loaded document object. |
| publish | | public void publish(jsx3.lang.Object objEvent, org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Publishes an event to all subscribed objects.
Parameters:
objEvent - the event, should have at least a field 'subject' that is the event id, another common field is 'target' (target will default to this instance)
Parameters:
callback - the number of listeners to which the event was broadcast |
| setDocument | | public void setDocument(String strId, jsx3.xml.CdfDocument objDocument)(Code) | | Stores the document objDocument in this cache under id strId. If a document already
exists in this cache under strId then that document is removed from the cache.
Parameters:
strId - the id under which to store objDocument.
Parameters:
objDocument - |
| subscribe | | public void subscribe(String strEventId, jsx3.lang.Object objHandler, String objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(String strEventId, org.directwebremoting.proxy.CodeBlock objHandler, String objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(Object[] strEventId, jsx3.lang.Object objHandler, String objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(Object[] strEventId, String objHandler, String objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(Object[] strEventId, org.directwebremoting.proxy.CodeBlock objHandler, org.directwebremoting.proxy.CodeBlock objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(Object[] strEventId, org.directwebremoting.proxy.CodeBlock objHandler, String objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(String strEventId, org.directwebremoting.proxy.CodeBlock objHandler, org.directwebremoting.proxy.CodeBlock objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(String strEventId, String objHandler, org.directwebremoting.proxy.CodeBlock objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(Object[] strEventId, jsx3.lang.Object objHandler, org.directwebremoting.proxy.CodeBlock objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(String strEventId, jsx3.lang.Object objHandler, org.directwebremoting.proxy.CodeBlock objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(Object[] strEventId, String objHandler, org.directwebremoting.proxy.CodeBlock objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| subscribe | | public void subscribe(String strEventId, String objHandler, String objFunction)(Code) | | Subscribes an object or function to a type of event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - if an object, the instance to notify of events (objFunction is required); if a string, the JSX id of the instance to notify of events (objFunction is required), must exist in the same Server; if a function, the function to call to notify of events (objFunction ignored)
Parameters:
objFunction - if objHandler is a string or object then the function to call on that instance. either a function or a string that is the name of a method of the instance |
| unsubscribe | | public void unsubscribe(String strEventId, String objHandler)(Code) | | Unsubscribe an object or function from an event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - the value of objHandler passed to subscribe |
| unsubscribe | | public void unsubscribe(Object[] strEventId, jsx3.lang.Object objHandler)(Code) | | Unsubscribe an object or function from an event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - the value of objHandler passed to subscribe |
| unsubscribe | | public void unsubscribe(Object[] strEventId, String objHandler)(Code) | | Unsubscribe an object or function from an event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - the value of objHandler passed to subscribe |
| unsubscribe | | public void unsubscribe(Object[] strEventId, org.directwebremoting.proxy.CodeBlock objHandler)(Code) | | Unsubscribe an object or function from an event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - the value of objHandler passed to subscribe |
| unsubscribe | | public void unsubscribe(String strEventId, jsx3.lang.Object objHandler)(Code) | | Unsubscribe an object or function from an event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - the value of objHandler passed to subscribe |
| unsubscribe | | public void unsubscribe(String strEventId, org.directwebremoting.proxy.CodeBlock objHandler)(Code) | | Unsubscribe an object or function from an event published by this object.
As of version 3.4 a string value for objHandler is deprecated.
Parameters:
strEventId - the event type(s).
Parameters:
objHandler - the value of objHandler passed to subscribe |
| unsubscribeAll | | public void unsubscribeAll(String strEventId)(Code) | | Unsubscribes all subscribed objects to a type of event published by this object.
Parameters:
strEventId - the event type |
| Methods inherited from jsx3.lang.Object | public void ignoreReturn()(Code)(Java Doc)
|
|
|