| java.lang.Object
 org.directwebremoting.proxy.io.Context
jsx3.lang.Object
jsx3.app.Server
| Server | | public class Server extends jsx3.lang.Object (Code) | | The controller of the JSX architecture.
author:
Joe Walker [joe at getahead dot org]
author:
DRAPGEN - Dwr Reverse Ajax Proxy GENerator |
| Field Summary | |
| final public static String | HELP
The subject of an event that instances of this class publish when a context help hot key is pressed
in the context of a DOM node that has a help ID. | | final public static String | INITED
The subject of an event that jsx3.app.Server publishes when an instance of this class
is created. |
| Method Summary | |
| public void | alert(String strTitle, String strMessage, org.directwebremoting.proxy.CodeBlock fctOnOk, String strOk, String objParams)
| | public void | configureAlert(java.lang.Object objDialog, jsx3.lang.Object objParams)
| | public void | confirm(String strTitle, String strMessage, org.directwebremoting.proxy.CodeBlock fctOnOk, org.directwebremoting.proxy.CodeBlock fctOnCancel, String strOk, String strCancel, int intBtnDefault, org.directwebremoting.proxy.CodeBlock fctOnNo, String strNo, String objParams)
| | public jsx3.gui.Window | createAppWindow(String strName)
Creates a new jsx3.gui.Window instance for this server. | | public void | deleteCookie(String name, String path, String domain)
| | public void | destroy()
| | public jsx3.app.Model | getAlertsParent()
To implement jsx3.gui.Alerts interface. | | public T | getAlertsParent(Class<T> returnType)
To implement jsx3.gui.Alerts interface. | | public jsx3.gui.Window | getAppWindow(String strName)
Retrieves a previously created jsx3.gui.Window instance. | | public jsx3.gui.Block | getBodyBlock()
| | public T | getBodyBlock(Class<T> returnType)
| | public jsx3.app.Cache | getCache()
| | public void | getCookie(String name, boolean bRaw, org.directwebremoting.proxy.Callback<String> callback)
| | public jsx3.app.DOM | getDOM()
| | public void | getDefaultLocale(org.directwebremoting.proxy.Callback<java.util.Locale> callback)
Returns the default locale of this server. | | public void | getDocumentOf(jsx3.app.Model objJSX, org.directwebremoting.proxy.Callback<String> callback)
Returns the browser document object containing a particular JSX object. | | public void | getDynamicProperty(String strPropName, String strToken, org.directwebremoting.proxy.Callback<String> callback)
| | public void | getEnv(String strEnvKey, org.directwebremoting.proxy.Callback<String> callback)
Returns the value of an environment setting of this server. | | public jsx3.app.Model | getJSX(String strId)
Looks up a DOM node owned by this server by id or by name. | | public T | getJSX(String strId, Class<T> returnType)
Looks up a DOM node owned by this server by id or by name. | | public jsx3.app.Model | getJSXById(String strId)
Looks up a DOM node owned by this server by id. | | public T | getJSXById(String strId, Class<T> returnType)
Looks up a DOM node owned by this server by id. | | public jsx3.app.Model | getJSXByName(String strId)
Looks up a DOM node owned by this server by name. | | public T | getJSXByName(String strId, Class<T> returnType)
Looks up a DOM node owned by this server by name. | | public void | getLocale(org.directwebremoting.proxy.Callback<java.util.Locale> callback)
Returns the current locale of this server. | | public void | getRenderedOf(jsx3.app.Model objJSX, org.directwebremoting.proxy.Callback<String> callback)
Returns the browser DOM object where a particulat JSX object renders. | | public jsx3.gui.Block | getRootBlock()
| | public T | getRootBlock(Class<T> returnType)
| | public void | getRootObjects(org.directwebremoting.proxy.Callback<Object[]> callback)
Returns the list of objects that are children of the body object. | | public jsx3.app.Settings | getSettings()
| | public jsx3.gui.WindowBar | getTaskBar(jsx3.app.Model objJSX)
| | public void | getUriPrefix(org.directwebremoting.proxy.Callback<String> callback)
| | public void | invokeHelp(jsx3.app.Model objJSX)
Invokes context-sensitive help as though the user had pressed the help hot key in the context of the DOM node
objJSX. | | public jsx3.gui.Window | loadAppWindow(String strSource)
Loads a new jsx3.gui.Window instance from a component file. | | public jsx3.gui.Window | loadAppWindow(jsx3.xml.Node strSource)
Loads a new jsx3.gui.Window instance from a component file. | | public jsx3.xml.CdfDocument | loadInclude(java.net.URI strSrc, String strId, String strType, String bReload)
Loads an external resource into this server instance. | | public T | loadInclude(java.net.URI strSrc, String strId, String strType, String bReload, Class<T> returnType)
Loads an external resource into this server instance. | | public jsx3.xml.CdfDocument | loadInclude(String strSrc, String strId, String strType, String bReload)
Loads an external resource into this server instance. | | public T | loadInclude(String strSrc, String strId, String strType, String bReload, Class<T> returnType)
Loads an external resource into this server instance. | | public jsx3.xml.CdfDocument | loadResource(String strId)
Loads an application resource. | | public T | loadResource(String strId, Class<T> returnType)
Loads an application resource. | | public void | paint(jsx3.xml.CdfDocument objXML)
Paints this application and its default component into the application view port on the host HTML page. | | public void | prompt(String strTitle, String strMessage, org.directwebremoting.proxy.CodeBlock fctOnOk, org.directwebremoting.proxy.CodeBlock fctOnCancel, String strOk, String strCancel, String objParams)
| | public void | publish(jsx3.lang.Object objEvent, org.directwebremoting.proxy.Callback<Integer> callback)
Publishes an event to all subscribed objects. | | public void | relativizeURI(java.net.URI strURI, boolean bRel, org.directwebremoting.proxy.Callback<java.net.URI> callback)
| | public void | relativizeURI(String strURI, boolean bRel, org.directwebremoting.proxy.Callback<java.net.URI> callback)
| | public void | reloadLocalizedResources()
Reloads all resource files that are localized. | | public void | resolveURI(String strURI, org.directwebremoting.proxy.Callback<java.net.URI> callback)
Resolves a URI that is referenced from a file in this server. | | public void | resolveURI(java.net.URI strURI, org.directwebremoting.proxy.Callback<java.net.URI> callback)
Resolves a URI that is referenced from a file in this server. | | public void | setCookie(String name, String value, java.util.Date expires, String path, String domain, boolean secure, boolean bRaw)
Sets a Cookie with the given name and value
Parameters:
name - name of the cookie
Parameters:
value - value of the cookie
Parameters:
expires - valid jscript date object. | | public void | setDimensions(int left, int top, int width, int height)
set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. | | public void | setDimensions(Object[] left, int top, int width, int height)
set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. | | public void | setDynamicProperty(String strPropName, String vntValue)
| | public void | setLocale(java.util.Locale objLocale)
Sets the locale of this server. | | 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, 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, 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, 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, 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(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, 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, 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, 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 | unloadInclude(String strId)
Removes a loaded JavaScript or CSS resource from the browser DOM. | | 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, String 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 | unsubscribe(String strEventId, jsx3.lang.Object 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. |
| HELP | | final public static String HELP(Code) | | The subject of an event that instances of this class publish when a context help hot key is pressed
in the context of a DOM node that has a help ID. The event has the following fields:
target - the server publishing the event.
model - the DOM node that received the key event.
helpid - the help ID of the nearest ancestor of model that defines a help ID.
|
| INITED | | final public static String INITED(Code) | | The subject of an event that jsx3.app.Server publishes when an instance of this class
is created. The target of the event object is the initialized server.
|
| Server | | public Server(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 |
| Server | | public Server(String strAppPath, String objGUI, boolean bPaint, jsx3.lang.Object objEnv)(Code) | | Sets environment variables used by this class (the controller for the JSX architecture)
Parameters:
strAppPath - URL (either relative or absolute) for the application to load
Parameters:
objGUI - the browser element (body, div, span, td, etc) into which the GI application should load
Parameters:
bPaint - false if null; if true, the application VIEW will immediately be generated.
Parameters:
objEnv - |
| alert | | public void alert(String strTitle, String strMessage, org.directwebremoting.proxy.CodeBlock fctOnOk, String strOk, String objParams)(Code) | | show an alert dialog
Parameters:
strTitle - the title of the dialog
Parameters:
strMessage - the message to display
Parameters:
fctOnOk - callback function on pressing ok button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog
Parameters:
strOk - the text of the ok button, can be false to remove button from display
Parameters:
objParams - argument to configureAlert() |
| configureAlert | | public void configureAlert(java.lang.Object objDialog, jsx3.lang.Object objParams)(Code) | | configure the dialog
Parameters:
objDialog - the dialog
Parameters:
objParams - may include fields 'width', 'height', 'noTitle', and 'nonModal'. |
| confirm | | public void confirm(String strTitle, String strMessage, org.directwebremoting.proxy.CodeBlock fctOnOk, org.directwebremoting.proxy.CodeBlock fctOnCancel, String strOk, String strCancel, int intBtnDefault, org.directwebremoting.proxy.CodeBlock fctOnNo, String strNo, String objParams)(Code) | | show a confirm alert
Parameters:
strTitle - the title of the dialog
Parameters:
strMessage - the message to display
Parameters:
fctOnOk - callback function on pressing ok button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog
Parameters:
fctOnCancel - callback function on pressing cancel button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog
Parameters:
strOk - the text of the ok button
Parameters:
strCancel - the text of the cancel button
Parameters:
intBtnDefault - the bold button that receives return key, 1:ok, 2:cancel, 3:no
Parameters:
fctOnNo - callback function on pressing no button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog
Parameters:
strNo - the text of the no button
Parameters:
objParams - argument to configureAlert() |
| createAppWindow | | public jsx3.gui.Window createAppWindow(String strName)(Code) | | Creates a new jsx3.gui.Window instance for this server. A branch of the DOM of this application can be placed
in this window in order to distribute the application across multiple browser windows.
Parameters:
strName - the unique name of the window to create |
| deleteCookie | | public void deleteCookie(String name, String path, String domain)(Code) | | delete a cookie
Parameters:
name - name of the cookie
Parameters:
path - path where the cookie is valid (default: path of calling document)
Parameters:
domain - domain where the cookie is valid (default: domain of calling document) |
| destroy | | public void destroy()(Code) | | call to shut down a server instance and free up resources used by the server (cache,dom,etc)
|
| getAlertsParent | | public jsx3.app.Model getAlertsParent()(Code) | | To implement jsx3.gui.Alerts interface.
the root block. |
| getAlertsParent | | public T getAlertsParent(Class<T> returnType)(Code) | | To implement jsx3.gui.Alerts interface.
Parameters:
returnType - The expected return type the root block. |
| getAppWindow | | public jsx3.gui.Window getAppWindow(String strName)(Code) | | Retrieves a previously created jsx3.gui.Window instance.
Parameters:
strName - the unique name of the window to retrieve the window instance or null if no such window exists. |
| getBodyBlock | | public jsx3.gui.Block getBodyBlock()(Code) | | Returns the body block for this server (JSXBODY)
|
| getBodyBlock | | public T getBodyBlock(Class<T> returnType)(Code) | | Returns the body block for this server (JSXBODY)
Parameters:
returnType - The expected return type |
| getDocumentOf | | public void getDocumentOf(jsx3.app.Model objJSX, org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the browser document object containing a particular JSX object. This method inspects whether the
JSX object is a descendent of the root block of this server or one of its jsx3.gui.Window roots.
Parameters:
objJSX -
Parameters:
callback - document object |
| getDynamicProperty | | public void getDynamicProperty(String strPropName, String strToken, org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the value of the dynamic property @strPropName
Parameters:
strPropName - id for this dynamic property among all properties
Parameters:
strToken - if present tokens such as {0}, {1}, {n} will be replaced with the nth element of this vararg array
Parameters:
callback - value of the property |
| getEnv | | public void getEnv(String strEnvKey, org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the value of an environment setting of this server. Valid keys correspond to deployment options and are
(case-insensitive):
VERSION
APPPATH
ABSPATH
CAPTION
MODE
SYSTEM
NAMESPACE
CANCELERROR
CANCELRIGHTCLICK
BODYHOTKEYS
WIDTH
HEIGHT
LEFT
TOP
POSITION
OVERFLOW
UNICODE
EVENTSVERS
Parameters:
strEnvKey - the key of the environment value to return |
| getJSX | | public jsx3.app.Model getJSX(String strId)(Code) | | Looks up a DOM node owned by this server by id or by name.
Parameters:
strId - either the id (_jsxid) of the object or its name (jsxname) the JSX object or null if none found |
| getJSX | | public T getJSX(String strId, Class<T> returnType)(Code) | | Looks up a DOM node owned by this server by id or by name.
Parameters:
strId - either the id (_jsxid) of the object or its name (jsxname)
Parameters:
returnType - The expected return type the JSX object or null if none found |
| getJSXById | | public jsx3.app.Model getJSXById(String strId)(Code) | | Looks up a DOM node owned by this server by id.
Parameters:
strId - the id (_jsxid) of the object the JSX object or null if none found |
| getJSXById | | public T getJSXById(String strId, Class<T> returnType)(Code) | | Looks up a DOM node owned by this server by id.
Parameters:
strId - the id (_jsxid) of the object
Parameters:
returnType - The expected return type the JSX object or null if none found |
| getJSXByName | | public jsx3.app.Model getJSXByName(String strId)(Code) | | Looks up a DOM node owned by this server by name. If more than one such objects exist, only one is returned.
Parameters:
strId - the name (jsxname) of the object the JSX object or null if none found |
| getJSXByName | | public T getJSXByName(String strId, Class<T> returnType)(Code) | | Looks up a DOM node owned by this server by name. If more than one such objects exist, only one is returned.
Parameters:
strId - the name (jsxname) of the object
Parameters:
returnType - The expected return type the JSX object or null if none found |
| getLocale | | public void getLocale(org.directwebremoting.proxy.Callback<java.util.Locale> callback)(Code) | | Returns the current locale of this server. If the locale has been set explicitly with setLocale(),
that locale is returned. Otherwise, getDefaultLocale() is consulted, and finally the system-wide
locale.
|
| getRenderedOf | | public void getRenderedOf(jsx3.app.Model objJSX, org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the browser DOM object where a particulat JSX object renders. This method inspects the main root of
this server as well as all of its jsx3.gui.Window roots.
Parameters:
objJSX -
Parameters:
callback - DOM object |
| getRootBlock | | public jsx3.gui.Block getRootBlock()(Code) | | Returns the root block for this server (JSXROOT)
|
| getRootBlock | | public T getRootBlock(Class<T> returnType)(Code) | | Returns the root block for this server (JSXROOT)
Parameters:
returnType - The expected return type |
| getRootObjects | | public void getRootObjects(org.directwebremoting.proxy.Callback<Object[]> callback)(Code) | | Returns the list of objects that are children of the body object. These are the root objects
in a serialization file and the root nodes in the Component Hierarchy palette.
|
| getTaskBar | | public jsx3.gui.WindowBar getTaskBar(jsx3.app.Model objJSX)(Code) | | Returns handle to a descendant taskbar belonging to this server instance (this is where JSXDialog instances will try to minimize to if it exists); returns null if none found;
if no taskbar is found, dialogs are not minimized, but are 'window shaded'Ñlike a Mac used to do
Parameters:
objJSX - if null, this.JSXROOT is assumed; otherwise the object in the DOM from which to start looking for a descendant taskbar (a jsx3.gui.WindowBar instance) |
| invokeHelp | | public void invokeHelp(jsx3.app.Model objJSX)(Code) | | Invokes context-sensitive help as though the user had pressed the help hot key in the context of the DOM node
objJSX.
Parameters:
objJSX - |
| loadAppWindow | | public jsx3.gui.Window loadAppWindow(String strSource)(Code) | | Loads a new jsx3.gui.Window instance from a component file.
Parameters:
strSource - either an XML document containing the window to load or the URL of thecomponent to load. |
| loadAppWindow | | public jsx3.gui.Window loadAppWindow(jsx3.xml.Node strSource)(Code) | | Loads a new jsx3.gui.Window instance from a component file.
Parameters:
strSource - either an XML document containing the window to load or the URL of thecomponent to load. |
| loadInclude | | public jsx3.xml.CdfDocument loadInclude(java.net.URI strSrc, String strId, String strType, String bReload)(Code) | | Loads an external resource into this server instance. What this method does depends on the strType
parameter.
script - Loads a JavaScript file asynchronously into the memory space of the page hosting this
application; returns null.
css - Loads a CSS file asynchronously into the memory space of the page hosting this
application; returns null.
xml or xsl - Loads an XML file synchronously into the XML cache of this
application; returns the loaded jsx3.xml.Document instance.
jss or ljss - Loads a dynamic properties file or localized properties bundle
synchronously into this application; returns null.
services - Loads and parses a mapping rules file synchronously; returns a new instance of
jsx3.net.Service.
Parameters:
strSrc - the path to the resource.
Parameters:
strId - the unique identifier of the resource. A resource loaded by this method may clobbera previously loaded resource of the same type and id.
Parameters:
strType - the type of include, one of: css, jss, xml,xsl, script (for JavaScript), services (for mapping rules),or ljss.
Parameters:
bReload - if true, a JavaScript or CSS file is reloaded from the remote serverwithout checking the local browser cache. Other types of resources are not affected by this parameter. the return type depends on the strTypeparameter. See the method description. |
| loadInclude | | public T loadInclude(java.net.URI strSrc, String strId, String strType, String bReload, Class<T> returnType)(Code) | | Loads an external resource into this server instance. What this method does depends on the strType
parameter.
script - Loads a JavaScript file asynchronously into the memory space of the page hosting this
application; returns null.
css - Loads a CSS file asynchronously into the memory space of the page hosting this
application; returns null.
xml or xsl - Loads an XML file synchronously into the XML cache of this
application; returns the loaded jsx3.xml.Document instance.
jss or ljss - Loads a dynamic properties file or localized properties bundle
synchronously into this application; returns null.
services - Loads and parses a mapping rules file synchronously; returns a new instance of
jsx3.net.Service.
Parameters:
strSrc - the path to the resource.
Parameters:
strId - the unique identifier of the resource. A resource loaded by this method may clobbera previously loaded resource of the same type and id.
Parameters:
strType - the type of include, one of: css, jss, xml,xsl, script (for JavaScript), services (for mapping rules),or ljss.
Parameters:
bReload - if true, a JavaScript or CSS file is reloaded from the remote serverwithout checking the local browser cache. Other types of resources are not affected by this parameter.
Parameters:
returnType - The expected return type the return type depends on the strTypeparameter. See the method description. |
| loadInclude | | public jsx3.xml.CdfDocument loadInclude(String strSrc, String strId, String strType, String bReload)(Code) | | Loads an external resource into this server instance. What this method does depends on the strType
parameter.
script - Loads a JavaScript file asynchronously into the memory space of the page hosting this
application; returns null.
css - Loads a CSS file asynchronously into the memory space of the page hosting this
application; returns null.
xml or xsl - Loads an XML file synchronously into the XML cache of this
application; returns the loaded jsx3.xml.Document instance.
jss or ljss - Loads a dynamic properties file or localized properties bundle
synchronously into this application; returns null.
services - Loads and parses a mapping rules file synchronously; returns a new instance of
jsx3.net.Service.
Parameters:
strSrc - the path to the resource.
Parameters:
strId - the unique identifier of the resource. A resource loaded by this method may clobbera previously loaded resource of the same type and id.
Parameters:
strType - the type of include, one of: css, jss, xml,xsl, script (for JavaScript), services (for mapping rules),or ljss.
Parameters:
bReload - if true, a JavaScript or CSS file is reloaded from the remote serverwithout checking the local browser cache. Other types of resources are not affected by this parameter. the return type depends on the strTypeparameter. See the method description. |
| loadInclude | | public T loadInclude(String strSrc, String strId, String strType, String bReload, Class<T> returnType)(Code) | | Loads an external resource into this server instance. What this method does depends on the strType
parameter.
script - Loads a JavaScript file asynchronously into the memory space of the page hosting this
application; returns null.
css - Loads a CSS file asynchronously into the memory space of the page hosting this
application; returns null.
xml or xsl - Loads an XML file synchronously into the XML cache of this
application; returns the loaded jsx3.xml.Document instance.
jss or ljss - Loads a dynamic properties file or localized properties bundle
synchronously into this application; returns null.
services - Loads and parses a mapping rules file synchronously; returns a new instance of
jsx3.net.Service.
Parameters:
strSrc - the path to the resource.
Parameters:
strId - the unique identifier of the resource. A resource loaded by this method may clobbera previously loaded resource of the same type and id.
Parameters:
strType - the type of include, one of: css, jss, xml,xsl, script (for JavaScript), services (for mapping rules),or ljss.
Parameters:
bReload - if true, a JavaScript or CSS file is reloaded from the remote serverwithout checking the local browser cache. Other types of resources are not affected by this parameter.
Parameters:
returnType - The expected return type the return type depends on the strTypeparameter. See the method description. |
| loadResource | | public jsx3.xml.CdfDocument loadResource(String strId)(Code) | | Loads an application resource. This method looks up a resource registered with this application by its id.
The resource must be registered in the config.xml file of this application.
Parameters:
strId - unique identifier for the resource (its unique id as an application resource file). the return type depends on the type of resource.See the documentation for loadInclude() for more information. |
| loadResource | | public T loadResource(String strId, Class<T> returnType)(Code) | | Loads an application resource. This method looks up a resource registered with this application by its id.
The resource must be registered in the config.xml file of this application.
Parameters:
strId - unique identifier for the resource (its unique id as an application resource file).
Parameters:
returnType - The expected return type the return type depends on the type of resource.See the documentation for loadInclude() for more information. |
| paint | | public void paint(jsx3.xml.CdfDocument objXML)(Code) | | Paints this application and its default component into the application view port on the host HTML page. The
system class loader calls this method once all the required resources of the application have loaded. The
order of actions taken by this method is:
Load the default component file
Execute the onload script for the application
Paint the default component in the view port
Parameters:
objXML - the pre-loaded default component document. |
| prompt | | public void prompt(String strTitle, String strMessage, org.directwebremoting.proxy.CodeBlock fctOnOk, org.directwebremoting.proxy.CodeBlock fctOnCancel, String strOk, String strCancel, String objParams)(Code) | | show a text box input prompt
Parameters:
strTitle - the title of the dialog
Parameters:
strMessage - the message to display
Parameters:
fctOnOk - callback function on pressing ok button, receives the dialog as an argument, and the value of the text input as a second argument; if null the dialog will close itself; if defined must explicitly close the dialog
Parameters:
fctOnCancel - callback function on pressing cancel button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog
Parameters:
strOk - the text of the ok button
Parameters:
strCancel - the text of the cancel button
Parameters:
objParams - argument to configureAlert() |
| 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 |
| reloadLocalizedResources | | public void reloadLocalizedResources()(Code) | | Reloads all resource files that are localized. This method should be called after calling
setLocale() for the server to render properly in the new locale.
|
| resolveURI | | public void resolveURI(String strURI, org.directwebremoting.proxy.Callback<java.net.URI> callback)(Code) | | Resolves a URI that is referenced from a file in this server. This method takes into account the changes in
resource addressing between 3.1 and 3.2. For version 3.1, the URI is resolved as any URI in the system, using
jsx3.resolveURI(). In version 3.2, the URI is taken as relative to the application folder. In
particular, a relative URI will be resolved to a base of the application folder, an absolute URI will be
unaffected.
Parameters:
strURI - the URI to resolve.
Parameters:
callback - the resolved URI. |
| resolveURI | | public void resolveURI(java.net.URI strURI, org.directwebremoting.proxy.Callback<java.net.URI> callback)(Code) | | Resolves a URI that is referenced from a file in this server. This method takes into account the changes in
resource addressing between 3.1 and 3.2. For version 3.1, the URI is resolved as any URI in the system, using
jsx3.resolveURI(). In version 3.2, the URI is taken as relative to the application folder. In
particular, a relative URI will be resolved to a base of the application folder, an absolute URI will be
unaffected.
Parameters:
strURI - the URI to resolve.
Parameters:
callback - the resolved URI. |
| setCookie | | public void setCookie(String name, String value, java.util.Date expires, String path, String domain, boolean secure, boolean bRaw)(Code) | | Sets a Cookie with the given name and value
Parameters:
name - name of the cookie
Parameters:
value - value of the cookie
Parameters:
expires - valid jscript date object. for example: new Date("11:59:59 12-31-2004")
Parameters:
path - path where the cookie is valid (default: path of calling document)
Parameters:
domain - domain where the cookie is valid (default: domain of calling document)
Parameters:
secure - valid jscript date object. for example: new Date("11:59:59 12-31-2004")
Parameters:
bRaw - |
| setDimensions | | public void setDimensions(int left, int top, int width, int height)(Code) | | set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. Must be called during/after the onload event for the server instance as it affects the VIEW for the server. Updates the absolutely positioned element that contains JSXROOT.
Parameters:
left - the new left value or a JavaScript array containing all four new values (in pixels)
Parameters:
top - the new top value (in pixels)
Parameters:
width - the new width value (in pixels)
Parameters:
height - the new height value (in pixels) |
| setDimensions | | public void setDimensions(Object[] left, int top, int width, int height)(Code) | | set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. Must be called during/after the onload event for the server instance as it affects the VIEW for the server. Updates the absolutely positioned element that contains JSXROOT.
Parameters:
left - the new left value or a JavaScript array containing all four new values (in pixels)
Parameters:
top - the new top value (in pixels)
Parameters:
width - the new width value (in pixels)
Parameters:
height - the new height value (in pixels) |
| setDynamicProperty | | public void setDynamicProperty(String strPropName, String vntValue)(Code) | | updates a single dynamic style property; dynamic properties are used by jsx3.gui.Block objects that extend the astract class, jsx3.gui.Block;
Parameters:
strPropName - id for this dynamic property among all properties
Parameters:
vntValue - value of the property; if null, the property with the name, @strPropName will be removed |
| setLocale | | public void setLocale(java.util.Locale objLocale)(Code) | | Sets the locale of this server.
Parameters:
objLocale - |
| 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, 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, 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, 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, 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(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, 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, 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, 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 |
| unloadInclude | | public void unloadInclude(String strId)(Code) | | Removes a loaded JavaScript or CSS resource from the browser DOM.
Parameters:
strId - the id used when loading the resource. |
| 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, 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, 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 |
| 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)
|
|
|