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

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

0

TRUE

static final int TRUE

1

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

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

Retud 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.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	Read-Only system settings interface.
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

gsx3.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.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	Read-Only system settings interface.
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	reass="">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.

n>String

Method Summary
jsx3.xml.Document	clearById(strId : String) Removes the document stored in this cache under id strId.
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.
intref="#class:Number">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.

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

0

TYPEREARRANGE

static final int TYPEREARRANGE

2

TYPEREMOVE

static final int TYPEREMOVE

1

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

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.
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.
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.
void	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.
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.
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.
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.

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

ASYNC_LOAD_TIMEOUT

static int ASYNC_LOAD_TIMEOUT

The number of milliseconds before asynchronous component loads time out.

CIF_VERSION

static String CIF_VERSION

Minimum supported version CIF formatted serialization files

CURRENT_VERSION

static String CURRENT_VERSION

Minimum supported version for serialization files

LT_NORMAL

static final int LT_NORMAL

The normal load type for a DOM branch. The DOM branch deserializes and paints with its parent.

LT_SHOW_DESER

static final int LT_SHOW_DESER

Load type indicating that the DOM branch will deserialize and paint as needed when it becomes visible. It is left to subclasses of Model to implement this functionality.

LT_SHOW_PAINT

static final int LT_SHOW_PAINT

Load type indicating that the DOM branch will paint as needed when it becomes visible. It is left to subclasses of Model to implement this functionality.

LT_SLEEP_DESER

static final int LT_SLEEP_DESER

Load type indicating that the DOM branch will deserialize and paint after its parent deserializes and the call stack resets.

LT_SLEEP_PAINT

static final int LT_SLEEP_PAINT

Load type indicating that the DOM branch will paint after its parent paints and the call stack resets.

LT_SLEEP_PD

static final 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.

META_FIELDS

static Object<String, boolean> META_FIELDS

The allowed meta data fields. See getMetaValue() and setMetaValue().

PERSISTEMBED

static final int PERSISTEMBED

Normal persistance value for a child that will be persisted.

PERSISTNONE

static final int PERSISTNONE

Persistance value fora child that is temporarily part of the DOM tree and will not be persisted.

PERSISTREF

static final int PERSISTREF

Persistance value for a child that exists in an external serialization file and is referenced by URI.

PERSISTREFASYNC

static final int PERSISTREFASYNC

Persistance value for a child that exists in an external serialization file and is referenced by URI. The loading of a child with this persistence value will happen asynchronously after the file that references it is loaded.

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 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. If the node to append does not already have a DOM parent, setChild() should be used instead of this method.

Parameters:

objChild – the child to adopt

bRepaint – if true or null, the object being adopted will be added to the parent's view via the parent's paintChild() method. This parameter is made available for those situations where a loop is executing and multiple objects are being adopted. As view operations are the most CPU intensive, passing false while looping through a collection of child objects to adopt will improve performance. After the last child is adopted, simply call repaint() on the parent to immediately synchronize the view.

bForce – if true, the adoption is forced, even if the parent/child don't accept such adoptions (onSetChild() and onSetParent() will still be called)

doClone

jsx3.app.Model doClone(intPersist : int, intMode : int)

Creates and returns an exact replica of the object. The clone will be appended as a new child node of this object's parent node.

Parameters:

intPersist – the persistance value of the clone.

intMode – 0 for insert as the last child of the parent of this object and paint, 1 for insert as the last child of this parent of this object and do not paint, or 2 for load as a fragment.

Throws:

{jsx3.lang.Exception} – if this object has no parent DOM node.

Returns:

the clone.

findAncestor

jsx3.app.Model findAncestor(fctTest : Function, bIncludeSelf : boolean)

Returns the first ancestor passing the given test function.

Parameters:

fctTest – test function, takes a single jsx3.app.Model parameter and returns true if the node matches.

bIncludeSelf – if true, include this object in the search

Returns:

findDescendants

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. Results are guaranteed to be returned in order according to the search order used.

Parameters:

fctTest – test function, takes a single jsx3.app.Model parameter and returns true if the node matches.

bDepthFirst – specifies whether to do a depth first or breadth first search.

bMultiple – if true, return an array of matches, otherwise just the first match.

bShallow – if true, only search direct children.

bIncludeSelf – if true, include this node in the search.

Returns:

the match (bMultiple = false) or matches (bMultiple = true).

getAncestorOfName

jsx3.app.Model getAncestorOfName(strName : String)

Returns the first ancestor with the given name.

Parameters:

strName – the name to query on.

Returns:

the first ancestor with the given name or null if none found.

getAncestorOfType

jsx3.app.Model getAncestorOfType(strType : String | Function | jsx3.lang.Class)

Returns the first ancestor of the given type.

Parameters:

strType – the fully-qualified class name, class constructor function, or jsx3.Class instance.

Returns:

the first ancestor of the given type or null if none found.

getChild

jsx3.app.Model getChild(vntIndexOrName : int | String)

Returns the child DOM node of this node at the given index or with the given name. If a name is supplied, the children are searched in order and the first matching child is returned.

Parameters:

vntIndexOrName – either the integer index or the string name of the child.

Returns:

the child at the given index or with the given name, or null if no such child exists.

getChildIndex

int getChildIndex()

Returns the zero-based index for this DOM node in relation to its siblings.

Returns:

the index or -1 if this object does not have a parent.

getChildren

Array<jsx3.app.Model> getChildren()

Returns an array containing all the child DOM nodes of this object. The return value is the original array rather than a copy and should not be modified.

Returns:

getDescendantOfName

jsx3.app.Model getDescendantOfName(strName : String, bDepthFirst : boolean, bChildOnly : boolean)

Finds the first descendant of this DOM node with a the given name.

Parameters:

strName – the name to query on.

bDepthFirst – specifies whether to do a depth first or breadth first search.

bChildOnly – if true, only search the children of this DOM node.

Returns:

the descendant with the given name or null if none found.

getDescendantsOfType

Array<jsx3.app.Model> getDescendantsOfType(strType : String | Function | jsx3.lang.Class, bShallow : boolean)

Finds all descendants of the given type.

Parameters:

strType – the fully-qualified class name, class constructor function, or jsx3.Class instance.

bShallow – if true, only search direct children, not all descendants.

Returns:

an array of matching descendants

getFirstChild

jsx3.app.Model getFirstChild()

Returns the first child.

Returns:

getFirstChildOfType

jsx3.app.Model getFirstChildOfType(strType : String | Function | jsx3.lang.Class, bExact : boolean)

Finds the first child of the given type.

Parameters:

strType – the fully-qualified class name, class constructor function, or jsx3.Class instance.

bExact – if true then only return objects whose class is exactly strType (rather than returning subclasses too).

Returns:

the child of the given type or null if none found.

getHelpId

String getHelpId()

Returns the help ID of this object.

Returns:

Since:

3.5

getId

String getId()

Returns the custom JSX-generated id for the object (i.e., _jsx2384098324509823049).

Returns:

JSX id

getLastChild

jsx3.app.Model getLastChild()

Returns the last child.

Returns:

getLoadType

int getLoadType()

Returns the load type of this DOM node and the descending branch. The load type determines how this DOM branch deserializes and paints in relation to its parent DOM node.

Returns:

LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER, LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER.

Since:

3.5

getMetaValue

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.

Parameters:

strKey – the name of the meta data field, one of the keys in META_FIELDS.

Returns:

the meta data value or empty string.

getNS

String getNS()

Returns the namespace that distinguishes this object's server (owner) from other server instances. The namespace is set when this object is bound to a DOM tree.

Returns:

the namespace of the server that owns this object instance.

getName

String getName()

Returns the custom developer-defined name of this object.

Returns:

getNextSibling

jsx3.app.Model getNextSibling()

Returns the next sibling.

Returns:

getParent

final jsx3.app.Model getParent()

Returns the parent DOM node of this object.

Returns:

getPersistence

int getPersistence()

Returns the persistence bit for this model object.

Returns:

one of PERSISTNONE, PERSISTEMBED, PERSISTREF, PERSISTREFASYNC.

getPreviousSibling

jsx3.app.Model getPreviousSibling()

Returns the previous sibling.

Returns:

getServer

jsx3.app.Server getServer()

Returns an object reference to the server that owns this object. This method returns null if this object is part of a DOM fragment. Until an object is added to a DOM tree by passing it as the parameter to setChild(), the object will be a DOM fragment.

Returns:

getUriResolver

jsx3.net.URIResolver getUriResolver()

Returns the URI resolver for this DOM node. This method returns the server of this object unless this node or its ancestor was loaded into the DOM with an explicit URI resolver.

Returns:

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "3.0.00")

Returns:

insertBefore

boolean insertBefore(objMoveChild : jsx3.app.Model, objPrecedeChild : jsx3.app.Model, bRepaint : boolean)

Assigns objMoveChild as the previousSibling of objPrecedeChild

Parameters:

objMoveChild – the one being moved. Can belong to this object, another object, or can be a GUI fragment

objPrecedeChild – the one to insert before

bRepaint – if false the repaint will be suppressed (useful for multiple obejct updates that would lead to unnecessary updates to the VIEW)

Returns:

true if successful

load

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.

Parameters:

strURL – URL (either relative or absolute) of the serialization file to deserialize. This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.

bRepaint – if true or null the deserialized objects will be added to the parent's view via the parent object's paintChild() method.

objResolver – If this parameter is provided, strURL is resolved relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.

Throws:

{jsx3.lang.Exception} – if strURL is not the URL of a valid XML document.

Returns:

the deserialized object. A serialization file may specify more than one root object, in which case this method returns the first deserialized object.

loadAndCache

void 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. If the component file already exists in the cache then it is loaded from the cache. All component files loaded as a result of this call (referenced files) are also cached. This method is a useful replacement for load() when the same URL will be loaded multiple times in one application.

Parameters:

strURL – URL (either relative or absolute) of the serialization file to deserialize. This URL is resolved relative to objResolver, if provided, or the URI resolver of this DOM node.

bRepaint – if true or null the deserialized objects will be added to the parent's view via the parent object's paintChild() method.

objCache – the cache to store the component XML documents in. If not provided, the cache of the server of this model object is used.

objResolver – If this parameter is provided, strURL is resolved relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.

Throws:

{jsx3.lang.Exception} – if strURL is not the URL of a valid XML document.

loadXML

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.

Parameters:

strXML – the XML content of a JSX serialization file.

bRepaint – if true or null the deserialized objects will be added to the parent's view via the parent object's paintChild() method.

objResolver –

Throws:

{jsx3.lang.Exception} – if strXML is not a valid XML document.

Returns:

the deserialized object. A serialization file may specify more than one root object, in which case this method returns the first deserialized object.

onAfterAssemble

protected void onAfterAssemble(objParent : jsx3.app.Model, objServer : jsx3.app.Server)

Called during deserialization of this object. This method provides a hook for initializing an object during deserialization since init() is not called. Called after this object has been instantiated and after its fields and children have been assembled.This method is called before this object is attached to the DOM, therefore getParent(), getServer(), getXML(), etc. return null.

Parameters:

objParent – the parent of this object once it is attached to the DOM.

objServer – the server that this DOM object will attach to.

onAfterAttach

protected void onAfterAttach()

Called during deserialization of this object. This method provides a hook for initializing an object during deserialization since init() is not called. Called after this object has been instantiated and after it has been attached to the DOM. Methods overriding this method should usually finish with a call to jsxsuper().

When a new branch is attached to the DOM, this method is executed on each node in the branch. The order is reverse-breadth-first meaning that child nodes are notified from oldest to youngest and before the parent node.

This implementation of this method executes the on-after-deserialize script of this object.

onBeforeAssemble

protected void onBeforeAssemble(objParent : jsx3.app.Model, objServer : jsx3.app.Server)

Called during deserialization of this object. This method provides a hook for initializing an object during deserialization since init() is not called. Called after this object has been instantiated but before its fields and children have been assembled. This method is called before this object is attached to the DOM, therefore getParent(), getServer(), getXML(), etc. return null.

Parameters:

objParent – the parent of this object once it is attached to the DOM.

objServer – the server that this DOM object will attach to.

onChangeServer

protected void onChangeServer(objNewServer : jsx3.app.Server, objOldServer : jsx3.app.Server)

Called when the server owning this DOM node changes.

Parameters:

objNewServer –

objOldServer –

Since:

3.5

onDestroy

protected void onDestroy(objParent : jsx3.app.Model)

The finalizer method. This method provides a hook for subclasses of this class to perform custom logic when an instance of this class is removed from the DOM. Methods that override this method should begin with a call to jsxsuper().

Note that this method is called after this object has been removed from the DOM tree. Therefore this.getParent() and this.getServer() will return null. Use the objParent parameter for access to the DOM tree.

Parameters:

objParent – reference to the former parent

onRemoveChild

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. This hook exists simply to allow this object to perform cleanup/re-render, and does not provide a veto mechanism. This method is called after the child has been removed from the model (this.getChildren() does not contain objChild) and after the child has been removed from the view (objChild.getRendered() is also null).

This method is only called if the child is being removed from the DOM but this object (the parent) is not being removed. Therefore, this hook cannot be relied upon for garbage collection.

If removeChildren() is called on this object, this hook is called exactly once after all children have been removed. In that case, the first parameter to this method will be the array of children and the second parameter will be null.

In general a method overriding this method should begin by calling jsxsuper.

Parameters:

objChild – the child that was removed

intIndex – the index of the removed child

onSetChild

protected boolean onSetChild(objChild : ?)

Hook that allows for a prospective parent DOM node to veto the adoption of a child.

Parameters:

objChild –

Returns:

true to allow the set, false to veto

onSetParent

protected boolean onSetParent(objParent : ?)

Hook that allows for a prospective child DOM node to veto its adoption by a parent. This method is only called if the prospective parent has not already vetoed the adoption in the onSetChild() method.

Parameters:

objParent –

Returns:

true to allow the set, false to veto

removeChild

jsx3.app.Model removeChild(vntItem : int | jsx3.app.Model)

Removes a DOM child from this object. This method removes the on-screen DHTML of the removed object. The removed child will be completely derefenced from the DOM and will be prepped for garbage collection. If a DOM child must continue to exist after removing it from this parent, adoptChild() should be used instead of this method.

Parameters:

vntItem – either the index of the child to remove or the child itself.

Returns:

this object

removeChildren

