org.xul.script.xul

Class AbstractScriptManager

java.lang.Object

org.xul.script.xul.AbstractScriptManager

All Implemented Interfaces:

ScriptManager, ScriptManagerProperties, XULScriptManagerContext

Direct Known Subclasses:

DefaultScriptManager

public abstract class AbstractScriptManager
extends java.lang.Object
implements ScriptManager, ScriptManagerProperties, XULScriptManagerContext

A Basic script manager, managing external, Javascript and XUL scripts.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active True if the manager is active.
protected java.util.Map<java.lang.String,java.util.Map<org.scripthelper.model.CachedMethodKey,org.scripthelper.model.ScriptWrapper<?>>>	callSites The map of call sites.
protected XULScriptContext	context The ScriptContext.
protected ScriptFactory	factory The script factory.
protected java.util.List<ScriptManagerListener>	listeners The script manager listeners.
protected java.util.Map<java.lang.String,XULDocument>	xulscripts The scripts.

Fields inherited from interface org.xul.script.xul.ScriptManager

LOADING_GLOBAL, LOADING_LOCAL

Fields inherited from interface org.xul.script.xul.ScriptManagerProperties

ALLOW_DISPOSE, ALLOW_EXIT, ALLOW_FILE_ACCESS

Constructor Summary

Constructors

Constructor and Description
AbstractScriptManager()

Method Summary

Modifier and Type	Method and Description
void	addManagerListener(ScriptManagerListener listener) Add a listener to the Script manager.
boolean	addScript(java.lang.String mime, java.net.URL url, XULDocument xuldoc, ScriptFactory factory) Add a script on XUL documents.
XULDocument	addXULScript(java.io.File file) Add a new XUL Script initialized with the content of a XUL XML File.
XULDocument	addXULScript(java.lang.String name, java.net.URL xulscript) Add a new XUL Script initialized with the content of a XUL XML File.
XULDocument	addXULScript(java.net.URL xulscript) Add a new XUL Script initialized with the content of a XUL XML File.
java.lang.Object	evalScript(ScriptHandle script, java.lang.String scriptMethod) Evaluate a Script.
java.lang.Object	evalScript(ScriptHandle script, java.lang.String scriptMethod, java.lang.Object arg) Evaluate a Script.
java.lang.Object	evalScript(ScriptHandle script, java.lang.String scriptMethod, java.lang.Object[] args) Evaluate a Script.
java.lang.Object	evalScript(java.lang.String scriptMethod, java.lang.Object... args) Evaluate a Script method.
java.util.Map<java.lang.String,java.util.Map<org.scripthelper.model.CachedMethodKey,org.scripthelper.model.ScriptWrapper<?>>>	getCallSites() Return the call sites.
XULDocument	getCurrentDocument() Return the document from which the last user event originates.
XULWidget	getCurrentWidget() Return the widget from which the last user event originates.
java.util.Map<java.net.URL,ScriptHandle>	getGlobalScripts() Return the Map of global scripts.
java.util.List<ScriptManagerListener>	getListeners() Return the list of manager listeners.
javax.swing.JMenuBar	getMenuBar() Return the Menubar.
ParserErrorReporter	getParserErrorReporter() Return the XUL parser error reporter.
java.lang.Object	getPropertyValue(java.lang.String key) Return a property value.
XULScriptContext	getScriptContext() Return the script context.
org.scripthelper.exceptions.ScriptExceptionListener	getScriptExceptionListener() Return the script exception listener.
ScriptFactory	getScriptFactory() Return the script factory.
ScriptListener	getScriptListener() Return the script listener.
org.scripthelper.context.ScriptLogger	getScriptLogger() Return the script logger.
java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle>	getScripts() Return the scripts.
short	getScriptsLoadingType() Return the scripts loading type
javax.swing.LookAndFeel	getSelectedLookAndFeel() Return the Look and Feel of the viewer.
java.util.List<javax.swing.JToolBar>	getToolBars() Return the toolbars.
XULDocument	getXULScript(java.lang.String scriptName) Return the XULScript of a specified name.
java.util.Map<java.lang.String,XULDocument>	getXULScripts() Return the XUL Scripts managed by the manager.
boolean	hasXULScript(java.lang.String scriptName) Return true if it exist a XUL script of the defined name.
java.awt.Container	install(javax.swing.JFrame parent) Install the manager content in a parent frame.
java.awt.Container	install(javax.swing.JFrame parent, boolean scrollable) Install the manager content in a parent frame.
java.awt.Container	install(javax.swing.JFrame parent, boolean scrollable, boolean hasLoggerArea, int loggerRows) Install the manager content in a parent frame.
boolean	isActive() Return true if the manager is active.
boolean	isListingAllScriptTypes() Return true if all script methods are returned by the XULDocument.getFunctionNames() method.
boolean	isValidatingXULSchemas() Return true if the XUL scripts schemas must be validated.
void	listAllScriptTypes(boolean listAllScripts) Set if all script methods are returned by the XULDocument.getFunctionNames() method.
void	removeManagerListener(ScriptManagerListener listener) Remove a listener from the Script manager.
void	removeXULScript(java.lang.String name) Remove a script.
void	setActive(boolean active) Set the activation of the manager.
void	setClassLoader(java.lang.ClassLoader classLoader) Set the classLoader to use to load the script classes
void	setCurrentWidget(XULWidget widget) Set the widget from which the last user event originates.
void	setLookAndFeel(javax.swing.LookAndFeel lf) Set the Look and Feel of the viewer.
void	setLookAndFeel(java.lang.String name) Set the Look and Feel of the viewer.
void	setParserErrorReporter(ParserErrorReporter errorReporter) Set the XUL parser error reporter.
boolean	setProperty(java.lang.String key, java.lang.Object value) Set the value of a Script manager property.
void	setScriptContext(XULScriptContext context) Set the script context.
void	setScriptExceptionListener(org.scripthelper.exceptions.ScriptExceptionListener exceptionListener) Set the script exception listener.
void	setScriptFactory(ScriptFactory factory) Set the script factory.
void	setScriptListener(ScriptListener listener) Set the script listener.
void	setScriptLogger(org.scripthelper.context.ScriptLogger scriptLogger) Set the script logger.
void	setScriptsLoadingType(short type) Set the scripts loading type.
void	validateXULSchema(boolean isValidating) Set if the XUL scripts schemas must be validated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xul.script.xul.ScriptManager

