class Engine

->jsx3.lang.Object

->jsx3.amp.Engine

All Implemented Interfaces:

jsx3.util.EventDispatcher

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

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

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

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

ERROR

static String ERROR

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

LOAD

static String LOAD

Event subject published when an engine finishes loading.

PROGRESS

static String PROGRESS

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

REGISTER

static String REGISTER

Event subject published when a plug-in is registered.

Method Detail

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