| java.lang.Object
 org.directwebremoting.proxy.io.Context
jsx3.lang.Object
jsx3.app.Model
All known Subclasses: jsx3.gui.Painted, jsx3.gui.Window,
| Model | | public class Model extends jsx3.lang.Object (Code) | | The abstract base class that defines the JSX DOM. Instances of this class exist as nodes in a tree, each with
a single parent and multiple children. This class includes all the methods for querying and manipulating the DOM's
tree structure, such as getChild(), adoptChild(), getParent(), etc.
author:
Joe Walker [joe at getahead dot org]
author:
DRAPGEN - Dwr Reverse Ajax Proxy GENerator |
| Field Summary | |
| final public static int | ASYNC_LOAD_TIMEOUT
The number of milliseconds before asynchronous component loads time out. | | final public static String | CIF_VERSION
| | final public static String | CURRENT_VERSION
| | final public static int | LT_NORMAL
The normal load type for a DOM branch. | | final public static int | LT_SHOW_DESER
Load type indicating that the DOM branch will deserialize and paint as needed when it becomes visible. | | final public static int | LT_SHOW_PAINT
Load type indicating that the DOM branch will paint as needed when it becomes visible. | | final public static int | LT_SLEEP_DESER
Load type indicating that the DOM branch will deserialize and paint after its parent deserializes and the
call stack resets. | | final public static int | LT_SLEEP_PAINT
Load type indicating that the DOM branch will paint after its parent paints and the call stack resets. | | final public static int | LT_SLEEP_PD
Load type indicating that the DOM branch will deserialize after its parent deserializes and the call stack
resets and will paint after its parent paints and the call stack resets. | | final public static int | PERSISTEMBED
Normal persistance value for a child that will be persisted. | | final public static int | PERSISTNONE
Persistance value fora child that is temporarily part of the DOM tree and will not be persisted. | | final public static int | PERSISTREF
Persistance value for a child that exists in an external serialization file and is referenced by URI. | | final public static int | PERSISTREFASYNC
Persistance value for a child that exists in an external serialization file and is referenced by URI. |
| Method Summary | |
| public void | adoptChild(jsx3.app.Model objChild, boolean bRepaint, boolean bForce)
Appends a DOM node to this object after removing the node from its former parent reference. | | public jsx3.app.Model | doClone(int intPersist, int intMode)
Creates and returns an exact replica of the object. | | public T | doClone(int intPersist, int intMode, Class<T> returnType)
Creates and returns an exact replica of the object. | | public jsx3.app.Model | findAncestor(org.directwebremoting.proxy.CodeBlock fctTest, boolean bIncludeSelf)
Returns the first ancestor passing the given test function. | | public T | findAncestor(org.directwebremoting.proxy.CodeBlock fctTest, boolean bIncludeSelf, Class<T> returnType)
Returns the first ancestor passing the given test function. | | public jsx3.app.Model | findDescendants(org.directwebremoting.proxy.CodeBlock fctTest, boolean bDepthFirst, boolean bMultiple, boolean bShallow, boolean bIncludeSelf)
Finds all DOM nodes descending from this DOM node that pass the given test function. | | public T | findDescendants(org.directwebremoting.proxy.CodeBlock fctTest, boolean bDepthFirst, boolean bMultiple, boolean bShallow, boolean bIncludeSelf, Class<T> returnType)
Finds all DOM nodes descending from this DOM node that pass the given test function. | | public jsx3.app.Model | getAncestorOfName(String strName)
Returns the first ancestor with the given name.
Parameters:
strName - the name to query on. | | public T | getAncestorOfName(String strName, Class<T> returnType)
Returns the first ancestor with the given name. | | public jsx3.app.Model | getAncestorOfType(String strType)
Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance. | | public T | getAncestorOfType(String strType, Class<T> returnType)
Returns the first ancestor of the given type. | | public jsx3.app.Model | getAncestorOfType(Class strType)
Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance. | | public T | getAncestorOfType(Class strType, Class<T> returnType)
Returns the first ancestor of the given type. | | public jsx3.app.Model | getAncestorOfType(org.directwebremoting.proxy.CodeBlock strType)
Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance. | | public T | getAncestorOfType(org.directwebremoting.proxy.CodeBlock strType, Class<T> returnType)
Returns the first ancestor of the given type. | | public jsx3.app.Model | getChild(int vntIndexOrName)
Returns the child DOM node of this node at the given index or with the given name. | | public T | getChild(int vntIndexOrName, Class<T> returnType)
Returns the child DOM node of this node at the given index or with the given name. | | public jsx3.app.Model | getChild(String vntIndexOrName)
Returns the child DOM node of this node at the given index or with the given name. | | public T | getChild(String vntIndexOrName, Class<T> returnType)
Returns the child DOM node of this node at the given index or with the given name. | | public void | getChildIndex(org.directwebremoting.proxy.Callback<Integer> callback)
Returns the zero-based index for this DOM node in relation to its siblings. | | public void | getChildren(org.directwebremoting.proxy.Callback<Object[]> callback)
Returns an array containing all the child DOM nodes of this object. | | public jsx3.app.Model | getDescendantOfName(String strName, boolean bDepthFirst, boolean bChildOnly)
Finds the first descendant of this DOM node with a the given name.
Parameters:
strName - the name to query on.
Parameters:
bDepthFirst - specifies whether to do a depth first or breadth first search.
Parameters:
bChildOnly - if true, only search the children of this DOM node. | | public T | getDescendantOfName(String strName, boolean bDepthFirst, boolean bChildOnly, Class<T> returnType)
Finds the first descendant of this DOM node with a the given name. | | public void | getDescendantsOfType(org.directwebremoting.proxy.CodeBlock strType, boolean bShallow, org.directwebremoting.proxy.Callback<Object[]> callback)
Finds all descendants of the given type. | | public void | getDescendantsOfType(String strType, boolean bShallow, org.directwebremoting.proxy.Callback<Object[]> callback)
Finds all descendants of the given type. | | public void | getDescendantsOfType(Class strType, boolean bShallow, org.directwebremoting.proxy.Callback<Object[]> callback)
Finds all descendants of the given type. | | public jsx3.app.Model | getFirstChild()
Returns the first child. | | public T | getFirstChild(Class<T> returnType)
Returns the first child. | | public jsx3.app.Model | getFirstChildOfType(org.directwebremoting.proxy.CodeBlock strType, boolean bExact)
Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too). | | public T | getFirstChildOfType(org.directwebremoting.proxy.CodeBlock strType, boolean bExact, Class<T> returnType)
Finds the first child of the given type. | | public jsx3.app.Model | getFirstChildOfType(Class strType, boolean bExact)
Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too). | | public T | getFirstChildOfType(Class strType, boolean bExact, Class<T> returnType)
Finds the first child of the given type. | | public jsx3.app.Model | getFirstChildOfType(String strType, boolean bExact)
Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too). | | public T | getFirstChildOfType(String strType, boolean bExact, Class<T> returnType)
Finds the first child of the given type. | | public void | getHelpId(org.directwebremoting.proxy.Callback<String> callback)
Returns the help ID of this object. | | public void | getId(org.directwebremoting.proxy.Callback<String> callback)
Returns the custom JSX-generated id for the object (i.e., _jsx2384098324509823049). | | public jsx3.app.Model | getLastChild()
Returns the last child. | | public T | getLastChild(Class<T> returnType)
Returns the last child. | | public void | getLoadType(org.directwebremoting.proxy.Callback<Integer> callback)
Returns the load type of this DOM node and the descending branch. | | public void | getMetaValue(String strKey, org.directwebremoting.proxy.Callback<String> callback)
Returns one of the meta data values stored at the top of the serialization file that this object was loaded from. | | public void | getNS(org.directwebremoting.proxy.Callback<String> callback)
Returns the namespace that distinguishes this object's server (owner) from other server instances. | | public void | getName(org.directwebremoting.proxy.Callback<String> callback)
Returns the custom developer-defined name of this object. | | public jsx3.app.Model | getNextSibling()
Returns the next sibling. | | public T | getNextSibling(Class<T> returnType)
Returns the next sibling. | | public jsx3.app.Model | getParent()
Returns the parent DOM node of this object. | | public T | getParent(Class<T> returnType)
Returns the parent DOM node of this object. | | public void | getPersistence(org.directwebremoting.proxy.Callback<Integer> callback)
Returns the persistence bit for this model object. | | public jsx3.app.Model | getPreviousSibling()
Returns the previous sibling. | | public T | getPreviousSibling(Class<T> returnType)
Returns the previous sibling. | | public jsx3.app.Server | getServer()
Returns an object reference to the server that owns this object. | | public jsx3.net.URIResolver | getUriResolver()
Returns the URI resolver for this DOM node. | | public T | getUriResolver(Class<T> returnType)
Returns the URI resolver for this DOM node. | | public void | insertBefore(jsx3.app.Model objMoveChild, jsx3.app.Model objPrecedeChild, boolean bRepaint, org.directwebremoting.proxy.Callback<Boolean> callback)
Assigns objMoveChild as the previousSibling of objPrecedeChild
Parameters:
objMoveChild - the one being moved. | | public jsx3.app.Model | load(java.net.URI strURL, boolean bRepaint, jsx3.net.URIResolver objResolver)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. | | public T | load(java.net.URI strURL, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. | | public jsx3.app.Model | load(String strURL, boolean bRepaint, jsx3.net.URIResolver objResolver)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. | | public T | load(String strURL, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. | | public void | loadAndCache(java.net.URI strURL, boolean bRepaint, jsx3.app.Cache objCache, jsx3.net.URIResolver objResolver)
Loads a component file and caches the document in an XML cache. | | public void | loadAndCache(String strURL, boolean bRepaint, jsx3.app.Cache objCache, jsx3.net.URIResolver objResolver)
Loads a component file and caches the document in an XML cache. | | public jsx3.app.Model | loadXML(jsx3.xml.CdfDocument strXML, boolean bRepaint, jsx3.net.URIResolver objResolver)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - the deserialized object. | | public T | loadXML(jsx3.xml.CdfDocument strXML, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver -
Parameters:
returnType - The expected return type the deserialized object. | | public jsx3.app.Model | loadXML(String strXML, boolean bRepaint, jsx3.net.URIResolver objResolver)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - the deserialized object. | | public T | loadXML(String strXML, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)
Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver -
Parameters:
returnType - The expected return type the deserialized object. | | public void | onAfterAssemble(jsx3.app.Model objParent, jsx3.app.Server objServer)
Called during deserialization of this object. | | public void | onAfterAttach()
Called during deserialization of this object. | | public void | onBeforeAssemble(jsx3.app.Model objParent, jsx3.app.Server objServer)
Called during deserialization of this object. | | public void | onChangeServer(jsx3.app.Server objNewServer, jsx3.app.Server objOldServer)
Called when the server owning this DOM node changes. | | public void | onDestroy(jsx3.app.Model objParent)
The finalizer method. | | public void | onRemoveChild(Object[] objChild, int intIndex)
Hook that notifies this model object that one of its children has been removed. | | public void | onRemoveChild(jsx3.app.Model objChild, int intIndex)
Hook that notifies this model object that one of its children has been removed. | | public void | onSetChild(java.lang.Object objChild, org.directwebremoting.proxy.Callback<Boolean> callback)
Hook that allows for a prospective parent DOM node to veto the adoption of a child. | | public void | onSetParent(java.lang.Object objParent, org.directwebremoting.proxy.Callback<Boolean> callback)
Hook that allows for a prospective child DOM node to veto its adoption by a parent. | | public void | publish(jsx3.lang.Object objEvent, org.directwebremoting.proxy.Callback<Integer> callback)
Publishes an event to all subscribed objects. | | public jsx3.app.Model | removeChild(jsx3.app.Model vntItem)
Removes a DOM child from this object. | | public T | removeChild(jsx3.app.Model vntItem, Class<T> returnType)
Removes a DOM child from this object. | | public jsx3.app.Model | removeChild(int vntItem)
Removes a DOM child from this object. | | public T | removeChild(int vntItem, Class<T> returnType)
Removes a DOM child from this object. | | public jsx3.app.Model | removeChildren(Object[] arrChildren)
Removes some or all children of this object.
Parameters:
arrChildren - the children to remove. | | public T | removeChildren(Object[] arrChildren, Class<T> returnType)
Removes some or all children of this object.
Parameters:
arrChildren - the children to remove. | | public jsx3.app.Model | setChild(jsx3.app.Model objChild, int intPersist, java.net.URI strSourceURL, String strNS)
Appends a child DOM node to this parent DOM node. | | public jsx3.app.Model | setChild(jsx3.app.Model objChild, int intPersist, String strSourceURL, String strNS)
Appends a child DOM node to this parent DOM node. | | public void | setHelpId(String strId)
Sets the help ID of this object. | | public void | setLoadType(int intLoadType)
Sets the load type of this DOM node and the descending branch. | | public void | setMetaValue(String strKey, String strValue)
setS one of the meta data values stored at the top of a component's serialization file. | | public void | setName(String strName)
Sets the custom developer-defined name of this object. | | public jsx3.app.Model | setPersistence(int intPersist)
Sets the persistence bit for this model object.
Parameters:
intPersist - one of PERSISTNONE, PERSISTEMBED, PERSISTREF,PERSISTREFASYNC. | | 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(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(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, 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, 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, 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, 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, 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, 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, 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, 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, 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 | toXML(jsx3.lang.Object objProperties, org.directwebremoting.proxy.Callback<String> callback)
Returns this object serialized as XML by calling toString() on the result of toXMLDoc()
called on this object.
Parameters:
objProperties - name-value pairs that affect the serialization. | | public jsx3.xml.CdfDocument | toXMLDoc(jsx3.lang.Object objProperties)
Serializes this object as an XML document.
The objProperties parameter may include the following keys:
onafter {String} - the value of the onAfterDeserialize element
onbefore {String} - the value of the onBeforeDeserialize element
name {String} - the value of the name element
icon {String} - the value of the icon element
description {String} - the value of the description element
children {boolean} - if true the children of this object, rather than this object, are
serialized
persistall {boolean} - if true all descendants with persistence PERSISTNONE are included in the
serialization
Parameters:
objProperties - name-value pairs that affect the serialization. | | public T | toXMLDoc(jsx3.lang.Object objProperties, Class<T> returnType)
Serializes this object as an XML document.
The objProperties parameter may include the following keys:
onafter {String} - the value of the onAfterDeserialize element
onbefore {String} - the value of the onBeforeDeserialize element
name {String} - the value of the name element
icon {String} - the value of the icon element
description {String} - the value of the description element
children {boolean} - if true the children of this object, rather than this object, are
serialized
persistall {boolean} - if true all descendants with persistence PERSISTNONE are included in the
serialization
Parameters:
objProperties - name-value pairs that affect the serialization. | | 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(Object[] strEventId, String objHandler)
Unsubscribe an object or function from an event published by this object. | | public void | unsubscribe(String strEventId, String 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(Object[] 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_LOAD_TIMEOUT | | final public static int ASYNC_LOAD_TIMEOUT(Code) | | The number of milliseconds before asynchronous component loads time out.
|
| CIF_VERSION | | final public static String CIF_VERSION(Code) | | Minimum supported version CIF formatted serialization files
|
| CURRENT_VERSION | | final public static String CURRENT_VERSION(Code) | | Minimum supported version for serialization files
|
| LT_NORMAL | | final public static int LT_NORMAL(Code) | | The normal load type for a DOM branch. The DOM branch deserializes and paints with its parent.
|
| LT_SHOW_DESER | | final public static int LT_SHOW_DESER(Code) | | Load type indicating that the DOM branch will deserialize and paint as needed when it becomes visible.
It is left to subclasses of Model to implement this functionality.
|
| LT_SHOW_PAINT | | final public static int LT_SHOW_PAINT(Code) | | Load type indicating that the DOM branch will paint as needed when it becomes visible. It is left to
subclasses of Model to implement this functionality.
|
| LT_SLEEP_DESER | | final public static int LT_SLEEP_DESER(Code) | | Load type indicating that the DOM branch will deserialize and paint after its parent deserializes and the
call stack resets.
|
| LT_SLEEP_PAINT | | final public static int LT_SLEEP_PAINT(Code) | | Load type indicating that the DOM branch will paint after its parent paints and the call stack resets.
|
| LT_SLEEP_PD | | final public static int LT_SLEEP_PD(Code) | | Load type indicating that the DOM branch will deserialize after its parent deserializes and the call stack
resets and will paint after its parent paints and the call stack resets.
|
| PERSISTEMBED | | final public static int PERSISTEMBED(Code) | | Normal persistance value for a child that will be persisted.
|
| PERSISTNONE | | final public static int PERSISTNONE(Code) | | Persistance value fora child that is temporarily part of the DOM tree and will not be persisted.
|
| PERSISTREF | | final public static int PERSISTREF(Code) | | Persistance value for a child that exists in an external serialization file and is referenced by URI.
|
| PERSISTREFASYNC | | final public static int PERSISTREFASYNC(Code) | | Persistance value for a child that exists in an external serialization file and is referenced by URI. The
loading of a child with this persistence value will happen asynchronously after the file that references it is
loaded.
|
| Model | | public Model(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 |
| Model | | public Model(String strName, String strInstanceOf)(Code) | | The instance initializer.
Parameters:
strName - a unique name distinguishing this object from all other JSX GUI objects in the JSX application
Parameters:
strInstanceOf - |
| adoptChild | | public void adoptChild(jsx3.app.Model objChild, boolean bRepaint, boolean bForce)(Code) | | Appends a DOM node to this object after removing the node from its former parent reference. If the node to append
does not already have a DOM parent, setChild() should be used instead of this method.
Parameters:
objChild - the child to adopt
Parameters:
bRepaint - if true or null, the object being adopted will be added tothe parent's view via the parent's paintChild() method.This parameter is made available for those situations where a loop is executing and multipleobjects are being adopted. As view operations are the most CPU intensive, passing falsewhile looping through a collection of child objects to adopt will improve performance. After thelast child is adopted, simply call repaint() on the parent to immediately synchronize the view.
Parameters:
bForce - if true, the adoption is forced, even if the parent/child don't accept such adoptions (onSetChild() and onSetParent() will still be called) |
| doClone | | public jsx3.app.Model doClone(int intPersist, int intMode)(Code) | | Creates and returns an exact replica of the object. The clone will be appended as a new child node of this
object's parent node.
Parameters:
intPersist - the persistance value of the clone.
Parameters:
intMode - 0 for insert as the last child of the parent of this object and paint,1 for insert as the last child of this parent of this object and do not paint, or 2for load as a fragment. the clone. |
| doClone | | public T doClone(int intPersist, int intMode, Class<T> returnType)(Code) | | Creates and returns an exact replica of the object. The clone will be appended as a new child node of this
object's parent node.
Parameters:
intPersist - the persistance value of the clone.
Parameters:
intMode - 0 for insert as the last child of the parent of this object and paint,1 for insert as the last child of this parent of this object and do not paint, or 2for load as a fragment.
Parameters:
returnType - The expected return type the clone. |
| findAncestor | | public jsx3.app.Model findAncestor(org.directwebremoting.proxy.CodeBlock fctTest, boolean bIncludeSelf)(Code) | | Returns the first ancestor passing the given test function.
Parameters:
fctTest - test function, takes a single jsx3.app.Model parameter and returnstrue if the node matches.
Parameters:
bIncludeSelf - if true, include this object in the search |
| findAncestor | | public T findAncestor(org.directwebremoting.proxy.CodeBlock fctTest, boolean bIncludeSelf, Class<T> returnType)(Code) | | Returns the first ancestor passing the given test function.
Parameters:
fctTest - test function, takes a single jsx3.app.Model parameter and returnstrue if the node matches.
Parameters:
bIncludeSelf - if true, include this object in the search
Parameters:
returnType - The expected return type |
| findDescendants | | public jsx3.app.Model findDescendants(org.directwebremoting.proxy.CodeBlock fctTest, boolean bDepthFirst, boolean bMultiple, boolean bShallow, boolean bIncludeSelf)(Code) | | Finds all DOM nodes descending from this DOM node that pass the given test function. Results are guaranteed to be
returned in order according to the search order used.
Parameters:
fctTest - test function, takes a single jsx3.app.Model parameter and returnstrue if the node matches.
Parameters:
bDepthFirst - specifies whether to do a depth first or breadth first search.
Parameters:
bMultiple - if true, return an array of matches, otherwise just the first match.
Parameters:
bShallow - if true, only search direct children.
Parameters:
bIncludeSelf - if true, include this node in the search. the match (bMultiple = false) or matches (bMultiple = true). |
| findDescendants | | public T findDescendants(org.directwebremoting.proxy.CodeBlock fctTest, boolean bDepthFirst, boolean bMultiple, boolean bShallow, boolean bIncludeSelf, Class<T> returnType)(Code) | | Finds all DOM nodes descending from this DOM node that pass the given test function. Results are guaranteed to be
returned in order according to the search order used.
Parameters:
fctTest - test function, takes a single jsx3.app.Model parameter and returnstrue if the node matches.
Parameters:
bDepthFirst - specifies whether to do a depth first or breadth first search.
Parameters:
bMultiple - if true, return an array of matches, otherwise just the first match.
Parameters:
bShallow - if true, only search direct children.
Parameters:
bIncludeSelf - if true, include this node in the search.
Parameters:
returnType - The expected return type the match (bMultiple = false) or matches (bMultiple = true). |
| getAncestorOfName | | public jsx3.app.Model getAncestorOfName(String strName)(Code) | | Returns the first ancestor with the given name.
Parameters:
strName - the name to query on. the first ancestor with the given name or null if none found. |
| getAncestorOfName | | public T getAncestorOfName(String strName, Class<T> returnType)(Code) | | Returns the first ancestor with the given name.
Parameters:
strName - the name to query on.
Parameters:
returnType - The expected return type the first ancestor with the given name or null if none found. |
| getAncestorOfType | | public jsx3.app.Model getAncestorOfType(String strType)(Code) | | Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance. the first ancestor of the given type or null if none found. |
| getAncestorOfType | | public T getAncestorOfType(String strType, Class<T> returnType)(Code) | | Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
returnType - The expected return type the first ancestor of the given type or null if none found. |
| getAncestorOfType | | public jsx3.app.Model getAncestorOfType(Class strType)(Code) | | Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance. the first ancestor of the given type or null if none found. |
| getAncestorOfType | | public T getAncestorOfType(Class strType, Class<T> returnType)(Code) | | Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
returnType - The expected return type the first ancestor of the given type or null if none found. |
| getAncestorOfType | | public jsx3.app.Model getAncestorOfType(org.directwebremoting.proxy.CodeBlock strType)(Code) | | Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance. the first ancestor of the given type or null if none found. |
| getAncestorOfType | | public T getAncestorOfType(org.directwebremoting.proxy.CodeBlock strType, Class<T> returnType)(Code) | | Returns the first ancestor of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
returnType - The expected return type the first ancestor of the given type or null if none found. |
| getChild | | public jsx3.app.Model getChild(int vntIndexOrName)(Code) | | Returns the child DOM node of this node at the given index or with the given name. If a name is supplied, the
children are searched in order and the first matching child is returned.
Parameters:
vntIndexOrName - either the integer index or the string name of the child. the child at the given index or with the given name, or null if no suchchild exists. |
| getChild | | public T getChild(int vntIndexOrName, Class<T> returnType)(Code) | | Returns the child DOM node of this node at the given index or with the given name. If a name is supplied, the
children are searched in order and the first matching child is returned.
Parameters:
vntIndexOrName - either the integer index or the string name of the child.
Parameters:
returnType - The expected return type the child at the given index or with the given name, or null if no suchchild exists. |
| getChild | | public jsx3.app.Model getChild(String vntIndexOrName)(Code) | | Returns the child DOM node of this node at the given index or with the given name. If a name is supplied, the
children are searched in order and the first matching child is returned.
Parameters:
vntIndexOrName - either the integer index or the string name of the child. the child at the given index or with the given name, or null if no suchchild exists. |
| getChild | | public T getChild(String vntIndexOrName, Class<T> returnType)(Code) | | Returns the child DOM node of this node at the given index or with the given name. If a name is supplied, the
children are searched in order and the first matching child is returned.
Parameters:
vntIndexOrName - either the integer index or the string name of the child.
Parameters:
returnType - The expected return type the child at the given index or with the given name, or null if no suchchild exists. |
| getChildIndex | | public void getChildIndex(org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Returns the zero-based index for this DOM node in relation to its siblings.
Parameters:
callback - the index or -1 if this object does not have a parent. |
| getChildren | | public void getChildren(org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Returns an array containing all the child DOM nodes of this object. The return value is the original array rather
than a copy and should not be modified.
|
| getDescendantOfName | | public jsx3.app.Model getDescendantOfName(String strName, boolean bDepthFirst, boolean bChildOnly)(Code) | | Finds the first descendant of this DOM node with a the given name.
Parameters:
strName - the name to query on.
Parameters:
bDepthFirst - specifies whether to do a depth first or breadth first search.
Parameters:
bChildOnly - if true, only search the children of this DOM node. the descendant with the given name or null if none found. |
| getDescendantOfName | | public T getDescendantOfName(String strName, boolean bDepthFirst, boolean bChildOnly, Class<T> returnType)(Code) | | Finds the first descendant of this DOM node with a the given name.
Parameters:
strName - the name to query on.
Parameters:
bDepthFirst - specifies whether to do a depth first or breadth first search.
Parameters:
bChildOnly - if true, only search the children of this DOM node.
Parameters:
returnType - The expected return type the descendant with the given name or null if none found. |
| getDescendantsOfType | | public void getDescendantsOfType(org.directwebremoting.proxy.CodeBlock strType, boolean bShallow, org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Finds all descendants of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bShallow - if true, only search direct children, not all descendants.
Parameters:
callback - an array of matching descendants |
| getDescendantsOfType | | public void getDescendantsOfType(String strType, boolean bShallow, org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Finds all descendants of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bShallow - if true, only search direct children, not all descendants.
Parameters:
callback - an array of matching descendants |
| getDescendantsOfType | | public void getDescendantsOfType(Class strType, boolean bShallow, org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Finds all descendants of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bShallow - if true, only search direct children, not all descendants.
Parameters:
callback - an array of matching descendants |
| getFirstChild | | public T getFirstChild(Class<T> returnType)(Code) | | Returns the first child.
Parameters:
returnType - The expected return type |
| getFirstChildOfType | | public jsx3.app.Model getFirstChildOfType(org.directwebremoting.proxy.CodeBlock strType, boolean bExact)(Code) | | Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too). the child of the given type or null if none found. |
| getFirstChildOfType | | public T getFirstChildOfType(org.directwebremoting.proxy.CodeBlock strType, boolean bExact, Class<T> returnType)(Code) | | Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too).
Parameters:
returnType - The expected return type the child of the given type or null if none found. |
| getFirstChildOfType | | public jsx3.app.Model getFirstChildOfType(Class strType, boolean bExact)(Code) | | Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too). the child of the given type or null if none found. |
| getFirstChildOfType | | public T getFirstChildOfType(Class strType, boolean bExact, Class<T> returnType)(Code) | | Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too).
Parameters:
returnType - The expected return type the child of the given type or null if none found. |
| getFirstChildOfType | | public jsx3.app.Model getFirstChildOfType(String strType, boolean bExact)(Code) | | Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too). the child of the given type or null if none found. |
| getFirstChildOfType | | public T getFirstChildOfType(String strType, boolean bExact, Class<T> returnType)(Code) | | Finds the first child of the given type.
Parameters:
strType - the fully-qualified class name, class constructor function,or jsx3.Class instance.
Parameters:
bExact - if true then only return objects whose class is exactly strType(rather than returning subclasses too).
Parameters:
returnType - The expected return type the child of the given type or null if none found. |
| getLastChild | | public T getLastChild(Class<T> returnType)(Code) | | Returns the last child.
Parameters:
returnType - The expected return type |
| getLoadType | | public void getLoadType(org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Returns the load type of this DOM node and the descending branch. The load type determines how this DOM branch
deserializes and paints in relation to its parent DOM node.
Parameters:
callback - LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER,LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER. |
| getMetaValue | | public void getMetaValue(String strKey, org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns one of the meta data values stored at the top of the serialization file that this object was loaded from.
Parameters:
strKey - the name of the meta data field, one of the keys in META_FIELDS.
Parameters:
callback - the meta data value or empty string. |
| getNS | | public void getNS(org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the namespace that distinguishes this object's server (owner) from other server instances. The namespace
is set when this object is bound to a DOM tree.
Parameters:
callback - the namespace of the server that owns this object instance. |
| getNextSibling | | public T getNextSibling(Class<T> returnType)(Code) | | Returns the next sibling.
Parameters:
returnType - The expected return type |
| getParent | | public T getParent(Class<T> returnType)(Code) | | Returns the parent DOM node of this object.
Parameters:
returnType - The expected return type |
| getPreviousSibling | | public T getPreviousSibling(Class<T> returnType)(Code) | | Returns the previous sibling.
Parameters:
returnType - The expected return type |
| getServer | | public jsx3.app.Server getServer()(Code) | | Returns an object reference to the server that owns this object. This method returns null if this
object is part of a DOM fragment. Until an object is added to a DOM tree by passing it as the parameter to
setChild(), the object will be a DOM fragment.
|
| getUriResolver | | public jsx3.net.URIResolver getUriResolver()(Code) | | Returns the URI resolver for this DOM node. This method returns the server of this object unless this node
or its ancestor was loaded into the DOM with an explicit URI resolver.
|
| getUriResolver | | public T getUriResolver(Class<T> returnType)(Code) | | Returns the URI resolver for this DOM node. This method returns the server of this object unless this node
or its ancestor was loaded into the DOM with an explicit URI resolver.
Parameters:
returnType - The expected return type |
| insertBefore | | public void insertBefore(jsx3.app.Model objMoveChild, jsx3.app.Model objPrecedeChild, boolean bRepaint, org.directwebremoting.proxy.Callback<Boolean> callback)(Code) | | Assigns objMoveChild as the previousSibling of objPrecedeChild
Parameters:
objMoveChild - the one being moved. Can belong to this object, another object, or can be a GUI fragment
Parameters:
objPrecedeChild - the one to insert before
Parameters:
bRepaint - if false the repaint will be suppressed (useful for multiple obejct updatesthat would lead to unnecessary updates to the VIEW)
Parameters:
callback - true if successful |
| load | | public jsx3.app.Model load(java.net.URI strURL, boolean bRepaint, jsx3.net.URIResolver objResolver)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants. the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| load | | public T load(java.net.URI strURL, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.
Parameters:
returnType - The expected return type the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| load | | public jsx3.app.Model load(String strURL, boolean bRepaint, jsx3.net.URIResolver objResolver)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants. the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| load | | public T load(String strURL, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.
Parameters:
returnType - The expected return type the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| loadAndCache | | public void loadAndCache(java.net.URI strURL, boolean bRepaint, jsx3.app.Cache objCache, jsx3.net.URIResolver objResolver)(Code) | | Loads a component file and caches the document in an XML cache. If the component file already exists in the cache
then it is loaded from the cache. All component files loaded as a result of this call (referenced files) are also
cached. This method is a useful replacement for load() when the same URL will be loaded multiple
times in one application.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objCache - the cache to store the component XML documents in. If not provided, the cacheof the server of this model object is used.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants. |
| loadAndCache | | public void loadAndCache(String strURL, boolean bRepaint, jsx3.app.Cache objCache, jsx3.net.URIResolver objResolver)(Code) | | Loads a component file and caches the document in an XML cache. If the component file already exists in the cache
then it is loaded from the cache. All component files loaded as a result of this call (referenced files) are also
cached. This method is a useful replacement for load() when the same URL will be loaded multiple
times in one application.
Parameters:
strURL - URL (either relative or absolute) of the serialization file to deserialize.This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objCache - the cache to store the component XML documents in. If not provided, the cacheof the server of this model object is used.
Parameters:
objResolver - If this parameter is provided, strURL is resolvedrelative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants. |
| loadXML | | public jsx3.app.Model loadXML(jsx3.xml.CdfDocument strXML, boolean bRepaint, jsx3.net.URIResolver objResolver)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| loadXML | | public T loadXML(jsx3.xml.CdfDocument strXML, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver -
Parameters:
returnType - The expected return type the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| loadXML | | public jsx3.app.Model loadXML(String strXML, boolean bRepaint, jsx3.net.URIResolver objResolver)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver - the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| loadXML | | public T loadXML(String strXML, boolean bRepaint, jsx3.net.URIResolver objResolver, Class<T> returnType)(Code) | | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
Parameters:
strXML - the XML content of a JSX serialization file.
Parameters:
bRepaint - if true or null the deserialized objects will beadded to the parent's view via the parent object's paintChild() method.
Parameters:
objResolver -
Parameters:
returnType - The expected return type the deserialized object. A serialization file may specify more than one rootobject, in which case this method returns the first deserialized object. |
| onAfterAssemble | | public void onAfterAssemble(jsx3.app.Model objParent, jsx3.app.Server objServer)(Code) | | Called during deserialization of this object. This method provides a hook for initializing
an object during deserialization since init() is not called. Called after this object has been instantiated and
after its fields and children have been assembled.This method is called before this object is attached to the
DOM, therefore getParent(), getServer(), getXML(), etc. return null.
Parameters:
objParent - the parent of this object once it is attached to the DOM.
Parameters:
objServer - the server that this DOM object will attach to. |
| onAfterAttach | | public void onAfterAttach()(Code) | | Called during deserialization of this object. This method provides a hook for initializing
an object during deserialization since init() is not called. Called after this object has been
instantiated and after it has been attached to the DOM. Methods overriding this method should usually finish
with a call to jsxsuper().
When a new branch is attached to the DOM, this method is executed on each node in the branch. The order is
reverse-breadth-first meaning that child nodes are notified from oldest to youngest and before the parent node.
This implementation of this method executes the on-after-deserialize script of this object.
|
| onBeforeAssemble | | public void onBeforeAssemble(jsx3.app.Model objParent, jsx3.app.Server objServer)(Code) | | Called during deserialization of this object. This method provides a hook for initializing
an object during deserialization since init() is not called. Called after this object has been instantiated but
before its fields and children have been assembled. This method is called before this object is attached to the
DOM, therefore getParent(), getServer(), getXML(), etc. return null.
Parameters:
objParent - the parent of this object once it is attached to the DOM.
Parameters:
objServer - the server that this DOM object will attach to. |
| onChangeServer | | public void onChangeServer(jsx3.app.Server objNewServer, jsx3.app.Server objOldServer)(Code) | | Called when the server owning this DOM node changes.
Parameters:
objNewServer -
Parameters:
objOldServer - |
| onDestroy | | public void onDestroy(jsx3.app.Model objParent)(Code) | | The finalizer method. This method provides a hook for subclasses of this class to perform custom logic
when an instance of this class is removed from the DOM. Methods that override this method should begin with
a call to jsxsuper().
Note that this method is called after this object has been removed from the DOM tree. Therefore
this.getParent() and this.getServer() will return null. Use the
objParent parameter for access to the DOM tree.
Parameters:
objParent - reference to the former parent |
| onRemoveChild | | public void onRemoveChild(Object[] objChild, int intIndex)(Code) | | Hook that notifies this model object that one of its children has been removed. This hook exists simply to allow
this object to perform cleanup/re-render, and does not provide a veto mechanism. This method is called after
the child has been removed from the model (this.getChildren() does not contain objChild)
and after the child has been removed from the view (objChild.getRendered() is also null).
This method is only called if the child is being removed from the DOM but this object (the parent) is not
being removed. Therefore, this hook cannot be relied upon for garbage collection.
If removeChildren() is called on this object, this hook is called exactly once after all children
have been removed. In that case, the first parameter to this method will be the array of children and the
second parameter will be null.
In general a method overriding this method should begin by calling jsxsuper.
Parameters:
objChild - the child that was removed
Parameters:
intIndex - the index of the removed child |
| onRemoveChild | | public void onRemoveChild(jsx3.app.Model objChild, int intIndex)(Code) | | Hook that notifies this model object that one of its children has been removed. This hook exists simply to allow
this object to perform cleanup/re-render, and does not provide a veto mechanism. This method is called after
the child has been removed from the model (this.getChildren() does not contain objChild)
and after the child has been removed from the view (objChild.getRendered() is also null).
This method is only called if the child is being removed from the DOM but this object (the parent) is not
being removed. Therefore, this hook cannot be relied upon for garbage collection.
If removeChildren() is called on this object, this hook is called exactly once after all children
have been removed. In that case, the first parameter to this method will be the array of children and the
second parameter will be null.
In general a method overriding this method should begin by calling jsxsuper.
Parameters:
objChild - the child that was removed
Parameters:
intIndex - the index of the removed child |
| onSetParent | | public void onSetParent(java.lang.Object objParent, org.directwebremoting.proxy.Callback<Boolean> callback)(Code) | | Hook that allows for a prospective child DOM node to veto its adoption by a parent. This method is only called if
the prospective parent has not already vetoed the adoption in the onSetChild() method.
Parameters:
objParent -
Parameters:
callback - true to allow the set, false to veto |
| 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 |
| removeChild | | public jsx3.app.Model removeChild(jsx3.app.Model vntItem)(Code) | | Removes a DOM child from this object. This method removes the on-screen DHTML of the removed object. The removed
child will be completely derefenced from the DOM and will be prepped for garbage collection. If a DOM child must
continue to exist after removing it from this parent, adoptChild() should be used instead of this
method.
Parameters:
vntItem - either the index of the child to remove or the child itself. this object |
| removeChild | | public T removeChild(jsx3.app.Model vntItem, Class<T> returnType)(Code) | | Removes a DOM child from this object. This method removes the on-screen DHTML of the removed object. The removed
child will be completely derefenced from the DOM and will be prepped for garbage collection. If a DOM child must
continue to exist after removing it from this parent, adoptChild() should be used instead of this
method.
Parameters:
vntItem - either the index of the child to remove or the child itself.
Parameters:
returnType - The expected return type this object |
| removeChild | | public jsx3.app.Model removeChild(int vntItem)(Code) | | Removes a DOM child from this object. This method removes the on-screen DHTML of the removed object. The removed
child will be completely derefenced from the DOM and will be prepped for garbage collection. If a DOM child must
continue to exist after removing it from this parent, adoptChild() should be used instead of this
method.
Parameters:
vntItem - either the index of the child to remove or the child itself. this object |
| removeChild | | public T removeChild(int vntItem, Class<T> returnType)(Code) | | Removes a DOM child from this object. This method removes the on-screen DHTML of the removed object. The removed
child will be completely derefenced from the DOM and will be prepped for garbage collection. If a DOM child must
continue to exist after removing it from this parent, adoptChild() should be used instead of this
method.
Parameters:
vntItem - either the index of the child to remove or the child itself.
Parameters:
returnType - The expected return type this object |
| removeChildren | | public jsx3.app.Model removeChildren(Object[] arrChildren)(Code) | | Removes some or all children of this object.
Parameters:
arrChildren - the children to remove. If this parameter is not provided then allchildren are removed. this object. |
| removeChildren | | public T removeChildren(Object[] arrChildren, Class<T> returnType)(Code) | | Removes some or all children of this object.
Parameters:
arrChildren - the children to remove. If this parameter is not provided then allchildren are removed.
Parameters:
returnType - The expected return type this object. |
| setChild | | public jsx3.app.Model setChild(jsx3.app.Model objChild, int intPersist, java.net.URI strSourceURL, String strNS)(Code) | | Appends a child DOM node to this parent DOM node. If the child already has a parent, adoptChild()
should be used instead to ensure that the child is removed from its current parent.
Parameters:
objChild - the root node of a DOM fragment.
Parameters:
intPersist - defines how the child will be persisted/serialized. The valid values are the fourpersistence values defined as static fields in this class.
Parameters:
strSourceURL - the path to the serialization file where the child exists. This parameter is onlyrelevant if the given intPersist is PERSISTREF or PERSISTREFASYNC.
Parameters:
strNS - the namespace of the child to append. This parameter is normally not required but is usefulwhen sharing DOM nodes between servers with different namespaces. this object or false if the set was vetoed |
| setChild | | public jsx3.app.Model setChild(jsx3.app.Model objChild, int intPersist, String strSourceURL, String strNS)(Code) | | Appends a child DOM node to this parent DOM node. If the child already has a parent, adoptChild()
should be used instead to ensure that the child is removed from its current parent.
Parameters:
objChild - the root node of a DOM fragment.
Parameters:
intPersist - defines how the child will be persisted/serialized. The valid values are the fourpersistence values defined as static fields in this class.
Parameters:
strSourceURL - the path to the serialization file where the child exists. This parameter is onlyrelevant if the given intPersist is PERSISTREF or PERSISTREFASYNC.
Parameters:
strNS - the namespace of the child to append. This parameter is normally not required but is usefulwhen sharing DOM nodes between servers with different namespaces. this object or false if the set was vetoed |
| setHelpId | | public void setHelpId(String strId)(Code) | | Sets the help ID of this object.
Parameters:
strId - |
| setLoadType | | public void setLoadType(int intLoadType)(Code) | | Sets the load type of this DOM node and the descending branch.
Parameters:
intLoadType - LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER,LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER. |
| setMetaValue | | public void setMetaValue(String strKey, String strValue)(Code) | | setS one of the meta data values stored at the top of a component's serialization file.
Parameters:
strKey - the name of the meta data field, one of the keys in META_FIELDS
Parameters:
strValue - the new value of the meta data field. |
| setName | | public void setName(String strName)(Code) | | Sets the custom developer-defined name of this object.
Parameters:
strName - a name unique among all DOM nodes currently loaded in the application. |
| setPersistence | | public jsx3.app.Model setPersistence(int intPersist)(Code) | | Sets the persistence bit for this model object.
Parameters:
intPersist - one of PERSISTNONE, PERSISTEMBED, PERSISTREF,PERSISTREFASYNC. this object |
| 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(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(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, 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, 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, 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, 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, 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, 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, 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, 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, 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 |
| toXML | | public void toXML(jsx3.lang.Object objProperties, org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns this object serialized as XML by calling toString() on the result of toXMLDoc()
called on this object.
Parameters:
objProperties - name-value pairs that affect the serialization. SeetoXMLDoc() for a description.
Parameters:
callback - this object serialized as an XML string. |
| toXMLDoc | | public jsx3.xml.CdfDocument toXMLDoc(jsx3.lang.Object objProperties)(Code) | | Serializes this object as an XML document.
The objProperties parameter may include the following keys:
onafter {String} - the value of the onAfterDeserialize element
onbefore {String} - the value of the onBeforeDeserialize element
name {String} - the value of the name element
icon {String} - the value of the icon element
description {String} - the value of the description element
children {boolean} - if true the children of this object, rather than this object, are
serialized
persistall {boolean} - if true all descendants with persistence PERSISTNONE are included in the
serialization
Parameters:
objProperties - name-value pairs that affect the serialization. See above forvalid names and how they affect serialization. this object serialized as an XML document. |
| toXMLDoc | | public T toXMLDoc(jsx3.lang.Object objProperties, Class<T> returnType)(Code) | | Serializes this object as an XML document.
The objProperties parameter may include the following keys:
onafter {String} - the value of the onAfterDeserialize element
onbefore {String} - the value of the onBeforeDeserialize element
name {String} - the value of the name element
icon {String} - the value of the icon element
description {String} - the value of the description element
children {boolean} - if true the children of this object, rather than this object, are
serialized
persistall {boolean} - if true all descendants with persistence PERSISTNONE are included in the
serialization
Parameters:
objProperties - name-value pairs that affect the serialization. See above forvalid names and how they affect serialization.
Parameters:
returnType - The expected return type this object serialized as an XML document. |
| 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(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(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(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(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(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)
|
|
|