org.xul.script.xul.model

Class XULDocument

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.scripthelper.js.AbstractJSScriptable

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

org.xul.script.xul.model.XULDocument

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, XULConstants, XULExecutorListener, XULScript

public class XULDocument
extends AbstractJSScriptContext
implements XULExecutorListener, XULScript, XULConstants

Hold a XUL document and its characteristics. Only a subset of mozilla XUL is handled:

• embedded and external Javascript scripts
• a subset of XUL components

It is also able to process external beanshell scripts.

Components and attributes

• button and toolbarbutton: with attributes label, disabled, image, and type
• checkbox: with attributes label, disabled, checked, image
• textbox: with attributes disabled, cols, value
• label: with attribute value
• spacer
• vbox and hbox
• groupbox and the associated caption
• stack
• menulist and menuitem
• image
• scrollbar
• scale (new as of Firefox 3.0)

The following attributes are handled for every widget:

• id, align, hidden, left, top, width, height, minWidth, minHeight, maxWidth, maxHeight

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 inherited from class org.xul.script.scripts.lang.js.AbstractJSScriptContext

compToNames, currentScript, isActive, listener, PAT_FUNCTION, 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.xul.script.xul.model.XULConstants

ALIGN, CHECKED, CLASS, COLS, CURPOS, CURRENTINDEX, CURRENTITEM, DECIMALPLACES, DIALOGTYPE, DIRECTORY, DISABLED, DOCUMENT, EDITABLE, EDITING_COLUMN, EDITING_ROW, EXTENSIONS, HEIGHT, HIDDEN, HORIZONTAL, ID, IMAGE, INCREMENT, ITEMCOUNT, LABEL, LEFT, MAX, MAX_HEIGHT, MAX_WIDTH, MAXPOS, MIN, MIN_HEIGHT, MIN_WIDTH, MODE, MULTILINE, ORIENT, PAGEINCREMENT, RESIZABLE, ROWS, SCREENX, SCREENY, SELECTED, SELECTEDINDEX, SRC, STYLE, TITLE, TOOLTIPTEXT, TOP, TYPE, VALUE, VERTICAL, VIEW, WIDTH, WINDOW, WRAP

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
XULDocument()
XULDocument(java.lang.String name, java.net.URL url)
XULDocument(java.lang.String name, java.net.URL url, org.w3c.dom.Document doc)

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.lang.String widgetID, XULActionListener listener) Add an action listener on a XUL widget ID.
void	addActionListener(XULActionListener listener) Add a XULActionListener to the underlying root component.
void	addWidget(XULWidget widget) Add a widget to the document.
void	alert(java.lang.String arg) The "print(String)" builtin Javascript function.
int	countScripts() Count the number of scripts in the document.
javax.swing.JMenuBar	createMenuBar() Create a menubar for the window.
java.util.List<javax.swing.JToolBar>	createToolBars() Create the list of toolbars for the window.
java.lang.Object	execute(java.lang.String functionName, java.lang.Object arg) Execute a Javascript method for this XULDocument, with only one argument.
java.lang.Object	execute(java.lang.String functionName, java.lang.Object[] args) Execute a Javascript method for this XULDocument, with two arguments.
java.lang.Object	execute(java.lang.String functionName, XULWidget parent, XULWidget child) Execute a Javascript method for this XULDocument, with only one argument.
protected void	fireListeners(XULWidget widget, XULActionEvent event) Fire the listeners for an action event.
java.lang.Object	get(java.lang.String property) Return a live property value at the Javascript level.
java.net.URL	getBaseDir()
java.util.Map<java.lang.String,java.util.Map<org.scripthelper.model.CachedMethodKey,org.scripthelper.model.ScriptWrapper<?>>>	getCallSites() Return the call sites for this document.
java.lang.String	getClassName()
CSSManager	getCSS() Return the CSS manager.
XULWidget	getCurrentWidget() Return the current widget.
XULWindow	getCurrentWindow() Return the current window.
org.w3c.dom.Document	getDocument() Return the associated DOM document.
java.lang.Class<? extends org.mozilla.javascript.ScriptableObject>	getExecutorClass()
java.io.File	getFile() Return the associated file.
java.util.Map<java.lang.String,ScriptHandle>	getFunctionNames() Return the function names which can be executed in the document.
java.lang.String[]	getFunctionProperties() Define the two builtin Javascript functions.
java.lang.String	getName() Return the script name.
java.util.Map<java.net.URL,java.lang.String>	getNotExistingScripts()
java.lang.String[]	getObjectNames()
XULSwingPanel	getRootComponent() Return the root component.
ScriptManager	getScriptManager() Return the script manager.
java.net.URL	getURL() Return the document URL.
XULWidget	getWidget(java.lang.String elementId) Return the widget of the corresponding Id.
java.util.Map<org.w3c.dom.Element,XULWidget>	getWidgets() Return the widgets which have an ID in the XUL Document.
XULWindow	getWindow() Return the window.
XULExecutor	getXULExecutor() Return the document-level executor for all Javascript methods on the "document" prototype.
boolean	hasNotExistingScripts()
void	print(java.lang.String arg) The "print(String)" builtin Javascript function.
void	removeActionListener(java.lang.String widgetID, XULActionListener listener) Remove an action listener on a XUL widget ID.
void	removeActionListener(XULActionListener listener) Remove an XULActionListener from the underlying root component.
java.lang.Object	runExternalMethod(java.lang.String name, java.lang.Object args)
void	set(java.lang.String property, java.lang.Object value) Set a live property value at the Javascript level.
void	setActive(boolean isActive) Set the context as active or inactive.
void	setCountScripts(int countScripts) Set the number of scripts in the document.
void	setCSS(CSSManager css) Set the CSS manager.
void	setDocument(org.w3c.dom.Document doc) Set the associated DOM.
void	setNotExistingScripts(java.util.Map<java.net.URL,java.lang.String> notExistingScripts)
void	setRootComponent(XULSwingPanel root) Set the root Swing component associated with this document.
void	setScriptManager(ScriptManager scriptManager) Set the script manager.
void	setupScripts() Setup the scripts.
void	setWidgets(java.util.Map<org.w3c.dom.Element,XULWidget> widgets) Set widgets which have an ID in the XUL Document.
void	setWindow(XULWindow window) Set the window.

