OverviewSingleDeprecatedPropertiesEventsXSL Parameters

package jsx3

No description provided.

Class Summary
jsx3.$Array
Useful extensions to the JavaScript Array class.
jsx3.$AsyncCB
The callback object passed as the single argument to an asynchronous method.
jsx3.$AsyncRV
The return value from an asynchronous method.
jsx3.$Function
Useful extensions to the JavaScript Function class.
jsx3.$Hash
Useful extensions to the JavaScript Object class for emulating a hashtable.
jsx3.$Object
Useful extensions to the JavaScript Object class.
jsx3.$String
Useful extensions to the JavaScript String class.
jsx3.Alerts
Deprecated. Renamed to jsx3.gui.Alerts.
jsx3.Block
Deprecated. Renamed to jsx3.gui.Block
jsx3.BlockX
Deprecated. Renamed to jsx3.gui.BlockX. Most functionality of this class was moved into a new interface, jsx3.xml.Cacheable.
jsx3.Boolean
Boolean class encapsulates GI's XML boolean values (0 and 1 rather than true and false).
jsx3.Button
Deprecated. Renamed to jsx3.gui.Button
jsx3.CDF
Deprecated. Renamed to jsx3.xml.CDF
jsx3.Cache
Deprecated. Renamed to jsx3.app.Cache
jsx3.CheckBox
Deprecated. Renamed to jsx3.gui.CheckBox
jsx3.Collection
Deprecated. Subsumed by jsx3.util.List.
jsx3.Column
Deprecated. Renamed to jsx3.gui.Column
jsx3.DOM
Deprecated. Renamed to jsx3.app.DOM
jsx3.DatePicker
Deprecated. Renamed to jsx3.gui.DatePicker
jsx3.Dialog
Deprecated. Renamed to jsx3.gui.Dialog
jsx3.Document
Deprecated. Renamed to jsx3.xml.Document
jsx3.ERROR
Deprecated. Renamed to jsx3.util.Logger
jsx3.EVT
Deprecated. Use class jsx3.gui.Event instead.
jsx3.Entity
Deprecated. Renamed to jsx3.xml.Entity
jsx3.Event
Deprecated. Renamed to jsx3.gui.Interactive
jsx3.EventDispatcher
Deprecated. Renamed to jsx3.util.EventDispatcher
jsx3.Form
Deprecated. Renamed to jsx3.gui.Form
jsx3.Grid
Deprecated. Renamed to jsx3.gui.Grid
jsx3.Heavyweight
Deprecated. Renamed to jsx3.gui.Heavyweight
jsx3.HttpForm
Deprecated. Renamed to jsx3.net.Form
jsx3.HttpRequest
Deprecated. Renamed to jsx3.net.Request
jsx3.LayoutGrid
Deprecated. Renamed to jsx3.gui.LayoutGrid
jsx3.List
Deprecated. Renamed to jsx3.gui.List
jsx3.Menu
Deprecated. Renamed to jsx3.gui.Menu
jsx3.Model
Deprecated. Renamed to jsx3.app.Model
jsx3.RadioButton
Deprecated. Renamed to jsx3.gui.RadioButton
jsx3.Select
Deprecated. Renamed to jsx3.gui.Select
jsx3.Server
Deprecated. Renamed to jsx3.app.Server
jsx3.Service
Deprecated. Renamed to jsx3.net.Service
jsx3.Settings
Deprecated. Renamed to jsx3.app.Settings
jsx3.Slider
Deprecated. Renamed to jsx3.gui.Slider
jsx3.Splitter
Deprecated. Renamed to jsx3.gui.Splitter
jsx3.Stack
Deprecated. Renamed to jsx3.gui.Stack
jsx3.StackGroup
Deprecated. Renamed to jsx3.gui.StackGroup
jsx3.Tab
Deprecated. Renamed to jsx3.gui.Tab
jsx3.TabbedPane
Deprecated. Renamed to jsx3.gui.TabbedPane
jsx3.TextBox
Deprecated. Renamed to jsx3.gui.TextBox
jsx3.ToolbarButton
Deprecated. Renamed to jsx3.gui.ToolbarButton
jsx3.Tree
Deprecated. Renamed to jsx3.gui.Tree
jsx3.UserSettings
Deprecated. Renamed to jsx3.app.UserSettings
jsx3.WindowBar
Deprecated. Renamed to jsx3.gui.WindowBar
Field Summary
static String
Deprecated. Use jsx3.getEnv("jsxabspath").
static String
ADDINSPATH
location for addin resources.
static String
Deprecated. Use jsx3.getEnv("jsxhomepath").
static jsx3.app.Cache
Deprecated. Use getSharedCache() instead.
static jsx3.lang.ClassLoader
CLASS_LOADER
the system class loader.
static void
Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.
static jsx3.EVT
Deprecated. Static access to the event object is deprecated as it is not cross-platform. Access to the current event object, where available, is granted via a method parameter or model event context variable.
static String
Deprecated.
static void
Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.
static jsx3.gui.Event
STARTUP_EVENT
static String
Deprecated.
static String
Deprecated.
Method Summary
static void
$A(a : Array | Object)
Injects class jsx3.$Array into array instance a.
static void
$F(f : Function)
Injects class jsx3.$Function into function instance f.
static void
$H(o : Object | Array)
Injects class jsx3.$Hash into object instance o.
static void
$O(o : Object)
Injects class jsx3.$Object into object instance o.
static void
$S(s : String)
Injects class jsx3.$String into string instance s.
static Function
$Y(f : Function)
Wraps an asynchronous method.
static Function
$Z(strMethod : String | Function, objThis : Object | jsx3.$AsyncRV)
Returns an asynchronous wrapper of a synchronous method.
static jsx3.app.Model
GO(strIdName : String, strNS : String | jsx3.app.Server)
global call to get a handle to a specific JSX GUI Object; NOTE: This is a significant modification used to support multi-instance servers.
static void
doDefine(strClassName : String, anonymousFunction : String)
Deprecated. create classes using jsx3.Class
static void
doImplement(subClass : String, superClass : String)
Deprecated. create classes using jsx3.Class
static void
doInherit(subClass : String, superClass : String, bImplement : boolean)
Deprecated. create classes using jsx3.Class
static void
doMixin(objInstance : Object, strClassName : String)
Deprecated. use jsx3.Class.mixin()
static void
eval(strScript : String, objContext : Object<String, Object>)
Evaluates a JavaScript expression in a controlled local variable context.
static Object
getClassConstants(strClassName : String)
Deprecated. use jsx3.lang.Class
static String
getClassMethods(strClassName : String)
Deprecated. use jsx3.lang.Class
static String
getEnv(strKey : String)
Returns the value of a system-wide environment variable.
static String
getInstanceMethods(strClassName : String)
Deprecated. use jsx3.lang.Class
static jsx3.app.Cache
Returns the global JSX XML/XSL cache.
static void
Returns the version of General Interface.
static void
log(strMessage : String)
Sends a message to the logging system.
static void
out(strErrorNumber : String, strMessage : String, PRIORITY : int, bTrace : boolean)
Deprecated. use jsx3.log() or the jsx3.util.Logger interface
static void
require(strClass : String...)
Ensures that one or more classes is available before this method returns.
static jsx3.$AsyncRV
requireAsync(strClass : String...)
Loads a class or classes asynchronously.
static String
Returns a URI resolved against the default URI resolver, URIResolver.DEFAULT.
static void
sleep(objFunction : Function, strId : String, objThis : Object, bClobber : boolean)
A replacement for peppering code with window.setTimeout(fnct, 0) statements.
Field Detail

