org.xul.script.scripts

Class AbstractXULScriptHelper

java.lang.Object

org.xul.script.scripts.AbstractXULScriptHelper

All Implemented Interfaces:

org.scripthelper.context.ScriptHelper, XULScriptHelper

Direct Known Subclasses:

DefaultXULScriptHelper

public abstract class AbstractXULScriptHelper
extends java.lang.Object
implements XULScriptHelper

An abstract XUL script helper.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ScriptManager	manager The ScriptManager.

Constructor Summary

Constructors

Constructor and Description
AbstractXULScriptHelper()

Method Summary

Modifier and Type	Method and Description
FilePicker	createFilePicker() Return a new FilePicker.
boolean	dispose() Call dispose() on the current document parent frame or winsow.
java.lang.Object	evalScript(java.lang.String scriptMethod, java.lang.Object... args) Evaluate a Script method.
boolean	exit() Call System.exit().
ScriptManager	getScriptManager() Return the ScriptManager.
java.lang.String	getText(java.io.File file) Return the text associated with a text File.
void	setScriptManager(ScriptManager manager) Set the ScriptManager.
boolean	setText(java.io.File file, java.lang.String text) Set the text associated with a text File.

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.scripts.XULScriptHelper

evalScript, getContext, getCurrentDocument, getCurrentWidget, getCurrentWindow

Field Detail

manager

protected ScriptManager manager

The ScriptManager.

Constructor Detail

AbstractXULScriptHelper

public AbstractXULScriptHelper()

Method Detail

setScriptManager

public void setScriptManager(ScriptManager manager)

Set the ScriptManager.

Specified by:

setScriptManager in interface XULScriptHelper

Parameters:

manager - the ScriptManager

getScriptManager

public ScriptManager getScriptManager()

Return the ScriptManager.

Returns:

the ScriptManager

evalScript

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

Evaluate a Script method.

Specified by:

evalScript in interface XULScriptHelper

Parameters:

scriptMethod - the Script method name

args - the arguments

Returns:

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

createFilePicker

public FilePicker createFilePicker()

Return a new FilePicker.

Returns:

the FilePicker

exit

public boolean exit()

Call System.exit(). It is allowed if the ScriptManagerProperties.ALLOW_EXIT is set to true (default is false so not allowed).

Specified by:

exit in interface XULScriptHelper

Returns:

false if the call is not allowed

dispose

public boolean dispose()

Call dispose() on the current document parent frame or winsow. It is allowed if the ScriptManagerProperties.ALLOW_DISPOSE is set to true (default is false so not allowed).

Specified by:

dispose in interface XULScriptHelper

Returns:

false if the call is not allowed

getText

public java.lang.String getText(java.io.File file)

Return the text associated with a text File. Return null if there is an exception when trying to get the content of the File.

Specified by:

getText in interface XULScriptHelper

Parameters:

file - the file

Returns:

the text

setText

public boolean setText(java.io.File file,
                       java.lang.String text)

Set the text associated with a text File.

Specified by:

setText in interface XULScriptHelper

Parameters:

file - the file

text - the text

Returns:

true if the operation succeeded