org.xul.script.xul

Interface ScriptManager

All Superinterfaces:

XULScriptManagerContext

All Known Implementing Classes:

AbstractScriptManager, DefaultScriptManager

public interface ScriptManager
extends XULScriptManagerContext

This class manage scripts.

Field Summary

Fields

Modifier and Type	Field and Description
static short	LOADING_GLOBAL The default type when scripts defined for a XUL script are global for all XUL files.
static short	LOADING_LOCAL The default type when scripts defined for a XUL script are local to this XUL file.

Method Summary

Modifier and Type	Method and Description
void	addManagerListener(ScriptManagerListener listener) Add a listener to the Script manager.
default boolean	addScript(java.lang.String mime, java.net.URL script) Add a script on all documents.
default boolean	addScript(java.lang.String mime, java.net.URL script, ScriptFactory fac) Add a script on all documents.
default boolean	addScript(java.lang.String mime, java.net.URL script, XULDocument xuldoc) Add a script only for a XULDocument.
boolean	addScript(java.lang.String mime, java.net.URL script, XULDocument xuldoc, ScriptFactory fac) Add a script only for a XULDocument.
default boolean	addScript(java.net.URL script) Add a script on all documents.
default boolean	addScript(java.net.URL script, XULDocument xuldoc) Add a script on all documents.
XULDocument	addXULScript(java.io.File file) Add a new XUL Script initialized with the content of a XUL XML File.
default XULDocument	addXULScript(java.lang.String name, java.io.File xulscript) 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.
default java.lang.Object	evalScript(java.lang.String scriptMethod) Evaluate a Script method without an argument.
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.
default XULWindow	getCurrentWindow() Return the window 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.
default boolean	getPropertyValueAsBoolean(java.lang.String key) Return a property value as a boolean.
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
java.util.List<javax.swing.JToolBar>	getToolBars() Return the toolbars.
java.util.Map<java.lang.String,XULDocument>	getXULScripts() Return the XUL Scripts managed by the manager.
default boolean	hasGlobalScript(java.net.URL url) Return true if the manager has the script for the specified URL as a global script.
boolean	hasXULScript(java.lang.String scriptName) Return true if it exist a XUL script of the defined name.
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	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 interface org.xul.script.xul.XULScriptManagerContext

evalScript, evalScript, evalScript, getXULScript

Field Detail

LOADING_LOCAL

static final short LOADING_LOCAL

The default type when scripts defined for a XUL script are local to this XUL file.

See Also:

Constant Field Values

LOADING_GLOBAL

static final short LOADING_GLOBAL

The default type when scripts defined for a XUL script are global for all XUL files.

See Also:

Constant Field Values

Method Detail

setScriptFactory

void setScriptFactory(ScriptFactory factory)

Set the script factory.

Parameters:

factory - the script factory

getScriptFactory

ScriptFactory getScriptFactory()

Return the script factory.

Returns:

the script factory

setClassLoader

void setClassLoader(java.lang.ClassLoader classLoader)

Set the classLoader to use to load the script classes

Parameters:

classLoader - the classLoader

setProperty

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

Parameters:

key - the property key

value - the property value

Returns:

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

getPropertyValue

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

Return a property value.

Parameters:

key - the property key

Returns:

the property value

getPropertyValueAsBoolean

default boolean getPropertyValueAsBoolean(java.lang.String key)

Return a property value as a boolean.

Parameters:

key - the property key

Returns:

the property value

validateXULSchema

void validateXULSchema(boolean isValidating)

Set if the XUL scripts schemas must be validated.

Parameters:

isValidating - true if the XUL scripts schemas must be validated

isValidatingXULSchemas

boolean isValidatingXULSchemas()

Return true if the XUL scripts schemas must be validated.

Returns:

true if the XUL scripts schemas must be validated

listAllScriptTypes

void listAllScriptTypes(boolean listAllScripts)

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

Parameters:

listAllScripts - true if all script methods are returned

isListingAllScriptTypes

boolean isListingAllScriptTypes()

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

Returns:

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

setScriptsLoadingType

void setScriptsLoadingType(short type)

Set the scripts loading type.

Parameters:

type - the scripts loading type

getScriptsLoadingType

short getScriptsLoadingType()

Return the scripts loading type

Returns:

the scripts loading type

hasGlobalScript

default boolean hasGlobalScript(java.net.URL url)

Return true if the manager has the script for the specified URL as a global script. It will invariably return false if getScriptsLoadingType() is LOADING_LOCAL.

Parameters:

url - the URL

Returns:

true if the manager has the script for the specified URL as a global script

getGlobalScripts

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

Return the Map of global scripts.

Returns:

the Map of global scripts

addManagerListener

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.

Parameters:

listener - the listener

getListeners

java.util.List<ScriptManagerListener> getListeners()

Return the list of manager listeners.

Returns:

the list of manager listeners

removeManagerListener

void removeManagerListener(ScriptManagerListener listener)

Remove a listener from the Script manager.

Parameters:

listener - the listener

setActive

void setActive(boolean active)

Set the activation of the manager.

Parameters:

active - true if the manager is activated

isActive

boolean isActive()

Return true if the manager is active.

Returns:

true if the manager is active

getMenuBar

javax.swing.JMenuBar getMenuBar()

Return the Menubar.

Returns:

the Menubar

getToolBars

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

Return the toolbars.

Returns:

the toolbars

addScript

default boolean addScript(java.net.URL script)

Add a script on all documents.

Parameters:

script - the script URL

Returns:

true if the script could be added

addScript

default boolean addScript(java.net.URL script,
                          XULDocument xuldoc)

Add a script on all documents.

Parameters:

script - the script URL

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

Returns:

true if the script could be added

addScript

default boolean addScript(java.lang.String mime,
                          java.net.URL script)

Add a script on all documents.

Parameters:

mime - the MIME type

script - the script URL

Returns:

true if the script could be added

addScript

default boolean addScript(java.lang.String mime,
                          java.net.URL script,
                          ScriptFactory fac)

Add a script on all documents.

Parameters:

mime - the MIME type

script - the script URL

fac - the ScriptFactory

Returns:

true if the script could be added

addScript

default boolean addScript(java.lang.String mime,
                          java.net.URL script,
                          XULDocument xuldoc)

Add a script only for a XULDocument.

Parameters:

mime - the MIME type

script - the script URL

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

Returns:

true if the script could be added

addScript

boolean addScript(java.lang.String mime,
                  java.net.URL script,
                  XULDocument xuldoc,
                  ScriptFactory fac)

Add a script only for a XULDocument.

Parameters:

mime - the MIME type

script - the script URL

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

fac - the script factory

Returns:

true if the script could be added

evalScript

default java.lang.Object evalScript(java.lang.String scriptMethod)

Evaluate a Script method without an argument.

Parameters:

scriptMethod - the Script method name

Returns:

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

evalScript

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

Evaluate a Script method.

Parameters:

scriptMethod - the Script method name

args - the arguments

Returns:

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

getScripts

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

Return the scripts.

Returns:

the scripts

getCurrentWidget

XULWidget getCurrentWidget()

Return the widget from which the last user event originates.

Returns:

the widget from which the last user event originates

getCurrentWindow

default XULWindow getCurrentWindow()

Return the window from which the last user event originates.

Returns:

the window from which the last user event originates

setCurrentWidget

void setCurrentWidget(XULWidget widget)

Set the widget from which the last user event originates.

Parameters:

widget - the widget from which the last user event originates

getCurrentDocument

XULDocument getCurrentDocument()

Return the document from which the last user event originates.

Returns:

the document from which the last user event originates

getCallSites

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

Return the call sites.

Returns:

the call sites

setScriptListener

void setScriptListener(ScriptListener listener)

Set the script listener.

Parameters:

listener - the script listener

getScriptListener

ScriptListener getScriptListener()

Return the script listener.

Returns:

the script listener

addXULScript

XULDocument addXULScript(java.io.File file)

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

Parameters:

file - the XUL File

Returns:

the XULDocument

addXULScript

XULDocument addXULScript(java.net.URL xulscript)

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

Parameters:

xulscript - the XUL File

Returns:

the XULDocument

addXULScript

default XULDocument addXULScript(java.lang.String name,
                                 java.io.File xulscript)

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

Parameters:

name - the script name

xulscript - the XUL File

Returns:

the XULDocument

addXULScript

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

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

Parameters:

name - the script name

xulscript - the XUL File

Returns:

the XULDocument

getXULScripts

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

Return the XUL Scripts managed by the manager.

Returns:

the XUL Scripts managed by the manager

hasXULScript

boolean hasXULScript(java.lang.String scriptName)

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

Parameters:

scriptName - the script name

Returns:

true if it exist a XUL script of the defined name

removeXULScript

void removeXULScript(java.lang.String name)

Remove a script.

Parameters:

name - the script name

setScriptContext

void setScriptContext(XULScriptContext context)

Set the script context.

Parameters:

context - the script context

getScriptContext

XULScriptContext getScriptContext()

Return the script context.

Returns:

the script context

setScriptExceptionListener

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

Set the script exception listener.

Parameters:

exceptionListener - the script exception listener

getScriptExceptionListener

org.scripthelper.exceptions.ScriptExceptionListener getScriptExceptionListener()

Return the script exception listener.

Returns:

the script exception listener

setScriptLogger

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

Set the script logger.

Parameters:

scriptLogger - the script logger

getScriptLogger

org.scripthelper.context.ScriptLogger getScriptLogger()

Return the script logger.

Returns:

the script logger

setParserErrorReporter

void setParserErrorReporter(ParserErrorReporter errorReporter)

Set the XUL parser error reporter.

Parameters:

errorReporter - the parser error reporter

getParserErrorReporter

ParserErrorReporter getParserErrorReporter()

Return the XUL parser error reporter.

Returns:

the parser error reporter