jsx3.app.Model removeChildren(arrChildren : Array<int | jsx3.app.Model>)

Removes some or all children of this object.

Parameters:

arrChildren – the children to remove. If this parameter is not provided then all children are removed.

Returns:

this object.

setChild

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. If the child already has a parent, adoptChild() should be used instead to ensure that the child is removed from its current parent.

Parameters:

objChild – the root node of a DOM fragment.

intPersist – defines how the child will be persisted/serialized. The valid values are the four persistence values defined as static fields in this class.

strSourceURL – the path to the serialization file where the child exists. This parameter is only relevant if the given intPersist is PERSISTREF or PERSISTREFASYNC.

strNS – the namespace of the child to append. This parameter is normally not required but is useful when sharing DOM nodes between servers with different namespaces.

Throws:

{jsx3.lang.Exception} – if this object is part of a DOM fragment (the namespace is null) and the strNS parameter is not specified.

Returns:

this object or false if the set was vetoed

setHelpId

void setHelpId(strId : String)

Sets the help ID of this object.

Parameters:

strId –

Since:

3.5

setLoadType

void setLoadType(intLoadType : int)

Sets the load type of this DOM node and the descending branch.

Parameters:

intLoadType – LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER, LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER.

Since:

3.5

setMetaValue

void setMetaValue(strKey : String, strValue : String)

setS one of the meta data values stored at the top of a component's serialization file.

Parameters:

strKey – the name of the meta data field, one of the keys in META_FIELDS

strValue – the new value of the meta data field.

setName

void setName(strName : String)

Sets the custom developer-defined name of this object.

Parameters:

strName – a name unique among all DOM nodes currently loaded in the application.

setPersistence

jsx3.app.Model setPersistence(intPersist : int)

Sets the persistence bit for this model object.

Parameters:

intPersist – one of PERSISTNONE, PERSISTEMBED, PERSISTREF, PERSISTREFASYNC.

Returns:

this object

toString

String toString()

Returns a string representation of this object.

Returns:

Overrides:

toString in jsx3.lang.Object

toXML

String toXML(objProperties : Object<String, String>)

Returns this object serialized as XML by calling toString() on the result of toXMLDoc() called on this object.

Parameters:

objProperties – name-value pairs that affect the serialization. See toXMLDoc() for a description.

Returns:

this object serialized as an XML string.

toXMLDoc

jsx3.xml.Document toXMLDoc(objProperties : Object<String, String>)

Serializes this object as an XML document.

The objProperties parameter may include the following keys:

onafter {String} - the value of the onAfterDeserialize element
onbefore {String} - the value of the onBeforeDeserialize element
name {String} - the value of the name element
icon {String} - the value of the icon element
description {String} - the value of the description element
children {boolean} - if true the children of this object, rather than this object, are serialized
persistall {boolean} - if true all descendants with persistence PERSISTNONE are included in the serialization

Parameters:

objProperties – name-value pairs that affect the serialization. See above for valid names and how they affect serialization.

Returns:

this object serialized as an XML document.

jsx3.app

class Monitor

Object

->jsx3.lang.Object

->jsx3.util.Logger.Handler

->jsx3.util.Logger.FormatHandler

->jsx3.app.Monitor

class Monitor
extends jsx3.util.Logger.FormatHandler

A logging handler that can be instantiated per JSX application and displays logging messages in a separate browser window while an application is running.

Since:

3.1

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

Method Summary
boolean	getActivateOnHotKey() Returns whether this monitor remains invisible until the user types the hotkey ctrl+alt+m in the attached application.
boolean	getDisableInIDE() Returns whether this monitor is disabled when its application is running inside the IDE.
String	getServerNamespace() Returns the server namespace of this monitor.
void	handle(objRecord : jsx3.util.Logger.Record) Writes the formatted logging message to a separate browser window if all relevant conditions are met.
void	setActivateOnHotKey(activateOnHotKey : boolean) Sets whether this monitor waits for the hotkey ctrl+alt+m before becoming visible.
void	setDisableInIDE(disableInIDE : boolean) Sets whether this monitor is disabled when its application is running inside the IDE.
void	setServerNamespace(serverNamespace : String) Sets the server namespace of this monitor.

Methods Inherited From jsx3.util.Logger.FormatHandler
getFormat, setFormat

Methods Inherited From jsx3.util.Logger.Handler
getLevel, getName, isLoggable, setLevel

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(strName : String)

The instance initializer.

Parameters:

strName –

Method Detail

getActivateOnHotKey

boolean getActivateOnHotKey()

Returns whether this monitor remains invisible until the user types the hotkey ctrl+alt+m in the attached application. If false this monitor will appear when the application is loaded and anytime the monitor is closed and a logging message is received.

Returns:

getDisableInIDE

boolean getDisableInIDE()

Returns whether this monitor is disabled when its application is running inside the IDE.

Returns:

getServerNamespace

String getServerNamespace()

Returns the server namespace of this monitor. When an application is created with a namespace equal to this value that application is attached to this monitor and the monitor becomes live.

Returns:

handle

void handle(objRecord : jsx3.util.Logger.Record)

Writes the formatted logging message to a separate browser window if all relevant conditions are met.

Parameters:

objRecord –

Overrides:

handle in jsx3.util.Logger.Handler

setActivateOnHotKey

void setActivateOnHotKey(activateOnHotKey : boolean)

Sets whether this monitor waits for the hotkey ctrl+alt+m before becoming visible.

Parameters:

activateOnHotKey –

setDisableInIDE

void setDisableInIDE(disableInIDE : boolean)

Sets whether this monitor is disabled when its application is running inside the IDE.

Parameters:

disableInIDE –

setServerNamespace

void setServerNamespace(serverNamespace : String)

Sets the server namespace of this monitor.

Parameters:

serverNamespace –

jsx3.app

class Properties

Object

->jsx3.lang.Object

->jsx3.app.Properties

Direct Known Subclasses:

jsx3.app.PropsBundle

class Properties
extends jsx3.lang.Object

Represents a repository of dynamic properties. Dynamic properties are simply name-value pairs. Dynamic properties can be loaded from an XML file in the CDF dynamic property format.

Since:

3.2

Constructor Summary
void	init() The instance initializer.

Method Summary
void	addParent(objParent : jsx3.app.Properties) Adds a parent property repository to this repository.
boolean	containsKey(strKey : String) Returns whether this property repository contains a particular property.
Object \| undefined	get(strKey : String) Returns the value of a property for a particular key.
Array<String>	getKeys() Returns a list of all the property keys contained in this repository.
Array<jsx3.app.Properties>	getParents() Returns the list of parent repositories of this repository.
void	loadXML(objXML : jsx3.xml.Document, strId : String) Loads a set of dynamic properties from an XML document into this repository.
void	remove(strKey : String) Removes a property from this repository.
void	removeAllParents() Removes all parent property repositories.
void	removeParent(objParent : jsx3.app.Properties) Removes a property repository from the set of parent repositories.
void	set(strKey : String, strValue : Object) Sets a property in this repository in the global space.

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

addParent

void addParent(objParent : jsx3.app.Properties)

Adds a parent property repository to this repository. get() consults all parents before returning undefined.

Parameters:

objParent –

containsKey

boolean containsKey(strKey : String)

Returns whether this property repository contains a particular property. Parent repositories are not consulted.

Parameters:

strKey – the property key to query for.

Returns:

true if this repository contains a property with the given key.

get

Object | undefined get(strKey : String)

Returns the value of a property for a particular key. This method consults the parent repositories as necessary until a property is found. If no property is found, undefined is returned.

Parameters:

strKey – the property key to query for.

Returns:

getKeys

Array<String> getKeys()

Returns a list of all the property keys contained in this repository. Parent repositories are not consulted.

Returns:

getParents

Array<jsx3.app.Properties> getParents()

Returns the list of parent repositories of this repository.

Returns:

loadXML

void loadXML(objXML : jsx3.xml.Document, strId : String)

Loads a set of dynamic properties from an XML document into this repository. The document should be a shallow CDF document with any number of record elements defined under the root data element.

The following CDF attributes are supported:

jsxid – the property key, required.
jsxtext – the property value, required.
eval – if "1" or "true" the jsxtext attribute is evaluated with JavaScript, optional.

Parameters:

objXML –

strId – specifies the id to store the document under. If none is provided, the default space is used.

remove

void remove(strKey : String)

Removes a property from this repository. The property is removed from all spaces.

Parameters:

strKey – the key of the property to remove.

removeAllParents

void removeAllParents()

Removes all parent property repositories.

removeParent

void removeParent(objParent : jsx3.app.Properties)

Removes a property repository from the set of parent repositories.

Parameters:

objParent – the parent repository to remove.

set

void set(strKey : String, strValue : Object)

Sets a property in this repository in the global space.

Parameters:

strKey – the key of the property to set.

strValue – the value of the property. This value may be null, in which case null will be stored as the property value. This value may not be undefined; use remove() to remove a property value.

jsx3.app

class PropsBundle

Object

->jsx3.lang.Object

->jsx3.app.Properties

->jsx3.app.PropsBundle

class PropsBundle
extends jsx3.app.Properties

A subclass of jsx3.app.Properties that supports localized properties. Using this class, an application can define properties for a number of locales but only load the properties necessary to display a particular locale. Additionally, this class supports fall-through so that if a property is not defined for a particular locale that locale inherits the value from the next most specific locale.

A properties bundle can consist of one or more XML files. The main file, fileName.ext, contains the properties for the default locale, as well as the properties for any number of other locales, and metadata indicating what locales are available external to the main file. The format of this file is:

<data jsxnamespace="propsbundle" locales="externalLocales">
  <!-- the default locale -->
  <locale>
    <record jsxid="propId" jsxtext="propValue"/>
    ...
  </locale>
  <!-- additional locales -->
  <locale key="en_US">
    <record jsxid="propId" jsxtext="propValueEnUs"/>
    ...
  </locale>
  ...
</data>

externalLocales is a comma-separated list of locales that are available for this properties bundle that are defined in separate files. By spreading a properties bundle over many files, loading a bundle for a single locale is optimized. For each locale, locKey, listed in externalLocales, there must be a file fileName.locKey.ext in the same directory as the main bundle file.

Each external file has the same format as the main file except that the locales attribute of the data tag should not be specified. Any number of locales can be defined. The first locale defined should be the locale explicit in the name of the file. Only more specific locales should follow this locale. For example, file props.es.xml, should start by defining locale es and could continue with locales es_ES and es_MX but should not define locales fr or de.

Since:

3.4

Method Summary
static void	clearCache(strPath : String, objCache : jsx3.app.Cache) Clears all the data stored in the caches internal to this class.
jsx3.app.Locale	getLocale() Returns the locale for which this properties object was created.
String	getPath() Returns the base path of this properties bundle.
static jsx3.app.PropsBundle	getProps(strBasePath : String \| jsx3.net.URI, objLocale : jsx3.util.Locale, objCache : jsx3.app.Cache) Returns a properties object representing a localized view onto a properties bundle.

Methods Inherited From jsx3.app.Properties
addParent, containsKey, get, getKeys, getParents, loadXML, remove, removeAllParents, removeParent, set

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

Method Detail

clearCache

static void clearCache(strPath : String, objCache : jsx3.app.Cache)

Clears all the data stored in the caches internal to this class. Repeated calls to getProps() consult only these caches. If files have changed on disk this method must be called for the return value of getProps() to reflect these changes.

Parameters:

strPath – if provided, only clear out the documents stored for the resource at path strPath.

objCache – if provided in addition to strPath, clear out any documents stored in objCache associated with the resource at path strPath.

getLocale

jsx3.app.Locale getLocale()

Returns the locale for which this properties object was created. The value returned by this method is the value sent to the getProps() method and not necessarily the most specific locale for which the properties in this view are defined.

Returns:

getPath

String getPath()

Returns the base path of this properties bundle.

Returns:

getProps

static jsx3.app.PropsBundle getProps(strBasePath : String | jsx3.net.URI, objLocale : jsx3.util.Locale, objCache : jsx3.app.Cache)

Returns a properties object representing a localized view onto a properties bundle.

Parameters:

strBasePath – the relative URI to the main properties file.

objLocale – the locale for which to load the localized properties. If this is not provided, the system locale is used.

objCache – if provided, any loaded XML documents will be placed in this cache.

Returns:

jsx3.app

class Server

Object

->jsx3.lang.Object

->jsx3.app.Server

All Implemented Interfaces:

jsx3.gui.Alerts, jsx3.net.URIResolver, jsx3.util.EventDispatcher

class Server
extends jsx3.lang.Object

The controller of the JSX architecture.

Field Summary
jsx3.app.Cache	Cache Deprecated. Use `Server.getCache()`
jsx3.app.DOM	DOM Deprecated. Use `Server.getDOM()`
Object<String, String>	ENVIRONMENT Deprecated. Use `Server.getEnv()`
static String	HELP The subject of an event that instances of this class publish when a context help hot key is pressed in the context of a DOM node that has a help ID.
static String	INITED The subject of an event that jsx3.app.Server publishes when an instance of this class is created.
jsx3.gui.Block	JSXBODY Deprecated. Use `Server.getBodyBlock()`
jsx3.gui.Block	JSXROOT Deprecated. Use `Server.getRootBlock()`

Constructor Summary
void	init(strAppPath : String, objGUI : HTMLElement, bPaint : boolean, objEnv : Object) Sets environment variables used by this class (the controller for the JSX architecture)