addScript, addScript, addScript, addScript, addScript, addXULScript, evalScript, getCurrentWindow, getPropertyValueAsBoolean, hasGlobalScript

Field Detail

xulscripts

protected java.util.Map<java.lang.String,XULDocument> xulscripts

The scripts.

active

protected boolean active

True if the manager is active.

context

protected XULScriptContext context

The ScriptContext.

listeners

protected java.util.List<ScriptManagerListener> listeners

The script manager listeners.

callSites

protected java.util.Map<java.lang.String,java.util.Map<org.scripthelper.model.CachedMethodKey,org.scripthelper.model.ScriptWrapper<?>>> callSites

The map of call sites.

factory

protected ScriptFactory factory

The script factory.

Constructor Detail

AbstractScriptManager

public AbstractScriptManager()

Method Detail

validateXULSchema

public void validateXULSchema(boolean isValidating)

Set if the XUL scripts schemas must be validated.

Specified by:

validateXULSchema in interface ScriptManager

Parameters:

isValidating - true if the XUL scripts schemas must be validated

isValidatingXULSchemas

public boolean isValidatingXULSchemas()

Return true if the XUL scripts schemas must be validated.

Specified by:

isValidatingXULSchemas in interface ScriptManager

Returns:

true if the XUL scripts schemas must be validated

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Set the classLoader to use to load the script classes

Specified by:

setClassLoader in interface ScriptManager

Parameters:

classLoader - the classLoader

setProperty

public boolean setProperty(java.lang.String key,
                           java.lang.Object value)

Set the value of a Script manager property. The supported properties are:

• ScriptManagerProperties.ALLOW_FILE_ACCESS allows files access (read and write) by scripts. Default is true
• ScriptManagerProperties.ALLOW_DISPOSE allows dispose of the current window access by scriprs. Default is false
• ScriptManagerProperties.ALLOW_EXIT allows System.exist(0) by scriprs. Default is false

Specified by:

setProperty in interface ScriptManager

Parameters:

key - the property key

value - the property value

Returns:

true if the property exists and the value is of the correct type

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String key)

Return a property value.

Specified by:

getPropertyValue in interface ScriptManager

Parameters:

key - the property key

Returns:

the property value

listAllScriptTypes

public void listAllScriptTypes(boolean listAllScripts)

Set if all script methods are returned by the XULDocument.getFunctionNames() method. By default only Javascript scripts methods and functions are listed.

Specified by:

listAllScriptTypes in interface ScriptManager

Parameters:

listAllScripts - the scripts loading type

isListingAllScriptTypes

public boolean isListingAllScriptTypes()

Return true if all script methods are returned by the XULDocument.getFunctionNames() method. By default only Javascript scripts methods and functions are listed.

Specified by:

isListingAllScriptTypes in interface ScriptManager

Returns:

true if all script methods are returned by the XULDocument.getFunctionNames() method

setScriptsLoadingType

public void setScriptsLoadingType(short type)

Set the scripts loading type.

Specified by:

setScriptsLoadingType in interface ScriptManager

Parameters:

type - the scripts loading type

getScriptsLoadingType

public short getScriptsLoadingType()

Return the scripts loading type

Specified by:

getScriptsLoadingType in interface ScriptManager

Returns:

the scripts loading type

getGlobalScripts

public java.util.Map<java.net.URL,ScriptHandle> getGlobalScripts()

Return the Map of global scripts.

Specified by:

getGlobalScripts in interface ScriptManager

Returns:

the Map of global scripts

setScriptFactory

public final void setScriptFactory(ScriptFactory factory)

Set the script factory.

Specified by:

setScriptFactory in interface ScriptManager

Parameters:

factory - the script factory

getScriptFactory

public ScriptFactory getScriptFactory()

Return the script factory.

Specified by:

getScriptFactory in interface ScriptManager

Returns:

the script factory

setScriptContext

public void setScriptContext(XULScriptContext context)

Set the script context.

Specified by:

setScriptContext in interface ScriptManager

Parameters:

context - the script context

getScriptContext

public XULScriptContext getScriptContext()

Return the script context.

Specified by:

getScriptContext in interface ScriptManager

Returns:

the script context

getScriptExceptionListener

public org.scripthelper.exceptions.ScriptExceptionListener getScriptExceptionListener()

Return the script exception listener.

Specified by:

getScriptExceptionListener in interface ScriptManager

Returns:

the script exception listener

setScriptExceptionListener

public void setScriptExceptionListener(org.scripthelper.exceptions.ScriptExceptionListener exceptionListener)

Set the script exception listener.

Specified by:

setScriptExceptionListener in interface ScriptManager

Parameters:

exceptionListener - the script exception listener

setScriptLogger

public void setScriptLogger(org.scripthelper.context.ScriptLogger scriptLogger)

Set the script logger.

Specified by:

setScriptLogger in interface ScriptManager

Parameters:

scriptLogger - the script logger

getScriptLogger

public org.scripthelper.context.ScriptLogger getScriptLogger()

Return the script logger.

Specified by:

getScriptLogger in interface ScriptManager

Returns:

the script logger

setParserErrorReporter

public void setParserErrorReporter(ParserErrorReporter errorReporter)

Set the XUL parser error reporter.

Specified by:

setParserErrorReporter in interface ScriptManager

Parameters:

errorReporter - the parser error reporter

