Packages
jsx3
jsx3.amp	The General Interface Asynchronous Modular Platform (AMP).
jsx3.amp.util	The standard library of AMP application utility classes.
jsx3.app	Application layer classes.
jsx3.chart	Various Charting related constants and utility functions.
jsx3.gui	GUI classes.
jsx3.html	Utility methods related to rendering HTML.
jsx3.ide	The public API of the General Interface IDE.
jsx3.lang
jsx3.net	Networking related classes.
jsx3.util	Utility classes.
jsx3.vector	This package and all contained classes are available only when the Charting add-in is enabled.
jsx3.xml	XML related classes.
window	Top-Level properties and functions.

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	ABSOLUTEPATH Deprecated. Use `jsx3.getEnv("jsxabspath")`.
static String	ADDINSPATH location for addin resources.
static String	APPPATH Deprecated. Use `jsx3.getEnv("jsxhomepath")`.
static jsx3.app.Cache	CACHE Deprecated. Use `getSharedCache()` instead.
static jsx3.lang.ClassLoader	CLASS_LOADER the system class loader.
static void	DESERIALIZE Deprecated. The new `jsx3.lang.Class` framework does not use this constant for instantiating objects.
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.
static String	HTTPREGKEY Deprecated.
static void	INITIALIZE Deprecated. The new `jsx3.lang.Class` framework does not use this constant for instantiating objects.
static jsx3.gui.Event	STARTUP_EVENT
static String	XMLREGKEY Deprecated.
static String	XSLREGKEY 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	getSharedCache() Returns the global JSX XML/XSL cache.
static void	getVersion() 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	resolveURI(strURI : String \| jsx3.net.URI) 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.

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:

f – the function to wrap.

Returns:

the wrapped function.

Since:

3.7

$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:

strMethod – the function to wrap or the name of a method of objThis to wrap.

objThis – optionally, 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:

strIdName – JSX 'id' or 'name' property for the object to get a handle to

strNS – namespace 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:

strClassName – named class containing the anonymous function to call

anonymousFunction – inner function containing named prototypes to bind

doImplement

static void doImplement(subClass : String, superClass : String)

Deprecated. create classes using jsx3.Class

transfers prototype methods from one class to another

Parameters:

subClass – named subclass to transfer prototypes to

superClass – named superclass to transfer prototypes from

Returns:

the eval value of the script

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:

subClass – named subclass to transfer prototypes to

superClass – named superclass to transfer prototypes from

bImplement – if true, @superClass is an interface

Returns:

the eval value of the script

doMixin

static void doMixin(objInstance : Object, strClassName : String)

Deprecated. use jsx3.Class.mixin()

transfer the methods of a class to a object instance

Parameters:

objInstance – any JavaScript object

strClassName – the name of a class

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:

strScript – the JavaScript to evaluate.

objContext – a 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.

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:

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

Returns:

JavaScript array

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:

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

Returns:

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:

strKey – the case-insensitive environment variable key.

Returns:

the environment variable value.

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:

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

Returns:

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:

strMessage – the message to send to the logging system.

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:

strErrorNumber – arbitrary identifier passed by the calling function to track the specific location of the error

strMessage – message to describe the error

PRIORITY – one of 1, 2 or 3, with 1 being most serious (red..orange..yellow)

bTrace – true if null; if true, the stack trace is printed, displaying the order of the call stack

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:

strClass – the 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:

strClass – the 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:

strURI – the URI to resolve.

Returns:

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:

objFunction – an anonymous function to call after a timeout.

strId – the 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.

objThis – if provided, this object is the "this" context for the anonymous function objFunction when it is called.

bClobber – if true and a job already exists, this new job clobbers the old job.

Since:

3.2

jsx3

class $Array

Object

->Array

->jsx3.$Array

class $Array
extends Array

Useful extensions to the JavaScript Array class.

Since:

3.7

Fields Inherited From Array
length

Method Summary
void	addAll(a : Array) Appends the contents of a to this array.
boolean	contains(o : Object) Returns true if o is in this array.
void	each(fct : Function) Calls fct for each element in this array.
boolean	eq(a : Array) Returns true if the contents of this array equal the contents of a.
jsx3.$Array	filter(fct : Function) Creates a new array with the filtered contents of this array.
Object	find(fct : Function) Returns the first element in this array for which fct returns true when passed the element as the sole parameter.
int	indexOf(o : Object) Returns the first index of o in this array.
jsx3.$Array	map(fct : Function) Creates a new array using the mapped values of each element in this array.
Object	remove(o : Object) Removes the first occurrence of o in this array.
jsx3.$Array	unique() Returns a list containing only the unique elements in this list.

Methods Inherited From Array
clone, concat, contentsEqual, join, lastIndexOf, pop, push, pushAll, reverse, shift, slice, sort, splice, toString, unshift

Method Detail

addAll

void addAll(a : Array)

Appends the contents of a to this array.

Parameters:

a –

contains

boolean contains(o : Object)

Returns true if o is in this array. This method uses strict equality for comparing objects (===).

Parameters:

o –

Returns:

Overrides:

contains in Array

each

void each(fct : Function)

Calls fct for each element in this array. fct is passed each element as the sole parameter.

Parameters:

fct –

eq

boolean eq(a : Array)

Returns true if the contents of this array equal the contents of a.

Parameters:

a –

Returns:

Since:

3.9

filter

jsx3.$Array filter(fct : Function)

Creates a new array with the filtered contents of this array. fct is called for each element in this array and the element is passed as the sole argument. The new array is constructed with only the elements of this array for which fct returns true.

Parameters:

fct –

Returns:

Overrides:

filter in Array

find

Object find(fct : Function)

Returns the first element in this array for which fct returns true when passed the element as the sole parameter.

Parameters:

fct –

Returns:

indexOf

int indexOf(o : Object)

Returns the first index of o in this array. This method uses strict equality for comparing objects (===).

Parameters:

o –

Returns:

Overrides:

indexOf in Array

map

jsx3.$Array map(fct : Function)

Creates a new array using the mapped values of each element in this array. fct is called for each element in this array and the element is passed as the sole argument. The new array is constructed with the return values of each call to fct. sole parameter.

Parameters:

fct –

Returns:

Overrides:

map in Array

remove

Object remove(o : Object)

Removes the first occurrence of o in this array. This method uses strict equality for comparing objects (===).

Parameters:

o –

Returns:

the removed object or undefined if o is not in this array.

Overrides:

remove in Array

unique

jsx3.$Array unique()

Returns a list containing only the unique elements in this list.

Returns:

jsx3

class $AsyncCB

Object

->jsx3.$AsyncCB

class $AsyncCB
extends Object

The callback object passed as the single argument to an asynchronous method.

Since:

3.7

Method Summary
Array<Object>	args() Returns the arguments that were passed to the asynchronous method wrapper.
void	done(rv : Object) Signals the callback object that the asynchronous method is done and passes the asynchronous return value.

args

Array<Object> args()

Returns the arguments that were passed to the asynchronous method wrapper.

Returns:

done

void done(rv : Object)

Signals the callback object that the asynchronous method is done and passes the asynchronous return value.

Parameters:

rv – the return value.

jsx3

class $AsyncRV

Object

->jsx3.$AsyncRV

class $AsyncRV
extends Object

The return value from an asynchronous method.

Since:

3.7

Method Summary
jsx3.$AsyncRV	and(rv : jsx3.$AsyncRV...) Creates and returns an asynchronous return value that completes when this and rv have completed.
jsx3.$AsyncRV	or(rv : jsx3.$AsyncRV...) Creates and returns an asynchronous return value that completes when this or rv have completed.
Object	rv() Returns the return value from the asynchronous method.
void	when(cb : Function \| jsx3.$AsyncCB, rv : Object) Registers code to be called when the asynchronous method completes.

and

jsx3.$AsyncRV and(rv : jsx3.$AsyncRV...)

Creates and returns an asynchronous return value that completes when this and rv have completed.

Parameters:

rv –

Returns:

or

jsx3.$AsyncRV or(rv : jsx3.$AsyncRV...)

Creates and returns an asynchronous return value that completes when this or rv have completed.

Parameters:

rv –

Returns:

rv

Object rv()

Returns the return value from the asynchronous method.

Throws:

{Error} – if called before done() is called on corresponding callback object.

Returns:

when

void when(cb : Function | jsx3.$AsyncCB, rv : Object)

Registers code to be called when the asynchronous method completes.

If argument cb is a function, then that function will be called when the asynchronous method completes. This function will be called synchronously is the function has already completed. The asynchronous method return value will be passed as the only argument to the function.

If argument cb is an instance of jsx3.$AsyncCB, then its done() method will be called when the asynchronous method completes. The done method will be passed the rv argument it is is provided. Otherwise, it will be passed the return value of cb.

Parameters:

cb –

rv –

jsx3

class $Function

Object

->jsx3.$Function

class $Function
extends Object

Useful extensions to the JavaScript Function class.

Since:

3.7

Method Summary
jsx3.$Function	bind(thisObj : Object, argsArr : Array) Returns a method that is this function applied to thisObj with arguments argsArr.

Methods Inherited From Object
toString

Method Detail

bind

jsx3.$Function bind(thisObj : Object, argsArr : Array)

Returns a method that is this function applied to thisObj with arguments argsArr.

Parameters:

thisObj –

argsArr –

Returns:

jsx3

class $Hash

Object

->jsx3.$Object

->jsx3.$Hash

class $Hash
extends jsx3.$Object

Useful extensions to the JavaScript Object class for emulating a hashtable.

Since:

3.7

Method Summary
void	each(fct : Function) Iterates over all the key-value pairs of this hashtable.
jsx3.$Array	keys() Returns the list of keys of this hashtable.
jsx3.$Array	values() Returns the list of values of this hashtable.

Methods Inherited From jsx3.$Object
clone, extend

Methods Inherited From Object
toString

Method Detail

each

void each(fct : Function)

Iterates over all the key-value pairs of this hashtable. fct is called for each pair; the pair key is the first parameter and the pair value is the second parameter.

Parameters:

fct – function(key : String, value: Object} : void

keys

jsx3.$Array keys()

Returns the list of keys of this hashtable.

Returns:

values

jsx3.$Array values()

Returns the list of values of this hashtable.

Returns:

jsx3

class $Object

Object

->jsx3.$Object

Direct Known Subclasses:

jsx3.$Hash, jsx3.$String

class $Object
extends Object

Useful extensions to the JavaScript Object class.

Since:

3.7

Method Summary
jsx3.$Object	clone() Creates a new objects with all the same properties as this object.
void	extend(o : Object) Copies all properties of o into this object.

Methods Inherited From Object
toString

Method Detail

clone

jsx3.$Object clone()

Creates a new objects with all the same properties as this object.

Returns:

extend

void extend(o : Object)

Copies all properties of o into this object.

Parameters:

o –

jsx3

class $String

Object

->jsx3.$Object

->jsx3.$String

class $String
extends jsx3.$Object

Useful extensions to the JavaScript String class.

Since:

3.7

Method Summary
boolean	endsWith(s : String) Returns true if this string ends with string s.
jsx3.$String	trim() Returns this string with all leading and trailing space removed.

Methods Inherited From jsx3.$Object
clone, extend

Methods Inherited From Object
toString

Method Detail

endsWith

boolean endsWith(s : String)

Returns true if this string ends with string s.

Parameters:

s –

Returns:

trim

jsx3.$String trim()

Returns this string with all leading and trailing space removed.

Returns:

jsx3

interface Alerts

jsx3.Alerts

interface Alerts

Deprecated. Renamed to jsx3.gui.Alerts.

jsx3

class Block

jsx3.Block

class Block

Deprecated. Renamed to jsx3.gui.Block

jsx3

class BlockX

jsx3.BlockX

class BlockX

Deprecated. Renamed to jsx3.gui.BlockX. Most functionality of this class was moved into a new interface, jsx3.xml.Cacheable.

jsx3

class Boolean

jsx3.Boolean

class Boolean

Boolean class encapsulates GI's XML boolean values (0 and 1 rather than true and false).

Field Summary
static int	FALSE 0
static int	TRUE 1

Method Summary
static int	valueOf(v : Object) Returns jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.

Field Detail

FALSE

static final int FALSE

TRUE

static final int TRUE

Method Detail

valueOf

static int valueOf(v : Object)

Returns jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.

Parameters:

v – boolean (or similar) that when evaluated via an 'if' would result in a true false; For example, null, 0 (numeric zero), and false all return jsx3.Boolean.FALSE

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

jsx3

class Button

jsx3.Button

class Button

Deprecated. Renamed to jsx3.gui.Button

jsx3

interface CDF

jsx3.CDF

interface CDF

Deprecated. Renamed to jsx3.xml.CDF

jsx3

class Cache

jsx3.Cache

class Cache

Deprecated. Renamed to jsx3.app.Cache

jsx3

class CheckBox

jsx3.CheckBox

class CheckBox