Method Summary
jsx3.gui.Window	createAppWindow(strName : String) Creates a new jsx3.gui.Window instance for this server.
void	deleteCookie(name : String, path : String, domain : String) delete a cookie
void	destroy() call to shut down a server instance and free up resources used by the server (cache,dom,etc)
jsx3.app.Model	getAlertsParent() To implement jsx3.gui.Alerts interface.
jsx3.gui.Window	getAppWindow(strName : String) Retrieves a previously created jsx3.gui.Window instance.
jsx3.gui.Block	getBodyBlock() Returns the body block for this server (JSXBODY)
jsx3.app.Cache	getCache() Returns the XML/XSL cache for this server
String	getCookie(name : String, bRaw : ?) Returns the value for the Cookie with the given @name
jsx3.app.DOM	getDOM() Returns the DOM for this server
jsx3.util.Locale	getDefaultLocale() Returns the default locale of this server.
HTMLDocument	getDocumentOf(objJSX : jsx3.app.Model) Returns the browser document object containing a particular JSX object.
String	getDynamicProperty(strPropName : String, strToken : String...) Returns the value of the dynamic property @strPropName
String	getEnv(strEnvKey : String) Returns the value of an environment setting of this server.
jsx3.app.Model	getJSX(strId : String) Looks up a DOM node owned by this server by id or by name.
jsx3.app.Model	getJSXById(strId : String) Looks up a DOM node owned by this server by id.
jsx3.app.Model	getJSXByName(strId : String) Looks up a DOM node owned by this server by name.
jsx3.util.Locale	getLocale() Returns the current locale of this server.
HTMLElement	getRenderedOf(objJSX : jsx3.app.Model) Returns the browser DOM object where a particulat JSX object renders.
jsx3.gui.Block	getRootBlock() Returns the root block for this server (JSXROOT)
Array<jsx3.app.Model>	getRootObjects() Returns the list of objects that are children of the body object.
jsx3.app.Server	getServer() Deprecated.
jsx3.app.Settings	getSettings() Returns the settings of this server/project per config.xml
jsx3.gui.WindowBar	getTaskBar(objJSX : jsx3.app.Model) Returns handle to a descendant taskbar belonging to this server instance (this is where JSXDialog instances will try to minimize to if it exists); returns null if none found; if no taskbar is found, dialogs are not minimized, but are 'window shaded'—like a Mac used to do
String	getUriPrefix()
static String	getVersion() Deprecated.
void	invokeHelp(objJSX : jsx3.app.Model) Invokes context-sensitive help as though the user had pressed the help hot key in the context of the DOM node objJSX.
jsx3.gui.Window	loadAppWindow(strSource : jsx3.xml.Entity \| String) Loads a new jsx3.gui.Window instance from a component file.
jsx3.xml.Document \| jsx3.net.Service \| null	loadInclude(strSrc : String \| jsx3.net.URI, strId : String, strType : String, bReload : String) Loads an external resource into this server instance.
jsx3.xml.Document \| jsx3.net.Service \| null	loadResource(strId : String) Loads an application resource.
void	paint(objXML : jsx3.xml.Document) Paints this application and its default component into the application view port on the host HTML page.
jsx3.net.URI	relativizeURI(strURI : String \| jsx3.net.URI, bRel : ?)
void	reloadLocalizedResources() Reloads all resource files that are localized.
jsx3.net.URI	resolveURI(strURI : String \| jsx3.net.URI) Resolves a URI that is referenced from a file in this server.
void	setCookie(name : String, value : String, expires : Date, path : String, domain : String, secure : boolean, bRaw : ?) Sets a Cookie with the given name and value
void	setDimensions(left : int \| Array, top : int, width : int, height : int) set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server.
void	setDynamicProperty(strPropName : String, vntValue : String) updates a single dynamic style property; dynamic properties are used by jsx3.gui.Block objects that extend the astract class, jsx3.gui.Block;
void	setLocale(objLocale : jsx3.util.Locale) Sets the locale of this server.
String	toString()
void	unloadInclude(strId : String) Removes a loaded JavaScript or CSS resource from the browser DOM.

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

Methods Inherited From jsx3.gui.Alerts
alert, configureAlert, confirm, prompt

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

Field Detail

Cache

jsx3.app.Cache Cache

Deprecated. Use Server.getCache()

DOM

jsx3.app.DOM DOM

Deprecated. Use Server.getDOM()

ENVIRONMENT

Object<String, String> ENVIRONMENT

Deprecated. Use Server.getEnv()

HELP

static String HELP

The subject of an event that instances of this class publish when a context help hot key is pressed in the context of a DOM node that has a help ID. The event has the following fields:

target - the server publishing the event.
model - the DOM node that received the key event.
helpid - the help ID of the nearest ancestor of model that defines a help ID.

INITED

static String INITED

The subject of an event that jsx3.app.Server publishes when an instance of this class is created. The target of the event object is the initialized server.

JSXBODY

jsx3.gui.Block JSXBODY

Deprecated. Use Server.getBodyBlock()

JSXROOT

jsx3.gui.Block JSXROOT

Deprecated. Use Server.getRootBlock()

Constructor Detail

init

void init(strAppPath : String, objGUI : HTMLElement, bPaint : boolean, objEnv : Object)

Sets environment variables used by this class (the controller for the JSX architecture)

Parameters:

strAppPath – URL (either relative or absolute) for the application to load

objGUI – the browser element (body, div, span, td, etc) into which the GI application should load

bPaint – false if null; if true, the application VIEW will immediately be generated.

objEnv –

Method Detail

createAppWindow

jsx3.gui.Window createAppWindow(strName : String)

Creates a new jsx3.gui.Window instance for this server. A branch of the DOM of this application can be placed in this window in order to distribute the application across multiple browser windows.

Parameters:

strName – the unique name of the window to create

Throws:

{jsx3.lang.IllegalArgumentException} – if there already exists a window in this server by that name

Returns:

Since:

3.2

deleteCookie

void deleteCookie(name : String, path : String, domain : String)

delete a cookie

Parameters:

name – name of the cookie

path – path where the cookie is valid (default: path of calling document)

domain – domain where the cookie is valid (default: domain of calling document)

destroy

void destroy()

call to shut down a server instance and free up resources used by the server (cache,dom,etc)

getAlertsParent

jsx3.app.Model getAlertsParent()

To implement jsx3.gui.Alerts interface.

Returns:

the root block.

Overrides:

getAlertsParent in jsx3.gui.Alerts

getAppWindow

jsx3.gui.Window getAppWindow(strName : String)

Retrieves a previously created jsx3.gui.Window instance.

Parameters:

strName – the unique name of the window to retrieve

Returns:

the window instance or null if no such window exists.

Since:

3.2

getBodyBlock

jsx3.gui.Block getBodyBlock()

Returns the body block for this server (JSXBODY)

Returns:

getCache

jsx3.app.Cache getCache()

Returns the XML/XSL cache for this server

Returns:

getCookie

String getCookie(name : String, bRaw : ?)

Returns the value for the Cookie with the given @name

Parameters:

name – name of the cookie

bRaw –

Returns:

getDOM

jsx3.app.DOM getDOM()

Returns the DOM for this server

Returns:

getDefaultLocale

jsx3.util.Locale getDefaultLocale()

Returns the default locale of this server. This is configured with the default_locale configuration setting.

Returns:

Since:

3.2

getDocumentOf

HTMLDocument getDocumentOf(objJSX : jsx3.app.Model)

Returns the browser document object containing a particular JSX object. This method inspects whether the JSX object is a descendent of the root block of this server or one of its jsx3.gui.Window roots.

Parameters:

objJSX –

Returns:

document object

getDynamicProperty

String getDynamicProperty(strPropName : String, strToken : String...)

Returns the value of the dynamic property @strPropName

Parameters:

strPropName – id for this dynamic property among all properties

strToken – if present tokens such as {0}, {1}, {n} will be replaced with the nth element of this vararg array

Returns:

value of the property

getEnv

String getEnv(strEnvKey : String)

Returns the value of an environment setting of this server. Valid keys correspond to deployment options and are (case-insensitive):

VERSION
APPPATH
ABSPATH
CAPTION
MODE
SYSTEM
NAMESPACE
CANCELERROR
CANCELRIGHTCLICK
BODYHOTKEYS
WIDTH
HEIGHT
LEFT
TOP
POSITION
OVERFLOW
UNICODE
EVENTSVERS

Parameters:

strEnvKey – the key of the environment value to return

Returns:

getJSX

jsx3.app.Model getJSX(strId : String)

Looks up a DOM node owned by this server by id or by name.

Parameters:

strId – either the id (_jsxid) of the object or its name (jsxname)

Returns:

the JSX object or null if none found

getJSXById

jsx3.app.Model getJSXById(strId : String)

Looks up a DOM node owned by this server by id.

Parameters:

strId – the id (_jsxid) of the object

Returns:

the JSX object or null if none found

getJSXByName

jsx3.app.Model getJSXByName(strId : String)

Looks up a DOM node owned by this server by name. If more than one such objects exist, only one is returned.

Parameters:

strId – the name (jsxname) of the object

Returns:

the JSX object or null if none found

getLocale

jsx3.util.Locale getLocale()

Returns the current locale of this server. If the locale has been set explicitly with setLocale(), that locale is returned. Otherwise, getDefaultLocale() is consulted, and finally the system-wide locale.

Returns:

Since:

3.2

getRenderedOf

HTMLElement getRenderedOf(objJSX : jsx3.app.Model)

Returns the browser DOM object where a particulat JSX object renders. This method inspects the main root of this server as well as all of its jsx3.gui.Window roots.

Parameters:

objJSX –

Returns:

DOM object

getRootBlock

jsx3.gui.Block getRootBlock()

Returns the root block for this server (JSXROOT)

Returns:

getRootObjects

Array<jsx3.app.Model> getRootObjects()

Returns the list of objects that are children of the body object. These are the root objects in a serialization file and the root nodes in the Component Hierarchy palette.

Returns:

getServer

jsx3.app.Server getServer()

Deprecated.

Conforms to the EventDispatcher contract.

Returns:

this object.

getSettings

jsx3.app.Settings getSettings()

Returns the settings of this server/project per config.xml

Returns:

getTaskBar

jsx3.gui.WindowBar getTaskBar(objJSX : jsx3.app.Model)

Returns handle to a descendant taskbar belonging to this server instance (this is where JSXDialog instances will try to minimize to if it exists); returns null if none found; if no taskbar is found, dialogs are not minimized, but are 'window shaded'—like a Mac used to do

Parameters:

objJSX – if null, this.JSXROOT is assumed; otherwise the object in the DOM from which to start looking for a descendant taskbar (a jsx3.gui.WindowBar instance)

Returns:

getUriPrefix

String getUriPrefix()

Returns:

Overrides:

getUriPrefix in jsx3.net.URIResolver

Since:

3.2

getVersion

static String getVersion()

Deprecated.

Returns version of the JSX runtime; separate versions are also available for GUI and Operational classes

Returns:

app version number (major (MM), minor (mm), and dot release (dd)) MM.mm.dd

invokeHelp

void invokeHelp(objJSX : jsx3.app.Model)

Invokes context-sensitive help as though the user had pressed the help hot key in the context of the DOM node objJSX.

Parameters:

objJSX –

Since:

3.5

loadAppWindow

jsx3.gui.Window loadAppWindow(strSource : jsx3.xml.Entity | String)

Loads a new jsx3.gui.Window instance from a component file.

Parameters:

strSource – either an XML document containing the window to load or the URL of the component to load.

Throws:

{jsx3.lang.Exception} – if the loaded entity is not an instance of jsx3.gui.Window or if the name of window is not unique with respect to the already loaded windows

Returns:

Since:

3.2

loadInclude

jsx3.xml.Document | jsx3.net.Service | null loadInclude(strSrc : String | jsx3.net.URI, strId : String, strType : String, bReload : String)

Loads an external resource into this server instance. What this method does depends on the strType parameter.

script - Loads a JavaScript file asynchronously into the memory space of the page hosting this application; returns null.
css - Loads a CSS file asynchronously into the memory space of the page hosting this application; returns null.
xml or xsl - Loads an XML file synchronously into the XML cache of this application; returns the loaded jsx3.xml.Document instance.
jss or ljss - Loads a dynamic properties file or localized properties bundle synchronously into this application; returns null.
services - Loads and parses a mapping rules file synchronously; returns a new instance of jsx3.net.Service.

Parameters:

strSrc – the path to the resource.

strId – the unique identifier of the resource. A resource loaded by this method may clobber a previously loaded resource of the same type and id.

strType – the type of include, one of: css, jss, xml, xsl, script (for JavaScript), services (for mapping rules), or ljss.

bReload – if true, a JavaScript or CSS file is reloaded from the remote server without checking the local browser cache. Other types of resources are not affected by this parameter.

Throws:

{jsx3.lang.IllegalArgumentException} – if strType in not a valid type.

Returns:

the return type depends on the strType parameter. See the method description.

loadResource

jsx3.xml.Document | jsx3.net.Service | null loadResource(strId : String)

Loads an application resource. This method looks up a resource registered with this application by its id. The resource must be registered in the config.xml file of this application.

Parameters:

strId – unique identifier for the resource (its unique id as an application resource file).

Returns:

the return type depends on the type of resource. See the documentation for loadInclude() for more information.

paint

void paint(objXML : jsx3.xml.Document)

Paints this application and its default component into the application view port on the host HTML page. The system class loader calls this method once all the required resources of the application have loaded. The order of actions taken by this method is:

Load the default component file
Execute the onload script for the application
Paint the default component in the view port

Parameters:

objXML – the pre-loaded default component document.

relativizeURI

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

Parameters:

strURI – the URI to relativize.

bRel –

Returns:

the relativized URI.

Overrides:

relativizeURI in jsx3.net.URIResolver

Since:

3.2

reloadLocalizedResources

void reloadLocalizedResources()

Reloads all resource files that are localized. This method should be called after calling setLocale() for the server to render properly in the new locale.

Since:

3.2

resolveURI

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

Resolves a URI that is referenced from a file in this server. This method takes into account the changes in resource addressing between 3.1 and 3.2. For version 3.1, the URI is resolved as any URI in the system, using jsx3.resolveURI(). In version 3.2, the URI is taken as relative to the application folder. In particular, a relative URI will be resolved to a base of the application folder, an absolute URI will be unaffected.

Parameters:

strURI – the URI to resolve.

Returns:

the resolved URI.

Overrides:

resolveURI in jsx3.net.URIResolver

Since:

3.2

setCookie

void setCookie(name : String, value : String, expires : Date, path : String, domain : String, secure : boolean, bRaw : ?)

Sets a Cookie with the given name and value

Parameters:

name – name of the cookie

value – value of the cookie

expires – valid jscript date object. for example: new Date("11:59:59 12-31-2004")

path – path where the cookie is valid (default: path of calling document)

domain – domain where the cookie is valid (default: domain of calling document)

secure – valid jscript date object. for example: new Date("11:59:59 12-31-2004")

bRaw –

setDimensions

void setDimensions(left : int | Array, top : int, width : int, height : int)

set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. Must be called during/after the onload event for the server instance as it affects the VIEW for the server. Updates the absolutely positioned element that contains JSXROOT.

Parameters:

left – the new left value or a JavaScript array containing all four new values (in pixels)