getParserErrorReporter

public ParserErrorReporter getParserErrorReporter()

Return the XUL parser error reporter.

Specified by:

getParserErrorReporter in interface ScriptManager

Returns:

the parser error reporter

getScripts

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

Return the scripts.

Specified by:

getScripts in interface ScriptManager

Returns:

the scripts

getCallSites

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

Return the call sites.

Specified by:

getCallSites in interface ScriptManager

Returns:

the call sites

setScriptListener

public void setScriptListener(ScriptListener listener)

Set the script listener.

Specified by:

setScriptListener in interface ScriptManager

Parameters:

listener - the script listener

getScriptListener

public ScriptListener getScriptListener()

Return the script listener.

Specified by:

getScriptListener in interface ScriptManager

Returns:

the script listener

evalScript

public java.lang.Object evalScript(java.lang.String scriptMethod,
                                   java.lang.Object... args)

Evaluate a Script method.

Specified by:

evalScript in interface ScriptManager

Parameters:

scriptMethod - the Script method name

args - the arguments

Returns:

the Object returned by the Script, if there is any, or null

evalScript

public java.lang.Object evalScript(ScriptHandle script,
                                   java.lang.String scriptMethod,
                                   java.lang.Object arg)
                            throws java.lang.Exception

Evaluate a Script.

Specified by:

evalScript in interface XULScriptManagerContext

Parameters:

script - the Script with one argument.

scriptMethod - the Script method name

arg - the argument

Returns:

the Object returned by the Script, if there is any, or null

Throws:

java.lang.Exception - if the evaluation fails

evalScript

public java.lang.Object evalScript(ScriptHandle script,
                                   java.lang.String scriptMethod,
                                   java.lang.Object[] args)
                            throws java.lang.Exception

Evaluate a Script.

Specified by:

evalScript in interface XULScriptManagerContext

Parameters:

script - the Script with several arguments.

scriptMethod - the Script method name

args - the arguments

Returns:

the Object returned by the Script, if there is any, or null

Throws:

java.lang.Exception - if the evaluation fails

evalScript

public java.lang.Object evalScript(ScriptHandle script,
                                   java.lang.String scriptMethod)
                            throws java.lang.Exception

Evaluate a Script.

Specified by:

evalScript in interface XULScriptManagerContext

Parameters:

script - the Script without any argument.

scriptMethod - the Script method name

Returns:

the Object returned by the Script, if there is any, or null

Throws:

java.lang.Exception - if the evaluation fails

getCurrentWidget

public XULWidget getCurrentWidget()

Return the widget from which the last user event originates.

Specified by:

getCurrentWidget in interface ScriptManager

Returns:

the widget from which the last user event originates

getCurrentDocument

public XULDocument getCurrentDocument()

Return the document from which the last user event originates.

Specified by:

getCurrentDocument in interface ScriptManager

Returns:

the document from which the last user event originates

setCurrentWidget

public void setCurrentWidget(XULWidget widget)

Set the widget from which the last user event originates.

Specified by:

setCurrentWidget in interface ScriptManager

Parameters:

widget - the widget from which the last user event originates

addManagerListener

public void addManagerListener(ScriptManagerListener listener)

Add a listener to the Script manager. This listener will be fired in the case of change of states in the manager.

Specified by:

addManagerListener in interface ScriptManager

Parameters:

listener - the listener

getListeners

public java.util.List<ScriptManagerListener> getListeners()

Return the list of manager listeners.

Specified by:

getListeners in interface ScriptManager

Returns:

the list of manager listeners

setLookAndFeel

public void setLookAndFeel(javax.swing.LookAndFeel lf)

Set the Look and Feel of the viewer.

Parameters:

lf - the Look and Feel

setLookAndFeel

public void setLookAndFeel(java.lang.String name)

Set the Look and Feel of the viewer.

Parameters:

name - the Look and Feel name

getSelectedLookAndFeel