Deprecated. Renamed to jsx3.gui.CheckBox

jsx3

class Collection

jsx3.Collection

class Collection

Deprecated. Subsumed by jsx3.util.List.

jsx3

class Column

jsx3.Column

class Column

Deprecated. Renamed to jsx3.gui.Column

jsx3

class DOM

jsx3.DOM

class DOM

Deprecated. Renamed to jsx3.app.DOM

jsx3

class DatePicker

jsx3.DatePicker

class DatePicker

Deprecated. Renamed to jsx3.gui.DatePicker

jsx3

class Dialog

jsx3.Dialog

class Dialog

Deprecated. Renamed to jsx3.gui.Dialog

jsx3

class Document

jsx3.Document

class Document

Deprecated. Renamed to jsx3.xml.Document

jsx3

class ERROR

jsx3.ERROR

class ERROR

Deprecated. Renamed to jsx3.util.Logger

jsx3

class EVT

Object

->jsx3.lang.Object

->jsx3.EVT

All Implemented Interfaces:

jsx3.util.EventDispatcher

class EVT
extends jsx3.lang.Object

Deprecated. Use class jsx3.gui.Event instead.

This class is the static event controller for the GI framework. It abstracts the browser-specific implementations of the event object while providing extensions of its own (i.e., drag/drop, event binding, etc).

Constructor Summary
void	init(e : ?) Use this instance initializer for wrapped access to the current event object event at a later point in time.

Method Summary
boolean	altKey() Returns true if the alt key was pressed
boolean	backspaceKey() Returns true if the backspace key was pressed
int	button() Returns integer designating the mouse button clicked/moused-down/moused-up; 1 (left), 2 (right), and as supported
void	cancelBubble() cancels event bubbling for the event
void	cancelKey() cancels the key from firing by setting the keyCode to 0 (zero) for the event
void	cancelReturn() cancels the returnValue for the event
int	clientX() Returns the clientX property for the event (where it occurred on-screen)
int	clientY() Returns the clientY property for the event (where it occurred on-screen)
boolean	ctrlKey() Returns true if the ctrl key was pressed
boolean	deleteKey() Returns true if the delete key was pressed
boolean	downArrow() Returns true if the down-arrow key was pressed
boolean	endKey() Returns true if the end key was pressed
boolean	enterKey() Returns true if the enter key was pressed
boolean	escapeKey() Returns true if the escape key was pressed
Object	event() Returns handle to the native browser event object (window.event)
boolean	exists() Returns true if the native event object is present (if an event of any type actualy occurred)
HTMLElement	fromElement() Returns handle to the HTML element that was moused away from (onmouseout)
int	getTrueX() Returns the actual position in the browser from the left edge for where the event occurred;
int	getTrueY() Returns the actual position in the browser from the top edge for where the event occurred;
Object	handleEvent(strType : String, bReturn : boolean) Deprecated. use jsx3.gui.Event.publish() instead
boolean	homeKey() Returns true if the home key was pressed
boolean	insertKey() Returns true if the insert key was pressed
int	keyCode() Returns integer representing the key code of the key just pressed/keyed-down
boolean	leftArrow() Returns true if the left-arrow key was pressed
boolean	leftButton() Returns true if the left-mouse-button was clicked
boolean	pageDownKey() Returns true if the page-down key was pressed
boolean	pageUpKey() Returns true if the page-up key was pressed
void	registerEvent(EVENTTYPE : String, strCode : String) Deprecated. use jsx3.gui.Event.subscribe instead
boolean	rightArrow() Returns true if the right-arrow key was pressed
boolean	rightButton() Returns true if the right-mouse-button was clicked
void	setKeyCode(intKeyCode : int) sets/updates the keycode for the event
void	setReturn(RETURN : String) sets string message to set on the returnValue for the event
boolean	shiftKey() Returns true if the shift key was pressed
boolean	spaceKey() Returns true if the space bar was pressed
HTMLElement	srcElement() Returns handle to the HTML element acted upon (click, mousedown, etc)
boolean	tabKey() Returns true if the tab key was pressed
HTMLElement	toElement() Returns handle to the HTML element that was moused over (onmouseover)
boolean	upArrow() Returns true if the up-arrow key was pressed

init

void init(e : ?)

Use this instance initializer for wrapped access to the current event object event at a later point in time.

Parameters:

e –

Method Detail

altKey

boolean altKey()

Returns true if the alt key was pressed

Returns:

backspaceKey

boolean backspaceKey()

Returns true if the backspace key was pressed

Returns:

button

int button()

Returns integer designating the mouse button clicked/moused-down/moused-up; 1 (left), 2 (right), and as supported

Returns:

cancelBubble

void cancelBubble()

cancels event bubbling for the event

cancelKey

void cancelKey()

cancels the key from firing by setting the keyCode to 0 (zero) for the event

cancelReturn

void cancelReturn()

cancels the returnValue for the event

clientX

int clientX()

Returns the clientX property for the event (where it occurred on-screen)

Returns:

pixel position

clientY

int clientY()

Returns the clientY property for the event (where it occurred on-screen)

Returns:

pixel position

ctrlKey

boolean ctrlKey()

Returns true if the ctrl key was pressed

Returns:

deleteKey

boolean deleteKey()

Returns true if the delete key was pressed

Returns:

downArrow

boolean downArrow()

Returns true if the down-arrow key was pressed

Returns:

endKey

boolean endKey()

Returns true if the end key was pressed

Returns:

enterKey

boolean enterKey()

Returns true if the enter key was pressed

Returns:

escapeKey

boolean escapeKey()

Returns true if the escape key was pressed

Returns:

event

Object event()

Returns handle to the native browser event object (window.event)

Returns:

event

exists

boolean exists()

Returns true if the native event object is present (if an event of any type actualy occurred)

Returns:

fromElement

HTMLElement fromElement()

Returns handle to the HTML element that was moused away from (onmouseout)

Returns:

HTML object

getTrueX

int getTrueX()

Returns the actual position in the browser from the left edge for where the event occurred;

Returns:

pixel position

getTrueY

int getTrueY()

Returns the actual position in the browser from the top edge for where the event occurred;

Returns:

pixel position

handleEvent

Object handleEvent(strType : String, bReturn : boolean)

Deprecated. use jsx3.gui.Event.publish() instead

the JSXEVENT class maintains an object array indexed via the EVENTTYPE constant for the given event. When the event bubbles up the IE DOM, or when this function is called directly, the JScript code bound to the given event is exectued via the JScript 'eval()' function

Parameters:

strType – the event type to handle

bReturn –

Returns:

the result of the event eval, but only if parameter bReturn is true, otherwise no return statement

homeKey

boolean homeKey()

Returns true if the home key was pressed

Returns:

insertKey

boolean insertKey()

Returns true if the insert key was pressed

Returns:

keyCode

int keyCode()

Returns integer representing the key code of the key just pressed/keyed-down

Returns:

keycode

leftArrow

boolean leftArrow()

Returns true if the left-arrow key was pressed

Returns:

leftButton

boolean leftButton()

Returns true if the left-mouse-button was clicked

Returns:

pageDownKey

boolean pageDownKey()

Returns true if the page-down key was pressed

Returns:

pageUpKey

boolean pageUpKey()

Returns true if the page-up key was pressed

Returns:

registerEvent

void registerEvent(EVENTTYPE : String, strCode : String)

Deprecated. use jsx3.gui.Event.subscribe instead

typically called by a JSX GUI foundation class (such as the JSXMenu class). Allows the given class to be notified when a given event occurs. For example in the case of the JSXMenu class, it must be notified to hide any visible menu when the user mouses down in the document.

Parameters:

EVENTTYPE – the type of event to handle such as mousedown, mouseup, etc

strCode – JScript code (passed as string) that will be evaluated via the JScript eval() function when the given event fires. Note: it is important that the code contain a trailing semicolon ';', in case a subsequent function binds its own callback code

rightArrow

boolean rightArrow()

Returns true if the right-arrow key was pressed

Returns:

rightButton

boolean rightButton()

Returns true if the right-mouse-button was clicked

Returns:

setKeyCode

void setKeyCode(intKeyCode : int)

sets/updates the keycode for the event

Parameters:

intKeyCode – keycode

setReturn

void setReturn(RETURN : String)

sets string message to set on the returnValue for the event

Parameters:

RETURN – string message to set on the returnValue for the event

shiftKey

boolean shiftKey()

Returns true if the shift key was pressed

Returns:

spaceKey

boolean spaceKey()

Returns true if the space bar was pressed

Returns:

srcElement

HTMLElement srcElement()

Returns handle to the HTML element acted upon (click, mousedown, etc)

Returns:

HTML object

tabKey

boolean tabKey()

Returns true if the tab key was pressed

Returns:

toElement

HTMLElement toElement()

Returns handle to the HTML element that was moused over (onmouseover)

Returns:

HTML object

upArrow

boolean upArrow()

Returns true if the up-arrow key was pressed

Returns:

jsx3

class Entity

jsx3.Entity

class Entity

Deprecated. Renamed to jsx3.xml.Entity

jsx3

interface Event

jsx3.Event

interface Event

Deprecated. Renamed to jsx3.gui.Interactive

jsx3

interface EventDispatcher

jsx3.EventDispatcher

interface EventDispatcher

Deprecated. Renamed to jsx3.util.EventDispatcher

jsx3

interface Form

jsx3.Form

interface Form

Deprecated. Renamed to jsx3.gui.Form

jsx3

class Grid

jsx3.Grid

class Grid

Deprecated. Renamed to jsx3.gui.Grid

jsx3

class Heavyweight

jsx3.Heavyweight

class Heavyweight

Deprecated. Renamed to jsx3.gui.Heavyweight

jsx3

class HttpForm

jsx3.HttpForm

class HttpForm

Deprecated. Renamed to jsx3.net.Form

jsx3

class HttpRequest

jsx3.HttpRequest

class HttpRequest

Deprecated. Renamed to jsx3.net.Request

jsx3

class LayoutGrid

jsx3.LayoutGrid

class LayoutGrid

Deprecated. Renamed to jsx3.gui.LayoutGrid

jsx3

class List

jsx3.List

class List

Deprecated. Renamed to jsx3.gui.List

jsx3

class Menu

jsx3.Menu

class Menu

Deprecated. Renamed to jsx3.gui.Menu

jsx3

class Model

jsx3.Model

class Model

Deprecated. Renamed to jsx3.app.Model

jsx3

class RadioButton

jsx3.RadioButton

class RadioButton

Deprecated. Renamed to jsx3.gui.RadioButton

jsx3

class Select

jsx3.Select

class Select

Deprecated. Renamed to jsx3.gui.Select

jsx3

class Server

jsx3.Server

class Server

Deprecated. Renamed to jsx3.app.Server

jsx3

class Service

jsx3.Service

class Service

Deprecated. Renamed to jsx3.net.Service

jsx3

class Settings

jsx3.Settings

class Settings

Deprecated. Renamed to jsx3.app.Settings

jsx3

class Slider

jsx3.Slider

class Slider

Deprecated. Renamed to jsx3.gui.Slider

jsx3

class Splitter

jsx3.Splitter

class Splitter

Deprecated. Renamed to jsx3.gui.Splitter

jsx3

class Stack

jsx3.Stack

class Stack

Deprecated. Renamed to jsx3.gui.Stack

jsx3

class StackGroup

jsx3.StackGroup

class StackGroup

Deprecated. Renamed to jsx3.gui.StackGroup

jsx3

class Tab

jsx3.Tab

class Tab

Deprecated. Renamed to jsx3.gui.Tab

jsx3

class TabbedPane

jsx3.TabbedPane

class TabbedPane

Deprecated. Renamed to jsx3.gui.TabbedPane

jsx3

class TextBox

jsx3.TextBox

class TextBox

Deprecated. Renamed to jsx3.gui.TextBox

jsx3

class ToolbarButton

jsx3.ToolbarButton

class ToolbarButton

Deprecated. Renamed to jsx3.gui.ToolbarButton

jsx3

class Tree

jsx3.Tree

class Tree

Deprecated. Renamed to jsx3.gui.Tree

jsx3

class UserSettings

jsx3.UserSettings

class UserSettings

Deprecated. Renamed to jsx3.app.UserSettings

jsx3

class WindowBar

jsx3.WindowBar

class WindowBar

Deprecated. Renamed to jsx3.gui.WindowBar

package jsx3.amp

The General Interface Asynchronous Modular Platform (AMP). Classes in this package are only available to applications that enable the AMP add-in.

Since:

3.7

Class Summary
jsx3.amp.Bindable
jsx3.amp.Engine	An AMP engine.
jsx3.amp.Ext	An AMP extension.
jsx3.amp.ExtPoint	An AMP extension point.
jsx3.amp.ExtProc	An extension processor utility class.
jsx3.amp.PlugIn	An AMP plug-in.
jsx3.amp.Resource	An AMP plug-in resource, such as a JavaScript file or XML file.
jsx3.amp.XML	An XML wrapper that can be backed either by a real XML node or by a nested object structure.