top – the new top value (in pixels)

width – the new width value (in pixels)

height – the new height value (in pixels)

setDynamicProperty

void setDynamicProperty(strPropName : String, vntValue : String)

updates a single dynamic style property; dynamic properties are used by jsx3.gui.Block objects that extend the astract class, jsx3.gui.Block;

Parameters:

strPropName – id for this dynamic property among all properties

vntValue – value of the property; if null, the property with the name, @strPropName will be removed

setLocale

void setLocale(objLocale : jsx3.util.Locale)

Sets the locale of this server.

Parameters:

objLocale –

Since:

3.2

toString

String toString()

Returns:

Overrides:

toString in jsx3.lang.Object

unloadInclude

void unloadInclude(strId : String)

Removes a loaded JavaScript or CSS resource from the browser DOM.

Parameters:

strId – the id used when loading the resource.

jsx3.app

class Settings

Object

->jsx3.lang.Object

->jsx3.app.Settings

class Settings
extends jsx3.lang.Object

Read-Only system settings interface.

Since:

3.0

Field Summary
static int	DOMAIN_ADDIN
static int	DOMAIN_PROJECT
static int	DOMAIN_SYSTEM Deprecated.

Constructor Summary
void	init(intDomain : int \| jsx3.xml.Document, objInstance : String \| Object) The instance initializer.

Method Summary
String \| Number \| boolean \| Array \| Object	get(strKey : String...) Returns a stored setting value.
jsx3.xml.Entity	getNode(strKey : String...) Returns a stored setting value as the raw XML node.

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

Field Detail

DOMAIN_ADDIN

static final int DOMAIN_ADDIN

DOMAIN_PROJECT

static final int DOMAIN_PROJECT

DOMAIN_SYSTEM

static final int DOMAIN_SYSTEM

Deprecated.

Constructor Detail

init

void init(intDomain : int | jsx3.xml.Document, objInstance : String | Object)

The instance initializer. Creates a view onto the settings persisted on disk. All identical instances of this class are backed by the same XML source document.

Parameters:

intDomain – the domain of the settings to load, one of jsx3.app.Settings.DOMAIN...

objInstance – if in the project or addin domain, the key of the specific project or addin to load settings for

Throws:

{jsx3.lang.IllegalArgumentException} – if intDomain is not a valid domain

Method Detail

get

String | Number | boolean | Array | Object get(strKey : String...)

Returns a stored setting value.

Parameters:

strKey – the setting key.

Returns:

the stored value.

getNode

jsx3.xml.Entity getNode(strKey : String...)

Returns a stored setting value as the raw XML node.

Parameters:

strKey – the setting key.

Returns:

jsx3.app

class UserSettings

Object

->jsx3.lang.Object

->jsx3.app.UserSettings

class UserSettings
extends jsx3.lang.Object

Read-Write per-User settings for a particular GI application (server).

This implementation stores settings in a browser cookie.

Since:

3.0

Field Summary
static int	PERSIST_INDEFINITE
static int	PERSIST_SESSION

Constructor Summary
void	init(objServer : jsx3.app.Server, intPersistence : int) The instance initializer.

Method Summary
void	clear() Clears all settings of this user settings instance.
String \| Number \| boolean \| Array \| Object	get(strKey : String...) Returns a stored setting value.
void	remove(strKey : String...) Removes a stored setting value.
void	save() Persists the user settings.
void	set(strKey : String..., value : String \| Number \| boolean \| Array \| Object) Sets a stored setting value.

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

Field Detail

PERSIST_INDEFINITE

static final int PERSIST_INDEFINITE

PERSIST_SESSION

static final int PERSIST_SESSION

Constructor Detail

init

void init(objServer : jsx3.app.Server, intPersistence : int)

The instance initializer.

Parameters:

objServer – the app server.

intPersistence – the persistence code, defaults to PERSIST_INDEFINITE.

Method Detail

clear

void clear()

Clears all settings of this user settings instance. This implementation deletes the cookie.

get

String | Number | boolean | Array | Object get(strKey : String...)

Returns a stored setting value.

Parameters:

strKey – the setting key.

Returns:

the stored value.

remove

void remove(strKey : String...)

Removes a stored setting value.

Parameters:

strKey – the key of the setting to remove.

save

void save()

Persists the user settings. Any modifications to this user settings instance will be lost if this method is not called.

set

void set(strKey : String..., value : String | Number | boolean | Array | Object)

Sets a stored setting value.

Parameters:

strKey – the setting key.

value – the value to store.

package jsx3.chart

Various Charting related constants and utility functions.

Version:

1.1

Authors:

Jesse Costello-Good

Class Summary
jsx3.chart.AreaChart	An area chart.
jsx3.chart.AreaSeries	A data series for an area chart.
jsx3.chart.Axis	A base class for all types of axis.
jsx3.chart.BCChart	Superclass of bar and column chart.
jsx3.chart.BCSeries	Shared functionality between BarSeries and ColumnSeries.
jsx3.chart.BarChart	A bar chart.
jsx3.chart.BarSeries	The data series type for a jsx3.chart.BarChart.
jsx3.chart.BubbleSeries	A data series used for a jsx3.chart.BubbleChart.
jsx3.chart.CartesianChart	Base chart class for charts that render on a cartesian plane with x and y axes.
jsx3.chart.CategoryAxis	Axis type that displays a set of discrete values (categories).
jsx3.chart.Chart	The base class for all charts in this package.
jsx3.chart.ChartComponent	A base class for every logical component of a chart.
jsx3.chart.ChartLabel	A chart component to render a text box.
jsx3.chart.ColumnChart	A column chart.
jsx3.chart.ColumnSeries	The data series type for a jsx3.chart.ColumnChart.
jsx3.chart.GridLines	A chart component that renders a grid of lines and fills aligned with an x and y axis.
jsx3.chart.Legend	Chart component that renders a simple legend.
jsx3.chart.LineChart	A line chart.
jsx3.chart.LineSeries	A data series for a line chart.
jsx3.chart.LinearAxis	Type of axis that displays a linear range of values.
jsx3.chart.LogarithmicAxis	An axis that displays a range of values logarithmically (base^n and base^(n+1) occupy same visual space).
jsx3.chart.PieChart	A pie chart.
jsx3.chart.PieSeries	A data series for a pie chart.
jsx3.chart.PlotChart	An plot (scatter/point/bubble) chart.
jsx3.chart.PlotSeries	Class encapsulating behavior shared by PointSeries and BubbleSeries
jsx3.chart.PointRenderer	Objects that implement this interface may be used in Line/Area/Point/Bubble charts to render the points that appear at each datapoint.
jsx3.chart.PointSeries	A data series used for a jsx3.chart.PointChart.
jsx3.chart.RadialChart	Base class for radial charts (pie chart is only example so far).
jsx3.chart.Series	The base class for all data series classes.

Field Summary
static String	QBOTTOM bottom/south quadrant
static String	QLEFT left/west quadrant
static String	QRIGHT right/east quadrant
static String	QTOP top/north quadrant

Method Summary
static jsx3.vector.Fill	addGradient(fill : jsx3.vector.Fill, value : String) Utility function, combines a vector fill and the property editor string format of a gradient
static Number	asNumber(v : Object) Utility function, converts a value to a Number
static boolean	isCategoryAxis(obj : Object) Tests whether an object is an Axis that displays set of discreet categories
static boolean	isValueAxis(obj : Object) Tests whether an object is an Axis that displays a range of number values
static Array	parseGradient(value : String) Utility function, parses the property editor string format of a gradient into its constituent parts
static Array	splitBox(left : int, top : int, width : int, height : int, placement : String, w : int, h : int) Splits a rectangular box in two pieces.

Field Detail

QBOTTOM

static final String QBOTTOM

bottom/south quadrant

QLEFT

static final String QLEFT

left/west quadrant

QRIGHT

static final String QRIGHT

right/east quadrant

QTOP

static final String QTOP

top/north quadrant

Method Detail

addGradient

static jsx3.vector.Fill addGradient(fill : jsx3.vector.Fill, value : String)

Utility function, combines a vector fill and the property editor string format of a gradient

Parameters:

fill – the base fill

value – the gradient in the form "color [angle [alpha [colors ...]]]"

Returns:

asNumber

static Number asNumber(v : Object)

Utility function, converts a value to a Number

Parameters:

v –

Returns:

isCategoryAxis

static boolean isCategoryAxis(obj : Object)

Tests whether an object is an Axis that displays set of discreet categories

Parameters:

obj –

Returns:

isValueAxis

static boolean isValueAxis(obj : Object)

Tests whether an object is an Axis that displays a range of number values

Parameters:

obj –

Returns:

parseGradient

static Array parseGradient(value : String)

Utility function, parses the property editor string format of a gradient into its constituent parts

Parameters:

value – the gradient in the form "color [angle [alpha [colors ...]]]"

Returns:

[color,angle,alpha,colors]

splitBox

static Array splitBox(left : int, top : int, width : int, height : int, placement : String, w : int, h : int)

Splits a rectangular box in two pieces.

Parameters:

left – the left value of the box to split

top – the top value of the box to split

width – the width value of the box to split

height – the height value of the box to split

placement – {top,left,right,bottom} where to place the first sub-box

w – the desired width of the first sub-box

h – the desired height of the first sub-box

Returns:

[[l1,t1,w1,h1],[l2,t2,w2,h2]]

jsx3.chart

class AreaChart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

->jsx3.chart.CartesianChart

->jsx3.chart.AreaChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

class AreaChart
extends jsx3.chart.CartesianChart

An area chart.

Series: AreaSeries only.
Axes: Y axis must be value axis, X axis can be value or category axis

The 'type' my be 'overlay', 'stacked', or 'stacked100', which correspond to the basic Excel-like variations of an area chart.

Field Summary
static String	TYPE_OVERLAY
static String	TYPE_STACKED
static String	TYPE_STACKED100

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
String	getType() Returns the type field, corresponds to the variation of area chart, one of {'overlay','stacked','stacked100'}.
static String	getVersion() Deprecated.
void	getXRange(series : ?) Returns the range of x values, used when x axis is value axis.
void	getYRange(series : ?) Returns the range of y values, considers chart type.
void	setType(type : String) Sets the type field.

Methods Inherited From jsx3.chart.CartesianChart
getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis

Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

TYPE_OVERLAY

static final String TYPE_OVERLAY

TYPE_STACKED

static final String TYPE_STACKED

TYPE_STACKED100

static final String TYPE_STACKED100

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getType

String getType()

Returns the type field, corresponds to the variation of area chart, one of {'overlay','stacked','stacked100'}.

Returns:

type

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

getXRange

void getXRange(series : ?)

Returns the range of x values, used when x axis is value axis.

Parameters:

series –

Overrides:

getXRange in jsx3.chart.CartesianChart

getYRange

void getYRange(series : ?)

Returns the range of y values, considers chart type.

Parameters:

series –

Overrides:

getYRange in jsx3.chart.CartesianChart

setType

void setType(type : String)

Sets the type field.

Parameters:

type – the new value for type, one of {'overlay','stacked','stacked100'}

jsx3.chart

class AreaSeries

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Series

->jsx3.chart.AreaSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class AreaSeries
extends jsx3.chart.Series

A data series for an area chart. An area series draws a solid polygon between the x-axis and a line defined by the data provider, or between a minimum line and a maximum line both defined by the data provider. An area series has the following properties:

xField: the attribute of a record to use as the x-coordinate of points defining the min and max line of the area, required if the x-axis is a value axis
yField: the attribute of a record to use as the y-coordinate of points defining the max line of the area, required
minField: the attribute of a record to use as the y-coordinate of points defining the min line of the area, optional
form: defines how the area is drawn, one of {'segment','step','reverseStep'}, defaults to 'segment'

The area series can also be painted with points at each data point. See LineSeries for a description of the relevant fields.

Field Summary
static String	FORM_REVSTEP
static String	FORM_SEGMENT
static String	FORM_STEP

Constructor Summary
void	init(name : String, seriesName : String) The instance initializer.

Method Summary
String	getForm() Returns the form field.
String	getMinField() Returns the minField field.
Number	getMinValue(record : jsx3.xml.Entity) Returns the minimum y-coordinate of a data point in this series for the given record.
String	getPointFill() Returns the pointFill field.
String	getPointGradient() Returns the pointGradient field.
int	getPointRadius() Returns the pointRadius field.
jsx3.chart.PointRenderer	getPointRenderer() Returns the pointRenderer field.
String	getPointStroke() Returns the pointStroke field.
static String	getVersion() Deprecated.
String	getXField() Returns the xField field.
Number	getXValue(record : jsx3.xml.Entity) Returns the x-coordinate of a data point in this series for the given record.
String	getYField() Returns the yField field.
Number	getYValue(record : jsx3.xml.Entity) Returns the y-coordinate of a data point in this series for the given record.
void	setForm(form : String) Sets the form field, checks for valid value.
void	setMinField(minField : String) Sets the minField field.
void	setPointFill(pointFill : String) Sets the pointFill field, string representation of vector fill.
void	setPointGradient(pointGradient : String) Sets the pointGradient field, string representation of vector fill gradient.
void	setPointRadius(pointRadius : int) Sets the pointRadius field.
void	setPointRenderer(pointRenderer : String) Sets the pointRenderer field.
void	setPointStroke(pointStroke : String) Sets the pointStroke field, string representation of VectorStroke.
void	setXField(xField : String) Sets the xField field.
void	setYField(yField : String) Sets the yField field.
static String	tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity) The default tooltip function for this type of series.

Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

FORM_REVSTEP

static final String FORM_REVSTEP

FORM_SEGMENT

static final String FORM_SEGMENT

FORM_STEP

static final String FORM_STEP

Constructor Detail

init

void init(name : String, seriesName : String)

The instance initializer.

Parameters:

name – the GI name of the instance

seriesName – the name of the Series, will be displayed in the Legend for most chart types

Method Detail

getForm

String getForm()

Returns the form field.

Returns:

form

getMinField

String getMinField()

Returns the minField field.

Returns:

minField

getMinValue

Number getMinValue(record : jsx3.xml.Entity)

Returns the minimum y-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

getPointFill

String getPointFill()

Returns the pointFill field.

Returns:

pointFill

getPointGradient

String getPointGradient()

Returns the pointGradient field.

Returns:

pointGradient

getPointRadius

int getPointRadius()

Returns the pointRadius field.