Methods inherited from class org.xul.script.scripts.lang.js.AbstractJSScriptContext

addScript, alert, getCurrentScript, getScriptListener, getScripts, getScriptsForClass, handleComponentAdjust, handleComponentChange, handleComponentChange, handleComponentCommand, handleComponentHover, handleComponentOut, handleComponentSelected, handleWindowLoad, isActive, removeScript, runFunction, setComponentsToNames, setScriptListener

Methods inherited from class org.scripthelper.js.AbstractJSScriptable

addExternalFunction, createJSContext, defineBuiltIntFunctions, defineExternalFunctions, defineFunctionProperties, 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

getExecutorsMap, jsConstructor

Methods inherited from interface org.mozilla.javascript.Scriptable

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

Constructor Detail

XULDocument

public XULDocument()

XULDocument

public XULDocument(java.lang.String name,
                   java.net.URL url)

XULDocument

public XULDocument(java.lang.String name,
                   java.net.URL url,
                   org.w3c.dom.Document doc)

Method Detail

setScriptManager

public void setScriptManager(ScriptManager scriptManager)

Set the script manager.

Parameters:

scriptManager - the script manager

getScriptManager

public ScriptManager getScriptManager()

Return the script manager.

Specified by:

getScriptManager in class AbstractJSScriptContext

Returns:

the script manager

setCSS

public void setCSS(CSSManager css)

Set the CSS manager.

Parameters:

css - the CSS manager

getCSS

public CSSManager getCSS()

Return the CSS manager.

Returns:

the CSS manager

setDocument

public void setDocument(org.w3c.dom.Document doc)

Set the associated DOM.

Parameters:

doc - the associated DOM

setRootComponent

public void setRootComponent(XULSwingPanel root)

Set the root Swing component associated with this document.

Parameters:

root - the root component

setWindow

public void setWindow(XULWindow window)

Set the window.

Parameters:

window - the window

getWindow

public XULWindow getWindow()

Return the window.

Returns:

the window

countScripts

public int countScripts()

Count the number of scripts in the document.

Returns:

the number of scripts in the document

setCountScripts

public void setCountScripts(int countScripts)

Set the number of scripts in the document.

Parameters:

countScripts - the number of scripts

createMenuBar

public javax.swing.JMenuBar createMenuBar()

Create a menubar for the window. Will return null if there is no menu for this document.

Returns:

the menubar

createToolBars

public java.util.List<javax.swing.JToolBar> createToolBars()

Create the list of toolbars for the window.

Returns:

the list of toolbars

getName

public java.lang.String getName()

Return the script name.

Returns:

the script name

getExecutorClass

public java.lang.Class<? extends org.mozilla.javascript.ScriptableObject> getExecutorClass()

Specified by:

getExecutorClass in interface org.scripthelper.js.JSScriptable

getDocument

public org.w3c.dom.Document getDocument()

Return the associated DOM document.

Returns:

the document

getURL

public java.net.URL getURL()

Return the document URL.

Returns:

the URL

getFunctionNames

public java.util.Map<java.lang.String,ScriptHandle> getFunctionNames()

Return the function names which can be executed in the document.

Returns:

the function names

setActive

public void setActive(boolean isActive)

Set the context as active or inactive.

Overrides:

setActive in class AbstractJSScriptContext

Parameters:

isActive - true if the context must be active

addActionListener

public void addActionListener(java.lang.String widgetID,
                              XULActionListener listener)

Add an action listener on a XUL widget ID.

Parameters:

widgetID - the widget ID

listener - the listener

addActionListener

public void addActionListener(XULActionListener listener)

Add a XULActionListener to the underlying root component.

Parameters:

listener - the listener

removeActionListener

public void removeActionListener(XULActionListener listener)

Remove an XULActionListener from the underlying root component.

Parameters:

listener - the listener

removeActionListener

public void removeActionListener(java.lang.String widgetID,
                                 XULActionListener listener)