Field Summary
static String	DESCRIPTOR The name of the plug-ins registration file.
static String	DIR The path where application plug-ins should reside.
static String	METAFILE The name of a plug-in descriptor file.
static String	NS The plug-in definition XML namespace URI.

Field Detail

DESCRIPTOR

static String DESCRIPTOR

The name of the plug-ins registration file.

DIR

static String DIR

The path where application plug-ins should reside.

METAFILE

static String METAFILE

The name of a plug-in descriptor file.

NS

static String NS

The plug-in definition XML namespace URI.

jsx3.amp

interface Bindable

jsx3.amp.Bindable

All Known Implementing Classes:

jsx3.amp.PlugIn

interface Bindable

No description provided.

Method Summary
void	addBindableProp(key : String, expression : String) Adds a bindable property to this object.
jsx3.$Array<String>	getBindableProps() Returns the list of bindable properties of this object.
void	setBindableProp(key : String, newValue : Object) Sets the current calculated value of a bindable property of this object.
void	updateBindable(key : String) Causes a bindable property of this object to be recalculated.
void	updateBindableOn(key : String, publisher : jsx3.util.EventDispatcher, subject : String) Causes a bindable property to be updated when publisher publishes an event with subject subject.

Method Detail

addBindableProp

void addBindableProp(key : String, expression : String)

Adds a bindable property to this object.

Parameters:

key – the property name.

expression – the binding expression.

getBindableProps

jsx3.$Array<String> getBindableProps()

Returns the list of bindable properties of this object.

Returns:

setBindableProp

void setBindableProp(key : String, newValue : Object)

Sets the current calculated value of a bindable property of this object. If the new value does not match the old value, an event is published. The schema of the event is {subject: propName, oldValue: previousValue, value: newValue}.

Parameters:

key – the property name.

newValue – the next calculated value.

updateBindable

void updateBindable(key : String)

Causes a bindable property of this object to be recalculated. The property is set to the value of the binding expression, evaluated in the context of this object. If the property value has changed then this object will publish an event with subject key.

Parameters:

key – the property to recalculate.

updateBindableOn

void updateBindableOn(key : String, publisher : jsx3.util.EventDispatcher, subject : String)

Causes a bindable property to be updated when publisher publishes an event with subject subject.

Parameters:

key – the property to update.

publisher – the object to which to subscribe.

subject – the event subject to which to subscribe.

jsx3.amp

class Engine

Object

->jsx3.lang.Object

->jsx3.amp.Engine

All Implemented Interfaces:

jsx3.util.EventDispatcher

class Engine
extends jsx3.lang.Object

An AMP engine. There is one engine instance per application that loads the AMP add-in.

Field Summary
static String	ERROR Event subject published when an error prevents the engine from loading.
static String	LOAD Event subject published when an engine finishes loading.
static String	PROGRESS Event subject published when progress is made loading an engine.
static String	REGISTER Event subject published when a plug-in is registered.

Method Summary
void	deregister(strId : String) Deregisters a plug-in from this engine.
static jsx3.amp.Engine	getEngine(objServer : jsx3.app.Server) Returns the engine for a given application.
jsx3.amp.ExtPoint	getExtPoint(strId : String) Returns a registered extension point by ID.
jsx3.$Array<jsx3.amp.Ext>	getExts(strId : String) Returns the extensions registered for a given extension point ID.
jsx3.amp.PlugIn	getPlugIn(strId : String) Returns a registered plug-in by ID.
jsx3.$Array<jsx3.amp.PlugIn>	getPlugIns() Returns all registered plug-ins.
jsx3.app.Server	getServer() Returns the application associated with this engine.
boolean	isLoaded() Returns true if all of the AMP and project plug-ins have been registered.
jsx3.$AsyncRV	register(strId : String, strPath : String, objXML : jsx3.xml.Entity) Registers a plug-in manually at runtime.

ERROR

static String ERROR

Event subject published when an error prevents the engine from loading.

LOAD

static String LOAD

Event subject published when an engine finishes loading.

PROGRESS

static String PROGRESS

Event subject published when progress is made loading an engine. pct and done fields may be defined.

REGISTER

static String REGISTER

Event subject published when a plug-in is registered.

Method Detail

deregister

void deregister(strId : String)

Deregisters a plug-in from this engine. Note that garbage collection may be incomplete if application code references the plug-in or any of its extension points or extensions. Also, this method does not unload any JavaScript, CSS, or XML resources from the browser page or the AMP application. Unexpecting things may happen if this method is called while the plug-in is still loading.

Parameters:

strId – the ID of the plug-in to deregister.

getEngine

static jsx3.amp.Engine getEngine(objServer : jsx3.app.Server)

Returns the engine for a given application.

Parameters:

objServer –

Returns:

getExtPoint

jsx3.amp.ExtPoint getExtPoint(strId : String)

Returns a registered extension point by ID.

Parameters:

strId – the ID of the extension point.

Returns:

getExts

jsx3.$Array<jsx3.amp.Ext> getExts(strId : String)

Returns the extensions registered for a given extension point ID.

Parameters:

strId – the ID of the extension point.

Returns:

getPlugIn

jsx3.amp.PlugIn getPlugIn(strId : String)

Returns a registered plug-in by ID.

Parameters:

strId –

Returns:

getPlugIns

jsx3.$Array<jsx3.amp.PlugIn> getPlugIns()

Returns all registered plug-ins.

Returns:

getServer

jsx3.app.Server getServer()

Returns the application associated with this engine.

Returns:

isLoaded

boolean isLoaded()

Returns true if all of the AMP and project plug-ins have been registered.

Returns:

register

asynchronous jsx3.$AsyncRV register(strId : String, strPath : String, objXML : jsx3.xml.Entity)

Registers a plug-in manually at runtime. Only plug-ins not referenced in the main plugins.xml file should be loaded in this way.

Parameters:

strId – the plug-in ID.

strPath – the relative path from the application directory to the directory containing the plug-in directory.

objXML – the optional XML declaration of the plug-in. Providing this parameter prevents this method from requesting the plug-in descriptor file.

Returns:

jsx3.amp

class Ext

Object

->jsx3.lang.Object

->jsx3.amp.Ext

class Ext
extends jsx3.lang.Object

An AMP extension.

Method Summary
jsx3.$Array<jsx3.amp.XML>	getData() Returns the list of XML elements declared in the body of the extension declaration.
jsx3.amp.Engine	getEngine() Returns the engine owning the plug-in owning this extension.
String	getId() Returns the full ID of this extension, which is unique among all extensions in the AMP engine.
String	getLocalId() Returns the local ID of this extension, which is defined by the id attribute of the XML extension declaration.
String	getName() Returns the name of this extension, which is defined by the name attribute of the XML extension declaration.
jsx3.amp.PlugIn	getPlugIn() Returns the plug-in declaring this extension.
jsx3.amp.ExtPoint	getPoint() Returns the extension point to which this extension is registered.
String	getPointId() Returns the ID of the extension point this this extension extends.

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Method Detail

getData

jsx3.$Array<jsx3.amp.XML> getData()

Returns the list of XML elements declared in the body of the extension declaration.

Returns:

getEngine

jsx3.amp.Engine getEngine()

Returns the engine owning the plug-in owning this extension.

Returns:

getId

String getId()

Returns the full ID of this extension, which is unique among all extensions in the AMP engine.

Returns:

getLocalId

String getLocalId()

Returns the local ID of this extension, which is defined by the id attribute of the XML extension declaration.

Returns:

getName

String getName()

Returns the name of this extension, which is defined by the name attribute of the XML extension declaration.

Returns:

getPlugIn

jsx3.amp.PlugIn getPlugIn()

Returns the plug-in declaring this extension.

Returns:

getPoint

jsx3.amp.ExtPoint getPoint()

Returns the extension point to which this extension is registered.

Returns:

getPointId

String getPointId()

Returns the ID of the extension point this this extension extends. This is equal to the point attribute of the XML extension declaration.

Returns:

jsx3.amp

class ExtPoint

Object

->jsx3.lang.Object

->jsx3.amp.ExtPoint

All Implemented Interfaces:

jsx3.util.EventDispatcher

class ExtPoint
extends jsx3.lang.Object

An AMP extension point.

Field Summary
static String	EXTENDED An event published by an extension point when it is extended by a new extension.

Method Summary
jsx3.amp.Engine	getEngine() Returns the engine owning the plug-in owning this extension point.
jsx3.$Array<jsx3.amp.Ext>	getExts() Returns the list of extensions registered with this extension point.
String	getId() Returns the full ID of this extension, which is unique among all extension points in the AMP engine.
String	getLocalId() Returns the local ID of this extension point, which is defined by the id attribute of the XML extension point declaration.
String	getName() Returns the name of this extension point, which is defined by the name attribute of the XML extension point declaration.
jsx3.amp.PlugIn	getPlugIn() Returns the plug-in declaring this extension point.
void	onExtension(arrExts : jsx3.$Array<jsx3.amp.Ext>) This method is called (after this extension point is instantiated) any time extensions are registered for this point.
jsx3.$Array<Object>	processExts(objProcessor : jsx3.amp.ExtProc \| Function, arrExt : Array<jsx3.amp.Ext>) Processes each extension of this extension point using the visitor pattern.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

EXTENDED

static String EXTENDED

An event published by an extension point when it is extended by a new extension.

Method Detail

getEngine

jsx3.amp.Engine getEngine()

Returns the engine owning the plug-in owning this extension point.

Returns:

getExts

jsx3.$Array<jsx3.amp.Ext> getExts()

Returns the list of extensions registered with this extension point.

Returns:

getId

String getId()

Returns the full ID of this extension, which is unique among all extension points in the AMP engine.

Returns:

getLocalId

String getLocalId()

Returns the local ID of this extension point, which is defined by the id attribute of the XML extension point declaration.

Returns:

getName

String getName()

Returns the name of this extension point, which is defined by the name attribute of the XML extension point declaration.

Returns:

getPlugIn

jsx3.amp.PlugIn getPlugIn()

Returns the plug-in declaring this extension point.

Returns:

onExtension

void onExtension(arrExts : jsx3.$Array<jsx3.amp.Ext>)

This method is called (after this extension point is instantiated) any time extensions are registered for this point. Subclasses may override this method to perform custom functionality but should call jsxsuper().

Parameters:

arrExts –

processExts

jsx3.$Array<Object> processExts(objProcessor : jsx3.amp.ExtProc | Function, arrExt : Array<jsx3.amp.Ext>)

Processes each extension of this extension point using the visitor pattern.

Parameters:

objProcessor – the visitor. This argument may be null if the XML declaration of this extension point specifies a processor that can be constructed with the processor factory.

arrExt – optionally, a subset of the extensions of this extension point. Only these extensions will be processed if this parameter is not empty.

Returns:

the extensions to process, defaults to all the extensions of this extension point.

jsx3.amp

class ExtProc

Object

->jsx3.lang.Object

->jsx3.amp.ExtProc

class ExtProc
extends jsx3.lang.Object

An extension processor utility class.

EVAL

static jsx3.amp.ExtProc EVAL

Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. The element should be named "eval" and the text body of the element is taken as the JavaScript to evaluate. The script is evaluated in the context of the extension object. So, for example, this.getPlugIn() grants access in the script to the plug-in defining the extension.

No value is returned from the extension processing. If the load attribute of the eval element is equal to "true" then the plug-in owning the extension is loaded before the script is evaluated. Therefore, the script may be evaluated either synchronously or asynchronously, but since there is no value returned from the processing, there is no way of knowing which one actually occurred.

RETURN

static jsx3.amp.ExtProc RETURN

The value that the script evaluates to is returned from the extension processing.

RETURN_ASYNC

static jsx3.amp.ExtProc RETURN_ASYNC

The value returned from the extension processing is an asynchronous return value as defined in the contract for jsx3.$Y(). The return value may be notified either asynchronously or synchronously, depending on whether the load attribute of the eval element is equal to "true". If it is, then the plug-in owning the extension is loaded first and then the script is evaluated asynchronously. The asynchronous return value is notified of completion with the value that the script evaluates to.

Method Detail

addProcessorFactory

static void addProcessorFactory(strType : String, fctFactory : Function)

Registers a processor factory. A processor factory is the object responsible for creating a processor when a <processor> is found as a child of an <extension-point> element. Each processor element must declare a type attribute. The factory that has been registered with the matching type is used to create the processor. The method signature of the factory method is: function(xml : jsx3.amp.XML) : jsx3.amp.ExtProc where xml is the XML representation of the <processor> element.

Parameters:

strType – the type of processor that the factory creates.

fctFactory – the factory function.

getProcessor

static void getProcessor(strType : String, xml : jsx3.amp.XML)

Creates a processor object from a <processor> element.

Parameters:

strType – the type attribute of the <processor> element.

xml – the <processor> element.

newDescrProc