Returns:

pointRadius

getPointRenderer

jsx3.chart.PointRenderer getPointRenderer()

Returns the pointRenderer field.

Returns:

pointRenderer

getPointStroke

String getPointStroke()

Returns the pointStroke field.

Returns:

pointStroke

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

getXField

String getXField()

Returns the xField field.

Returns:

xField

getXValue

Number getXValue(record : jsx3.xml.Entity)

Returns the x-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

getYField

String getYField()

Returns the yField field.

Returns:

yField

getYValue

Number getYValue(record : jsx3.xml.Entity)

Returns the y-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

setForm

void setForm(form : String)

Sets the form field, checks for valid value.

Parameters:

form – the new value for form, one of {'segment','step','reverseStep'}

setMinField

void setMinField(minField : String)

Sets the minField field.

Parameters:

minField – the new value for minField

setPointFill

void setPointFill(pointFill : String)

Sets the pointFill field, string representation of vector fill.

Parameters:

pointFill – the new value for pointFill

setPointGradient

void setPointGradient(pointGradient : String)

Sets the pointGradient field, string representation of vector fill gradient.

Parameters:

pointGradient – the new value for pointGradient

setPointRadius

void setPointRadius(pointRadius : int)

Sets the pointRadius field.

Parameters:

pointRadius – the new value for pointRadius

setPointRenderer

void setPointRenderer(pointRenderer : String)

Sets the pointRenderer field.

Parameters:

pointRenderer – the new value for pointRenderer, should eval to an object that implements the renderer interface

setPointStroke

void setPointStroke(pointStroke : String)

Sets the pointStroke field, string representation of VectorStroke.

Parameters:

pointStroke – the new value for pointStroke

setXField

void setXField(xField : String)

Sets the xField field.

Parameters:

xField – the new value for xField

setYField

void setYField(yField : String)

Sets the yField field.

Parameters:

yField – the new value for yField

tooltip

static String tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity)

The default tooltip function for this type of series.

Parameters:

series –

record –

Returns:

jsx3.chart

class Axis

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Axis

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

Direct Known Subclasses:

jsx3.chart.CategoryAxis, jsx3.chart.LinearAxis, jsx3.chart.LogarithmicAxis

class Axis
extends jsx3.chart.ChartComponent

A base class for all types of axis. Provides all the common properties as well as all rendering logic. Rendering relies on template methods implemented in concrete subclasses.

An axis renders in the following location based on its horizontal and primary properties:

  horizontal x primary   -> bottom
  vertical x primary     -> left
  horizontal x secondary -> top
  vertical x secondary   -> right

Field Summary
static String	LABEL_AXIS
static String	LABEL_HIGH
static String	LABEL_LOW
static String	TICK_CROSS
static String	TICK_INSIDE
static String	TICK_NONE
static String	TICK_OUTSIDE

Constructor Summary
void	init(name : String, horizontal : boolean, primary : boolean) The instance initializer.

Method Summary
String	getAxisStroke() Returns the axisStroke field, string representation of the VectorStroke used to draw the line of the axis.
jsx3.chart.ChartLabel	getAxisTitle() Returns the optional jsx3.chart.ChartLabel child.
int	getDisplayWidth() Returns the display width, the maximum amount of space perpendicular to the axis and outside of the data area that the ticks and labels may occupy (doesn't include area given to axis title).
boolean	getHorizontal() Returns the horizontal field, whether this is an x axis, otherwise it is a y axis.
String	getLabelClass() Returns the labelClass field, the CSS class used to render major tick labels.
String \| Number	getLabelColor() Returns the labelColor field, the RGB color value of the label font; note that this is the only way to set the color of the text, using a CSS style attribute will have no effect.
Function	getLabelFunction() Returns the labelFunction field.
int	getLabelGap() Returns the labelGap field, the pixel gap between the tick lines and the labels.
String	getLabelStyle() Returns the labelStyle field, the CSS style attribute used to render major tick labels.
int	getMinorTickDivisions() Returns the minorTickDivisions field, number of minor tick divisions between major ticks; the number of minor ticks drawn will be this number minus 1.
int	getMinorTickLength() Returns the minorTickLength field, the length in pixels of the minor tick (if tickPlacement is "cross" the length will actually be twice this.
String	getMinorTickPlacement() Returns the minorTickPlacement field, where to place the minor ticks.
String	getMinorTickStroke() Returns the minorTickStroke field, string representation of VectorStroke used to draw minor ticks.
jsx3.chart.Axis	getOpposingAxis() Returns the opposing axis.
boolean	getShowAxis() Returns the showAxis field, whether to show the line along the axis.
boolean	getShowLabels() Returns the showLabels field, whether to show major tick labels.
int	getTickLength() Returns the tickLength field, the length in pixels of the major tick (if tickPlacement is "cross" the length will actually be twice this.
String	getTickPlacement() Returns the tickPlacement field, where to place the major ticks.
String	getTickStroke() Returns the tickStroke field, string representation of VectorStroke used to draw major ticks.
static String	getVersion() Deprecated.
static String	percent(v : Number) formats labels as a percent, ie "50%"
static String	scientific(v : Number, signif : int) formats labels in scientific notation, ie "5e2"
void	setAxisStroke(axisStroke : String) Sets the axisStroke field.
void	setDisplayWidth(displayWidth : int) Sets the displayWidth field.
void	setHorizontal(horizontal : boolean) Sets the horizontal field.
void	setLabelClass(labelClass : String) Sets the labelClass field.
void	setLabelColor(labelColor : String \| Number) Sets the labelColor field.
void	setLabelFunction(labelFunction : String) Sets the labelFunction field, allows for formatting and transformation of a major tick label; should eval to a function with the signature function(object) : string.
void	setLabelGap(labelGap : int) Sets the labelGap field.
void	setLabelPlacement(labelPlacement : String) Sets the labelPlacement field, checks for invalid values.
void	setLabelStyle(labelStyle : String) Sets the labelStyle field.
void	setMinorTickDivisions(minorTickDivisions : int) Sets the minorTickDivisions field.
void	setMinorTickLength(minorTickLength : int) Sets the minorTickLength field.
void	setMinorTickPlacement(minorTickPlacement : String) Sets the minorTickPlacement field.
void	setMinorTickStroke(minorTickStroke : String) Sets the minorTickStroke field.
void	setShowAxis(showAxis : boolean) Sets the showAxis field.
void	setShowLabels(showLabels : boolean) Sets the showLabels field.
void	setTickLength(tickLength : int) Sets the tickLength field.
void	setTickPlacement(tickPlacement : String) Sets the tickPlacement field.
void	setTickStroke(tickStroke : String) Sets the tickStroke field.

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

LABEL_AXIS

static final String LABEL_AXIS

LABEL_HIGH

static final String LABEL_HIGH

LABEL_LOW

static final String LABEL_LOW

TICK_CROSS

static final String TICK_CROSS

TICK_INSIDE

static final String TICK_INSIDE

TICK_NONE

static final String TICK_NONE

TICK_OUTSIDE

static final String TICK_OUTSIDE

Constructor Detail

init

void init(name : String, horizontal : boolean, primary : boolean)

The instance initializer.

Parameters:

name – the GI name of the instance

horizontal – whether this axis is horizontal (x), otherwise it's vertical (y)

primary – whether this axis is primary, otherwise it's secondary

Method Detail

getAxisStroke

String getAxisStroke()

Returns the axisStroke field, string representation of the VectorStroke used to draw the line of the axis.

Returns:

axisStroke

getAxisTitle

jsx3.chart.ChartLabel getAxisTitle()

Returns the optional jsx3.chart.ChartLabel child.

Returns:

getDisplayWidth

int getDisplayWidth()

Returns the display width, the maximum amount of space perpendicular to the axis and outside of the data area that the ticks and labels may occupy (doesn't include area given to axis title).

Returns:

displayWidth

getHorizontal

boolean getHorizontal()

Returns the horizontal field, whether this is an x axis, otherwise it is a y axis.

Returns:

horizontal

getLabelClass

String getLabelClass()

Returns the labelClass field, the CSS class used to render major tick labels.

Returns:

labelClass

getLabelColor

String | Number getLabelColor()

Returns the labelColor field, the RGB color value of the label font; note that this is the only way to set the color of the text, using a CSS style attribute will have no effect.

Returns:

labelColor

getLabelFunction

Function getLabelFunction()

Returns the labelFunction field.

Returns:

labelFunction

getLabelGap

int getLabelGap()

Returns the labelGap field, the pixel gap between the tick lines and the labels.

Returns:

labelGap

getLabelStyle

String getLabelStyle()

Returns the labelStyle field, the CSS style attribute used to render major tick labels.

Returns:

labelStyle

getMinorTickDivisions

int getMinorTickDivisions()

Returns the minorTickDivisions field, number of minor tick divisions between major ticks; the number of minor ticks drawn will be this number minus 1.

Returns:

minorTickDivisions

getMinorTickLength

int getMinorTickLength()

Returns the minorTickLength field, the length in pixels of the minor tick (if tickPlacement is "cross" the length will actually be twice this.

Returns:

minorTickLength

getMinorTickPlacement

String getMinorTickPlacement()

Returns the minorTickPlacement field, where to place the minor ticks.

Returns:

minorTickPlacement, one of {'none','inside','outside','cross'}

getMinorTickStroke

String getMinorTickStroke()

Returns the minorTickStroke field, string representation of VectorStroke used to draw minor ticks.

Returns:

minorTickStroke

getOpposingAxis

jsx3.chart.Axis getOpposingAxis()

Returns the opposing axis.

Returns:

getShowAxis

boolean getShowAxis()

Returns the showAxis field, whether to show the line along the axis.

Returns:

showAxis

getShowLabels

boolean getShowLabels()

Returns the showLabels field, whether to show major tick labels.

Returns:

showLabels

getTickLength

int getTickLength()

Returns the tickLength field, the length in pixels of the major tick (if tickPlacement is "cross" the length will actually be twice this.

Returns:

tickLength

getTickPlacement

String getTickPlacement()

Returns the tickPlacement field, where to place the major ticks.

Returns:

tickPlacement, one of {'none','inside','outside','cross'}

getTickStroke

String getTickStroke()

Returns the tickStroke field, string representation of VectorStroke used to draw major ticks.

Returns:

tickStroke

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

percent

static String percent(v : Number)

formats labels as a percent, ie "50%"

Parameters:

v –

Returns:

scientific

static String scientific(v : Number, signif : int)

formats labels in scientific notation, ie "5e2"

Parameters:

v –

signif –

Returns:

setAxisStroke

void setAxisStroke(axisStroke : String)

Sets the axisStroke field.

Parameters:

axisStroke – the new value for axisStroke

setDisplayWidth

void setDisplayWidth(displayWidth : int)

Sets the displayWidth field.

Parameters:

displayWidth – the new value for displayWidth

setHorizontal

void setHorizontal(horizontal : boolean)

Sets the horizontal field.

Parameters:

horizontal – the new value for horizontal

setLabelClass

void setLabelClass(labelClass : String)

Sets the labelClass field.

Parameters:

labelClass – the new value for labelClass

setLabelColor

void setLabelColor(labelColor : String | Number)

Sets the labelColor field.

Parameters:

labelColor – the new value for labelColor

setLabelFunction

void setLabelFunction(labelFunction : String)

Sets the labelFunction field, allows for formatting and transformation of a major tick label; should eval to a function with the signature function(object) : string.

Parameters:

labelFunction – the new value for labelFunction

setLabelGap

void setLabelGap(labelGap : int)

Sets the labelGap field.

Parameters:

labelGap – the new value for labelGap

setLabelPlacement

void setLabelPlacement(labelPlacement : String)

Sets the labelPlacement field, checks for invalid values.

Parameters:

labelPlacement – the new value for labelPlacement, one of {'axis','high','low'}

setLabelStyle

void setLabelStyle(labelStyle : String)

Sets the labelStyle field.

Parameters:

labelStyle – the new value for labelStyle

setMinorTickDivisions

void setMinorTickDivisions(minorTickDivisions : int)

Sets the minorTickDivisions field.

Parameters:

minorTickDivisions – the new value for minorTickDivisions

setMinorTickLength

void setMinorTickLength(minorTickLength : int)

Sets the minorTickLength field.

Parameters:

minorTickLength – the new value for minorTickLength

setMinorTickPlacement

void setMinorTickPlacement(minorTickPlacement : String)

Sets the minorTickPlacement field.

Parameters:

minorTickPlacement – the new value for minorTickPlacement, one of {'none','inside','outside','cross'}

setMinorTickStroke

void setMinorTickStroke(minorTickStroke : String)

Sets the minorTickStroke field.

Parameters:

minorTickStroke – the new value for minorTickStroke

setShowAxis

void setShowAxis(showAxis : boolean)

Sets the showAxis field.

Parameters:

showAxis – the new value for showAxis

setShowLabels

void setShowLabels(showLabels : boolean)

Sets the showLabels field.

Parameters:

showLabels – the new value for showLabels

setTickLength

void setTickLength(tickLength : int)

Sets the tickLength field.

Parameters:

tickLength – the new value for tickLength

setTickPlacement

void setTickPlacement(tickPlacement : String)

Sets the tickPlacement field.

Parameters:

tickPlacement – the new value for tickPlacement, one of {'none','inside','outside','cross'}

setTickStroke

void setTickStroke(tickStroke : String)

Sets the tickStroke field.

Parameters:

tickStroke – the new value for tickStroke

jsx3.chart

class BCChart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

->jsx3.chart.CartesianChart

->jsx3.chart.BCChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

Direct Known Subclasses:

jsx3.chart.BarChart, jsx3.chart.ColumnChart

class BCChart
extends jsx3.chart.CartesianChart

Superclass of bar and column chart. Contains all the common functionality, provides template methods to the subclasses so that they can render horizontal bars or vertical columns.

Basically abstracts a bar/column chart into a chart with a parallel dimension and a normal dimension. The parallel dimension is the dimension in which the rows/columns extend.

Field Summary
static String	TYPE_CLUSTERED
static String	TYPE_STACKED
static String	TYPE_STACKED100

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
float	getCategoryCoverage() Returns the categoryCoverage field, the ratio of the range of a category that is covered by bars/columns.
float	getSeriesOverlap() Returns the seriesOverlap field, the ratio of a column width/row height that a column/row overlaps with the adjacent column/row.
String	getType() Returns the type field, corresponds to the variation of chart, one of {'clustered','stacked','stacked100'}.
static String	getVersion() Deprecated.
void	setCategoryCoverage(categoryCoverage : float) Sets the categoryCoverage field.
void	setSeriesOverlap(seriesOverlap : float) Sets the seriesOverlap field.
void	setType(type : String) Sets the type field.

Methods Inherited From jsx3.chart.CartesianChart
getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis, getXRange, getYRange

Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

TYPE_CLUSTERED

static final String TYPE_CLUSTERED

TYPE_STACKED

static final String TYPE_STACKED

TYPE_STACKED100

static final String TYPE_STACKED100

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getCategoryCoverage

float getCategoryCoverage()

Returns the categoryCoverage field, the ratio of the range of a category that is covered by bars/columns.

Returns:

categoryCoverage

getSeriesOverlap

float getSeriesOverlap()

Returns the seriesOverlap field, the ratio of a column width/row height that a column/row overlaps with the adjacent column/row.

Returns:

seriesOverlap

getType

String getType()

Returns the type field, corresponds to the variation of chart, one of {'clustered','stacked','stacked100'}.

Returns:

type

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

setCategoryCoverage

void setCategoryCoverage(categoryCoverage : float)

Sets the categoryCoverage field.

Parameters:

categoryCoverage – the new value for categoryCoverage, between 0 and 1

setSeriesOverlap

void setSeriesOverlap(seriesOverlap : float)

Sets the seriesOverlap field.

Parameters:

seriesOverlap – the new value for seriesOverlap, usually between -0.5 and 0.5

setType

void setType(type : String)

Sets the type field.

Parameters:

type – the new value for type, one of {'clustered','stacked','stacked100'}

jsx3.chart

class BCSeries

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Series

->jsx3.chart.BCSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

Direct Known Subclasses:

jsx3.chart.BarSeries, jsx3.chart.ColumnSeries

class BCSeries
extends jsx3.chart.Series

Shared functionality between BarSeries and ColumnSeries.

Constructor Summary
void	init(name : String, seriesName : String) The instance initializer.

Method Summary
String	getMinField() Returns the minField field.
Number	getMinValue(record : jsx3.xml.Entity) Returns the minimum value (x or y) of a data point in this series for the given record.
static String	getVersion() Deprecated.
String	getXField() Returns the xField field.
Number	getXValue(record : jsx3.xml.Entity) Returns the x-coordinate of a data point in this series for the given record.
String	getYField() Returns the yField field.
Number	getYValue(record : jsx3.xml.Entity) Returns the y-coordinate of a data point in this series for the given record.
void	setMinField(minField : String) Sets the minField field.
void	setXField(xField : String) Sets the xField field.
void	setYField(yField : String) Sets the yField field.

Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String, seriesName : String)

The instance initializer.

Parameters:

name – the GI name of the instance

seriesName – the name of the Series, will be displayed in the Legend for most chart types

Method Detail

getMinField

String getMinField()

Returns the minField field.

Returns:

minField

getMinValue

Number getMinValue(record : jsx3.xml.Entity)

Returns the minimum value (x or y) of a data point in this series for the given record.

Parameters:

record – the node

Returns:

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

getXField

String getXField()

Returns the xField field.

Returns:

xField

getXValue

Number getXValue(record : jsx3.xml.Entity)

Returns the x-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

getYField

String getYField()

Returns the yField field.

Returns:

yField

getYValue

Number getYValue(record : jsx3.xml.Entity)

Returns the y-coordinate of a data point in this series for the given record.

Parameters:

record – the node

Returns:

setMinField

void setMinField(minField : String)

Sets the minField field.

Parameters:

minField – the new value for minField

setXField

void setXField(xField : String)

Sets the xField field.

Parameters:

xField – the new value for xField

setYField

void setYField(yField : String)

Sets the yField field.

Parameters:

yField – the new value for yField

jsx3.chart

class BarChart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

->jsx3.chart.CartesianChart

->jsx3.chart.BCChart

->jsx3.chart.BarChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

class BarChart
extends jsx3.chart.BCChart

A bar chart.

Series: BarSeries only.
Axes: X axis must be value axis, Y axis can be value or category axis

The 'type' my be 'clustered', 'stacked', or 'stacked100', which correspond to the basic Excel-like variations of a bar chart.

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
Array<Number>	getXRange(series : ?)
Array<Number>	getYRange(series : ?)

Methods Inherited From jsx3.chart.BCChart
getCategoryCoverage, getSeriesOverlap, getType, setCategoryCoverage, setSeriesOverlap, setType

Methods Inherited From jsx3.chart.CartesianChart
getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis

Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getXRange

Array<Number> getXRange(series : ?)

Parameters:

series –

Returns:

[min, max].

Overrides:

getXRange in jsx3.chart.CartesianChart

getYRange

Array<Number> getYRange(series : ?)

Parameters:

series –

Returns:

[min, max].

Overrides:

getYRange in jsx3.chart.CartesianChart

jsx3.chart

class BarSeries

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Series

->jsx3.chart.BCSeries

->jsx3.chart.BarSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class BarSeries
extends jsx3.chart.BCSeries

The data series type for a jsx3.chart.BarChart. Draws horizontal bars between the y axis and an x value determined by the data provider, or between two x values determined by the data provider. A bar series has the following fields:

xField: the attribute of a record to use as the horizontal extent of the bar, required
yField: the attribute of a record to use as the vertical midpoint of the bar, required if the y axis of the chart is a value axis
minField: the attribute of a record to use as the minimum horizontal extent of the bar, optional

Field Summary
static int	DEFAULT_BARHEIGHT

Constructor Summary
void	init(name : String, seriesName : String) The instance initializer.

Method Summary
int	getBarHeight() Returns the barHeight field.
void	setBarHeight(barHeight : int) Sets the barHeight field.
static String	tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity) The default tooltip function for this type of series.

Methods Inherited From jsx3.chart.BCSeries
getMinField, getMinValue, getXField, getXValue, getYField, getYValue, setMinField, setXField, setYField

Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

DEFAULT_BARHEIGHT

static int DEFAULT_BARHEIGHT

Constructor Detail

init

void init(name : String, seriesName : String)

The instance initializer.

Parameters:

name – the GI name of the instance

seriesName – the name of the Series, will be displayed in the Legend for most chart types

Method Detail

getBarHeight

int getBarHeight()

Returns the barHeight field.

Returns:

barHeight

setBarHeight

void setBarHeight(barHeight : int)

Sets the barHeight field.

Parameters:

barHeight – the new value for barHeight

tooltip

static String tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity)

The default tooltip function for this type of series.

Parameters:

series –

record –

Returns:

jsx3.chart

class BubbleSeries

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Series

->jsx3.chart.PlotSeries

->jsx3.chart.BubbleSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class BubbleSeries
extends jsx3.chart.PlotSeries

A data series used for a jsx3.chart.BubbleChart. A bubble series has the following fields: xField - the attribute of a record to use as the x-coordinate of points in the series, required yField - the attribute of a record to use as the y-coordinate of points in the series, required magnitudeField - the attribute of a record to use as the magnitude of points in the series, required pointRenderer - string that evals to an object that implements the renderer interface, optional

Constructor Summary
void	init(name : String, seriesName : String) The instance initializer.

Method Summary
String	getMagnitudeField() Returns the magnitudeField field.
Number	getMagnitudeValue(record : jsx3.xml.Entity) Returns the magnitude of a data point in this series for the given record.
void	setMagnitudeField(magnitudeField : String) Sets the magnitudeField field.
static String	tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity) The default tooltip function for this type of series.

Methods Inherited From jsx3.chart.PlotSeries
getLegendRenderer, getRenderer, getXField, getXValue, getYField, getYValue, setRenderer, setXField, setYField

Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String, seriesName : String)

The instance initializer.

Parameters:

name – the GI name of the instance

seriesName – the name of the Series, will be displayed in the Legend for most chart types

Method Detail

getMagnitudeField

String getMagnitudeField()

Returns the magnitudeField field.

Returns:

magnitudeField

getMagnitudeValue

Number getMagnitudeValue(record : jsx3.xml.Entity)

Returns the magnitude of a data point in this series for the given record.

Parameters:

record – the node

Returns:

setMagnitudeField

void setMagnitudeField(magnitudeField : String)

Sets the magnitudeField field.

Parameters:

magnitudeField – the new value for magnitudeField

tooltip

static String tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity)

