Packages
jsx3	Global GI static methods and constants.
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 TIBCO 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

Global GI static methods and constants.

Class Summary
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 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) Evaluate a string of code with a particular local variable stack 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)
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 TIBCO 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 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

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)

Evaluate a string of code with a particular local variable stack context.

Parameters:

strScript – the code to execute

objContext – a map containing the local variable stack context

Returns:

the eval value of the script

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)

Parameters:

strKey –

Returns:

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 TIBCO 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

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

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	div> 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

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	Read-Only system settings interface.
jsx3.app.UserSettings	Read-Write per-User settings for a particular GI application (server).

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()

TIBCO General Interface™ 3.5 API Documentation

package jsx3

Parameters:

Returns:

Parameters:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Parameters:

See Also:

Parameters:

Returns:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Returns:

Parameters:

Returns:

See Also:

Returns:

Parameters:

See Also:

Parameters:

See Also:

Parameters:

Since:

Parameters:

Returns:

See Also:

Parameters:

Since:

interface Alerts

See Also:

class Block

See Also:

class BlockX

See Also:

class Boolean

Parameters:

Returns:

class Button

See Also:

interface CDF

See Also:

class Cache

See Also:

class CheckBox

See Also:

class Collection

See Also:

class Column

See Also:

class DOM

See Also:

class DatePicker

See Also:

class Dialog

See Also:

class Document

See Also:

class ERROR

See Also:

class EVT

All Implemented Interfaces:

See Also:

Parameters:

Returns:

Retud Detail

Returns:

Returns:

Returns:

Returns:

TIBCO General Interface™ 3.5
API Documentation