Remove an action listener on a XUL widget ID.

Parameters:

widgetID - the widget ID

listener - the listener

fireListeners

protected void fireListeners(XULWidget widget,
                             XULActionEvent event)

Fire the listeners for an action event.

Overrides:

fireListeners in class AbstractJSScriptContext

Parameters:

widget - the widget

event - the event

getCallSites

public java.util.Map<java.lang.String,java.util.Map<org.scripthelper.model.CachedMethodKey,org.scripthelper.model.ScriptWrapper<?>>> getCallSites()

Return the call sites for this document.

Returns:

the call sites

setupScripts

public void setupScripts()

Setup the scripts.

getFile

public java.io.File getFile()

Return the associated file.

Returns:

the associated file

addWidget

public void addWidget(XULWidget widget)

Add a widget to the document.

Parameters:

widget - the widget

getXULExecutor

public XULExecutor getXULExecutor()

Return the document-level executor for all Javascript methods on the "document" prototype.

Returns:

the document-level executor

getBaseDir

public java.net.URL getBaseDir()

setNotExistingScripts

public void setNotExistingScripts(java.util.Map<java.net.URL,java.lang.String> notExistingScripts)

getNotExistingScripts

public java.util.Map<java.net.URL,java.lang.String> getNotExistingScripts()

hasNotExistingScripts

public boolean hasNotExistingScripts()

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Overrides:

getClassName in class org.scripthelper.js.AbstractJSScriptable

getFunctionProperties

public java.lang.String[] getFunctionProperties()

Define the two builtin Javascript functions. They are:

• print(String), which prints in the logger
• alert(String), which shows an alert popup

Specified by:

getFunctionProperties in interface org.scripthelper.js.JSScriptable

Overrides:

getFunctionProperties in class AbstractJSScriptContext

Returns:

the builtin Javascript functions

print

public void print(java.lang.String arg)

The "print(String)" builtin Javascript function.

Overrides:

print in class AbstractJSScriptContext

Parameters:

arg - the String argument

alert

public void alert(java.lang.String arg)

The "print(String)" builtin Javascript function.

Parameters:

arg - the String argument

getObjectNames

public java.lang.String[] getObjectNames()

Specified by:

getObjectNames in interface org.scripthelper.js.JSScriptable

getRootComponent

public XULSwingPanel getRootComponent()

Return the root component.

Specified by:

getRootComponent in class AbstractJSScriptContext

Returns:

the root component

getCurrentWindow

public XULWindow getCurrentWindow()

Return the current window.

Returns:

the current widget

getCurrentWidget

public XULWidget getCurrentWidget()

Return the current widget.

Returns:

the current widget

setWidgets

public void setWidgets(java.util.Map<org.w3c.dom.Element,XULWidget> widgets)

Set widgets which have an ID in the XUL Document.

Parameters:

widgets - the widgets

getWidgets

public java.util.Map<org.w3c.dom.Element,XULWidget> getWidgets()

Return the widgets which have an ID in the XUL Document.

Returns:

the widgets

getWidget

public XULWidget getWidget(java.lang.String elementId)

Return the widget of the corresponding Id.

Specified by:

getWidget in interface XULScript

Parameters:

elementId - the widget ID

Returns:

the widget

get

public java.lang.Object get(java.lang.String property)

Return a live property value at the Javascript level. It will be fired by all jsGet_<property Name> methods in the XULExecutor enclosing class.

Specified by:

get in interface XULExecutorListener

Parameters:

property - the property name

Returns:

the property value

set

public void set(java.lang.String property,
                java.lang.Object value)

Set a live property value at the Javascript level. It will be fired by all jsSet_<property Name> methods in the XULExecutor enclosing class.

Specified by:

set in interface XULExecutorListener

Parameters:

property - the property name

value - the property value

execute

public java.lang.Object execute(java.lang.String functionName,
                                java.lang.Object[] args)

Execute a Javascript method for this XULDocument, with two arguments.

Specified by:

execute in interface org.scripthelper.js.JSScriptable

Specified by:

execute in interface XULExecutorListener

Parameters:

functionName - the function name

args - the arguments

Returns:

the script result

runExternalMethod

public java.lang.Object runExternalMethod(java.lang.String name,
                                          java.lang.Object args)

execute

public java.lang.Object execute(java.lang.String functionName,
                                java.lang.Object arg)

Execute a Javascript method for this XULDocument, with only one argument. The only Javascript method handled for the moment is getElementById(String). It will be fired as execute("jsFunction_getElementById", String)

Specified by:

execute in interface XULExecutorListener

Parameters:

functionName - the javascript function name, with the prefix

arg - the argument

Returns:

the single XULExecutor enclosed in this XULDocument

execute

public java.lang.Object execute(java.lang.String functionName,
                                XULWidget parent,
                                XULWidget child)

Execute a Javascript method for this XULDocument, with only one argument. The only Javascript method handled for the moment is getElementById(String). It will be fired as execute("jsFunction_getElementById", String)

Parameters:

functionName - the javascript function name, with the prefix

parent - the parent

child - the child

Returns:

the single XULExecutor enclosed in this XULDocument