The default tooltip function for this type of series.

Parameters:

series –

record –

Returns:

jsx3.chart

class CartesianChart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

->jsx3.chart.CartesianChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

Direct Known Subclasses:

jsx3.chart.AreaChart, jsx3.chart.BCChart, jsx3.chart.LineChart, jsx3.chart.PlotChart

class CartesianChart
extends jsx3.chart.Chart

Base chart class for charts that render on a cartesian plane with x and y axes. Currently only supports primary x and y axes, even though there are methods pertaining to secondary axes.

Cartesian charts can have the following additional children:

{0,n} GridLines, will render lines aligned with the axes below or above the data series
{2,n} Axis, required to define the coordinate space of the cartesian plane

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
Array<jsx3.chart.GridLines>	getGridLines() Returns the array of children GridLines instances.
jsx3.chart.Axis	getPrimaryXAxis() Returns the primary x axis, if any.
jsx3.chart.Axis	getPrimaryYAxis() Returns the primary y axis, if any.
Array<Number>	getRangeForAxis(axis : jsx3.chart.Axis) Returns the range for axis, delegates to getXRange() or getYRange().
static String	getVersion() Deprecated.
abstract Array<Number>	getXRange(series : Array<jsx3.chart.Series>) Returns the range of x values in the data provider, subclasses must implement.
abstract Array<Number>	getYRange(series : Array<jsx3.chart.Series>) Returns the range of y values in the data provider, subclasses must implement.

Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getGridLines

Array<jsx3.chart.GridLines> getGridLines()

Returns the array of children GridLines instances.

Returns:

gridLines

getPrimaryXAxis

jsx3.chart.Axis getPrimaryXAxis()

Returns the primary x axis, if any.

Returns:

primaryXAxis

getPrimaryYAxis

jsx3.chart.Axis getPrimaryYAxis()

Returns the primary y axis, if any.

Returns:

primaryYAxis

getRangeForAxis

Array<Number> getRangeForAxis(axis : jsx3.chart.Axis)

Returns the range for axis, delegates to getXRange() or getYRange().

Parameters:

axis –

Returns:

[min,max] or null if no range can be found

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

getXRange

abstract Array<Number> getXRange(series : Array<jsx3.chart.Series>)

Returns the range of x values in the data provider, subclasses must implement.

Parameters:

series – the series to consider

Returns:

[min,max] or null if no range can be found

getYRange

abstract Array<Number> getYRange(series : Array<jsx3.chart.Series>)

Returns the range of y values in the data provider, subclasses must implement.

Parameters:

series – the series to consider

Returns:

[min,max] or null if no range can be found

jsx3.chart

class CategoryAxis

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Axis

->jsx3.chart.CategoryAxis

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class CategoryAxis
extends jsx3.chart.Axis

Axis type that displays a set of discrete values (categories). Usually a category corresponds to a record in the chart's data provider.

Field Summary
static String	TICKS_ALIGNED
static String	TICKS_BETWEEN

Constructor Summary
void	init(name : String, horizontal : boolean, primary : boolean) The instance initializer.