static jsx3.amp.ExtProc newDescrProc(objClass : String | jsx3.lang.Class | Function)

Creates a new extension processor that creates instances of a certain class. The only requirement of the class is that is have a two-argument constructor with the signature: function init(ext : jsx3.amp.Ext, xml : jsx3.amp.XML).

The processing visitor will create a new instance of objClass for each child element of each extension. If any child element defines a ext-class attribute, this is interpreted as the fully-qualified class name of a subclass of objClass. This class, if it is defined, will be used instead of objClass to process that particular child element.

Parameters:

objClass – a class or constructor.

Returns:

process

static jsx3.$Array process(arrExt : Array<jsx3.amp.Ext>, objVisitor : Function | Object)

Processes a list of extensions using the visitor pattern. For each extension in arrExt, this method iterates over each child element of the extension declaration and invokes objVisitor for each element. At each iteration the visitor is passed as arguments the extension object and an XML object representing the child element.

Parameters:

arrExt –

objVisitor – an object that defines method process(ext : jsx3.amp.Ext, data: jsx3.amp.XML) : Object or the function itself.

Returns:

jsx3.amp

class PlugIn

Object

->jsx3.lang.Object

->jsx3.amp.PlugIn

All Implemented Interfaces:

jsx3.amp.Bindable, jsx3.net.URIResolver, jsx3.util.EventDispatcher

class PlugIn
extends jsx3.lang.Object

An AMP plug-in. A plug-in is a logical collection of application logic and resources. Plug-ins are loaded as needed and may contain extension points and extensions.

Field Summary
static String	EXTENDED Event subject published when an extension point of this plug-in has been extended.
static String	READY Event subject published when this plug-in has loaded completely.

Method Summary
void	addExt(x : jsx3.amp.Ext) Adds an extension to this plug-in programmatically.
void	addExtPoint(xp : jsx3.amp.ExtPoint) Adds an extension point to this plug-in programmatically.
jsx3.amp.Engine	getEngine() Returns the engine of this plug-in.
jsx3.$Array<String>	getEvents() Returns the list of event subjects that this plug-in declares to publish.
jsx3.amp.Ext	getExt(strId : String) Returns an extension of this plug-in by its ID.
jsx3.amp.ExtPoint	getExtPoint(strId : String) Returns an extension point of this plug-in by its ID.
jsx3.$Array<jsx3.amp.ExtPoint>	getExtPoints() Returns the extension points of this plug-in.
jsx3.$Array<jsx3.amp.Ext>	getExts() Returns the extensions of this plug-in.
String	getId() Returns the id attribute from the plug-in configuration element.
jsx3.util.Logger	getLog() Returns a logger for this plug-in.
String	getName() Returns the name attribute from the plug-in configuration element.
jsx3.$Array<String>	getRequires() Returns the list of plug-in IDs that this plug-in requires.
jsx3.amp.Resource	getResource(strId : String) Returns a resource of this plug-in by its ID.
jsx3.$Array<jsx3.amp.Resource>	getResources() Returns the resources of this plug-in that are defined in the plug-in configuration data.
jsx3.app.Server	getServer() Returns the server of the engine of this plug-in.
String	getUriPrefix() Implements jsx3.net.URIResolver.
String	getVersion() Returns the version attribute from the plug-in configuration element.
static void	isBindExpr(e : String) Returns true if e is a binding expression.
boolean	isGlobal() Returns whether this is a global plug-in.
boolean	isLoaded() Returns true is all of the resources of this plug-in have loaded.
jsx3.$AsyncRV	load() Loads this plug-in asynchronously if it is not already loaded.
jsx3.app.Model	loadRsrcComponent(strRsrcId : String \| jsx3.amp.Resource, objParent : jsx3.app.Model, bPaint : boolean) Loads the contents of a plug-in resource as a GUI component.
void	onExtension(objExtPt : jsx3.amp.ExtPoint, arrExts : Array<jsx3.amp.Ext>) Called (after this plug-in is instantiated) any time extensions are registered for an extension point of this plug-in.
void	onLoaded() Called when all the resources of this plug-in have loaded.
void	onRegister() Calls when this plug-in is registered with its engine.
void	onStartup() Called when the engine of this plug-in has completely registered all plug-ins.
void	regBindExpr(expression : String, handler : Function) Registers a function to be called when the value of a binding expression changes.
jsx3.net.URI	relativizeURI(strURI : String \| jsx3.net.URI, bRel : boolean) Implements jsx3.net.URIResolver.
void	removeExt(x : jsx3.amp.Ext) Removes an extension from this plug-in programmatically.
void	removeExtPoint(xp : jsx3.amp.ExtPoint) Removes an extension point from this plug-in programmatically.
jsx3.net.URI	resolveURI(strURI : String \| jsx3.net.URI) Implements jsx3.net.URIResolver.
void	setData(objElm : jsx3.xml.Entity) Called after this plug-in is instantiated to provide the plug-in with its XML configuration data.
void	setEngine(objEngine : jsx3.amp.Engine) Called after this plug-in is instantiated to provide the plug-in with the engine that created it.
void	setPath(strPath : String) Called after this plug-in is instantiated to provide the plug-in with its path.
void	setResources(arrRsrc : Array<jsx3.amp.Resource>) Called after this plug-in is instantiated to provide the plug-in with the resources defined in the configuration data.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.amp.Bindable
addBindableProp, getBindableProps, setBindableProp, updateBindable, updateBindableOn

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

EXTENDED

static String EXTENDED

Event subject published when an extension point of this plug-in has been extended.

READY

static String READY

Event subject published when this plug-in has loaded completely.

Method Detail

addExt

void addExt(x : jsx3.amp.Ext)

Adds an extension to this plug-in programmatically. x.getPlugIn() must return this plug-in.

Parameters:

x – the extension to add.

Since:

3.9

addExtPoint

void addExtPoint(xp : jsx3.amp.ExtPoint)

Adds an extension point to this plug-in programmatically. xp.getPlugIn() must return this plug-in.

Parameters:

xp – the extension point to add.

Since:

3.9

getEngine

jsx3.amp.Engine getEngine()

Returns the engine of this plug-in.

Returns:

getEvents

jsx3.$Array<String> getEvents()

Returns the list of event subjects that this plug-in declares to publish.

Returns:

getExt

jsx3.amp.Ext getExt(strId : String)

Returns an extension of this plug-in by its ID.

Parameters:

strId – the local ID of the extension.

Returns:

getExtPoint

jsx3.amp.ExtPoint getExtPoint(strId : String)

Returns an extension point of this plug-in by its ID.

Parameters:

strId – the local ID of the extension point.

Returns:

getExtPoints

jsx3.$Array<jsx3.amp.ExtPoint> getExtPoints()

Returns the extension points of this plug-in.

Returns:

getExts

jsx3.$Array<jsx3.amp.Ext> getExts()

Returns the extensions of this plug-in.

Returns:

getId

String getId()

Returns the id attribute from the plug-in configuration element.

Returns:

getLog

jsx3.util.Logger getLog()

Returns a logger for this plug-in.

Returns:

getName

String getName()

Returns the name attribute from the plug-in configuration element.

Returns:

getRequires

jsx3.$Array<String> getRequires()

Returns the list of plug-in IDs that this plug-in requires. These plug-ins must be loaded before this plug-in loads.

Returns:

getResource

jsx3.amp.Resource getResource(strId : String)

Returns a resource of this plug-in by its ID.

Parameters:

strId –

Returns:

getResources

jsx3.$Array<jsx3.amp.Resource> getResources()

Returns the resources of this plug-in that are defined in the plug-in configuration data.

Returns:

getServer

jsx3.app.Server getServer()

Returns the server of the engine of this plug-in.

Returns:

getUriPrefix

String getUriPrefix()

Implements jsx3.net.URIResolver.

Returns:

Overrides:

getUriPrefix in jsx3.net.URIResolver

getVersion

String getVersion()

Returns the version attribute from the plug-in configuration element.

Returns:

isBindExpr

static void isBindExpr(e : String)

Returns true if e is a binding expression. A binding expression starts with '{' and ends with '}'.

Parameters:

e –

isGlobal

boolean isGlobal()

Returns whether this is a global plug-in. A global plug-in is only instantiated once for all of the applications that register it.

Returns:

isLoaded

boolean isLoaded()

Returns true is all of the resources of this plug-in have loaded.

Returns:

load

asynchronous jsx3.$AsyncRV load()

Loads this plug-in asynchronously if it is not already loaded.

Returns:

loadRsrcComponent

jsx3.app.Model loadRsrcComponent(strRsrcId : String | jsx3.amp.Resource, objParent : jsx3.app.Model, bPaint : boolean)

Loads the contents of a plug-in resource as a GUI component. The resource should be an XML resource whose data is a GI component file. The resource must be already loaded to call this method. This method loads the component with this plug-in as the URI resolver. Therefore, any relative paths in the component will be resolved relative to the directory of this plug-in.

Once the component is loaded, this method defines a getPlugIn() method on the root component object that returns this component. In addition, if the root component object defines an onRsrcLoad() method, that method is called.

Parameters:

strRsrcId –

objParent – the GUI component into which to load the resource.

bPaint – whether to paint the loaded resource (default is true).

Returns:

the loaded component.

onExtension

void onExtension(objExtPt : jsx3.amp.ExtPoint, arrExts : Array<jsx3.amp.Ext>)

Called (after this plug-in is instantiated) any time extensions are registered for an extension point of this plug-in. Subclasses may override this method to provide custom behavior but should call jsxsuper to ensure that the EXTENDED event is published.

Parameters:

objExtPt –

arrExts –

onLoaded

void onLoaded()

Called when all the resources of this plug-in have loaded. Subclasses may override this method to provide custom behavior.

onRegister

void onRegister()

Calls when this plug-in is registered with its engine. Subclasses may override this method to provide custom behavior.

onStartup

void onStartup()

Called when the engine of this plug-in has completely registered all plug-ins. Subclasses may override this method to provide custom behavior.

regBindExpr

void regBindExpr(expression : String, handler : Function)

Registers a function to be called when the value of a binding expression changes.

The binding expression should begin with a '{' and end with a '}'. The expression is parsed for any tokens that match a bindable property of this object. handler will be invoked any time one of these bindable properties changes value. This function is passed the value of the binding expression. The binding expression is evaluated in the context of this object. The "this" keyword is optional in the expression because the expression is evaluated inside of a with block.

Parameters:

expression – a valid binding expression.

handler –

relativizeURI

jsx3.net.URI relativizeURI(strURI : String | jsx3.net.URI, bRel : boolean)

Implements jsx3.net.URIResolver.

Parameters:

strURI –

bRel –

Returns:

Overrides:

relativizeURI in jsx3.net.URIResolver

removeExt

void removeExt(x : jsx3.amp.Ext)

Removes an extension from this plug-in programmatically. x must be an extension of this plug-in.

Parameters:

x – the extension of this plug-in to remove.

Since:

3.9

removeExtPoint

void removeExtPoint(xp : jsx3.amp.ExtPoint)

Removes an extension point from this plug-in programmatically. xp must be an extension point of this plug-in.

Parameters:

xp – the extension point of this plug-in to remove.

Since:

3.9

resolveURI

jsx3.net.URI resolveURI(strURI : String | jsx3.net.URI)

Implements jsx3.net.URIResolver.

Parameters:

strURI –

Returns:

Overrides:

resolveURI in jsx3.net.URIResolver

setData

void setData(objElm : jsx3.xml.Entity)

Called after this plug-in is instantiated to provide the plug-in with its XML configuration data. This method is optional for objects used as plug-ins.

Parameters:

objElm –

setEngine

void setEngine(objEngine : jsx3.amp.Engine)

Called after this plug-in is instantiated to provide the plug-in with the engine that created it. This method is optional for objects used as plug-ins.

Parameters:

objEngine –

setPath

void setPath(strPath : String)

Called after this plug-in is instantiated to provide the plug-in with its path. This method is optional for objects used as plug-ins.

Parameters:

strPath –

setResources

void setResources(arrRsrc : Array<jsx3.amp.Resource>)

Called after this plug-in is instantiated to provide the plug-in with the resources defined in the configuration data. This method is optional for objects used as plug-ins.

Parameters:

arrRsrc –

jsx3.amp

class Resource

Object

->jsx3.lang.Object

->jsx3.amp.Resource

All Implemented Interfaces:

jsx3.util.EventDispatcher

class Resource
extends jsx3.lang.Object

An AMP plug-in resource, such as a JavaScript file or XML file.

Field Summary
static String	LOAD_EARLY Loads a resource before the plug-in is instantiated and registered.
static String	LOAD_MANUAL Waits for a resource to be loaded programatically some time after the plug-in loads.
static String	LOAD_NORMAL Loads a resource before the plug-in loads.
static String	READY Event subject published when this resource has loaded.
static String	TYPE_BUNDLE
static String	TYPE_CSS
static String	TYPE_JSS
static String	TYPE_SCRIPT
static String	TYPE_XML
static String	TYPE_XSL

