org.xul.script.scripts

Interface ScriptFactory

All Known Implementing Classes:

AbstractScriptFactory, DefaultScriptFactory

public interface ScriptFactory

A factory for scripts. Note that the architecture of the framework allows to maintain more than one language factory for scripts, which means that you are not obliged to support only one script interface for all your scripts. For example, you can use one script interface for one MIME type, and another for other MIME types.

Method Summary

Modifier and Type	Method and Description
ScriptHandle	addScript(short scriptType, XULDocument document, org.scripthelper.model.ScriptSource source) Add a script.
ScriptHandle	addScript(XULDocument document, org.scripthelper.model.ScriptSource source) Add a script.
void	addScriptToDocuments(ScriptHandle script) Add a script to all XUL documents.
void	addScriptToXUL(java.net.URL url, XULDocument doc) Add a script to a XUL document.
boolean	containsScript(org.scripthelper.model.ScriptSource source) Return true if the factory contains a ScriptSource.
default ScriptLanguageFactory<?>	createScriptLanguageFactory(short scriptType, XULDocument document, org.scripthelper.model.ScriptSource source) Create the script language factory for a source and a MIME type.
ScriptLanguageFactory<?>	createScriptLanguageFactoryImpl(short scriptType, int countScripts, org.scripthelper.model.ScriptSource source) Create the script language factory for a source and a MIME type.
java.lang.ClassLoader	getClassLoader() Return the classLoader to use to load the script classes
java.util.Set<java.lang.Class<?>>	getInterfaces() Return the Set of interfaces which are handled by this factory.
ScriptHandle	getScript(org.scripthelper.model.ScriptSource source) Return the script associated with a source.
XULScriptContext	getScriptContext() Return the script context.
org.scripthelper.exceptions.ScriptExceptionListener	getScriptExceptionListener() Return the script exception listener.
org.scripthelper.context.ScriptLogger	getScriptLogger() Return the script logger.
java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle>	getScripts() Return the scripts.
boolean	hasScript(java.lang.String name) Return true if the factory has a script of a specified name.
ScriptHandle	removeScript(org.scripthelper.model.ScriptSource source) Removed a script.
void	setClassLoader(java.lang.ClassLoader classLoader) Set the classLoader to use to load the script classes.
void	setScriptContext(XULScriptContext context) Set the global script context used by all scripts.
void	setScriptExceptionListener(org.scripthelper.exceptions.ScriptExceptionListener exceptionListener) Set the script exception listener.
void	setScriptLogger(org.scripthelper.context.ScriptLogger scriptLogger) Set the script logger.

Method Detail

setClassLoader

void setClassLoader(java.lang.ClassLoader classLoader)

Set the classLoader to use to load the script classes.

Parameters:

classLoader - the classLoader

getClassLoader

java.lang.ClassLoader getClassLoader()

Return the classLoader to use to load the script classes

Returns:

classLoader the classLoader

createScriptLanguageFactory

default ScriptLanguageFactory<?> createScriptLanguageFactory(short scriptType,
                                                             XULDocument document,
                                                             org.scripthelper.model.ScriptSource source)

Create the script language factory for a source and a MIME type. The factory will not be cteated if it does not exist for this MIME and source. Additionnally, this method can return null if no factory is provided for the MIME and source.

Parameters:

scriptType - the script type

document - the XULDocument

source - the script source

Returns:

the script language factory

createScriptLanguageFactoryImpl

ScriptLanguageFactory<?> createScriptLanguageFactoryImpl(short scriptType,
                                                         int countScripts,
                                                         org.scripthelper.model.ScriptSource source)

Create the script language factory for a source and a MIME type. The factory will not be cteated if it does not exist for this MIME and source. Additionnally, this method can return null if no factory is provided for the MIME and source.

Parameters:

scriptType - the script type

countScripts - the total number of scripts in the document

source - the script source

Returns:

the script language factory

getInterfaces

java.util.Set<java.lang.Class<?>> getInterfaces()

Return the Set of interfaces which are handled by this factory.

Returns:

the Set of interfaces

setScriptContext

void setScriptContext(XULScriptContext context)

Set the global script context used by all scripts.

Parameters:

context - the global 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

getScripts

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

Return the scripts.

Returns:

the scripts

addScriptToXUL

void addScriptToXUL(java.net.URL url,
                    XULDocument doc)

Add a script to a XUL document.

Parameters:

url - the script

doc - the XUL document

getScript

ScriptHandle getScript(org.scripthelper.model.ScriptSource source)

Return the script associated with a source.

Parameters:

source - the ScriptSource

Returns:

the script

containsScript

boolean containsScript(org.scripthelper.model.ScriptSource source)

Return true if the factory contains a ScriptSource.

Parameters:

source - the ScriptSource

Returns:

true if the factory contains the ScriptSource

removeScript

ScriptHandle removeScript(org.scripthelper.model.ScriptSource source)

Removed a script.

Parameters:

source - the ScriptSource

Returns:

the ScriptHandle which corresponded to the source

addScriptToDocuments

void addScriptToDocuments(ScriptHandle script)

Add a script to all XUL documents.

Parameters:

script - the script handle

addScript

ScriptHandle addScript(XULDocument document,
                       org.scripthelper.model.ScriptSource source)

Add a script. The factory will try to infer the MIME from the source file name.

Parameters:

document - the XULDocument

source - the script source

Returns:

the script handle

addScript

ScriptHandle addScript(short scriptType,
                       XULDocument document,
                       org.scripthelper.model.ScriptSource source)

Add a script.

Parameters:

scriptType - the script type

document - the XULDocument

source - the script source

Returns:

the script handle

hasScript

boolean hasScript(java.lang.String name)

Return true if the factory has a script of a specified name.

Parameters:

name - the script name

Returns:

true if the factory has a script of the specified name