org.xul.script.scripts

Interface XULScriptHelper

All Superinterfaces:

org.scripthelper.context.ScriptHelper

All Known Implementing Classes:

AbstractXULScriptHelper, DefaultXULScriptHelper

public interface XULScriptHelper
extends org.scripthelper.context.ScriptHelper

A XUL ScriptContext interface.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default boolean	dispose() Call dispose() on the current document parent frame or winsow.
default java.lang.Object	evalScript(java.lang.String scriptMethod) Evaluate a Script method without any argument.
java.lang.Object	evalScript(java.lang.String scriptMethod, java.lang.Object... args) Evaluate a Script method.
default boolean	exit() Call System.exit().
XULScriptContext	getContext() Return the script context.
default XULDocument	getCurrentDocument() Return the document from which the last user event originates.
default XULWidget	getCurrentWidget() Return the widget from which the last user event originates.
default XULWindow	getCurrentWindow() Return the widget from which the last user event originates.
default java.lang.String	getText(java.io.File file) Return the text associated with a text File.
void	setScriptManager(ScriptManager manager) Set the ScriptManager.
default boolean	setText(java.io.File file, java.lang.String text) Set the text associated with a text File.

Method Detail

setScriptManager

void setScriptManager(ScriptManager manager)

Set the ScriptManager.

Parameters:

manager - the ScriptManager

getContext

XULScriptContext getContext()

Return the script context.

Specified by:

getContext in interface org.scripthelper.context.ScriptHelper

Returns:

the script context

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

exit

default boolean exit()

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

Returns:

false if the call is not allowed

dispose

default 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). Do nothing and return false by default.

Returns:

false if the call is not allowed

getText

default 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. Return null by default.

Parameters:

file - the file

Returns:

the text

setText

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

Set the text associated with a text File. Do nothing and return false by default.

Parameters:

file - the file

text - the text

Returns:

true if the operation succeeded

evalScript

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

Evaluate a Script method without any argument.

Parameters:

scriptMethod - the Script method name

Returns:

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

getCurrentWidget

default 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 widget from which the last user event originates.

Returns:

the widget from which the last user event originates

getCurrentDocument

default XULDocument getCurrentDocument()

Return the document from which the last user event originates.

Returns:

the document from which the last user event originates