Method Summary
String	getCategoryField() Returns the categoryField field, the attribute of records from the data provider that contains the category name (this value can still be transformed by Axis's 'labelFunction' field).
float	getPaddingHigh() Returns the paddingHigh field, the number of category widths to pad the end of the axis with.
float	getPaddingLow() Returns the paddingLow field, the number of category widths to pad the beginning of the axis with.
String	getTickAlignment() Returns the tickAlignment field, if 'between' then the midpoint of the category is between two major ticks, otherwise if 'aligned' then the midpoint of the category is aligned with a major tick.
static String	getVersion() Deprecated.
void	setCategoryField(categoryField : String) Sets the categoryField field.
void	setPaddingHigh(paddingHigh : float) Sets the paddingHigh field.
void	setPaddingLow(paddingLow : float) Sets the paddingLow field.
void	setTickAlignment(tickAlignment : String) Sets the tickAlignment field.

Methods Inherited From jsx3.chart.Axis

getAxisStroke, getAxisTitle, getDisplayWidth, getHorizontal, getLabelClass, getLabelColor, getLabelFunction, getLabelGap, getLabelStyle, getMinorTickDivisions, getMinorTickLength, getMinorTickPlacement, getMinorTickStroke, getOpposingAxis, getShowAxis, getShowLabels, getTickLength, getTickPlacement, getTickStroke, setAxisStroke, setDisplayWidth, setHorizontal, setLabelClass, setLabelColor, setLabelFunction, setLabelGap, setLabelPlacement, setLabelStyle, setMinorTickDivisions, setMinorTickLength, setMinorTickPlacement, setMinorTickStroke, setShowAxis, setShowLabels, setTickLength, setTickPlacement, setTickStroke

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

TICKS_ALIGNED

static final String TICKS_ALIGNED

TICKS_BETWEEN

static final String TICKS_BETWEEN

Constructor Detail

init

void init(name : String, horizontal : boolean, primary : boolean)

The instance initializer.

Parameters:

name – the GI name of the instance

horizontal – whether this axis is horizontal (x), otherwise it's vertical (y)

primary – whether this axis is primary, otherwise it's secondary

Method Detail

getCategoryField

String getCategoryField()

Returns the categoryField field, the attribute of records from the data provider that contains the category name (this value can still be transformed by Axis's 'labelFunction' field).

Returns:

categoryField

getPaddingHigh

float getPaddingHigh()

Returns the paddingHigh field, the number of category widths to pad the end of the axis with.

Returns:

paddingHigh

getPaddingLow

float getPaddingLow()

Returns the paddingLow field, the number of category widths to pad the beginning of the axis with.

Returns:

paddingLow

getTickAlignment

String getTickAlignment()

Returns the tickAlignment field, if 'between' then the midpoint of the category is between two major ticks, otherwise if 'aligned' then the midpoint of the category is aligned with a major tick.

Returns:

tickAlignment, one of {'aligned','between'}

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

setCategoryField

void setCategoryField(categoryField : String)

Sets the categoryField field.

Parameters:

categoryField – the new value for categoryField

setPaddingHigh

void setPaddingHigh(paddingHigh : float)

Sets the paddingHigh field.

Parameters:

paddingHigh – the new value for paddingHigh

setPaddingLow

void setPaddingLow(paddingLow : float)

Sets the paddingLow field.

Parameters:

paddingLow – the new value for paddingLow

setTickAlignment

void setTickAlignment(tickAlignment : String)

Sets the tickAlignment field.

Parameters:

tickAlignment – the new value for tickAlignment, one of {'aligned','between'}

jsx3.chart

class Chart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

Direct Known Subclasses:

jsx3.chart.CartesianChart, jsx3.chart.RadialChart

class Chart
extends jsx3.vector.Block

The base class for all charts in this package. Encapsulates common functionality shared by all charts.

In general, a chart is responsible for managing its children components and handling any coordination between them. A chart always manages the layout of its children.

All charts can have the following children:

{0,1} jsx3.chart.ChartLabel, will render as the chart's title
{0,1} Legend, will render as the chart's legend
{0,n} Series, will render the chart's data series; in general a subclass of Chart will only allow a certain subclass of Series

Field Summary
static Array<jsx3.vector.Fill>	DEFAULT_FILLS The default fill colors for series and categories whose fills are not specified.

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
float	getAlpha() Returns the alpha field, the opacity to render the chart's background.
float	getBorderAlpha() Returns the borderAlpha field, the opacity to render the chart's border.
String \| Number	getBorderColor() Returns the borderColor field, the RGB color to render the chart's border.
int	getBorderWidth() Returns the borderWidth field, the pixel width of the chart's border.
jsx3.chart.ChartLabel	getChartTitle() Find the first jsx3.chart.ChartLabel child
String	getDataPadding() Returns the dataPadding field, the CSS padding value that determines the padding around the data area, ie "10" or "5 0 5 0".
jsx3.chart.Legend	getLegend() Find the first Legend child
int	getLegendEntryType() in general the chart legend renders one entry for every series in the chart, override this method to show categories in the legend
String	getLegendPlacement() Returns the legendPlacement field, the quadrant in which to place the legend.
Array<jsx3.chart.Series>	getSeries() Returns the list of Series children.
int	getSeriesIndex(s : jsx3.chart.Series) Returns the index of a series in the list of series children.
String	getTitlePlacement() Returns the titlePlacement field, the quadrant in which to place the title.
static String	getVersion() Deprecated.
void	redrawRecord() Note that this method is very expensive because it causes the entire chart to be redrawn.
void	setAlpha(alpha : float) Sets the alpha field.
void	setBorderAlpha(borderAlpha : float) Sets the borderAlpha field.
void	setBorderColor(borderColor : String \| Number) Sets the borderColor field.
void	setBorderWidth(borderWidth : int) Sets the borderWidth field.
void	setDataPadding(dataPadding : String) Sets the dataPadding field.
void	setLegendPlacement(legendPlacement : String) Sets the legendPlacement field.
void	setTitlePlacement(titlePlacement : String) Sets the titlePlacement field.

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

DEFAULT_FILLS

static Array<jsx3.vector.Fill> DEFAULT_FILLS

The default fill colors for series and categories whose fills are not specified.

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getAlpha

float getAlpha()

Returns the alpha field, the opacity to render the chart's background.

Returns:

alpha

getBorderAlpha

float getBorderAlpha()

Returns the borderAlpha field, the opacity to render the chart's border.

Returns:

borderAlpha

getBorderColor

String | Number getBorderColor()

Returns the borderColor field, the RGB color to render the chart's border.

Returns:

borderColor

getBorderWidth

int getBorderWidth()

Returns the borderWidth field, the pixel width of the chart's border.

Returns:

borderWidth

getChartTitle

jsx3.chart.ChartLabel getChartTitle()

Find the first jsx3.chart.ChartLabel child

Returns:

getDataPadding

String getDataPadding()

Returns the dataPadding field, the CSS padding value that determines the padding around the data area, ie "10" or "5 0 5 0".

Returns:

dataPadding

getLegend

jsx3.chart.Legend getLegend()

Find the first Legend child

Returns:

getLegendEntryType

int getLegendEntryType()

in general the chart legend renders one entry for every series in the chart, override this method to show categories in the legend

Returns:

jsx3.chart.Legend.SHOW_SERIES

getLegendPlacement

String getLegendPlacement()

Returns the legendPlacement field, the quadrant in which to place the legend.

Returns:

legendPlacement, one of {'top','right','bottom','left'}

getSeries

Array<jsx3.chart.Series> getSeries()

Returns the list of Series children.

Returns:

getSeriesIndex

int getSeriesIndex(s : jsx3.chart.Series)

Returns the index of a series in the list of series children.

Parameters:

s –

Returns:

the index or -1 if not found

getTitlePlacement

String getTitlePlacement()

Returns the titlePlacement field, the quadrant in which to place the title.

Returns:

titlePlacement, one of {'top','right','bottom','left'}

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

redrawRecord

void redrawRecord()

Note that this method is very expensive because it causes the entire chart to be redrawn. It is recommended that the methods in the CDF interface which cause this method to be called, be passed bRedraw=false to prevent this method from being called.

Overrides:

redrawRecord in jsx3.xml.CDF

setAlpha

void setAlpha(alpha : float)

Sets the alpha field.

Parameters:

alpha – the new value for alpha

setBorderAlpha

void setBorderAlpha(borderAlpha : float)

Sets the borderAlpha field.

Parameters:

borderAlpha – the new value for borderAlpha

setBorderColor

void setBorderColor(borderColor : String | Number)

Sets the borderColor field.

Parameters:

borderColor – the new value for borderColor

setBorderWidth

void setBorderWidth(borderWidth : int)

Sets the borderWidth field.

Parameters:

borderWidth – the new value for borderWidth

setDataPadding

void setDataPadding(dataPadding : String)

Sets the dataPadding field.

Parameters:

dataPadding – the new value for dataPadding

setLegendPlacement

void setLegendPlacement(legendPlacement : String)

Sets the legendPlacement field.

Parameters:

legendPlacement – the new value for legendPlacement, one of {'top','right','bottom','left'}

setTitlePlacement

void setTitlePlacement(titlePlacement : String)

Sets the titlePlacement field.

Parameters:

titlePlacement – the new value for titlePlacement, one of {'top','right','bottom','left'}

jsx3.chart

class ChartComponent

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

Direct Known Subclasses:

jsx3.chart.Axis, jsx3.chart.ChartLabel, jsx3.chart.GridLines, jsx3.chart.Legend, jsx3.chart.Series

class ChartComponent
extends jsx3.gui.Block

A base class for every logical component of a chart. A chart component exists in the DOM tree and is selectable with ctrl-click in a component editor in General Interface™ Builder.

Constructor Summary
void	init(name : String) The instance initializer.

Method Summary
jsx3.chart.Chart	getChart() Returns the chart of which this component is a part.
static String	getVersion() Deprecated.

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String)

The instance initializer.

Parameters:

name – the GI name of the instance

Method Detail

getChart

jsx3.chart.Chart getChart()

Returns the chart of which this component is a part.

Returns:

this if this is a chart, or the first ancestor that is a chart

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

jsx3.chart

class ChartLabel

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.ChartLabel

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class ChartLabel
extends jsx3.chart.ChartComponent

A chart component to render a text box. Used to render the titles of charts, legends, axes, and series. Encapsulates all the font settings of the label so that the parent container does not experience property bloat.

Field Summary
static int	DEFAULT_WIDTH the default preferred width
static int	ROTATION_CCW angle for one-quarter counter-clockwise rotation
static int	ROTATION_CW angle for one-quarter clockwise rotation
static int	ROTATION_NORMAL non-rotated angle

Constructor Summary
void	init(name : String, text : String) The instance initializer.

Method Summary
float	getAlpha() Returns the alpha field, the opacity of the background fill.
String	getBorderStroke() Returns the borderStroke field, string representation of the VectorStroke used to outline the background.
int	getLabelRotation() Returns the labelRotation field.
int	getPreferredHeight() Returns the preferredHeight field.
int	getPreferredWidth() Returns the preferredWidth field.
String	getText() Returns the text field.
static String	getVersion() Deprecated.
boolean	isRotated() whether this label is display at 90 or -90 degrees
void	setAlpha(alpha : float) Sets the alpha field.
void	setBorderStroke(borderStroke : String) Sets the borderStroke field.
void	setLabelRotation(labelRotation : int) Sets the labelRotation field.
void	setPreferredHeight(preferredHeight : int) Sets the preferredHeight field.
void	setPreferredWidth(preferredWidth : int) Sets the preferredWidth field.
void	setText(text : String) Sets the text field.

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

DEFAULT_WIDTH

static int DEFAULT_WIDTH

the default preferred width

ROTATION_CCW

static final int ROTATION_CCW

angle for one-quarter counter-clockwise rotation

ROTATION_CW

static final int ROTATION_CW

angle for one-quarter clockwise rotation

ROTATION_NORMAL

static final int ROTATION_NORMAL

non-rotated angle

Constructor Detail

init

void init(name : String, text : String)

The instance initializer.

Parameters:

name – the GI name of the instance

text – text to display in the label

Method Detail

getAlpha

float getAlpha()

Returns the alpha field, the opacity of the background fill.

Returns:

alpha

getBorderStroke

String getBorderStroke()

Returns the borderStroke field, string representation of the VectorStroke used to outline the background.

Returns:

borderStroke

getLabelRotation

int getLabelRotation()

Returns the labelRotation field.

Returns:

labelRotation

getPreferredHeight

int getPreferredHeight()

Returns the preferredHeight field.

Returns:

preferredHeight

getPreferredWidth

int getPreferredWidth()

Returns the preferredWidth field.

Returns:

preferredWidth

getText

String getText()

Returns the text field.

Returns:

text

Overrides:

getText in jsx3.gui.Block

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

isRotated

boolean isRotated()

whether this label is display at 90 or -90 degrees

Returns:

setAlpha

void setAlpha(alpha : float)

Sets the alpha field.

Parameters:

alpha – the new value for alpha

setBorderStroke

void setBorderStroke(borderStroke : String)

Sets the borderStroke field.

Parameters:

borderStroke – the new value for borderStroke

setLabelRotation

void setLabelRotation(labelRotation : int)

Sets the labelRotation field.

Parameters:

labelRotation – the new value for labelRotation, one of {0, 90, 270}

setPreferredHeight

void setPreferredHeight(preferredHeight : int)

Sets the preferredHeight field.

Parameters:

preferredHeight – the new value for preferredHeight

setPreferredWidth

void setPreferredWidth(preferredWidth : int)

Sets the preferredWidth field.

Parameters:

preferredWidth – the new value for preferredWidth

setText

void setText(text : String)

Sets the text field.

Parameters:

text – the new value for text

Overrides:

setText in jsx3.gui.Block

jsx3.chart

class ColumnChart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

->jsx3.chart.CartesianChart

->jsx3.chart.BCChart

->jsx3.chart.ColumnChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

class ColumnChart
extends jsx3.chart.BCChart

A column chart.

Series: ColumnSeries only.
Axes: Y axis must be value axis, X axis can be value or category axis

The 'type' my be 'clustered', 'stacked', or 'stacked100', which correspond to the basic Excel-like variations of a column chart.

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
Array<Number>	getXRange(series : ?)
Array<Number>	getYRange(series : ?)

Methods Inherited From jsx3.chart.BCChart
getCategoryCoverage, getSeriesOverlap, getType, setCategoryCoverage, setSeriesOverlap, setType

Methods Inherited From jsx3.chart.CartesianChart
getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis

Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getXRange

Array<Number> getXRange(series : ?)

Parameters:

series –

Returns:

[min, max].

Overrides:

getXRange in jsx3.chart.CartesianChart

getYRange

Array<Number> getYRange(series : ?)

Parameters:

series –

Returns:

[min, max].

Overrides:

getYRange in jsx3.chart.CartesianChart

jsx3.chart

class ColumnSeries

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Series

->jsx3.chart.BCSeries

->jsx3.chart.ColumnSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class ColumnSeries
extends jsx3.chart.BCSeries

The data series type for a jsx3.chart.ColumnChart. Draws vertical columns between the x axis and a y value determined by the data provider, or between two y values determined by the data provider. A column series has the following fields:

yField: the attribute of a record to use as the vertical extent of the column, required
xField: the attribute of a record to use as the horizontal midpoint of the column, required if the x axis of the chart is a value axis
minField: the attribute of a record to use as the minimum vertical extent of the column, optional

Field Summary
static int	DEFAULT_COLUMNWIDTH

Constructor Summary
void	init(name : String, seriesName : String) The instance initializer.

Method Summary
int	getColumnWidth() Returns the columnWidth field.
void	setColumnWidth(columnWidth : int) Sets the columnWidth field.
static String	tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity) The default tooltip function for this type of series.

Methods Inherited From jsx3.chart.BCSeries
getMinField, getMinValue, getXField, getXValue, getYField, getYValue, setMinField, setXField, setYField

Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

DEFAULT_COLUMNWIDTH

static int DEFAULT_COLUMNWIDTH

Constructor Detail

init

void init(name : String, seriesName : String)

The instance initializer.

Parameters:

name – the GI name of the instance

seriesName – the name of the Series, will be displayed in the Legend for most chart types

Method Detail

getColumnWidth

int getColumnWidth()

Returns the columnWidth field.

Returns:

columnWidth

setColumnWidth

void setColumnWidth(columnWidth : int)

Sets the columnWidth field.

Parameters:

columnWidth – the new value for columnWidth

tooltip

static String tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity)

The default tooltip function for this type of series.

Parameters:

series –

record –

Returns:

jsx3.chart

class GridLines

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.GridLines

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class GridLines
extends jsx3.chart.ChartComponent