Constructor Summary
void	init(objPlugIn : jsx3.amp.PlugIn, strId : String, elm : jsx3.xml.Element)

Method Summary
void	attr(k : String) Returns the value of any attribute of the XML declaration of this resource.
jsx3.xml.Document \| jsx3.app.Properties \| jsx3.app.PropsBundle	getData(bClear : boolean) Returns the data associated with this resource.
String	getId() Returns the full ID of this resource, which is unique to the entire AMP engine.
String	getLoadType() Returns the load type, such as LOAD_NORMAL.
String	getLocalId() Returns the ID Of this resource, which is unique among all resources of the same plug-in.
Array<String>	getLocales() Returns the list of locale keys for which this resources is localized.
String	getPath() Returns the path of this resource, which is relative to the directory of the plug-in owning this resource.
String	getPathForLocale(objLocale : jsx3.util.Locale) Returns the path of the best localized version of this resource for objLocale.
jsx3.amp.PlugIn	getPlugIn() Returns the plug-in that owns this resource.
String	getType() Returns the resource type, such as TYPE_SCRIPT.
boolean	isLoaded()
jsx3.$AsyncRV	load() Asynchronously loads this resource if it is not already loaded.
jsx3.$AsyncRV	loaded() Returns an asynchronous return value that completes when this resource is loaded.
jsx3.xml.Entity	xml() Returns the XML declaration of this resource as passed to the constructor.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

LOAD_EARLY

static String LOAD_EARLY

Loads a resource before the plug-in is instantiated and registered.

LOAD_MANUAL

static String LOAD_MANUAL

Waits for a resource to be loaded programatically some time after the plug-in loads.

LOAD_NORMAL

static String LOAD_NORMAL

Loads a resource before the plug-in loads.

READY

static String READY

Event subject published when this resource has loaded.

TYPE_BUNDLE

static final String TYPE_BUNDLE

TYPE_CSS

static final String TYPE_CSS

TYPE_JSS

static final String TYPE_JSS

TYPE_SCRIPT

static final String TYPE_SCRIPT

TYPE_XML

static final String TYPE_XML

TYPE_XSL

static final String TYPE_XSL

Constructor Detail

init

void init(objPlugIn : jsx3.amp.PlugIn, strId : String, elm : jsx3.xml.Element)

Parameters:

objPlugIn – the plug-in owning the resource.

strId – the ID of the resource. This ID is unique among all resources of the same plug-in.

elm – the XML declaration of the resource.

Method Detail

attr

void attr(k : String)

Returns the value of any attribute of the XML declaration of this resource.

Parameters:

k – the attribute name.

getData

jsx3.xml.Document | jsx3.app.Properties | jsx3.app.PropsBundle getData(bClear : boolean)

Returns the data associated with this resource. Only resources of type xml, xsl, jss, and propsbundle will return a defined value.

Parameters:

bClear – if true then delete the reference to the data object in order to allow garbage collection.

Returns:

getId

String getId()

Returns the full ID of this resource, which is unique to the entire AMP engine.

Returns:

getLoadType

String getLoadType()

Returns the load type, such as LOAD_NORMAL. The load type is defined using the load attribute of the resource XML declaration.

Returns:

getLocalId

String getLocalId()

Returns the ID Of this resource, which is unique among all resources of the same plug-in.

Returns:

getLocales

Array<String> getLocales()

Returns the list of locale keys for which this resources is localized. This is equal to the locales attribute of the resource, split by whitespace.

Returns:

getPath

String getPath()

Returns the path of this resource, which is relative to the directory of the plug-in owning this resource. The resource type is defined by the id attribute of the resource XML declaration.

Returns:

getPathForLocale

String getPathForLocale(objLocale : jsx3.util.Locale)

Returns the path of the best localized version of this resource for objLocale.

Parameters:

objLocale –

Returns:

getPlugIn

jsx3.amp.PlugIn getPlugIn()

Returns the plug-in that owns this resource.

Returns:

getType

String getType()

Returns the resource type, such as TYPE_SCRIPT. The resource type is defined by the element node name of the resource XML declaration.

Returns:

isLoaded

boolean isLoaded()

Returns:

load

asynchronous jsx3.$AsyncRV load()

Asynchronously loads this resource if it is not already loaded.

Returns:

loaded

asynchronous jsx3.$AsyncRV loaded()

Returns an asynchronous return value that completes when this resource is loaded.

Returns:

xml

jsx3.xml.Entity xml()

Returns the XML declaration of this resource as passed to the constructor.

Returns:

jsx3.amp

class XML

Object

->jsx3.lang.Object

->jsx3.amp.XML

class XML
extends jsx3.lang.Object

An XML wrapper that can be backed either by a real XML node or by a nested object structure.

To wrap a nested object structure, pass an object to the constructor with the following format:

Every element has a name() property equal to the base node name
Every element has a children() property that is an array of nested objects
Every attribute of an element corresponds to a property whose name is "@" prepended to the attribute name
Every nested child element is stored in the children() property and is also referended by another property whose name is "/" prepended to the base node name of the child element.

Constructor Summary
void	init(elm : jsx3.xml.Entity \| Object)

Method Summary
String	attr(a : String) Returns an attribute of this element.
jsx3.amp.XML	child(name : String) Returns a child element of this element whose base name is equal to name.
jsx3.$Array<jsx3.amp.XML>	children() Returns this child elements of this element.
String	nname() Returns the base name of this element.
String	value() Returns the node value of this element.

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Constructor Detail

init

void init(elm : jsx3.xml.Entity | Object)

Parameters:

elm –

Method Detail

attr

String attr(a : String)

Returns an attribute of this element.

Parameters:

a – the name of the attribute.

Returns:

the value of the attribute.

child

jsx3.amp.XML child(name : String)

Returns a child element of this element whose base name is equal to name.

Parameters:

name –

Returns:

children

jsx3.$Array<jsx3.amp.XML> children()

Returns this child elements of this element.

Returns:

nname

String nname()

Returns the base name of this element.

Returns:

the base name.

value

String value()

Returns the node value of this element.

Returns:

package jsx3.amp.util

The standard library of AMP application utility classes. Classes in this package are loaded via AMP plug-ins.

Since:

3.7

Class Summary
jsx3.amp.util.Menu	A managed menu.
jsx3.amp.util.MenuItem	A managed menu item.
jsx3.amp.util.MenuManager	Manages a set of menus.
jsx3.amp.util.Prefs	A preferences panel.
jsx3.amp.util.PrefsPane	A pane in a preferences panel.
jsx3.amp.util.ToolbarItem	Manages a toolbar.
jsx3.amp.util.ToolbarManager	Manages a toolbar.
jsx3.amp.util.Wizard	A wizard.
jsx3.amp.util.WizardPane	A pane of a wizard.

jsx3.amp.util

class Menu

Object

->jsx3.lang.Object

->jsx3.amp.util.MenuItem

->jsx3.amp.util.Menu

class Menu
extends jsx3.amp.util.MenuItem

A managed menu. Provided by the jsx3.amp.util.menumgr plug-in.

init

void init(objExt : jsx3.amp.Ext, objElm : jsx3.amp.XML)

The instance initializer.

Parameters:

objExt –

objElm –

Method Detail

addItem

void addItem(objItem : jsx3.amp.util.MenuItem, strSection : String)

Adds an item to this menu.

Parameters:

objItem – the item to add.

strSection – the section ID.

addSection

void addSection(strId : String, bDivider : boolean)

Adds a logical section to this menu.

Parameters:

strId – the section ID.

bDivider – whether the section begins with a visual dividing line.

getId

String getId()

Returns the ID of this menu.

Returns:

Overrides:

getId in jsx3.amp.util.MenuItem

getItem

jsx3.amp.util.MenuItem getItem(id : String)

Returns the item in this menu whose ID is equal to id.

Parameters:

id –

Returns:

getItems

jsx3.$Array<jsx3.amp.util.MenuItem> getItems()

Returns all items in this menu.

Returns:

getNativeMenu

jsx3.gui.Menu getNativeMenu()

Returns the native GI menu that was rendered for this AMP menu.

Returns:

getPath

String getPath()

Returns the path of this menu.

Returns:

Overrides:

getPath in jsx3.amp.util.MenuItem

getXML

jsx3.xml.Document getXML()

Returns the CDF data source for this menu. If this is a nested menu then this XML will be inserted into the XML document of the base GI Menu.

This method is the bridge between the object-oriented AMP definition of a menu and the XML-based GI definition of a menu.

Returns:

onShow

void onShow(objMenu : jsx3.gui.Menu, objElm : jsx3.xml.Entity)

Called just before this menu is expanded. This method may modify any of the XML inside objElm, for example by enabling or selecting menu items or generating menu items on the fly.

Parameters:

objMenu –

objElm –

jsx3.amp.util

class MenuItem

Object

->jsx3.lang.Object

->jsx3.amp.util.MenuItem

Direct Known Subclasses:

jsx3.amp.util.Menu

class MenuItem
extends jsx3.lang.Object

A managed menu item. Provided by the jsx3.amp.util.menumgr plug-in.

init

void init(objExt : jsx3.amp.Ext, objData : jsx3.amp.XML)

The instance initializer.

Parameters:

objExt –

objData –

Method Detail

attr

String attr(strKey : String)

Returns an attribute of the XML declaration of this menu item.

Parameters:

strKey –

Returns:

execute

void execute()

Executes this menu item. If the execute attribute is not empty then the plug-in that declared this menu item is loaded. Once the plug-in loads the contents of the execute attribute are execute in the context of the extension that defined this menu item.

getExt

jsx3.amp.Ext getExt()

Returns the extension that defined this menu item.

Returns:

getHotKey

String getHotKey()

Returns the accelerator key code of this menu item.

Returns:

getId

String getId()

Returns the full ID of this menu item.

Returns:

getImg

String getImg()

Returns the resolved image path of this item.

Returns:

getLabel

String getLabel()

Returns the label of this menu item.

Returns:

getMenu

jsx3.amp.util.Menu getMenu()

Returns the menu that contains this menu item.

Returns:

getPath

String getPath()

Returns the path of this menu item.

Returns:

getRootMenu

jsx3.amp.util.Menu getRootMenu()

Returns:

getTip

String getTip()

Returns the tip of this menu item.

Returns:

isEnabled

boolean isEnabled()

Returns whether this menu item is enabled. This implementation interprets bind expressions in the enabled attribute of the item definition. Otherwise this method returns true.

Returns:

isSelected

boolean isSelected()

Returns whether this menu item is selected. This implementation interprets bind expressions in the selected attribute of the item definition. Otherwise this method returns false.

Returns:

jsx3.amp.util

class MenuManager

Object

->jsx3.lang.Object

->jsx3.amp.util.MenuManager

class MenuManager
extends jsx3.lang.Object

Manages a set of menus. Provided by the jsx3.amp.util.menumgr plug-in.

Constructor Summary
void	init() The instance initializer.

Method Summary
void	addItem(objItem : jsx3.amp.util.MenuItem) Adds a menu item to this manager.
void	addMenu(objMenu : jsx3.amp.util.Menu) Adds a menu to this manager.
void	addMenuBar(strPath : String, objContainer : jsx3.app.Model) Adds a menu bar to this manager.
void	finishInit() Paints all the menus in this manager into their respective menu bars.
void	getMenu(strPath : String) Returns the menu with full path strPath.
jsx3.$Array<jsx3.amp.util.Menu>	getMenus() Returns all the menus in this manager.

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Constructor Detail

init

void init()

The instance initializer.

Method Detail

addItem

void addItem(objItem : jsx3.amp.util.MenuItem)

Adds a menu item to this manager.

Parameters:

objItem –

addMenu

void addMenu(objMenu : jsx3.amp.util.Menu)

Adds a menu to this manager.

Parameters:

objMenu –

addMenuBar

void addMenuBar(strPath : String, objContainer : jsx3.app.Model)

Adds a menu bar to this manager. Any menu encountered at strPath will be inserted into the menu bar.

Parameters:

strPath – the menu bar path.

objContainer – the menu bar GUI object.

finishInit

void finishInit()

Paints all the menus in this manager into their respective menu bars.

getMenu

void getMenu(strPath : String)

Returns the menu with full path strPath.

Parameters:

strPath –

getMenus

jsx3.$Array<jsx3.amp.util.Menu> getMenus()

Returns all the menus in this manager.

Returns:

jsx3.amp.util

class Prefs

Object

->jsx3.lang.Object

->jsx3.amp.util.Prefs

All Implemented Interfaces:

jsx3.util.EventDispatcher

class Prefs
extends jsx3.lang.Object

A preferences panel. Provided by the jsx3.amp.util.prefspanel plug-in.

Field Summary
static String	SAVE Event subject published when a preferences panel is saved.
static String	SWITCH Event subject published when the active pane of a preferences panel is changed.
static String	UNLOAD Event subject published when a preferences panel is closed.