public javax.swing.LookAndFeel getSelectedLookAndFeel()

Return the Look and Feel of the viewer.

Returns:

the Look and Feel

getMenuBar

public javax.swing.JMenuBar getMenuBar()

Return the Menubar.

Specified by:

getMenuBar in interface ScriptManager

Returns:

the Menubar

getToolBars

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

Return the toolbars.

Specified by:

getToolBars in interface ScriptManager

Returns:

the toolbars

install

public java.awt.Container install(javax.swing.JFrame parent)

Install the manager content in a parent frame. It will set the frame menubar and tooolbars.

Parameters:

parent - the parent frame

Returns:

the parent container

install

public java.awt.Container install(javax.swing.JFrame parent,
                                  boolean scrollable)

Install the manager content in a parent frame. It will set the frame menubar and tooolbars.

Parameters:

parent - the parent frame

scrollable - true if the content must be scrollable

Returns:

the parent container

install

public java.awt.Container install(javax.swing.JFrame parent,
                                  boolean scrollable,
                                  boolean hasLoggerArea,
                                  int loggerRows)

Install the manager content in a parent frame. It will set the frame menubar and tooolbars.

Parameters:

parent - the parent frame

scrollable - true if the content must be scrollable

hasLoggerArea - true if the frame must have a logger area

loggerRows - the number of rows in the logger (will only be used if hasLoggerArea is true)

Returns:

the parent container

removeManagerListener

public void removeManagerListener(ScriptManagerListener listener)

Remove a listener from the Script manager.

Specified by:

removeManagerListener in interface ScriptManager

Parameters:

listener - the listener

removeXULScript

public void removeXULScript(java.lang.String name)

Remove a script.

Specified by:

removeXULScript in interface ScriptManager

Parameters:

name - the script name

hasXULScript

public boolean hasXULScript(java.lang.String scriptName)

Return true if it exist a XUL script of the defined name.

Specified by:

hasXULScript in interface ScriptManager

Parameters:

scriptName - the script name

Returns:

true if it exist a XUL script of the defined name

getXULScript

public XULDocument getXULScript(java.lang.String scriptName)

Return the XULScript of a specified name.

Specified by:

getXULScript in interface XULScriptManagerContext

Parameters:

scriptName - the script name

Returns:

the XULScript

addXULScript

public XULDocument addXULScript(java.io.File file)

Add a new XUL Script initialized with the content of a XUL XML File.

Specified by:

addXULScript in interface ScriptManager

Parameters:

file - the XUL File

Returns:

the XULDocument

addXULScript

public XULDocument addXULScript(java.net.URL xulscript)

Add a new XUL Script initialized with the content of a XUL XML File.

Specified by:

addXULScript in interface ScriptManager

Parameters:

xulscript - the XUL File

Returns:

the XULDocument

addXULScript

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

Add a new XUL Script initialized with the content of a XUL XML File.

Specified by:

addXULScript in interface ScriptManager

Parameters:

name - the script name

xulscript - the XUL File

Returns:

the XULDocument

addScript

public boolean addScript(java.lang.String mime,
                         java.net.URL url,
                         XULDocument xuldoc,
                         ScriptFactory factory)

Add a script on XUL documents.

Specified by:

addScript in interface ScriptManager

Parameters:

url - the script URL

xuldoc - the XUL document on which the script must be added

factory - the ScriptFactory (can be null)

mime - the MIME type

Returns:

true if the script could be added

getXULScripts

public java.util.Map<java.lang.String,XULDocument> getXULScripts()

Return the XUL Scripts managed by the manager.

Specified by:

getXULScripts in interface ScriptManager

Returns:

the XUL Scripts managed by the manager

isActive

public boolean isActive()

Return true if the manager is active.

Specified by:

isActive in interface ScriptManager

Returns:

true if the manager is active

setActive

public void setActive(boolean active)

Set the activation of the manager.

Specified by:

setActive in interface ScriptManager

Parameters:

active - true if the manager is activated