org.xul.script.scripts.lang.js

Class AbstractJSScriptContext

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.scripthelper.js.AbstractJSScriptable

org.xul.script.scripts.lang.js.AbstractJSScriptContext

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable, org.scripthelper.js.JSScriptable

Direct Known Subclasses:

XULDocument

public abstract class AbstractJSScriptContext
extends org.scripthelper.js.AbstractJSScriptable

This class is able to load and run JavaScript scripts, in the context of XUL Scripts.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<javax.swing.JComponent,java.lang.String>	compToNames
protected ScriptHandle	currentScript
protected boolean	isActive
protected ScriptListener	listener
protected static java.util.regex.Pattern	PAT_FUNCTION
protected java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle>	scripts

Fields inherited from class org.scripthelper.js.AbstractJSScriptable

context, ctx, functions

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJSScriptContext()

Method Summary

Modifier and Type	Method and Description
void	addScript(ScriptHandle script) Add a script.
void	alert(java.lang.String message, javax.swing.JComponent root) Alert with a message.
protected void	fireListeners(XULWidget widget, XULActionEvent event) Do nothing by default.
ScriptHandle	getCurrentScript()
java.lang.String[]	getFunctionProperties()
abstract javax.swing.JComponent	getRootComponent() Return the root component which will be used to present the error messages of the Script execution.
ScriptListener	getScriptListener() Return the script listener.
abstract ScriptManager	getScriptManager() Return the ScriptManager.
java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle>	getScripts()
java.util.List<ScriptHandle>	getScriptsForClass(java.lang.Class<?> clazz) Return the scripts for a specified Script interface.
void	handleComponentAdjust(XULAdjustmentEvent e, boolean hasCommand) Handle an action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.
void	handleComponentChange(XULChangeEvent e, boolean hasCommand) Handle a change action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.
void	handleComponentChange(XULWidget widget, XULChangeEvent e, boolean hasCommand) Handle a change action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.
void	handleComponentCommand(XULCommandEvent e, boolean hasCommand) Handle an action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.
void	handleComponentHover(XULHoverEvent e, boolean hasCommand) Handle an action on a component that fire ActionEvents in the XUL Script.
void	handleComponentOut(XULExitEvent e, boolean hasCommand) Handle an action on a component that fire ActionEvents in the XUL Script.
void	handleComponentSelected(XULSelectedEvent e, boolean hasCommand) Handle an action on a component that fire ActionEvents in the XUL Script.
void	handleWindowLoad(XULLoadEvent e, boolean hasCommand) Handle an action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.
boolean	isActive() Return true if the context is active.
void	print(java.lang.String message) print a message.
void	removeScript(org.scripthelper.model.ScriptSource source)
protected java.lang.Object	runFunction(FunctionBinding binding, javax.swing.JComponent comp) Exexute a Javascript function call on a Component in the XUL File.
void	setActive(boolean isActive) Set the context as active or inactive.
void	setComponentsToNames(java.util.Map<javax.swing.JComponent,java.lang.String> compToNames)
void	setScriptListener(ScriptListener listener) Set the script listener.

Methods inherited from class org.scripthelper.js.AbstractJSScriptable

addExternalFunction, createJSContext, defineBuiltIntFunctions, defineExternalFunctions, defineFunctionProperties, getClassName, getDefinedClasses, getExecutorInstance, getExecutorInstancesMap, getJSContext, jsFunction_call, runScriptMethod, setContext, setDefinedClasses

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scripthelper.js.JSScriptable

execute, getExecutorClass, getExecutorsMap, getObjectNames, jsConstructor

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, get, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

Field Detail

PAT_FUNCTION

protected static final java.util.regex.Pattern PAT_FUNCTION

compToNames

protected java.util.Map<javax.swing.JComponent,java.lang.String> compToNames

isActive

protected boolean isActive

listener

protected ScriptListener listener

currentScript

protected ScriptHandle currentScript

scripts

protected java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle> scripts

Constructor Detail

AbstractJSScriptContext