Constructor Summary
void	init() The instance initializer.

Method Summary
void	addPane(objPane : jsx3.amp.util.PrefsPane) Adds a prefs pane to this controller.
void	apply() Saves the state of the current pane.
boolean	getCollapse() Returns whether to collapse the left side pane list.
void	renderIn(objParent : jsx3.gui.Model, intPaneToShow : int \| jsx3.amp.util.PrefsPane) Renders the preferences panel in objParent.
void	save() Saves the state of the current pane and closes this panel.
void	setCollapse(bCollapse : boolean) Sets whether to collapse the left side pane list.
jsx3.$AsyncRV	showPane(objPane : jsx3.amp.util.PrefsPane \| int, bForce : boolean) Displays a prefs pane in the edit area.
jsx3.$AsyncRV	unload(bForce : boolean) Removes this preferences panel from the view.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

SAVE

static String SAVE

Event subject published when a preferences panel is saved.

SWITCH

static String SWITCH

Event subject published when the active pane of a preferences panel is changed.

UNLOAD

static String UNLOAD

Event subject published when a preferences panel is closed.

Constructor Detail

init

void init()

The instance initializer.

Method Detail

addPane

void addPane(objPane : jsx3.amp.util.PrefsPane)

Adds a prefs pane to this controller. This method may be called either before or after renderIn() has been called.

Parameters:

objPane – the pane to add.

apply

void apply()

Saves the state of the current pane.

getCollapse

boolean getCollapse()

Returns whether to collapse the left side pane list.

Returns:

renderIn

void renderIn(objParent : jsx3.gui.Model, intPaneToShow : int | jsx3.amp.util.PrefsPane)

Renders the preferences panel in objParent.

Parameters:

objParent – the parent to load this panel into.

intPaneToShow – optionally, the pane to reveal initially.

save

void save()

Saves the state of the current pane and closes this panel.

setCollapse

void setCollapse(bCollapse : boolean)

Sets whether to collapse the left side pane list.

Parameters:

bCollapse –

showPane

asynchronous jsx3.$AsyncRV showPane(objPane : jsx3.amp.util.PrefsPane | int, bForce : boolean)

Displays a prefs pane in the edit area. Unloads the current prefs pane if necessary. If the current prefs pane is dirty, the user will be prompted to save or discard changes before the prefs pane is switched.

The asynchronous return value is true only if the pane was shown successfully.

Parameters:

objPane – the pane to switch to.

bForce – if true, the current pane is unloaded without saving changes.

Returns:

unload

asynchronous jsx3.$AsyncRV unload(bForce : boolean)

Removes this preferences panel from the view.

The asynchronous return value is true only if the preferences panel was unloaded successfully.

Parameters:

bForce – whether to force the removal even if there are unsaved changes.

Returns:

jsx3.amp.util

class PrefsPane

Object

->jsx3.lang.Object

->jsx3.amp.util.PrefsPane

All Implemented Interfaces:

jsx3.util.EventDispatcher

class PrefsPane
extends jsx3.lang.Object

A pane in a preferences panel. Provided by the jsx3.amp.util.prefspanel plug-in.

Field Summary
static String	DIRTIED Event subject published when the state of a preference pane is dirtied.
static String	SAVED Event subject published when a preference pane is saved.

Constructor Summary
void	init(ext : jsx3.amp.Ext, obj : jsx3.amp.XML) The instance initializer.

Method Summary
String	getDescription() Returns the description of this pane.
jsx3.app.Model	getFirstResponder() Returns the object in the UI of this pane that should get focus when this pane is first revealed.
String	getImage() Returns the resolved path of the image of this pane.
Object	getProperty(strId : String) Returns an arbitrary property of this pane.
String	getTitle() Returns the title of this pane.
jsx3.app.Model	getUI() Returns the root component of this pane once it is rendered.
boolean	isDirty() Returns whether this pane has unsaved changes.
jsx3.$AsyncRV	save() Saves the state of this pane.
void	setDirty(bDirty : boolean) Sets whether this pane has unsaved changes.
void	setProperty(strId : String, objValue : Object) Sets an arbitrary property of this pane.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

DIRTIED

static String DIRTIED

Event subject published when the state of a preference pane is dirtied.

SAVED

static String SAVED

Event subject published when a preference pane is saved.

Constructor Detail

init

void init(ext : jsx3.amp.Ext, obj : jsx3.amp.XML)

The instance initializer. The obj parameter must define an attribute, resource, which is the name of an XML resource of ext. This resource will be loaded as the UI component of this pane. The root object of this component file may define the following methods:

getFirstResponder() : jsx3.app.Model — returns the object that should be focused when the pane is revealed.
loadPrefs() : void — restores the state of the pane before it is revealed.
savePrefs() : void | Object{title, message} — saves the state of the pane and optionally returns a title and message to be shown in an alert dialog.

Parameters:

ext – the AMP extension declaring this pane.

obj – the XML declaration of the extension.

Method Detail

getDescription

String getDescription()

Returns the description of this pane.

Returns:

getFirstResponder

jsx3.app.Model getFirstResponder()

Returns the object in the UI of this pane that should get focus when this pane is first revealed. This method delegates to the method getFirstResponder() of the root UI component for this pane, if that method is defined.

Returns:

getImage

String getImage()

Returns the resolved path of the image of this pane.

Returns:

getProperty

Object getProperty(strId : String)

Returns an arbitrary property of this pane.

Parameters:

strId –

Returns:

getTitle

String getTitle()

Returns the title of this pane.

Returns:

getUI

jsx3.app.Model getUI()

Returns the root component of this pane once it is rendered.

Returns:

isDirty

boolean isDirty()

Returns whether this pane has unsaved changes.

Returns:

save

asynchronous jsx3.$AsyncRV save()

Saves the state of this pane. This method delegates to the savePrefs() method of the root UI component of this pane.

Returns:

setDirty

void setDirty(bDirty : boolean)

Sets whether this pane has unsaved changes.

Parameters:

bDirty –

setProperty

void setProperty(strId : String, objValue : Object)

Sets an arbitrary property of this pane. This method may be used for saving state.

Parameters:

strId –

objValue –

jsx3.amp.util

class ToolbarItem

Object

->jsx3.lang.Object

->jsx3.amp.util.ToolbarItem

class ToolbarItem
extends jsx3.lang.Object

Manages a toolbar. Provided by the jsx3.amp.util.toolbarmgr plug-in.

Constructor Summary
void	init(ext : jsx3.amp.Ext, xml : jsx3.amp.Xml) The instance initializer.

Method Summary
String	getImg() Returns the resolved image path of this toolbar item.
String	getSection() Returns the section of this toolbar item.
String	getTip() Returns the tip of this toolbar item.

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Constructor Detail

init

void init(ext : jsx3.amp.Ext, xml : jsx3.amp.Xml)

The instance initializer.

Parameters:

ext –

xml –

Method Detail

getImg

String getImg()

Returns the resolved image path of this toolbar item.

Returns:

getSection

String getSection()

Returns the section of this toolbar item.

Returns:

getTip

String getTip()

Returns the tip of this toolbar item.

Returns:

jsx3.amp.util

class ToolbarManager

Object

->jsx3.lang.Object

->jsx3.amp.util.ToolbarManager

class ToolbarManager
extends jsx3.lang.Object

Manages a toolbar. Provided by the jsx3.amp.util.toolbarmgr plug-in.

Constructor Summary
void	init(objToolbar : jsx3.gui.WindowBar) The instance initializer.

Method Summary
void	addItem(objItem : jsx3.amp.util.ToolbarItem)
void	addSection(strName : String, bDivider : boolean)

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Constructor Detail

init

void init(objToolbar : jsx3.gui.WindowBar)

The instance initializer.

Parameters:

objToolbar –

Method Detail

addItem

void addItem(objItem : jsx3.amp.util.ToolbarItem)

Parameters:

objItem –

addSection

void addSection(strName : String, bDivider : boolean)

Parameters:

strName –

bDivider –

jsx3.amp.util

class Wizard

Object

->jsx3.lang.Object

->jsx3.amp.util.Wizard

All Implemented Interfaces:

jsx3.util.EventDispatcher

class Wizard
extends jsx3.lang.Object

A wizard. Provided by the jsx3.amp.util.wizard plug-in.

Field Summary
static String	CANCEL Event subject published when a wizard is cancelled.
static String	FINISH Event subject published when a wizard is finished.
static String	NEXT Event subject published when a wizard advances to the next pane.
static String	PREVIOUS Event subject published when a wizard advances to the previous pane.

Constructor Summary
void	init() The instance initializer.

Method Summary
void	addPane(p : jsx3.amp.util.WizardPane) Adds a pane to this wizard.
void	cancel() Invokes the cancel button.
void	finish() Invokes the finish button.
jsx3.amp.util.WizardPane	getPane(index : int) Returns a pane of this wizard by its index.
int	getPaneCount() Returns the number of panes in this wizard.
int	getPaneIndex(p : jsx3.amp.util.WizardPane) Returns the index of a pane of this wizard.
Object	getSession() Returns the wizard session object.
void	next() Invokes the next button.
void	previous() Invokes the previous button.
void	removePane(index : int) Removes a pane from this wizard by its list index.
void	renderIn(objContainer : jsx3.app.Model) Renders the wizard UI as a child of objContainer.
void	setButtonState(previous : boolean, next : boolean, finish : boolean, cancel : boolean) Updates the enabled button states of the four wizard buttons.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

CANCEL

static String CANCEL

Event subject published when a wizard is cancelled.

FINISH

static String FINISH

Event subject published when a wizard is finished.

static String NEXT

Event subject published when a wizard advances to the next pane.

static String PREVIOUS

Event subject published when a wizard advances to the previous pane.

Constructor Detail

init

void init()

The instance initializer.

Method Detail

addPane

void addPane(p : jsx3.amp.util.WizardPane)

Adds a pane to this wizard.

Parameters:

p –

cancel

void cancel()

Invokes the cancel button.

finish

void finish()

Invokes the finish button.

getPane

jsx3.amp.util.WizardPane getPane(index : int)

Returns a pane of this wizard by its index.

Parameters:

index –

Returns:

getPaneCount

int getPaneCount()

Returns the number of panes in this wizard.

Returns:

getPaneIndex

int getPaneIndex(p : jsx3.amp.util.WizardPane)

Returns the index of a pane of this wizard.

Parameters:

p –

Returns:

getSession

Object getSession()

Returns the wizard session object. The session can be used by wizard panes to store arbitrary data for the duration of the wizard.

Returns:

void next()

Invokes the next button.

void previous()

Invokes the previous button.

removePane

void removePane(index : int)

Removes a pane from this wizard by its list index.

Parameters:

index –

renderIn

void renderIn(objContainer : jsx3.app.Model)

Renders the wizard UI as a child of objContainer.

Parameters:

objContainer –

setButtonState

void setButtonState(previous : boolean, next : boolean, finish : boolean, cancel : boolean)

Updates the enabled button states of the four wizard buttons.

Parameters:

previous –

next –

finish –

cancel –

jsx3.amp.util

class WizardPane

Object

->jsx3.lang.Object

->jsx3.amp.util.WizardPane

All Implemented Interfaces:

jsx3.util.EventDispatcher

class WizardPane
extends jsx3.lang.Object

A pane of a wizard. Provided by the jsx3.amp.util.wizard plug-in.

Constructor Summary
jsx3.app.Model	init(data : jsx3.xml.Entity \| jsx3.amp.Resource, resolver : jsx3.amp.PlugIn) The instance initializer.

Method Summary
jsx3.app.Model	getFirstResponder() Returns the object in the UI of this pane that should be focused when the pane is revealed.
String	getTitle() Returns the title of this pane.
jsx3.app.Model	getUI() Returns the root UI component of this pane once it has been rendered.
jsx3.amp.util.Wizard	getWizard() Returns the wizard owning this pane.
boolean	mayCancel() Returns true if the cancel button should be enabled.
boolean	mayFinish() Returns true if the finish button should be enabled.
boolean	mayNext() Returns true if the next button should be enabled.
boolean	mayPrevious() Returns true if the previous button should be enabled.
void	onEnter(objSession : Object) Called when this pane is revealed.
void	onExit(objSession : Object) Called when this pane is hidden.
void	onNext() Called when the UI requests continuing to the next pane.
void	onPrevious() Called when the UI requests backtracking to the previous pane.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Constructor Detail

init

jsx3.app.Model init(data : jsx3.xml.Entity | jsx3.amp.Resource, resolver : jsx3.amp.PlugIn)

The instance initializer.

Parameters:

data – the UI component that renders this pane.

resolver – the plug-in against which to resolve paths in the UI component.

Returns:

Method Detail

getFirstResponder

jsx3.app.Model getFirstResponder()

Returns the object in the UI of this pane that should be focused when the pane is revealed. This method delegates to the getFirstResponder() method of the UI component, if that method is defined.

Returns:

getTitle