A chart component that renders a grid of lines and fills aligned with an x and y axis.

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
String	getBorderStroke() Returns the borderStroke field, string representation of the stroke used to outline the grid lines.
Array<String>	getFillH() Returns the fillH field, array of string representations of vector fills used to fill in areas between horizontal major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.
Array<String>	getFillV() Returns the fillV field, array of string representations of vector fills used to fill in areas between vertical major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.
boolean	getHorizontalAbove() Returns the horizontalAbove field, whether to draw the horizontal lines and fills above the vertical ones.
boolean	getInForeground() Returns the inForeground field, whether to draw this legend on top of the data series (or below).
Array<String>	getStrokeMajorH() Returns the strokeMajorH field, array of string representations of VectorStroke's used to draw the horizontal major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
Array<String>	getStrokeMajorV() Returns the strokeMajorV field, array of string representations of VectorStroke's used to draw the vertical major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
Array<String>	getStrokeMinorH() Returns the strokeMinorH field, array of string representations of VectorStroke's used to draw the horizontal minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
Array<String>	getStrokeMinorV() Returns the strokeMinorV field, array of string representations of VectorStroke's used to draw the vertical minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
static String	getVersion() Deprecated.
jsx3.chart.Axis	getXAxis() Returns the x (horizontal) axis used to determine where to draw tick lines.
jsx3.chart.Axis	getYAxis() Returns the y (vertical) axis used to determine where to draw tick lines.
void	setBorderStroke(borderStroke : String) Sets the borderStroke field.
void	setFillH(fillH : Array<String>) Sets the fillH field.
void	setFillV(fillV : Array<String>) Sets the fillV field.
void	setHorizontalAbove(horizontalAbove : boolean) Sets the horizontalAbove field.
void	setInForeground(inForeground : boolean) Sets the inForeground field.
void	setStrokeMajorH(strokeMajorH : Array<String>) Sets the strokeMajorH field.
void	setStrokeMajorV(strokeMajorV : Array<String>) Sets the strokeMajorV field.
void	setStrokeMinorH(strokeMinorH : Array<String>) Sets the strokeMinorH field.
void	setStrokeMinorV(strokeMinorV : Array<String>) Sets the strokeMinorV field.

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the object relative to its parent container

top – top position (in pixels) of the object relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getBorderStroke

String getBorderStroke()

Returns the borderStroke field, string representation of the stroke used to outline the grid lines.

Returns:

borderStroke

getFillH

Array<String> getFillH()

Returns the fillH field, array of string representations of vector fills used to fill in areas between horizontal major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.

Returns:

fillH

getFillV

Array<String> getFillV()

Returns the fillV field, array of string representations of vector fills used to fill in areas between vertical major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.

Returns:

fillV

getHorizontalAbove

boolean getHorizontalAbove()

Returns the horizontalAbove field, whether to draw the horizontal lines and fills above the vertical ones.

Returns:

horizontalAbove

getInForeground

boolean getInForeground()

Returns the inForeground field, whether to draw this legend on top of the data series (or below).

Returns:

inForeground

getStrokeMajorH

Array<String> getStrokeMajorH()

Returns the strokeMajorH field, array of string representations of VectorStroke's used to draw the horizontal major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMajorH

getStrokeMajorV

Array<String> getStrokeMajorV()

Returns the strokeMajorV field, array of string representations of VectorStroke's used to draw the vertical major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMajorV

getStrokeMinorH

Array<String> getStrokeMinorH()

Returns the strokeMinorH field, array of string representations of VectorStroke's used to draw the horizontal minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMinorH

getStrokeMinorV

Array<String> getStrokeMinorV()

Returns the strokeMinorV field, array of string representations of VectorStroke's used to draw the vertical minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMinorV

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

getXAxis

jsx3.chart.Axis getXAxis()

Returns the x (horizontal) axis used to determine where to draw tick lines.

Returns:

getYAxis

jsx3.chart.Axis getYAxis()

Returns the y (vertical) axis used to determine where to draw tick lines.

Returns:

setBorderStroke

void setBorderStroke(borderStroke : String)

Sets the borderStroke field.

Parameters:

borderStroke – the new value for borderStroke

setFillH

void setFillH(fillH : Array<String>)

Sets the fillH field.

Parameters:

fillH – the new value for fillH

setFillV

void setFillV(fillV : Array<String>)

Sets the fillV field.

Parameters:

fillV – the new value for fillV

setHorizontalAbove

void setHorizontalAbove(horizontalAbove : boolean)

Sets the horizontalAbove field.

Parameters:

horizontalAbove – the new value for horizontalAbove

setInForeground

void setInForeground(inForeground : boolean)

Sets the inForeground field.

Parameters:

inForeground – the new value for inForeground

setStrokeMajorH

void setStrokeMajorH(strokeMajorH : Array<String>)

Sets the strokeMajorH field.

Parameters:

strokeMajorH – the new value for strokeMajorH

setStrokeMajorV

void setStrokeMajorV(strokeMajorV : Array<String>)

Sets the strokeMajorV field.

Parameters:

strokeMajorV – the new value for strokeMajorV

setStrokeMinorH

void setStrokeMinorH(strokeMinorH : Array<String>)

Sets the strokeMinorH field.

Parameters:

strokeMinorH – the new value for strokeMinorH

setStrokeMinorV

void setStrokeMinorV(strokeMinorV : Array<String>)

Sets the strokeMinorV field.

Parameters:

strokeMinorV – the new value for strokeMinorV

jsx3.chart

class Legend

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Legend

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class Legend
extends jsx3.chart.ChartComponent

Chart component that renders a simple legend. A legend may contain a list of series or a list of categories, depending on the type of chart.

Field Summary
static int	DEFAULT_HEIGHT the default height
static int	DEFAULT_WIDTH the default width

Constructor Summary
void	init(name : String) The instance initializer.

Method Summary
String	getBackgroundFill() Returns the backgroundFill field, a string representation of the vector fill used to color in the background of the legend.
String	getBackgroundStroke() Returns the backgroundStroke field, a string representation of the VectorStroke used to outline the legend.
int	getBoxHeight() Returns the boxHeight field, the diameter of the box that shows the fill of each series or category.
String	getLabelClass() Returns the labelClass field, the CSS class name applied to the name of each series or category.
String	getLabelStyle() Returns the labelStyle field, a CSS style attribute applied to the name of each series or category, ie "font-family: Arial; font-size: 10px;".
jsx3.chart.ChartLabel	getLegendTitle() Find the first jsx3.chart.ChartLabel child
int	getLineHeight() Returns the lineHeight field, the vertical space taken for each legend entry.
int	getPreferredHeight() Returns the preferredHeight field, the height that this component would like to have, though its true size is dictated by the container component.
int	getPreferredWidth() Returns the preferredWidth field, the width that this component would like to have, though its true size is dictated by the container component.
static String	getVersion() Deprecated.
void	setBackgroundFill(backgroundFill : String) Sets the backgroundFill field.
void	setBackgroundStroke(backgroundStroke : String) Sets the backgroundStroke field.
void	setBoxHeight(boxHeight : int) Sets the boxHeight field.
void	setLabelClass(labelClass : String) Sets the labelClass field.
void	setLabelStyle(labelStyle : String) Sets the labelStyle field.
void	setLineHeight(lineHeight : int) Sets the lineHeight field.
void	setPreferredHeight(preferredHeight : int) Sets the preferredHeight field.
void	setPreferredWidth(preferredWidth : int) Sets the preferredWidth field.

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

DEFAULT_HEIGHT

static int DEFAULT_HEIGHT

the default height

DEFAULT_WIDTH

static int DEFAULT_WIDTH

the default width

Constructor Detail

init

void init(name : String)

The instance initializer.

Parameters:

name – the GI name of the instance

Method Detail

getBackgroundFill

String getBackgroundFill()

Returns the backgroundFill field, a string representation of the vector fill used to color in the background of the legend.

Returns:

backgroundFill

getBackgroundStroke

String getBackgroundStroke()

Returns the backgroundStroke field, a string representation of the VectorStroke used to outline the legend.

Returns:

backgroundStroke

getBoxHeight

int getBoxHeight()

Returns the boxHeight field, the diameter of the box that shows the fill of each series or category.

Returns:

boxHeight

getLabelClass

String getLabelClass()

Returns the labelClass field, the CSS class name applied to the name of each series or category.

Returns:

labelClass

getLabelStyle

String getLabelStyle()

Returns the labelStyle field, a CSS style attribute applied to the name of each series or category, ie "font-family: Arial; font-size: 10px;".

Returns:

labelStyle

getLegendTitle

jsx3.chart.ChartLabel getLegendTitle()

Find the first jsx3.chart.ChartLabel child

Returns:

getLineHeight

int getLineHeight()

Returns the lineHeight field, the vertical space taken for each legend entry.

Returns:

lineHeight

getPreferredHeight

int getPreferredHeight()

Returns the preferredHeight field, the height that this component would like to have, though its true size is dictated by the container component.

Returns:

preferredHeight

getPreferredWidth

int getPreferredWidth()

Returns the preferredWidth field, the width that this component would like to have, though its true size is dictated by the container component.

Returns:

preferredWidth

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

setBackgroundFill

void setBackgroundFill(backgroundFill : String)

Sets the backgroundFill field.

Parameters:

backgroundFill – the new value for backgroundFill

setBackgroundStroke

void setBackgroundStroke(backgroundStroke : String)

Sets the backgroundStroke field.

Parameters:

backgroundStroke – the new value for backgroundStroke

setBoxHeight

void setBoxHeight(boxHeight : int)

Sets the boxHeight field.

Parameters:

boxHeight – the new value for boxHeight

setLabelClass

void setLabelClass(labelClass : String)

Sets the labelClass field.

Parameters:

labelClass – the new value for labelClass

setLabelStyle

void setLabelStyle(labelStyle : String)

Sets the labelStyle field.

Parameters:

labelStyle – the new value for labelStyle

setLineHeight

void setLineHeight(lineHeight : int)

Sets the lineHeight field.

Parameters:

lineHeight – the new value for lineHeight

setPreferredHeight

void setPreferredHeight(preferredHeight : int)

Sets the preferredHeight field.

Parameters:

preferredHeight – the new value for preferredHeight

setPreferredWidth

void setPreferredWidth(preferredWidth : int)

Sets the preferredWidth field.

Parameters:

preferredWidth – the new value for preferredWidth

jsx3.chart

class LineChart

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.vector.Block

->jsx3.chart.Chart

->jsx3.chart.CartesianChart

->jsx3.chart.LineChart

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

class LineChart
extends jsx3.chart.CartesianChart

A line chart.

Series: LineSeries only.
Axes: Y axis must be value axis, X axis can be value or category axis

The 'type' my be 'overlay', 'stacked', or 'stacked100', which correspond to the basic Excel-like variations of a line chart.

Field Summary
static String	TYPE_OVERLAY
static String	TYPE_STACKED
static String	TYPE_STACKED100

Constructor Summary
void	init(name : String, left : int, top : int, width : int, height : int) The instance initializer.

Method Summary
String	getType() Returns the type field, one of {'overlay','stacked','stacked100'}.
static String	getVersion() Deprecated.
void	getXRange(series : ?) Returns the range of x values, used when x axis is value axis.
void	getYRange(series : ?) Returns the range of y values, considers chart type.
void	setType(type : String) Sets the type field.

Methods Inherited From jsx3.chart.CartesianChart
getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis

Methods Inherited From jsx3.chart.Chart
getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement

Methods Inherited From jsx3.xml.Cacheable

clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource

Methods Inherited From jsx3.vector.Block
createCanvas, createVector, getCanvas, paintEventHandler, updateVector

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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(name : String, left : int, top : int, width : int, height : int)

The instance initializer.

Parameters:

name – the GI name of the instance

left – left position (in pixels) of the chart relative to its parent container

top – top position (in pixels) of the chart relative to its parent container

width – width (in pixels) of the chart

height – height (in pixels) of the chart

Method Detail

getType

String getType()

Returns the type field, one of {'overlay','stacked','stacked100'}.

Returns:

type

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

getXRange

void getXRange(series : ?)

Returns the range of x values, used when x axis is value axis.

Parameters:

series –

Overrides:

getXRange in jsx3.chart.CartesianChart

getYRange

void getYRange(series : ?)

Returns the range of y values, considers chart type.

Parameters:

series –

Overrides:

getYRange in jsx3.chart.CartesianChart

setType

void setType(type : String)

Sets the type field.

Parameters:

type – the new value for type, one of {'overlay','stacked','stacked100'}

jsx3.chart

class LineSeries

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Series

->jsx3.chart.LineSeries

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class LineSeries
extends jsx3.chart.Series

A data series for a line chart. An line series draws a set of points connected by a line. A line series has the following properties:

xField: the attribute of a record to use as the x-coordinate of points in the series, required if the x-axis is a value axis
yField: the attribute of a record to use as the y-coordinate of points in the series, required
form: defines how the area is drawn, one of {'segment','step','reverseStep','horizontal','vertical'}, defaults to 'segment'
interpolateValues: if true the the line will be continuous even over missing data points, if false the the line will break over missing data points
pointRadius: the radius of the points to render at each data point on the line, optional
pointRenderer: string that evals to an object that implements the renderer interface, optional
pointFill: string representation of a vector fill for the points
pointStroke: string representation of a VectorStroke for the points
pointGradient: string representation of a vector fill gradient for the points

Field Summary
static String	FORM_HORIZONTAL
static String	FORM_REVSTEP
static String	FORM_SEGMENT
static String	FORM_STEP
static String	FORM_VERTICAL

Constructor Summary
void	init(name : String, seriesName : String) The instance initializer.

Method Summary
String	getForm() Returns the form field.
boolean	getInterpolateValues() Returns the interpolateValues field.
String	getPointFill() Returns the pointFill field.
String	getPointGradient() Returns the pointGradient field.
int	getPointRadius() Returns the pointRadius field.
jsx3.chart.PointRenderer	getPointRenderer() Returns the pointRenderer field.
String	getPointStroke() Returns the pointStroke field.
static String	getVersion() Deprecated.
String	getXField() Returns the xField field.
String	getYField() Returns the yField field.
void	setForm(form : String) Sets the form field, checks for valid value.
void	setInterpolateValues(interpolateValues : boolean) Sets the interpolateValues field.
void	setPointFill(pointFill : String) Sets the pointFill field.
void	setPointGradient(pointGradient : String) Sets the pointGradient field.
void	setPointRadius(pointRadius : int) Sets the pointRadius field.
void	setPointRenderer(pointRenderer : String) Sets the pointRenderer field, should eval to an object that implements the renderer interface.
void	setPointStroke(pointStroke : String) Sets the pointStroke field.
void	setXField(xField : String) Sets the xField field.
void	setYField(yField : String) Sets the yField field.
static String	tooltip(series : jsx3.chart.Series, record : jsx3.xml.Entity) The default tooltip function for this type of series.

Methods Inherited From jsx3.chart.Series
getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

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