| Packages | |
|---|---|
| The TIBCO General Interface™ Asynchronous Modular Platform (AMP). | |
| The standard library of AMP application utility classes. | |
| Application layer classes. | |
| Various Charting related constants and utility functions. | |
| GUI classes. | |
| Utility methods related to rendering HTML. | |
| The public API of the TIBCO General Interface™ IDE. | |
| Base classes and the GI introspection framework. | |
| Networking related classes. | |
| Utility classes. | |
| This package and all contained classes are available only when the Charting add-in is enabled. | |
| XML related classes. | |
| Top-Level properties and functions. | |
| Class Summary | |
|---|---|
| jsx3.$Array | Useful extensions to the JavaScript Array class. |
| jsx3.$AsyncCB | The callback object passed as the single argument to an asynchronous method. |
| jsx3.$AsyncRV | The return value from an asynchronous method. |
| jsx3.$Function | Useful extensions to the JavaScript Function class. |
| jsx3.$Hash | Useful extensions to the JavaScript Object class for emulating a hashtable. |
| jsx3.$Object | Useful extensions to the JavaScript Object class. |
| jsx3.$String | Useful extensions to the JavaScript String class. |
| jsx3.Alerts | Deprecated. Renamed to jsx3.gui.Alerts. |
| jsx3.Block | Deprecated. Renamed to jsx3.gui.Block |
| jsx3.BlockX | Deprecated. Renamed to jsx3.gui.BlockX. Most functionality of this class was moved into a new interface,
jsx3.xml.Cacheable. |
| jsx3.Boolean | Boolean class encapsulates GI's XML boolean values (0 and 1 rather than true and false). |
| jsx3.Button | Deprecated. Renamed to jsx3.gui.Button |
| jsx3.CDF | Deprecated. Renamed to jsx3.xml.CDF |
| jsx3.Cache | Deprecated. Renamed to jsx3.app.Cache |
| jsx3.CheckBox | Deprecated. Renamed to jsx3.gui.CheckBox |
| jsx3.Collection | Deprecated. Subsumed by jsx3.util.List. |
| jsx3.Column | Deprecated. Renamed to jsx3.gui.Column |
| jsx3.DOM | Deprecated. Renamed to jsx3.app.DOM |
| jsx3.DatePicker | Deprecated. Renamed to jsx3.gui.DatePicker |
| jsx3.Dialog | Deprecated. Renamed to jsx3.gui.Dialog |
| jsx3.Document | Deprecated. Renamed to jsx3.xml.Document |
| jsx3.ERROR | Deprecated. Renamed to jsx3.util.Logger |
| jsx3.EVT | Deprecated. Use class jsx3.gui.Event instead. |
| jsx3.Entity | Deprecated. Renamed to jsx3.xml.Entity |
| jsx3.Event | Deprecated. Renamed to jsx3.gui.Interactive |
| jsx3.EventDispatcher | Deprecated. Renamed to jsx3.util.EventDispatcher |
| jsx3.Form | Deprecated. Renamed to jsx3.gui.Form |
| jsx3.Grid | Deprecated. Renamed to jsx3.gui.Grid |
| jsx3.Heavyweight | Deprecated. Renamed to jsx3.gui.Heavyweight |
| jsx3.HttpForm | Deprecated. Renamed to jsx3.net.Form |
| jsx3.HttpRequest | Deprecated. Renamed to jsx3.net.Request |
| jsx3.LayoutGrid | Deprecated. Renamed to jsx3.gui.LayoutGrid |
| jsx3.List | Deprecated. Renamed to jsx3.gui.List |
| jsx3.Menu | Deprecated. Renamed to jsx3.gui.Menu |
| jsx3.Model | Deprecated. Renamed to jsx3.app.Model |
| jsx3.RadioButton | Deprecated. Renamed to jsx3.gui.RadioButton |
| jsx3.Select | Deprecated. Renamed to jsx3.gui.Select |
| jsx3.Server | Deprecated. Renamed to jsx3.app.Server |
| jsx3.Service | Deprecated. Renamed to jsx3.net.Service |
| jsx3.Settings | Deprecated. Renamed to jsx3.app.Settings |
| jsx3.Slider | Deprecated. Renamed to jsx3.gui.Slider |
| jsx3.Splitter | Deprecated. Renamed to jsx3.gui.Splitter |
| jsx3.Stack | Deprecated. Renamed to jsx3.gui.Stack |
| jsx3.StackGroup | Deprecated. Renamed to jsx3.gui.StackGroup |
| jsx3.Tab | Deprecated. Renamed to jsx3.gui.Tab |
| jsx3.TabbedPane | Deprecated. Renamed to jsx3.gui.TabbedPane |
| jsx3.TextBox | Deprecated. Renamed to jsx3.gui.TextBox |
| jsx3.ToolbarButton | Deprecated. Renamed to jsx3.gui.ToolbarButton |
| jsx3.Tree | Deprecated. Renamed to jsx3.gui.Tree |
| jsx3.UserSettings | Deprecated. Renamed to jsx3.app.UserSettings |
| jsx3.WindowBar | Deprecated. Renamed to jsx3.gui.WindowBar |
| Field Summary | |
|---|---|
| static String | Deprecated. Use jsx3.getEnv("jsxabspath").
|
| static String | location for addin resources. |
| static String | Deprecated. Use jsx3.getEnv("jsxhomepath").
|
| static jsx3.app.Cache | Deprecated. Use getSharedCache() instead. |
| static jsx3.lang.ClassLoader | the system class loader. |
| static void | Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.
|
| static jsx3.EVT | Deprecated. Static access to the event object is deprecated as it is not cross-platform. Access to the current
event object, where available, is granted via a method parameter or model event context variable. |
| static String | Deprecated. |
| static void | Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.
|
| static jsx3.gui.Event | |
| static String | Deprecated. |
| static String | Deprecated. |
| Method Summary | |
|---|---|
| static void | Injects class jsx3.$Array into array instance a. |
| static void | Injects class jsx3.$Function into function instance f. |
| static void | Injects class jsx3.$Hash into object instance o. |
| static void | Injects class jsx3.$Object into object instance o. |
| static void | Injects class jsx3.$String into string instance s. |
| static Function | Wraps an asynchronous method. |
| static Function | Returns an asynchronous wrapper of a synchronous method. |
| static jsx3.app.Model | 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 | Deprecated. create classes using jsx3.Class |
| static void | Deprecated. create classes using jsx3.Class |
| static void | Deprecated. create classes using jsx3.Class |
| static void | Deprecated. use jsx3.Class.mixin() |
| static void | 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 | |
| static String | getInstanceMethods(strClassName : String) Deprecated. use jsx3.lang.Class |
| static jsx3.app.Cache | Returns the global JSX XML/XSL cache. |
| static void | Returns the version of TIBCO General Interface™. |
| static void | Sends a message to the logging system. |
| static void | Deprecated. use jsx3.log() or the jsx3.util.Logger interface |
| static void | 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 | A replacement for peppering code with window.setTimeout(fnct, 0) statements. |
| Field Detail |
|---|
jsx3.getEnv("jsxabspath").
jsx3.getEnv("jsxhomepath").
getSharedCache() instead.jsx3.app.Cache instance used by the JSX system to store XML and XSL documents.jsx3.lang.Class framework does not use this constant for instantiating objects.
jsx3.lang.Class framework does not use this constant for instantiating objects.
| Method Detail |
|---|
jsx3.$Array into array instance a.jsx3.$Function into function instance f.jsx3.$Hash into object instance o. If o is an array, it
is first converted into an object by setting a property equal to 1 for each item in the array.jsx3.$Object into object instance o.jsx3.$String into string instance s.jsx3.$AsyncCB. The wrapped method must call done() on this
method parameter, either synchronously or asynchronously. The done() method takes a single
parameter, which is the return value of the method.
The wrapped method should not itself return anything. The only exception to this is that the method may return
and instance of jsx3.$AsyncRV. In this case, the method will return when and with the same return
value as the returned instance of jsx3.$AsyncRV.
Client code that calls the asynchronous method will see a synchronous return value of type
jsx3.$AsyncRV. Client code should use the when() method of this return value to
continue execution when the asynchronous method has completed. Or this return value may be used in conjuction
with other asynchronous methods (such as by passing is as a parameter to an asynchronous method).
Another feature of asynchronous methods is that you can pass instances of jsx3.$AsyncRV as
parameters to the method and the method is only invoked once all of those parameters have returned. The parameters
that the wrapped method sees are automatically converted into the return values of the jsx3.$AsyncRV
instances.strMethod
bound to object objThis. objThis is optional and may be an object or an instance of
jsx3.$AsyncRV. If the latter, then the wrapped method is only called on the return value of
objThis after objThis returns.
The wrapper takes the same parameters as the wrapped method. However, instead of returning the return value of the
wrapped method, it returns an instance of jsx3.$AsyncRV.
The returned method may be passed parameters that are actually instances of jsx3.$AsyncRV. In this
case, the wrapped method is only actually called when all the parameters have returned.objThis to wrap.jsx3.Classjsx3.Classjsx3.Classjsx3.Class.mixin()jsx3.lang.Classjsx3.lang.Classjsx3.lang.ClassgetDocument() is called on the server cache with
a cache id that does not correspond to a document in the server cache.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.jsx3.log() or the jsx3.util.Logger interfacejsx3.util.Logger.doLog() (formerly jsx3.Error.doLog()).URIResolver.DEFAULT.window.setTimeout(fnct, 0) statements. This method places
all jobs in a queue. Each job gets its own stack.null and a job already
exists in the queue with this id, then this job is not added to the queue.objFunction when it is called.true and a job already exists, this new job clobbers the old job.Array class.| Fields Inherited From Array |
|---|
| length |
| Method Summary | |
|---|---|
| boolean | Returns true if o is in this array. |
| void | Calls fct for each element in this array. |
| jsx3.$Array | Creates a new array with the filtered contents of this array. |
| Object | Returns the first element in this array for which fct returns true when passed the element as
the sole parameter. |
| int | Returns the first index of o in this array. |
| jsx3.$Array | Creates a new array using the mapped values of each element in this array. |
| Object | Removes the first occurrence of o in this array. |
| jsx3.$Array | unique() Returns a list containing only the unique elements in this list. |
| Methods Inherited From Array |
|---|
| clone, concat, contentsEqual, join, lastIndexOf, pop, push, pushAll, reverse, shift, slice, sort, splice, toString, unshift |
| Method Detail |
|---|
o is in this array. This method uses strict equality for comparing objects
(===).fct for each element in this array. fct is passed each element as the
sole parameter.fct is called for
each element in this array and the element is passed as the sole argument. The new array is constructed with
only the elements of this array for which fct returns true.fct returns true when passed the element as
the sole parameter.o in this array. This method uses strict equality for comparing objects
(===).fct is called for
each element in this array and the element is passed as the sole argument. The new array is constructed with
the return values of each call to fct.
sole parameter.o in this array. This method uses strict equality for comparing objects
(===).undefined if o is not in this array.
| Method Summary | |
|---|---|
| Array<Object> | args() Returns the arguments that were passed to the asynchronous method wrapper. |
| void | Signals the callback object that the asynchronous method is done and passes the asynchronous return value. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
| Method Summary | |
|---|---|
| jsx3.$AsyncRV | and(rv : jsx3.$AsyncRV...) Creates and returns an asynchronous return value that completes when this and rv have completed. |
| jsx3.$AsyncRV | or(rv : jsx3.$AsyncRV...) Creates and returns an asynchronous return value that completes when this or rv have completed. |
| Object | rv() Returns the return value from the asynchronous method. |
| void | Registers code to be called when the asynchronous method completes. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
rv have completed.rv have completed.done() is called on corresponding callback object.
cb is a function, then that function will be called when the asynchronous method
completes. This function will be called synchronously is the function has already completed. The
asynchronous method return value will be passed as the only argument to the function.
If argument cb is an instance of jsx3.$AsyncCB, then its done() method
will be called when the asynchronous method completes. The done method will be passed the rv
argument it is is provided. Otherwise, it will be passed the return value of cb.Function class.| Method Summary | |
|---|---|
| jsx3.$Function | Returns a method that is this function applied to thisObj with arguments argsArr. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
thisObj with arguments argsArr.Object class for emulating a hashtable.| Method Summary | |
|---|---|
| void | Iterates over all the key-value pairs of this hashtable. |
| jsx3.$Array | keys() Returns the list of keys of this hashtable. |
| jsx3.$Array | values() Returns the list of values of this hashtable. |
| Methods Inherited From jsx3.$Object |
|---|
| clone, extend |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
fct is called for each pair; the pair key
is the first parameter and the pair value is the second parameter.function(key : String, value: Object} : void
Object class.| Method Summary | |
|---|---|
| jsx3.$Object | clone() Creates a new objects with all the same properties as this object. |
| void | Copies all properties of o into this object. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
o into this object.String class.| Method Summary | |
|---|---|
| boolean | Returns true if this string ends with string s. |
| jsx3.$String | trim() Returns this string with all leading and trailing space removed. |
| Methods Inherited From jsx3.$Object |
|---|
| clone, extend |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
s.jsx3.xml.Cacheable.| Field Summary | |
|---|---|
| static int | 0 |
| static int | 1 |
| Method Summary | |
|---|---|
| static int | Returns jsx3.Boolean.TRUE or jsx3.Boolean.FALSE. |
| Field Detail |
|---|
| Method Detail |
|---|
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.gui.Event instead.| 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 | 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 | cancels event bubbling for the event
|
| void | cancels the key from firing by setting the keyCode to 0 (zero) for the event
|
| void | 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 | Returns true if the delete key was pressed |
| boolean | 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 | 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 | 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 | Deprecated. use jsx3.gui.Event.publish() instead
|
| boolean | homeKey() Returns true if the home key was pressed |
| boolean | Returns true if the insert key was pressed |
| int | keyCode() Returns integer representing the key code of the key just pressed/keyed-down |
| boolean | Returns true if the left-arrow key was pressed |
| boolean | Returns true if the left-mouse-button was clicked |
| boolean | Returns true if the page-down key was pressed |
| boolean | Returns true if the page-up key was pressed |
| void | Deprecated. use jsx3.gui.Event.subscribe instead |
| boolean | Returns true if the right-arrow key was pressed |
| boolean | Returns true if the right-mouse-button was clicked |
| void | setKeyCode(intKeyCode : int) sets/updates the keycode for the event |
| void | 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 | Returns handle to the HTML element acted upon (click, mousedown, etc) |
| boolean | tabKey() Returns true if the tab key was pressed |
| HTMLElement | Returns handle to the HTML element that was moused over (onmouseover) |
| boolean | upArrow() Returns true if the up-arrow key was pressed |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
event at a later point in time.
| Method Detail |
|---|
bReturn is true, otherwise no return statement | Class Summary | |
|---|---|
| jsx3.amp.Bindable | |
| jsx3.amp.Engine | An AMP engine. |
| jsx3.amp.Ext | An AMP extension. |
| jsx3.amp.ExtPoint | An AMP extension point. |
| jsx3.amp.ExtProc | An extension processor utility class. |
| jsx3.amp.PlugIn | An AMP plug-in. |
| jsx3.amp.Resource | An AMP plug-in resource, such as a JavaScript file or XML file. |
| jsx3.amp.XML | An XML wrapper that can be backed either by a real XML node or by a nested object structure. |
| Field Summary | |
|---|---|
| static String | The name of the plug-ins registration file. |
| static String | The path where application plug-ins should reside. |
| static String | The name of a plug-in descriptor file. |
| static String | The plug-in definition XML namespace URI. |
| Field Detail |
|---|
| Method Summary | |
|---|---|
| void | Adds a bindable property to this object. |
| jsx3.$Array<String> | Returns the list of bindable properties of this object. |
| void | Sets the current calculated value of a bindable property of this object. |
| void | updateBindable(key : String) Causes a bindable property of this object to be recalculated. |
| void | Causes a bindable property to be updated when publisher publishes an event with subject
subject. |
| Method Detail |
|---|
{subject: propName, oldValue: previousValue, value: newValue}.key.publisher publishes an event with subject
subject.| Field Summary | |
|---|---|
| static String | Event subject published when an error prevents the engine from loading. |
| static String | Event subject published when an engine finishes loading. |
| static String | Event subject published when progress is made loading an engine. |
| static String | Event subject published when a plug-in is registered. |
| Method Summary | |
|---|---|
| void | deregister(strId : String) Deregisters a plug-in from this engine. |
| static jsx3.amp.Engine | getEngine(objServer : jsx3.app.Server) Returns the engine for a given application. |
| jsx3.amp.ExtPoint | getExtPoint(strId : String) Returns a registered extension point by ID. |
| jsx3.$Array<jsx3.amp.Ext> | Returns the extensions registered for a given extension point ID. |
| jsx3.amp.PlugIn | Returns a registered plug-in by ID. |
| jsx3.$Array<jsx3.amp.PlugIn> | Returns all registered plug-ins. |
| jsx3.app.Server | Returns the application associated with this engine. |
| boolean | isLoaded() Returns true if all of the AMP and project plug-ins have been registered. |
| jsx3.$AsyncRV | Registers a plug-in manually at runtime. |
| 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 |
|---|
pct and done
fields may be defined. | Method Detail |
|---|
| Method Summary | |
|---|---|
| jsx3.$Array<jsx3.amp.XML> | getData() Returns the list of XML elements declared in the body of the extension declaration. |
| jsx3.amp.Engine | Returns the engine owning the plug-in owning this extension. |
| String | getId() Returns the full ID of this extension, which is unique among all extensions in the AMP engine. |
| String | Returns the local ID of this extension, which is defined by the id attribute of the XML
extension declaration. |
| String | getName() Returns the name of this extension, which is defined by the name attribute of the XML
extension declaration. |
| jsx3.amp.PlugIn | Returns the plug-in declaring this extension. |
| jsx3.amp.ExtPoint | getPoint() Returns the extension point to which this extension is registered. |
| String | Returns the ID of the extension point this this extension extends. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
id attribute of the XML
extension declaration.name attribute of the XML
extension declaration.point
attribute of the XML extension declaration.| Field Summary | |
|---|---|
| static String | An event published by an extension point when it is extended by a new extension. |
| Method Summary | |
|---|---|
| jsx3.amp.Engine | Returns the engine owning the plug-in owning this extension point. |
| jsx3.$Array<jsx3.amp.Ext> | getExts() Returns the list of extensions registered with this extension point. |
| String | getId() Returns the full ID of this extension, which is unique among all extension points in the AMP engine. |
| String | Returns the local ID of this extension point, which is defined by the id attribute of the XML
extension point declaration. |
| String | getName() Returns the name of this extension point, which is defined by the name attribute of the XML
extension point declaration. |
| jsx3.amp.PlugIn | Returns the plug-in declaring this extension point. |
| void | onExtension(arrExts : jsx3.$Array<jsx3.amp.Ext>) This method is called (after this extension point is instantiated) any time extensions are registered for this
point. |
| jsx3.$Array<Object> | Processes each extension of this extension point using the visitor pattern. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Method Detail |
|---|
id attribute of the XML
extension point declaration.name attribute of the XML
extension point declaration.jsxsuper().| Field Summary | |
|---|---|
| static jsx3.amp.ExtProc | Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. |
| static jsx3.amp.ExtProc | Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. |
| static jsx3.amp.ExtProc | Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. |
| Method Summary | |
|---|---|
| static void | Registers a processor factory. |
| static void | Creates a processor object from a |
| static jsx3.amp.ExtProc | newDescrProc(objClass : String | jsx3.lang.Class | Function) Creates a new extension processor that creates instances of a certain class. |
| static jsx3.$Array | Processes a list of extensions using the visitor pattern. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
this.getPlugIn()
grants access in the script to the plug-in defining the extension.
No value is returned from the extension processing. If the load attribute of the eval
element is equal to "true" then the plug-in owning the extension is loaded before the script is evaluated.
Therefore, the script may be evaluated either synchronously or asynchronously, but since there is no value returned
from the processing, there is no way of knowing which one actually occurred.
this.getPlugIn()
grants access in the script to the plug-in defining the extension.
The value that the script evaluates to is returned from the extension processing.
this.getPlugIn()
grants access in the script to the plug-in defining the extension.
The value returned from the extension processing is an asynchronous return value as defined in the contract for
jsx3.$Y(). The return value may be notified either asynchronously or synchronously, depending on
whether the load attribute of the eval element is equal to "true". If it is, then
the plug-in owning the extension is loaded first and then the script is evaluated asynchronously. The asynchronous
return value is notified of completion with the value that the script evaluates to.
| Method Detail |
|---|
<processor> is found as a child of an <extension-point> element. Each processor element must
declare a type attribute. The factory that has been registered with the matching type is used to create
the processor. The method signature of the factory method is:
function(xml : jsx3.amp.XML) : jsx3.amp.ExtProc where xml is the XML representation
of the <processor> element.<processor> element.<processor> element.<processor> element.function init(ext : jsx3.amp.Ext, xml : jsx3.amp.XML).
The processing visitor will create a new instance of objClass for each child element of each
extension. If any child element defines a ext-class attribute, this is interpreted as the
fully-qualified class name of a subclass of objClass. This class, if it is defined, will be used
instead of objClass to process that particular child element.arrExt, this
method iterates over each child element of the extension declaration and invokes objVisitor for
each element. At each iteration the visitor is passed as arguments the extension object and an XML object
representing the child element.process(ext : jsx3.amp.Ext, data: jsx3.amp.XML) : Object or the function itself.| Field Summary | |
|---|---|
| static String | Event subject published when an extension point of this plug-in has been extended. |
| static String | Event subject published when this plug-in has loaded completely. |
| Method Summary | |
|---|---|
| jsx3.amp.Engine | Returns the engine of this plug-in. |
| jsx3.$Array<String> | Returns the list of event subjects that this plug-in declares to publish. |
| jsx3.amp.Ext | Returns an extension of this plug-in by its ID. |
| jsx3.amp.ExtPoint | getExtPoint(strId : String) Returns an extension point of this plug-in by its ID. |
| jsx3.$Array<jsx3.amp.ExtPoint> | Returns the extension points of this plug-in. |
| jsx3.$Array<jsx3.amp.Ext> | getExts() Returns the extensions of this plug-in. |
| String | getId() Returns the id attribute from the plug-in configuration element. |
| jsx3.util.Logger | getLog() Returns a logger for this plug-in. |
| String | getName() Returns the name attribute from the plug-in configuration element. |
| jsx3.$Array<String> | Returns the list of plug-in IDs that this plug-in requires. |
| jsx3.amp.Resource | getResource(strId : String) Returns a resource of this plug-in by its ID. |
| jsx3.$Array<jsx3.amp.Resource> | Returns the resources of this plug-in that are defined in the plug-in configuration data. |
| jsx3.app.Server | Returns the server of the engine of this plug-in. |
| String | Implements jsx3.net.URIResolver. |
| String | Returns the version attribute from the plug-in configuration element. |
| static void | isBindExpr(e : String) Returns true if e is a binding expression. |
| boolean | isGlobal() Returns whether this is a global plug-in. |
| boolean | isLoaded() Returns true is all of the resources of this plug-in have loaded. |
| jsx3.$AsyncRV | load() Loads this plug-in asynchronously if it is not already loaded. |
| void | loadRsrcComponent(strRsrcId : String | jsx3.amp.Resource, objParent : jsx3.app.Model, bPaint : boolean) Loads the contents of a plug-in resource as a GUI component. |
| void | Called (after this plug-in is instantiated) any time extensions are registered for an extension
point of this plug-in. |
| void | onLoaded() Called when all the resources of this plug-in have loaded. |
| void | Calls when this plug-in is registered with its engine. |
| void | Called when the engine of this plug-in has completely registered all plug-ins. |
| void | Registers a function to be called when the value of a binding expression changes. |
| jsx3.net.URI | Implements jsx3.net.URIResolver. |
| jsx3.net.URI | resolveURI(strURI : String | jsx3.net.URI) Implements jsx3.net.URIResolver. |
| void | setData(objElm : jsx3.xml.Entity) Called after this plug-in is instantiated to provide the plug-in with its XML configuration data. |
| void | setEngine(objEngine : jsx3.amp.Engine) Called after this plug-in is instantiated to provide the plug-in with the engine that created it. |
| void | Called after this plug-in is instantiated to provide the plug-in with its path. |
| void | setResources(arrRsrc : Array<jsx3.amp.Resource>) Called after this plug-in is instantiated to provide the plug-in with the resources defined in the
configuration data. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.amp.Bindable |
|---|
| addBindableProp, getBindableProps, setBindableProp, updateBindable, updateBindableOn |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Method Detail |
|---|
true if e is a binding expression. A binding expression starts with '{'
and ends with '}'.getPlugIn() method on the root component object
that returns this component. In addition, if the root component object defines an onRsrcLoad()
method, that method is called.true).
jsxsuper to ensure that the EXTENDED event is published.handler will be invoked any time one of these
bindable properties changes value. This function is passed the value of the binding expression. The binding
expression is evaluated in the context of this object. The "this" keyword is optional in the expression
because the expression is evaluated inside of a with block.jsx3.net.URIResolver.jsx3.net.URIResolver.| Field Summary | |
|---|---|
| static String | Loads a resource before the plug-in is instantiated and registered. |
| static String | Waits for a resource to be loaded programatically some time after the plug-in loads. |
| static String | Loads a resource before the plug-in loads. |
| static String | Event subject published when this resource has loaded. |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | |
| Method Summary | |
|---|---|
| static void | |
| void | Returns the value of any attribute of the XML declaration of this resource. |
| jsx3.xml.Document | jsx3.app.Properties | jsx3.app.PropsBundle | Returns the data associated with this resource. |
| String | getId() Returns the full ID of this resource, which is unique to the entire AMP engine. |
| String | Returns the load type, such as LOAD_NORMAL. |
| String | Returns the ID Of this resource, which is unique among all resources of the same plug-in. |
| Array<String> | Returns the list of locale keys for which this resources is localized. |
| String | getPath() Returns the path of this resource, which is relative to the directory of the plug-in owning this resource. |
| String | getPathForLocale(objLocale : jsx3.util.Locale) Returns the path of the best localized version of this resource for objLocale. |
| jsx3.amp.PlugIn | Returns the plug-in that owns this resource. |
| String | getType() Returns the resource type, such as TYPE_SCRIPT. |
| boolean | isLoaded() |
| jsx3.$AsyncRV | load() Asynchronously loads this resource if it is not already loaded. |
| jsx3.$AsyncRV | loaded() Returns an asynchronous return value that completes when this resource is loaded. |
| jsx3.xml.Entity | xml() Returns the XML declaration of this resource as passed to the constructor. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
true then delete the reference to the data object in order to allow
garbage collection.LOAD_NORMAL. The load type is defined using the load
attribute of the resource XML declaration.id attribute of the resource XML declaration.objLocale.TYPE_SCRIPT. The resource type is defined by the element
node name of the resource XML declaration.name() property equal to the base node namechildren() property that is an array of nested objects| Constructor Summary | |
|---|---|
| void | init(elm : jsx3.xml.Entity | Object) |
| Method Summary | |
|---|---|
| String | Returns an attribute of this element. |
| jsx3.amp.XML | Returns a child element of this element whose base name is equal to name. |
| jsx3.$Array<jsx3.amp.XML> | children() Returns this child elements of this element. |
| String | nname() Returns the base name of this element. |
| String | value() Returns the node value of this element. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
name.| Class Summary | |
|---|---|
| jsx3.amp.util.Menu | A managed menu. |
| jsx3.amp.util.MenuItem | A managed menu item. |
| jsx3.amp.util.MenuManager | Manages a set of menus. |
| jsx3.amp.util.Prefs | A preferences panel. |
| jsx3.amp.util.PrefsPane | A pane in a preferences panel. |
| jsx3.amp.util.ToolbarItem | Manages a toolbar. |
| jsx3.amp.util.ToolbarManager | Manages a toolbar. |
| jsx3.amp.util.Wizard | A wizard. |
| jsx3.amp.util.WizardPane | A pane of a wizard. |
jsx3.amp.util.menumgr plug-in.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Adds an item to this menu. |
| void | Adds a logical section to this menu. |
| String | getId() Returns the ID of this menu. |
| jsx3.amp.util.MenuItem | Returns the item in this menu whose ID is equal to id. |
| jsx3.$Array<jsx3.amp.util.MenuItem> | getItems() Returns all items in this menu. |
| jsx3.gui.Menu | Returns the native GI menu that was rendered for this AMP menu. |
| String | getPath() Returns the path of this menu. |
| jsx3.xml.Document | getXML() Returns the CDF data source for this menu. |
| void | Called just before this menu is expanded. |
| Methods Inherited From jsx3.amp.util.MenuItem |
|---|
| attr, execute, getExt, getHotKey, getImg, getLabel, getMenu, getRootMenu, getTip, isEnabled, isSelected |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
id.objElm,
for example by enabling or selecting menu items or generating menu items on the fly.jsx3.amp.util.menumgr plug-in.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns an attribute of the XML declaration of this menu item. |
| void | execute() Executes this menu item. |
| jsx3.amp.Ext | getExt() Returns the extension that defined this menu item. |
| String | Returns the accelerator key code of this menu item. |
| String | getId() Returns the full ID of this menu item. |
| String | getImg() Returns the resolved image path of this item. |
| String | getLabel() Returns the label of this menu item. |
| jsx3.amp.util.Menu | getMenu() Returns the menu that contains this menu item. |
| String | getPath() Returns the path of this menu item. |
| jsx3.amp.util.Menu | |
| String | getTip() Returns the tip of this menu item. |
| boolean | Returns whether this menu item is enabled. |
| boolean | Returns whether this menu item is selected. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
execute attribute is not empty then the plug-in that
declared this menu item is loaded. Once the plug-in loads the contents of the execute attribute
are execute in the context of the extension that defined this menu item.
enabled attribute of the item definition. Otherwise this method returns true.selected attribute of the item definition. Otherwise this method returns false.jsx3.amp.util.menumgr plug-in.
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | addItem(objItem : jsx3.amp.util.MenuItem) Adds a menu item to this manager. |
| void | addMenu(objMenu : jsx3.amp.util.Menu) Adds a menu to this manager. |
| void | Adds a menu bar to this manager. |
| void | Paints all the menus in this manager into their respective menu bars. |
| void | Returns the menu with full path strPath. |
| jsx3.$Array<jsx3.amp.util.Menu> | getMenus() Returns all the menus in this manager. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
strPath will be inserted into the menu bar.strPath.jsx3.amp.util.prefspanel plug-in.
| Field Summary | |
|---|---|
| static String | Event subject published when a preferences panel is saved. |
| static String | Event subject published when the active pane of a preferences panel is changed. |
| static String | Event subject published when a preferences panel is closed. |
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | addPane(objPane : jsx3.amp.util.PrefsPane) Adds a prefs pane to this controller. |
| void | apply() Saves the state of the current pane. |
| boolean | Returns whether to collapse the left side pane list. |
| void | Renders the preferences panel in objParent. |
| void | save() Saves the state of the current pane and closes this panel. |
| void | setCollapse(bCollapse : boolean) Sets whether to collapse the left side pane list. |
| jsx3.$AsyncRV | Displays a prefs pane in the edit area. |
| jsx3.$AsyncRV | Removes this preferences panel from the view. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
renderIn()
has been called.objParent.true only if the pane was shown successfully.true, the current pane is unloaded without saving changes.
true only if the preferences panel was unloaded successfully.jsx3.amp.util.prefspanel plug-in.
| Field Summary | |
|---|---|
| static String | Event subject published when the state of a preference pane is dirtied. |
| static String | Event subject published when a preference pane is saved. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the description of this pane. |
| jsx3.app.Model | Returns the object in the UI of this pane that should get focus when this pane is first revealed. |
| String | getImage() Returns the resolved path of the image of this pane. |
| Object | getProperty(strId : String) Returns an arbitrary property of this pane. |
| String | getTitle() Returns the title of this pane. |
| jsx3.app.Model | getUI() Returns the root component of this pane once it is rendered. |
| boolean | isDirty() Returns whether this pane has unsaved changes. |
| jsx3.$AsyncRV | save() Saves the state of this pane. |
| void | Sets whether this pane has unsaved changes. |
| void | Sets an arbitrary property of this pane. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
obj parameter must define an attribute, resource, which
is the name of an XML resource of ext. This resource will be loaded as the UI component of this
pane. The root object of this component file may define the following methods:
| Method Detail |
|---|
getFirstResponder() of the root UI component for this pane,
if that method is defined.savePrefs() method of the root
UI component of this pane.
jsx3.amp.util.toolbarmgr plug-in.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getImg() Returns the resolved image path of this toolbar item. |
| String | Returns the section of this toolbar item. |
| String | getTip() Returns the tip of this toolbar item. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.amp.util.toolbarmgr plug-in.
| Constructor Summary | |
|---|---|
| void | init(objToolbar : jsx3.gui.WindowBar) The instance initializer. |
| Method Summary | |
|---|---|
| void | addItem(objItem : jsx3.amp.util.ToolbarItem) |
| void | |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.amp.util.wizard plug-in.
| Field Summary | |
|---|---|
| static String | Event subject published when a wizard is cancelled. |
| static String | Event subject published when a wizard is finished. |
| static String | Event subject published when a wizard advances to the next pane. |
| static String | Event subject published when a wizard advances to the previous pane. |
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | Adds a pane to this wizard. |
| void | cancel() Invokes the cancel button. |
| void | finish() Invokes the finish button. |
| jsx3.amp.util.WizardPane | Returns a pane of this wizard by its index. |
| int | Returns the number of panes in this wizard. |
| int | Returns the index of a pane of this wizard. |
| Object | Returns the wizard session object. |
| void | next() Invokes the next button. |
| void | previous() Invokes the previous button. |
| void | removePane(index : int) Removes a pane from this wizard by its list index. |
| void | renderIn(objContainer : jsx3.app.Model) Renders the wizard UI as a child of objContainer. |
| void | Updates the enabled button states of the four wizard buttons. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
objContainer.jsx3.amp.util.wizard plug-in.
| Constructor Summary | |
|---|---|
| jsx3.app.Model | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.app.Model | Returns the object in the UI of this pane that should be focused when the pane is revealed. |
| String | getTitle() Returns the title of this pane. |
| jsx3.app.Model | getUI() Returns the root UI component of this pane once it has been rendered. |
| jsx3.amp.util.Wizard | Returns the wizard owning this pane. |
| boolean | Returns true if the cancel button should be enabled. |
| boolean | Returns true if the finish button should be enabled. |
| boolean | mayNext() Returns true if the next button should be enabled. |
| boolean | Returns true if the previous button should be enabled. |
| void | Called when this pane is revealed. |
| void | Called when this pane is hidden. |
| void | onNext() Called when the UI requests continuing to the next pane. |
| void | Called when the UI requests backtracking to the previous pane. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
getFirstResponder() method of the UI component, if that method is defined.true if the cancel button should be enabled.true if the finish button should be enabled.true if the next button should be enabled.true if the previous button should be enabled.onReveal() method of the root UI component, if that
method is defined.onConceal() method of the root UI component, if that
method is defined.ok field equal to false.{ok:Boolean, alert:Boolean, title:String, message:String}
ok field equal to false.{ok:Boolean, alert:Boolean, title:String, message:String}
| Class Summary | |
|---|---|
| jsx3.app.AddIn | A class that represents a JSX add-in. |
| jsx3.app.Cache | Provides cached access to XML and XSL data. |
| jsx3.app.DOM | Registers all DOM nodes in an instance of jsx3.app.Server and publishes related events. |
| jsx3.app.Model | The abstract base class that defines the JSX DOM. |
| jsx3.app.Monitor | A logging handler that can be instantiated per JSX application and displays logging messages in a separate
browser window while an application is running. |
| jsx3.app.Properties | Represents a repository of dynamic properties. |
| jsx3.app.PropsBundle | A subclass of jsx3.app.Properties that supports localized properties. |
| jsx3.app.Server | The controller of the JSX architecture. |
| jsx3.app.Settings | An object oriented interface onto the XML system settings format. |
| jsx3.app.UserSettings | Read-Write per-User settings for a particular GI application (server). |
| Field Summary | |
|---|---|
| static String | |
| Method Summary | |
|---|---|
| String | |
| String | getId() |
| String | getKey() |
| String | getName() |
| jsx3.app.Settings | |
| String | |
| String | |
| jsx3.net.URI | |
| 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 |
|---|
| Method Detail |
|---|
subject - Cache.CHANGE
id or ids - the ID or array of IDs of the modified documentsaction - Cache.ADD, Cache.CHANGE or Cache.REMOVE
subject - the cache ID of the modified documentaction - Cache.ADD, Cache.CHANGE or Cache.REMOVE
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 | Event action. |
| static int | The number of milliseconds before asynchronous document loads time out. |
| static String | Event subject and action. |
| static String | Event action. |
| static String | |
| Constructor Summary | |
|---|---|
| void | init() Creates a new instance of this class. |
| Method Summary | |
|---|---|
| jsx3.xml.Document | 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 | Asynchronously loads an xml document and stores it in this cache. |
| jsx3.xml.Document | Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it. |
| int | getTimestamp(strId : String) Returns the timestamp from when the document stored under id strId was stored in this cache. |
| boolean | Deprecated. |
| Array<String> | keys() Returns a list of all the keys in this cache instance. |
| jsx3.xml.Document | Synchronously loads an xml document, stores it in this cache, and returns the loaded document. |
| void | 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 |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
strId.intTimestamp.strId.null if none exists.
strURL parameter is used as the id.jsx3.xml.Document (default value) or one of its subclasses. The
class with which to instantiate the new document instance.strURL parameter is used as the id.jsx3.xml.Document (default value) or one of its subclasses. The
class with which to instantiate the new document instance if a new document is opened.strId was stored in this cache.null if no such document exists
in this cache.
false. strURL parameter is used as the id.jsx3.xml.Document (default value) or one of its subclasses. The
class with which to instantiate the new document instance.objDocument in this cache under id strId. If a document already
exists in this cache under strId then that document is removed from the cache.objDocument.jsx3.app.Server and publishes related events.
This class keeps all contained JSX objects indexed on id and name.
| Field Summary | |
|---|---|
| static int | 0 |
| static int | 2 |
| static int | 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 | 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 | Looks up a DOM object contained in this DOM by id. |
| jsx3.app.Model | Looks up a DOM object contained in this DOM by name. |
| static String | Creates a new unique system id. |
| void | 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 | 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 |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
null if none found.
strName. The name index keeps a bucket of
DOM nodes for each unique name. Therefore, this method performs efficiently.null if none found.
strName the behavior of this method is undefined.null if none found. getChild(), adoptChild(), getParent(), etc.| Field Summary | |
|---|---|
| static int | The number of milliseconds before asynchronous component loads time out. |
| static String | Minimum supported version CIF formatted serialization files |
| static String | Minimum supported version for serialization files
|
| static int | The normal load type for a DOM branch. |
| static int | Load type indicating that the DOM branch will deserialize and paint as needed when it becomes visible. |
| static int | Load type indicating that the DOM branch will paint as needed when it becomes visible. |
| static int | Load type indicating that the DOM branch will deserialize and paint after its parent deserializes and the
call stack resets. |
| static int | Load type indicating that the DOM branch will paint after its parent paints and the call stack resets. |
| static int | 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> | The allowed meta data fields. |
| static int | Normal persistance value for a child that will be persisted. |
| static int | Persistance value fora child that is temporarily part of the DOM tree and will not be persisted. |
| static int | Persistance value for a child that exists in an external serialization file and is referenced by URI. |
| static int | Persistance value for a child that exists in an external serialization file and is referenced by URI. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | _applyId(strNS : ?) |
| void | Appends a DOM node to this object after removing the node from its former parent reference. |
| jsx3.app.Model | Creates and returns an exact replica of the object. |
| jsx3.app.Model | 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 | Returns the child DOM node of this node at the given index or with the given name. |
| int | Returns the zero-based index for this DOM node in relation to its siblings. |
| Array<jsx3.app.Model> | Returns an array containing all the child DOM nodes of this object. |
| jsx3.app.Model | Finds the first descendant of this DOM node with a the given name. |
| Array<jsx3.app.Model> | Finds all descendants of the given type. |
| jsx3.app.Model | Returns the first child. |
| jsx3.app.Model | Finds the first child of the given type. |
| String | Returns the help ID of this object. |
| String | getId() Returns the custom JSX-generated id for the object (i.e. |
| jsx3.app.Model | Returns the last child. |
| int | 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 | Returns the next sibling. |
| jsx3.app.Model | Returns the parent DOM node of this object. |
| int | Returns the persistence bit for this model object. |
| jsx3.app.Model | Returns the previous sibling. |
| jsx3.app.Server | Returns an object reference to the server that owns this object. |
| jsx3.net.URIResolver | Returns the URI resolver for this DOM node. |
| static String | Deprecated. |
| boolean | Assigns objMoveChild as the previousSibling of objPrecedeChild |
| jsx3.app.Model | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node. |
| jsx3.app.Model | loadAndCache(strURL : String | jsx3.net.URI, bRepaint : boolean, objCache : jsx3.app.Cache, objResolver : jsx3.net.URIResolver) Loads a component file and caches the document in an XML cache. |
| jsx3.app.Model | loadXML(strXML : String | jsx3.xml.Document, bRepaint : boolean, objResolver : jsx3.net.URIResolver) Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node. |
| protected void | Called during deserialization of this object. |
| protected void | Called during deserialization of this object. |
| protected void | Called during deserialization of this object. |
| protected void | Called when the server owning this DOM node changes. |
| void | onChildAdded(objChild : jsx3.gui.Model) Hook that notifies the model object that a child has been added to it. |
| protected void | onDestroy(objParent : jsx3.app.Model) The finalizer method. |
| protected void | 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 | Sets the help ID of this object. |
| void | setLoadType(intLoadType : int) Sets the load type of this DOM node and the descending branch. |
| void | setS one of the meta data values stored at the top of a component's serialization file. |
| void | 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 | Returns this object serialized as XML by calling toString() on the result of toXMLDoc()
called on this object. |
| jsx3.xml.Document | 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 |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
setChild() should be used instead of this method.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.onSetChild() and onSetParent() will still be called)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.jsx3.app.Model parameter and returns
true if the node matches.true, include this object in the searchjsx3.app.Model parameter and returns
true if the node matches.true, return an array of matches, otherwise just the first match.true, only search direct children.true, include this node in the search.null if none found.
jsx3.Class instance.null if none found.
null if no such
child exists.
-1 if this object does not have a parent.
true, only search the children of this DOM node.null if none found.
jsx3.Class instance.true, only search direct children, not all descendants.jsx3.Class instance.true then only return objects whose class is exactly strType
(rather than returning subclasses too).null if none found.
LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER,
LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER. META_FIELDS.PERSISTNONE, PERSISTEMBED, PERSISTREF,
PERSISTREFASYNC. 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.false the repaint will be suppressed (useful for multiple obejct updates
that would lead to unnecessary updates to the VIEW)objResolver, if provided, or the URI resolver of this DOM node.true or null the deserialized objects will be
added to the parent's view via the parent object's paintChild() method.strURL is resolved
relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.strURL is not the URL of a valid XML document.load() when the same URL will be loaded multiple
times in one application.objResolver, if provided, or the URI resolver of this DOM node.true or null the deserialized objects will be
added to the parent's view via the parent object's paintChild() method.strURL is resolved
relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.strURL is not the URL of a valid XML document.
true or null the deserialized objects will be
added to the parent's view via the parent object's paintChild() method.strXML is not a valid XML document.
getParent(), getServer(), getXML(), etc. return null.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 begin
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.getParent(), getServer(), getXML(), etc. return null.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.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.onSetChild() method.adoptChild() should be used instead of this
method.adoptChild()
should be used instead to ensure that the child is removed from its current parent.intPersist is PERSISTREF or PERSISTREFASYNC.strNS parameter is not specified.false if the set was vetoed LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER,
LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER.META_FIELDSPERSISTNONE, PERSISTEMBED, PERSISTREF,
PERSISTREFASYNC.toString() on the result of toXMLDoc()
called on this object.toXMLDoc() for a description.objProperties parameter may include the following keys:
onAfterDeserialize elementonBeforeDeserialize elementname elementicon elementdescription elementtrue the children of this object, rather than this object, are
serializedtrue all descendants with persistence PERSISTNONE are included in the
serialization| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | Returns whether this monitor remains invisible until the user types the hotkey ctrl+alt+m in the attached
application. |
| boolean | Returns whether this monitor is disabled when its application is running inside the IDE. |
| String | 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 |
|---|
| Method Detail |
|---|
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.ctrl+alt+m before becoming visible.| 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 | 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> | Returns the list of parent repositories of this repository. |
| void | Loads a set of dynamic properties from an XML document into this repository. |
| void | Removes a property from this repository. |
| void | Removes all parent property repositories. |
| void | removeParent(objParent : jsx3.app.Properties) Removes a property repository from the set of parent repositories. |
| void | 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 |
|---|
| Method Detail |
|---|
get() consults all parents before returning
undefined.true if this repository contains a property with the given key.
undefined is returned.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.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.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.| Method Summary | |
|---|---|
| static void | Clears all the data stored in the caches internal to this class. |
| jsx3.app.Locale | 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. |
| static jsx3.app.PropsBundle | getPropsAsync(strBasePath : String | jsx3.net.URI, objLocale : jsx3.util.Locale, fctCallback : Function, 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 |
|---|
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.strPath.strPath, clear out any documents
stored in objCache associated with the resource at path strPath.
getProps() method and not necessarily the most specific locale for which the
properties in this view are defined.| Field Summary | |
|---|---|
| jsx3.app.Cache | Deprecated. Use Server.getCache() |
| jsx3.app.DOM | Deprecated. Use Server.getDOM() |
| Object<String, String> | Deprecated. Use Server.getEnv() |
| static String | 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 | The subject of an event that jsx3.app.Server publishes when an instance of this class
is created. |
| jsx3.gui.Block | Deprecated. Use Server.getBodyBlock() |
| jsx3.gui.Block | Deprecated. Use Server.getRootBlock() |
| Constructor Summary | |
|---|---|
| void | 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 | 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 | To implement jsx3.gui.Alerts interface. |
| jsx3.gui.Window | getAppWindow(strName : String) Retrieves a previously created jsx3.gui.Window instance. |
| jsx3.gui.Block | Returns the body block for this server (JSXBODY) |
| jsx3.app.Cache | getCache() Returns the XML/XSL cache for this server |
| String | Returns the value for the Cookie with the given @name |
| jsx3.app.DOM | getDOM() Returns the DOM for this server |
| jsx3.util.Locale | Returns the default locale of this server. |
| HTMLDocument | getDocumentOf(objJSX : jsx3.app.Model) Returns the browser document object containing a particular JSX object. |
| String | Returns the value of the dynamic property @strPropName |
| String | Returns the value of an environment setting of this server. |
| jsx3.app.Model | 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 | Returns the current locale of this server. |
| jsx3.app.Properties | Returns the dynamic properties registry for this server. |
| HTMLElement | getRenderedOf(objJSX : jsx3.app.Model) Returns the browser DOM object where a particulat JSX object renders. |
| jsx3.gui.Block | Returns the root block for this server (JSXROOT) |
| Array<jsx3.app.Model> | Returns the list of objects that are children of the body object. |
| jsx3.app.Server | Deprecated. |
| jsx3.app.Settings | 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 | |
| static String | 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 | Loads a new jsx3.gui.Window instance from a component file. |
| jsx3.xml.Document | jsx3.net.Service | null | 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 | |
| void | 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 | set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. |
| void | 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 |
|---|
Server.getCache()Server.getDOM()Server.getEnv()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.jsx3.app.Server publishes when an instance of this class
is created. The target of the event object is the initialized server.
Server.getBodyBlock()Server.getRootBlock()| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.Window instance.null if no such window exists. default_locale configuration
setting.jsx3.gui.Window roots.setLocale(),
that locale is returned. Otherwise, getDefaultLocale() is consulted, and finally the system-wide
locale.jsx3.gui.Window roots.objJSX.strSource is resolved
relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.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.css, jss, xml,
xsl, script (for JavaScript), services (for mapping rules),
or ljss.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.strType in not a valid type.
strType
parameter. See the method description. config.xml file of this application.loadInclude() for more information. setLocale() for the server to render properly in the new locale.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.getNode()
with no parameters. | Constructor Summary | |
|---|---|
| void | init(objXML : jsx3.xml.Document) The instance initializer. |
| Method Summary | |
|---|---|
| String | Number | boolean | Array | Object | Returns a stored setting value. |
| jsx3.xml.Entity | Returns a stored setting value as the raw XML node. |
| void | Removes a stored setting value. |
| void | 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 |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | |
| static int | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | clear() Clears all settings of this user settings instance. |
| String | Number | boolean | Array | Object | Returns a stored setting value. |
| void | Removes a stored setting value. |
| void | save() Persists the user settings. |
| void | 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 |
|---|
| Constructor Detail |
|---|
PERSIST_INDEFINITE.
| Method Detail |
|---|
| 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 | bottom/south quadrant |
| static String | left/west quadrant |
| static String | right/east quadrant |
| static String | top/north quadrant |
| Method Summary | |
|---|---|
| static jsx3.vector.Fill | Utility function, combines a vector fill and the property editor string format of a gradient |
| static Number | 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 | Splits a rectangular box in two pieces. |
| Field Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | 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 | 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 | 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, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| 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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getForm() Returns the form field. |
| String | 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 | Returns the pointFill field. |
| String | Returns the pointGradient field. |
| int | Returns the pointRadius field. |
| jsx3.chart.PointRenderer | Returns the pointRenderer field. |
| String | Returns the pointStroke field. |
| static String | Deprecated. |
| String | 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 | 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 | 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 | Sets the xField field. |
| void | Sets the yField field. |
| static String | 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.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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
horizontal x primary -> bottom vertical x primary -> left horizontal x secondary -> top vertical x secondary -> right
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the axisStroke field, string representation of the VectorStroke used to draw the line of the axis. |
| jsx3.chart.ChartLabel | Returns the optional jsx3.chart.ChartLabel child. |
| int | 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 | Returns the horizontal field, whether this is an x axis, otherwise it is a y axis. |
| String | Returns the labelClass field, the CSS class used to render major tick labels. |
| String | Number | 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 | Returns the labelFunction field. |
| int | Returns the labelGap field, the pixel gap between the tick lines and the labels. |
| String | Returns the labelStyle field, the CSS style attribute used to render major tick labels. |
| int | 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 | Returns the minorTickLength field, the length in pixels of the minor tick (if tickPlacement is "cross" the length will actually be twice this. |
| String | Returns the minorTickPlacement field, where to place the minor ticks. |
| String | Returns the minorTickStroke field, string representation of VectorStroke used to draw minor ticks. |
| jsx3.chart.Axis | Returns the opposing axis. |
| boolean | Returns the showAxis field, whether to show the line along the axis. |
| boolean | Returns the showLabels field, whether to show major tick labels. |
| int | Returns the tickLength field, the length in pixels of the major tick (if tickPlacement is "cross" the length will actually be twice this. |
| String | Returns the tickPlacement field, where to place the major ticks. |
| String | Returns the tickStroke field, string representation of VectorStroke used to draw major ticks. |
| static String | Deprecated. |
| static String | formats labels as a percent, ie "50%" |
| static String | 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 | Function) Sets the labelFunction field, allows for formatting and transformation of a major tick label. |
| 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.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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
function(value : Number|String) : String.
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | Returns the categoryCoverage field, the ratio of the range of a category that is covered by bars/columns. |
| float | 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 | Deprecated. |
| void | setCategoryCoverage(categoryCoverage : float) Sets the categoryCoverage field. |
| void | setSeriesOverlap(seriesOverlap : float) Sets the seriesOverlap field. |
| void | 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, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| 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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
BarSeries and ColumnSeries.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | 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 | Deprecated. |
| String | 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 | 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 | Sets the xField field. |
| void | 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.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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | 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, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| 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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns the barHeight field. |
| void | setBarHeight(barHeight : int) Sets the barHeight field. |
| static String | 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.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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | 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 | 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.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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Array<jsx3.chart.GridLines> | Returns the array of children GridLines instances. |
| jsx3.chart.Axis | Returns the primary x axis, if any. |
| jsx3.chart.Axis | 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 | 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, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| 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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | 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 | Returns the paddingHigh field, the number of category widths to pad the end of the axis with. |
| float | Returns the paddingLow field, the number of category widths to pad the beginning of the axis with. |
| String | 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 | 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.ChartComponent |
|---|
| getChart |
| 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, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
| Method Detail |
|---|