String getTitle()

Returns the title of this pane.

Returns:

getUI

jsx3.app.Model getUI()

Returns the root UI component of this pane once it has been rendered.

Returns:

getWizard

jsx3.amp.util.Wizard getWizard()

Returns the wizard owning this pane.

Returns:

mayCancel

boolean mayCancel()

Returns true if the cancel button should be enabled.

Returns:

mayFinish

boolean mayFinish()

Returns true if the finish button should be enabled.

Returns:

mayNext

boolean mayNext()

Returns true if the next button should be enabled.

Returns:

mayPrevious

boolean mayPrevious()

Returns true if the previous button should be enabled.

Returns:

onEnter

void onEnter(objSession : Object)

Called when this pane is revealed. Calls the onReveal() method of the root UI component, if that method is defined.

Parameters:

objSession –

onExit

void onExit(objSession : Object)

Called when this pane is hidden. Calls the onConceal() method of the root UI component, if that method is defined.

Parameters:

objSession –

onNext

void onNext()

Called when the UI requests continuing to the next pane. This pane may veto such a change by returning an object with the ok field equal to false.

Returns:

{ok:Boolean, alert:Boolean, title:String, message:String}

onPrevious

void onPrevious()

Called when the UI requests backtracking to the previous pane. This pane may veto such a change by returning an object with the ok field equal to false.

Returns:

{ok:Boolean, alert:Boolean, title:String, message:String}

package jsx3.app

Application layer classes.

Class Summary
jsx3.app.AddIn	A class that represents a JSX add-in.
jsx3.app.Cache	Provides cached access to XML and XSL data.
jsx3.app.DOM	Registers all DOM nodes in an instance of jsx3.app.Server and publishes related events.
jsx3.app.Model	The abstract base class that defines the JSX DOM.
jsx3.app.Monitor	A logging handler that can be instantiated per JSX application and displays logging messages in a separate browser window while an application is running.
jsx3.app.Properties	Represents a repository of dynamic properties.
jsx3.app.PropsBundle	A subclass of jsx3.app.Properties that supports localized properties.
jsx3.app.Server	The controller of the JSX architecture.
jsx3.app.Settings	An object oriented interface onto the XML system settings format.
jsx3.app.UserSettings	Read-Write per-User settings for a particular GI application (server).

jsx3.app

class AddIn

Object

->jsx3.lang.Object

->jsx3.app.AddIn

All Implemented Interfaces:

jsx3.net.URIResolver

class AddIn
extends jsx3.lang.Object

A class that represents a JSX add-in. The JSX system creates an instance of this class for every add-in that is loaded.

Since:

3.2

Field Summary
static String	PROTOTYPES_DIR

Method Summary
String	getDescription()
String	getId()
String	getKey()
String	getName()
jsx3.app.Settings	getSettings()
String	getUriPrefix()
String	getVersion()
jsx3.net.URI	relativizeURI(strURI : String \| jsx3.net.URI, bRel : ?)
jsx3.net.URI	resolveURI(strURI : String \| jsx3.net.URI)
String	toString()

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf

Field Detail

PROTOTYPES_DIR

static final String PROTOTYPES_DIR

Method Detail

getDescription

String getDescription()

Returns:

getId

String getId()

Returns:

getKey

String getKey()

Returns:

getName

String getName()

Returns:

getSettings

jsx3.app.Settings getSettings()

Returns:

getUriPrefix

String getUriPrefix()

Returns:

Overrides:

getUriPrefix in jsx3.net.URIResolver

getVersion

String getVersion()

Returns:

relativizeURI

jsx3.net.URI relativizeURI(strURI : String | jsx3.net.URI, bRel : ?)

Parameters:

strURI –

bRel –

Returns:

Overrides:

relativizeURI in jsx3.net.URIResolver

resolveURI

jsx3.net.URI resolveURI(strURI : String | jsx3.net.URI)

Parameters:

strURI –

Returns:

Overrides:

resolveURI in jsx3.net.URIResolver

toString

String toString()

Returns:

Overrides:

toString in jsx3.lang.Object

jsx3.app

class Cache

Object

->jsx3.lang.Object

->jsx3.app.Cache

All Implemented Interfaces:

jsx3.util.EventDispatcher

class Cache
extends jsx3.lang.Object

Provides cached access to XML and XSL data.

Events

Cache instances publish two types of events for every operation that modifies the contents of the cache. The schemas of the two event types are

subject - Cache.CHANGE
id or ids - the ID or array of IDs of the modified documents
action - Cache.ADD, Cache.CHANGE or Cache.REMOVE

and

subject - the cache ID of the modified document
action - Cache.ADD, Cache.CHANGE or Cache.REMOVE

Asynchronous Loading

Cache documents can be loaded asychronously with the getOrOpenAsync() method. This method returns the corresponding document synchronously if it already exists in the cache. If the document does not exist in the cache, then it is loaded asynchronously and the method returns a placeholder document. The namespace URI of this placeholder document is Cache.XSDNS and its root node name is "loading".

Since the cache stores this placeholder document until the document finishes loading, subsequent calls to synchronous APIs (getDocument(), getOrOpenDocument(), etc) may also return the placeholder document. It is therefore important to check the namespace of the returned document when any code uses the asynchronous APIs.

Once a document finishes loading asynchronously the placeholder document is replaced with the loaded document. This change in value causes the cache to publish a pair of events of action Cache.CHANGE. If loading the document fails or times out the placeholder document is instead replaced with another placeholder document. This document also has a URI namespace of Cache.XSDNS. Its root node name may be either "error" or "timeout". If the root node name is "error" then the root node has an attribute, also named "error", which contains the XML error message.

Field Summary
static String	ADD Event action.
static int	ASYNC_TIMEOUT The number of milliseconds before asynchronous document loads time out.
static String	CHANGE Event subject and action.
static String	REMOVE Event action.
static String	XSDNS

Constructor Summary
void	init() Creates a new instance of this class.

Method Summary
jsx3.xml.Document	clearById(strId : String) Removes the document stored in this cache under id strId.
Array<String>	clearByTimestamp(intTimestamp : int \| Date) Removes all documents placed in this cache before intTimestamp.
void	destroy() Removes all references to documents contained in this cache.
jsx3.xml.Document	getDocument(strId : String) Returns the document stored in this cache under id strId.
jsx3.xml.Document	getOrOpenAsync(strURL : String \| jsx3.net.URI, strId : String, objClass : jsx3.lang.Class) Asynchronously loads an xml document and stores it in this cache.
jsx3.xml.Document	getOrOpenDocument(strURL : String \| jsx3.net.URI, strId : String, objClass : jsx3.lang.Class) Retrieves a document from this cache or, if this cache contains no such document, loads the document synchronously and returns it.
int	getTimestamp(strId : String) Returns the timestamp from when the document stored under id strId was stored in this cache.
boolean	isSystem(strId : String) Deprecated.
Array<String>	keys() Returns a list of all the keys in this cache instance.
jsx3.xml.Document	openDocument(strURL : String \| jsx3.net.URI, strId : String, objClass : jsx3.lang.Class) Synchronously loads an xml document, stores it in this cache, and returns the loaded document.
void	setDocument(strId : String, objDocument : jsx3.xml.Document) Stores the document objDocument in this cache under id strId.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

ADD

static final String ADD

Event action.

ASYNC_TIMEOUT

static int ASYNC_TIMEOUT

The number of milliseconds before asynchronous document loads time out.

CHANGE

static final String CHANGE

Event subject and action.

REMOVE

static final String REMOVE

Event action.

XSDNS

static String XSDNS

Constructor Detail

init

void init()

Creates a new instance of this class.

Method Detail

clearById

jsx3.xml.Document clearById(strId : String)

Removes the document stored in this cache under id strId.

Parameters:

strId –

Returns:

the remove document, if any.

clearByTimestamp

Array<String> clearByTimestamp(intTimestamp : int | Date)

Removes all documents placed in this cache before intTimestamp.

Parameters:

intTimestamp – epoch seconds or a date object.

Returns:

the ids of the removed documents.

destroy

void destroy()

Removes all references to documents contained in this cache. This cache is no longer usable after calling this method.

getDocument

jsx3.xml.Document getDocument(strId : String)

Returns the document stored in this cache under id strId.

Parameters:

strId –

Returns:

the stored document or null if none exists.

getOrOpenAsync

jsx3.xml.Document getOrOpenAsync(strURL : String | jsx3.net.URI, strId : String, objClass : jsx3.lang.Class)

Asynchronously loads an xml document and stores it in this cache.

Parameters:

strURL – url (relative or absolute) the URI of the document to open.

strId – the id under which to store the document. If this parameter is not provided, the strURL parameter is used as the id.

objClass – jsx3.xml.Document (default value) or one of its subclasses. The class with which to instantiate the new document instance.

Returns:

the document retrieved from the cache or a placeholder document if the document is in the process of loading asynchronously.

Since:

3.5

getOrOpenDocument

jsx3.xml.Document getOrOpenDocument(strURL : String | jsx3.net.URI, strId : String, objClass : jsx3.lang.Class)

Retrieves a document from this cache or, if this cache contains no such document, loads the document synchronously and returns it.

Parameters:

strURL – the URI of the document.

strId – the id under which the document is/will be stored. If this parameter is not provided, the strURL parameter is used as the id.

objClass – jsx3.xml.Document (default value) or one of its subclasses. The class with which to instantiate the new document instance if a new document is opened.

Returns:

the document retrieved from the cache or loaded.

getTimestamp

int getTimestamp(strId : String)

Returns the timestamp from when the document stored under id strId was stored in this cache.

Parameters:

strId – the id under which the document is stored.

Returns:

the timestamp as an integer (epoch seconds) or null if no such document exists in this cache.

isSystem

boolean isSystem(strId : String)

Deprecated.

returns whether or not the given document in the cache is owned by the system. If no document by the given ID exists, false is returned.

Parameters:

strId – unique identifier for the jsx3.xml.DocumentInstance instance when it was placed in the cache

Returns:

false.

keys

Array<String> keys()

Returns a list of all the keys in this cache instance.

Returns:

openDocument

jsx3.xml.Document openDocument(strURL : String | jsx3.net.URI, strId : String, objClass : jsx3.lang.Class)

Synchronously loads an xml document, stores it in this cache, and returns the loaded document.

Parameters:

strURL – url (relative or absolute) the URI of the document to open.

strId – the id under which to store the document. If this parameter is not provided, the strURL parameter is used as the id.

objClass – jsx3.xml.Document (default value) or one of its subclasses. The class with which to instantiate the new document instance.

Returns:

the loaded document object.

setDocument

void setDocument(strId : String, objDocument : jsx3.xml.Document)

Stores the document objDocument in this cache under id strId. If a document already exists in this cache under strId then that document is removed from the cache.

Parameters:

strId – the id under which to store objDocument.

objDocument –

jsx3.app

class DOM

Object

->jsx3.lang.Object

->jsx3.app.DOM

All Implemented Interfaces:

jsx3.util.EventDispatcher

class DOM
extends jsx3.lang.Object

Registers all DOM nodes in an instance of jsx3.app.Server and publishes related events. This class keeps all contained JSX objects indexed on id and name.

Field Summary
static int	TYPEADD 0
static int	TYPEREARRANGE 2
static int	TYPEREMOVE 1

Constructor Summary
void	init() The instance initializer.

Method Summary
void	add(objJSX : jsx3.app.Model) Adds a JSX object to this DOM and indexes it by its id and name.
void	destroy() The instance finalizer.
jsx3.app.Model	get(strId : String) Looks up a DOM object contained in this DOM by id or name.
Array<jsx3.app.Model>	getAllByName(strName : String) Returns all the DOM nodes in this DOM with a name of strName.
jsx3.app.Model	getById(strId : String) Looks up a DOM object contained in this DOM by id.
jsx3.app.Model	getByName(strName : String) Looks up a DOM object contained in this DOM by name.
static String	newId(strNameSpace : String) Creates a new unique system id.
void	onChange(TYPE : int, JSXPARENTID : String, JSXID : String) called when a change to the JSX DOM occurs for this server instance (adopt, load, delete, etc); publishes an event object (javascript object) with the following named properties: subject (jsx3.app.DOM.EVENT_CHANGE); type (jsx3.app.DOM.TYPEADD \| jsx3.app.DOM.TYPEREMOVE); parentId (id of JSX parent); jsxId (id of element added or removed)
void	onNameChange(objJSX : jsx3.app.Model, oldName : String) A method that must be called after changing the name of a contained DOM node.
void	remove(objJSX : jsx3.app.Model) Removes a JSX object from this DOM and removes it from the indices.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

TYPEADD

static final int TYPEADD

TYPEREARRANGE

static final int TYPEREARRANGE

TYPEREMOVE

static final int TYPEREMOVE

Constructor Detail

init

void init()

The instance initializer.

Method Detail

add

void add(objJSX : jsx3.app.Model)