ABSOLUTEPATH

static String ABSOLUTEPATH
Deprecated. Use jsx3.getEnv("jsxabspath").
Absolute path (the path on the server (file or http) from the accessible root to the directory containing the JSX system folder. Specifies a directory (ie it's empty or ends with a "/").

ADDINSPATH

static String ADDINSPATH
location for addin resources.

APPPATH

static String APPPATH
Deprecated. Use jsx3.getEnv("jsxhomepath").
Path for application resources (the prefix that precedes JSXAPPS). Specifies a directory (ie it's empty or ends with a "/").

CACHE

static jsx3.app.Cache CACHE
Deprecated. Use getSharedCache() instead.
The jsx3.app.Cache instance used by the JSX system to store XML and XSL documents.

CLASS_LOADER

static jsx3.lang.ClassLoader CLASS_LOADER
the system class loader.

DESERIALIZE

static ? DESERIALIZE
Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.

EVENT

static jsx3.EVT EVENT
Deprecated. Static access to the event object is deprecated as it is not cross-platform. Access to the current event object, where available, is granted via a method parameter or model event context variable.
wrapped static access to the current JavaScript event

HTTPREGKEY

static String HTTPREGKEY
Deprecated.
Default ActiveX HTTP object key.

INITIALIZE

static ? INITIALIZE
Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.

STARTUP_EVENT

static jsx3.gui.Event STARTUP_EVENT

XMLREGKEY

static String XMLREGKEY
Deprecated.
Default ActiveX XML object key.

XSLREGKEY

static String XSLREGKEY
Deprecated.
Default ActiveX XSL object key.
Method Detail

$A

static void $A(a : Array | Object)
Injects class jsx3.$Array into array instance a.

Parameters:

a

Since:

3.7

$F

static void $F(f : Function)
Injects class jsx3.$Function into function instance f.

Parameters:

f

Since:

3.7

$H

static void $H(o : Object | Array)
Injects class jsx3.$Hash into object instance o. If o is an array, it is first converted into an object by setting a property equal to 1 for each item in the array.

Parameters:

o

Since:

3.7

$O

static void $O(o : Object)
Injects class jsx3.$Object into object instance o.

Parameters:

o

Since:

3.7

$S

static void $S(s : String)
Injects class jsx3.$String into string instance s.

Parameters:

s

Since:

3.7

$Y

static Function $Y(f : Function)
Wraps an asynchronous method. An asynchronous method follows a very strict contract. It can be called with any number of parameters but the wrapped method sees only a single parameter, an instance of jsx3.$AsyncCB. The wrapped method must call done() on this method parameter, either synchronously or asynchronously. The done() method takes a single parameter, which is the return value of the method.

The wrapped method should not itself return anything. The only exception to this is that the method may return and instance of jsx3.$AsyncRV. In this case, the method will return when and with the same return value as the returned instance of jsx3.$AsyncRV.

Client code that calls the asynchronous method will see a synchronous return value of type jsx3.$AsyncRV. Client code should use the when() method of this return value to continue execution when the asynchronous method has completed. Or this return value may be used in conjuction with other asynchronous methods (such as by passing is as a parameter to an asynchronous method).

Another feature of asynchronous methods is that you can pass instances of jsx3.$AsyncRV as parameters to the method and the method is only invoked once all of those parameters have returned. The parameters that the wrapped method sees are automatically converted into the return values of the jsx3.$AsyncRV instances.

Parameters:

fthe function to wrap.

Returns:

the wrapped function.  

Since:

3.7

See Also:

jsx3.$AsyncCB, jsx3.$AsyncCB.done(), jsx3.$AsyncRV, jsx3.$AsyncRV.when()

$Z

static Function $Z(strMethod : String | Function, objThis : Object | jsx3.$AsyncRV)
Returns an asynchronous wrapper of a synchronous method. The returned method is method strMethod bound to object objThis. objThis is optional and may be an object or an instance of jsx3.$AsyncRV. If the latter, then the wrapped method is only called on the return value of objThis after objThis returns.

The wrapper takes the same parameters as the wrapped method. However, instead of returning the return value of the wrapped method, it returns an instance of jsx3.$AsyncRV.

The returned method may be passed parameters that are actually instances of jsx3.$AsyncRV. In this case, the wrapped method is only actually called when all the parameters have returned.

Parameters:

strMethodthe function to wrap or the name of a method of objThis to wrap.
objThisoptionally, the object to which to bind the wrapper.

Returns:

the wrapper function. 

Since:

3.7

GO

static jsx3.app.Model GO(strIdName : String, strNS : String | jsx3.app.Server)
global call to get a handle to a specific JSX GUI Object; NOTE: This is a significant modification used to support multi-instance servers. It is equivalently the same as calling 'getJO' in all builds prior to 3.0; returns null if object cannot be found. The specific app (a jsx3.app.Server instance) can also be queried for objects using its own DOM APIs.

Parameters:

strIdNameJSX 'id' or 'name' property for the object to get a handle to
strNSnamespace for the server to get the object from; when a 'name' is passed as @strNameId (as opposed to the object's 'id'), this allows the global JSX controller to more-quickly find the server that owns the given object. As this parameter is optional, the JSX controller will try to locate the named object by iterating through all server instances running in the browser in load order if no namespace is passed. When an 'id' is passed, the namespaces is not required as it explicitly contains this namespace.

Returns:

handle to given JSX GUI object or null if none found 

doDefine

static void doDefine(strClassName : String, anonymousFunction : String)
Deprecated. create classes using jsx3.Class
Registers all prototype functions and properties, contained by the inner function @anonymousFunction; used by jsx3.Object

Parameters:

strClassNamenamed class containing the anonymous function to call
anonymousFunctioninner function containing named prototypes to bind

See Also:

jsx3.lang.Class

doImplement

static void doImplement(subClass : String, superClass : String)
Deprecated. create classes using jsx3.Class
transfers prototype methods from one class to another

Parameters:

subClassnamed subclass to transfer prototypes to
superClassnamed superclass to transfer prototypes from

Returns:

the eval value of the script 

See Also:

jsx3.lang.Class

doInherit

static void doInherit(subClass : String, superClass : String, bImplement : boolean)
Deprecated. create classes using jsx3.Class
transfers prototype methods from one class to another; establishes @superClass as the super for @subClass

Parameters:

subClassnamed subclass to transfer prototypes to
superClassnamed superclass to transfer prototypes from
bImplementif true, @superClass is an interface

Returns:

the eval value of the script 

See Also:

jsx3.lang.Class

doMixin

static void doMixin(objInstance : Object, strClassName : String)
Deprecated. use jsx3.Class.mixin()
transfer the methods of a class to a object instance

Parameters:

objInstanceany JavaScript object
strClassNamethe name of a class

See Also:

jsx3.lang.Class.mixin()

eval

static void eval(strScript : String, objContext : Object<String, Object>)
Evaluates a JavaScript expression in a controlled local variable context. Every name-value pair in objContext will be exposed as a local variable to the evaluated script. All names must be valid JavaScript names in order to be exposed as local variables. Any invalid names will be ignored.

Parameters:

strScriptthe JavaScript to evaluate.
objContexta map containing the local variable context. Each key is the name of a variable to expose and each value is the value of that variable.

Returns:

the results of evaluating strScript.  

See Also:

jsx3.util.isName()

getClassConstants

static Object getClassConstants(strClassName : String)
Deprecated. use jsx3.lang.Class
Returns a JavaScript array of all named constants for this class; these names (strings) can then be used by the developer to lookup/evaluate/modify applicable constants; To derive the value for the first named constant for the jsx3.gui.Block class, a method such as the following would work: var myFirstConstantValue = eval(jsx3.getClassConstants("jsx3.gui.Block")[0]); NOTE: passing an invalid class name results in a null value being returned. If no constants exist for the given class, an empty array will be returned

Parameters:

strClassNamename of the class to get the constants for. For example: jsx3.gui.Block, jsx3.gui.Select, etc.

Returns:

JavaScript array 

See Also:

jsx3.lang.Class

getClassMethods

static String getClassMethods(strClassName : String)
Deprecated. use jsx3.lang.Class
Returns a new-line-delimited (e.g., \n) list of all instance methods for the particular class

Parameters:

strClassNamename of the class to get the constants for. For example: jsx3.gui.Block, jsx3.gui.Select, etc.

Returns:

 

See Also:

jsx3.lang.Class

getEnv

static String getEnv(strKey : String)
Returns the value of a system-wide environment variable. System-wide environment parameters are set either by query parameters in the launch page URL or by attributes on the GI script tag. System-wide environment variable keys always begin with "jsx" and do not begin with "jsxapp".

Parameters:

strKeythe case-insensitive environment variable key.

Returns:

the environment variable value. 

See Also:

jsx3.app.Server.getEnv()

getInstanceMethods

static String getInstanceMethods(strClassName : String)
Deprecated. use jsx3.lang.Class
Returns a new-line-delimited (e.g., \n) list of all instance methods for the particular class

Parameters:

strClassNamename of the class to get the constants for. For example: jsx3.gui.Block, jsx3.gui.Select, etc.

Returns:

 

See Also:

jsx3.lang.Class

getSharedCache

static jsx3.app.Cache getSharedCache()
Returns the global JSX XML/XSL cache. This cache is shared by all applications in the JSX runtime. Every server cache instance consults this cache when getDocument() is called on the server cache with a cache id that does not correspond to a document in the server cache.

Returns:

 

getVersion

static void getVersion()
Returns the version of General Interface.

log

static void log(strMessage : String)
Sends a message to the logging system. This method is an alias for jsx3.util.Logger.GLOBAL.info().

Since this method is defined before the logging system, any messages passed to this method before the logging system is defined are cached and sent with the first message passed after the logging system is defined.

Parameters:

strMessagethe message to send to the logging system.

See Also:

jsx3.util.Logger.GLOBAL

out

static void out(strErrorNumber : String, strMessage : String, PRIORITY : int, bTrace : boolean)
Deprecated. use jsx3.log() or the jsx3.util.Logger interface
Alias for jsx3.util.Logger.doLog() (formerly jsx3.Error.doLog()).

Parameters:

strErrorNumberarbitrary identifier passed by the calling function to track the specific location of the error
strMessagemessage to describe the error
PRIORITYone of 1, 2 or 3, with 1 being most serious (red..orange..yellow)
bTracetrue if null; if true, the stack trace is printed, displaying the order of the call stack

See Also:

log(), jsx3.util.Logger

require

static void require(strClass : String...)
Ensures that one or more classes is available before this method returns. Any class that fails to load will throw an error. Only classes that can be found by the system class loader may be loaded in this manner.

Parameters:

strClassthe fully-qualified names of the classes to load.

Since:

3.2

requireAsync

static asynchronous jsx3.$AsyncRV requireAsync(strClass : String...)
Loads a class or classes asynchronously. If multiple classes are specified they are loaded serially rather than in parallel. This method does not resolve dependencies, i.e. if the class to load contains a call to jsx3.require that class will be loaded synchronously.

Note that if strClass does not correspond to an file on the classpath or if the corresponding file does not actualy define a class whose name is strClass, this async function will never complete and no callbacks will be executed.

Parameters:

strClassthe fully-qualified names of the classes to load.

Throws:

{jsx3.lang.Exception}if the package of strClass is not registered as a system, add-in or application classpath.

Returns:

 

Since:

3.9

resolveURI

static String resolveURI(strURI : String | jsx3.net.URI)
Returns a URI resolved against the default URI resolver, URIResolver.DEFAULT.

Parameters:

strURIthe URI to resolve.

Returns:

 

See Also:

jsx3.net.URIResolver.DEFAULT

sleep

static void sleep(objFunction : Function, strId : String, objThis : Object, bClobber : boolean)
A replacement for peppering code with window.setTimeout(fnct, 0) statements. This method places all jobs in a queue. Each job gets its own stack.

Parameters:

objFunctionan anonymous function to call after a timeout.
strIdthe id of this job. If this parameter is not null and a job already exists in the queue with this id, then this job is not added to the queue.
objThisif provided, this object is the "this" context for the anonymous function objFunction when it is called.
bClobberif true and a job already exists, this new job clobbers the old job.

Since:

3.2