protected AbstractJSScriptContext()

Method Detail

isActive

public boolean isActive()

Return true if the context is active.

Returns:

true if the context is active

setActive

public void setActive(boolean isActive)

Set the context as active or inactive.

Parameters:

isActive - true if the context must be active

getScriptManager

public abstract ScriptManager getScriptManager()

Return the ScriptManager.

Returns:

the ScriptManager

setScriptListener

public void setScriptListener(ScriptListener listener)

Set the script listener.

Parameters:

listener - the script listener

getScriptListener

public ScriptListener getScriptListener()

Return the script listener.

Returns:

the script listener

getRootComponent

public abstract javax.swing.JComponent getRootComponent()

Return the root component which will be used to present the error messages of the Script execution.

Returns:

the root component

getScripts

public java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle> getScripts()

getCurrentScript

public ScriptHandle getCurrentScript()

print

public void print(java.lang.String message)

print a message.

Parameters:

message -

alert

public void alert(java.lang.String message,
                  javax.swing.JComponent root)

Alert with a message.

Parameters:

message - the message alter

root - the root component

getFunctionProperties

public java.lang.String[] getFunctionProperties()

addScript

public void addScript(ScriptHandle script)

Add a script.

Parameters:

script - the script.

getScriptsForClass

public java.util.List<ScriptHandle> getScriptsForClass(java.lang.Class<?> clazz)

Return the scripts for a specified Script interface.

Parameters:

clazz - the Script interface class

Returns:

the list of scripts

removeScript

public void removeScript(org.scripthelper.model.ScriptSource source)

setComponentsToNames

public void setComponentsToNames(java.util.Map<javax.swing.JComponent,java.lang.String> compToNames)

fireListeners

protected void fireListeners(XULWidget widget,
                             XULActionEvent event)

Do nothing by default.

Parameters:

widget - the widget

event - the event

handleWindowLoad

public void handleWindowLoad(XULLoadEvent e,
                             boolean hasCommand)

Handle an action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.

Parameters:

e - the ActionEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentHover

public void handleComponentHover(XULHoverEvent e,
                                 boolean hasCommand)

Handle an action on a component that fire ActionEvents in the XUL Script.

Parameters:

e - the ActionEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentOut

public void handleComponentOut(XULExitEvent e,
                               boolean hasCommand)

Handle an action on a component that fire ActionEvents in the XUL Script.

Parameters:

e - the ActionEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentSelected

public void handleComponentSelected(XULSelectedEvent e,
                                    boolean hasCommand)

Handle an action on a component that fire ActionEvents in the XUL Script.

Parameters:

e - the ActionEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentCommand

public void handleComponentCommand(XULCommandEvent e,
                                   boolean hasCommand)

Handle an action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.

Parameters:

e - the ActionEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentAdjust

public void handleComponentAdjust(XULAdjustmentEvent e,
                                  boolean hasCommand)

Handle an action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.

Parameters:

e - the AdjustmentEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentChange

public void handleComponentChange(XULChangeEvent e,
                                  boolean hasCommand)

Handle a change action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.

Parameters:

e - the ChangeEvent

hasCommand - true if there is a command, which means that a script must be fired

handleComponentChange

public void handleComponentChange(XULWidget widget,
                                  XULChangeEvent e,
                                  boolean hasCommand)

Handle a change action on a component that fire ActionEvents in the XUL Script, such as Buttons and CheckBox.

Parameters:

widget - the widget which is at the origin of the event

e - the ChangeEvent

hasCommand - true if there is a command, which means that a script must be fired

runFunction

protected java.lang.Object runFunction(FunctionBinding binding,
                                       javax.swing.JComponent comp)
                                throws java.lang.Exception

Exexute a Javascript function call on a Component in the XUL File. It correspond to a "oncommand" attribute in the XML XUL File. An example of a function call could be: oncommand="buttonPressed()"

Parameters:

binding - the Javascript binding

comp - the component firing the call

Returns:

the result of the command

Throws:

java.lang.Exception - if the command fails