Adds a JSX object to this DOM and indexes it by its id and name.

Parameters:

objJSX –

destroy

void destroy()

The instance finalizer.

get

jsx3.app.Model get(strId : String)

Looks up a DOM object contained in this DOM by id or name.

Parameters:

strId – either the id of the object to return or its name.

Returns:

the matching DOM object or null if none found.

getAllByName

Array<jsx3.app.Model> getAllByName(strName : String)

Returns all the DOM nodes in this DOM with a name of strName. The name index keeps a bucket of DOM nodes for each unique name. Therefore, this method performs efficiently.

Parameters:

strName – the name of the objects to return.

Returns:

an array of the matching DOM nodes. This return value should not be mutated as that will effect the internal functioning of this DOM.

Since:

3.2

getById

jsx3.app.Model getById(strId : String)

Looks up a DOM object contained in this DOM by id.

Parameters:

strId – the id of the object to return.

Returns:

the matching DOM object or null if none found.

getByName

jsx3.app.Model getByName(strName : String)

Looks up a DOM object contained in this DOM by name. It is left to the developer to specify unique names for all DOM nodes that must be accessed in this manner. If more than one DOM nodes exist with a name of strName the behavior of this method is undefined.

Parameters:

strName – the name of the object to return.

Returns:

the matching DOM object or null if none found.

newId

static String newId(strNameSpace : String)

Creates a new unique system id.

Parameters:

strNameSpace – the application namespace for which to generate the id.

Returns:

onChange

void onChange(TYPE : int, JSXPARENTID : String, JSXID : String)

called when a change to the JSX DOM occurs for this server instance (adopt, load, delete, etc); publishes an event object (javascript object) with the following named properties: subject (jsx3.app.DOM.EVENT_CHANGE); type (jsx3.app.DOM.TYPEADD | jsx3.app.DOM.TYPEREMOVE); parentId (id of JSX parent); jsxId (id of element added or removed)

Parameters:

TYPE – one of: jsx3.app.DOM.TYPEADD, jsx3.app.DOM.TYPEREMOVE

JSXPARENTID – id of dom parent

JSXID – id of dom element either added or removed

onNameChange

void onNameChange(objJSX : jsx3.app.Model, oldName : String)

A method that must be called after changing the name of a contained DOM node. This method updates the name index appropriately.

Parameters:

objJSX –

oldName – the name before it was changed

remove

void remove(objJSX : jsx3.app.Model)

Removes a JSX object from this DOM and removes it from the indices.

Parameters:

objJSX –

jsx3.app

class Model

Object

->jsx3.lang.Object

->jsx3.app.Model

All Implemented Interfaces:

jsx3.util.EventDispatcher

Direct Known Subclasses:

jsx3.gui.Painted, jsx3.gui.Window, jsx3.xml.CDFSchema

abstract class Model
extends jsx3.lang.Object

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.

Field Summary
static int	ASYNC_LOAD_TIMEOUT The number of milliseconds before asynchronous component loads time out.
static String	CIF_VERSION Minimum supported version CIF formatted serialization files
static String	CURRENT_VERSION Minimum supported version for serialization files
static int	LT_NORMAL The normal load type for a DOM branch.
static int	LT_SHOW_DESER Load type indicating that the DOM branch will deserialize and paint as needed when it becomes visible.
static int	LT_SHOW_PAINT Load type indicating that the DOM branch will paint as needed when it becomes visible.
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.
static int	LT_SLEEP_PAINT Load type indicating that the DOM branch will paint after its parent paints and the call stack resets.
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.
static Object<String, boolean>	META_FIELDS The allowed meta data fields.
static int	PERSISTEMBED Normal persistance value for a child that will be persisted.
static int	PERSISTNONE Persistance value fora child that is temporarily part of the DOM tree and will not be persisted.
static int	PERSISTREF Persistance value for a child that exists in an external serialization file and is referenced by URI.
static int	PERSISTREFASYNC Persistance value for a child that exists in an external serialization file and is referenced by URI.

Constructor Summary
void	init(strName : String, strInstanceOf : ?) The instance initializer.

Method Summary
void	adoptChild(objChild : jsx3.app.Model, bRepaint : boolean, bForce : boolean) Appends a DOM node to this object after removing the node from its former parent reference.
boolean	assembleFromXML(objElm : jsx3.xml.Entity) Builds this object from its serialized XML representation.
jsx3.app.Model	doClone(intPersist : int, intMode : int) Creates and returns an exact replica of the object.
jsx3.app.Model	findAncestor(fctTest : Function, bIncludeSelf : boolean) Returns the first ancestor passing the given test function.
jsx3.app.Model \| Array<jsx3.app.Model>	findDescendants(fctTest : Function, bDepthFirst : boolean, bMultiple : boolean, bShallow : boolean, bIncludeSelf : boolean) Finds all DOM nodes descending from this DOM node that pass the given test function.
jsx3.app.Model	getAncestorOfName(strName : String) Returns the first ancestor with the given name.
jsx3.app.Model	getAncestorOfType(strType : String \| Function \| jsx3.lang.Class) Returns the first ancestor of the given type.
jsx3.app.Model	getChild(vntIndexOrName : int \| String) Returns the child DOM node of this node at the given index or with the given name.
int	getChildIndex() Returns the zero-based index for this DOM node in relation to its siblings.
Array<jsx3.app.Model>	getChildren() Returns an array containing all the child DOM nodes of this object.
jsx3.app.Model	getDescendantOfName(strName : String, bDepthFirst : boolean, bChildOnly : boolean) Finds the first descendant of this DOM node with a the given name.
Array<jsx3.app.Model>	getDescendantsOfType(strType : String \| Function \| jsx3.lang.Class, bShallow : boolean) Finds all descendants of the given type.
String	getDynamicProperty(strName : String) Returns the value of the dynamic property @strPropName; if not found, returns null
jsx3.app.Model	getFirstChild() Returns the first child.
jsx3.app.Model	getFirstChildOfType(strType : String \| Function \| jsx3.lang.Class, bExact : boolean) Finds the first child of the given type.
String	getHelpId() Returns the help ID of this object.
String	getId() Returns the custom JSX-generated id for the object (i.e.
jsx3.app.Model	getLastChild() Returns the last child.
int	getLoadType() Returns the load type of this DOM node and the descending branch.
String	getMetaValue(strKey : String) Returns one of the meta data values stored at the top of the serialization file that this object was loaded from.
String	getNS() Returns the namespace that distinguishes this object's server (owner) from other server instances.
String	getName() Returns the custom developer-defined name of this object.
jsx3.app.Model	getNextSibling() Returns the next sibling.
jsx3.app.Model	getParent() Returns the parent DOM node of this object.
int	getPersistence() Returns the persistence bit for this model object.
jsx3.app.Model	getPreviousSibling() Returns the previous sibling.
jsx3.app.Server	getServer() Returns an object reference to the server that owns this object.
jsx3.net.URIResolver	getUriResolver() Returns the URI resolver for this DOM node.
static String	getVersion() Deprecated.
boolean	insertBefore(objMoveChild : jsx3.app.Model, objPrecedeChild : jsx3.app.Model, bRepaint : boolean) Assigns objMoveChild as the previousSibling of objPrecedeChild
jsx3.app.Model	load(strURL : String \| jsx3.net.URI, bRepaint : boolean, objResolver : jsx3.net.URIResolver) Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
jsx3.app.Model	loadAndCache(strURL : String \| jsx3.net.URI, bRepaint : boolean, objCache : jsx3.app.Cache, objResolver : jsx3.net.URIResolver) Loads a component file and caches the document in an XML cache.
jsx3.app.Model	loadXML(strXML : String \| jsx3.xml.Document, bRepaint : boolean, objResolver : jsx3.net.URIResolver) Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node.
protected void	onAfterAssemble(objParent : jsx3.app.Model, objServer : jsx3.app.Server) Called during deserialization of this object.
protected void	onAfterAttach() Called during deserialization of this object.
protected void	onBeforeAssemble(objParent : jsx3.app.Model, objServer : jsx3.app.Server) Called during deserialization of this object.
protected void	onChangeServer(objNewServer : jsx3.app.Server, objOldServer : jsx3.app.Server) Called when the server owning this DOM node changes.
void	onChildAdded(objChild : jsx3.gui.Model) Hook that notifies the model object that a child has been added to it.
protected void	onDestroy(objParent : jsx3.app.Model) The finalizer method.
protected void	onRemoveChild(objChild : jsx3.app.Model \| Array<jsx3.app.Model>, intIndex : int) Hook that notifies this model object that one of its children has been removed.
protected boolean	onSetChild(objChild : ?) Hook that allows for a prospective parent DOM node to veto the adoption of a child.
protected boolean	onSetParent(objParent : ?) Hook that allows for a prospective child DOM node to veto its adoption by a parent.
jsx3.app.Model	removeChild(vntItem : int \| jsx3.app.Model) Removes a DOM child from this object.
jsx3.app.Model	removeChildren(arrChildren : Array<int \| jsx3.app.Model>) Removes some or all children of this object.
Array<jsx3.app.Model> \| jsx3.app.Model	selectDescendants(strExpr : String, bSingle : boolean) Select objects from the DOM using a CSS3-like selection syntax.
jsx3.app.Model \| boolean	setChild(objChild : jsx3.app.Model, intPersist : int, strSourceURL : String \| jsx3.net.URI, strNS : String) Appends a child DOM node to this parent DOM node.
jsx3.gui.Painted	setDynamicProperty(strName : String, strValue : String, bNoSave : boolean) Assigns a dynamic property to one of this object's instance properties.
void	setHelpId(strId : String) Sets the help ID of this object.
void	setLoadType(intLoadType : int) Sets the load type of this DOM node and the descending branch.
void	setMetaValue(strKey : String, strValue : String) setS one of the meta data values stored at the top of a component's serialization file.
void	setName(strName : String) Sets the custom developer-defined name of this object.
jsx3.app.Model	setPersistence(intPersist : int) Sets the persistence bit for this model object.
String	toString() Returns a string representation of this object.
String	toXML(objProperties : Object<String, String>) Returns this object serialized as XML by calling toString() on the result of toXMLDoc() called on this object.
jsx3.xml.Document	toXMLDoc(objProperties : Object<String, String>) Serializes this object as an XML document.
jsx3.xml.Entity	toXMLElm(objXML : jsx3.xml.Document, objProperties : Object) Serializes this object as an XML node in the XML document objXML.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf

Field Detail

Constructor Detail

init

void init(strName : String, strInstanceOf : ?)

The instance initializer.

Parameters:

strName – a unique name distinguishing this object from all other JSX GUI objects in the JSX application

strInstanceOf –

Method Detail

adoptChild

void<

Field Summary
static jsx3.amp.ExtProc	EVAL Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate.
static jsx3.amp.ExtProc	RETURN Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate.
static jsx3.amp.ExtProc	RETURN_ASYNC Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate.

Method Summary
static void	addProcessorFactory(strType : String, fctFactory : Function) Registers a processor factory.
static void	getProcessor(strType : String, xml : jsx3.amp.XML) Creates a processor object from a element.
static jsx3.amp.ExtProc	newDescrProc(objClass : String \| jsx3.lang.Class \| Function) Creates a new extension processor that creates instances of a certain class.
static jsx3.$Array	process(arrExt : Array<jsx3.amp.Ext>, objVisitor : Function \| Object) Processes a list of extensions using the visitor pattern.

Method Summary
String	attr(strKey : String) Returns an attribute of the XML declaration of this menu item.
void	execute() Executes this menu item.
jsx3.amp.Ext	getExt() Returns the extension that defined this menu item.
String	getHotKey() Returns the accelerator key code of this menu item.
String	getId() Returns the full ID of this menu item.
String	getImg() Returns the resolved image path of this item.
String	getLabel() Returns the label of this menu item.
jsx3.amp.util.Menu	getMenu() Returns the menu that contains this menu item.
String	getPath() Returns the path of this menu item.
jsx3.amp.util.Menu	getRootMenu()
String	getTip() Returns the tip of this menu item.
boolean	isEnabled() Returns whether this menu item is enabled.
boolean	isSelected() Returns whether this menu item is selected.

General Interface 3.9.1API Documentation

package jsx3

Parameters:

Since:

Parameters:

Since:

Parameters:

Since:

Parameters:

Since:

Parameters:

Since:

Parameters:

Returns:

Since:

See Also:

Parameters:

Returns:

Since:

Parameters:

Returns:

Parameters:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Parameters:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Returns:

Parameters:

See Also:

Parameters:

See Also:

Parameters:

Since:

Parameters:

Throws:

Returns:

Since:

Parameters:

Returns:

See Also:

Parameters:

Since:

class $Array

Since:

Parameters:

Parameters:

Returns:

Overrides:

Parameters:

Parameters:

Returns:

Since:

Parameters:

Returns:

Overrides:

Parameters:

Returns:

Parameters:

Returns:

Overrides:

General Interface 3.9.1
API Documentation