org.xul.script.scripts

Interface XULScriptContext

All Superinterfaces:

org.scripthelper.context.ScriptContext

All Known Implementing Classes:

AbstractXULScriptContext, DefaultXULScriptContext

public interface XULScriptContext
extends org.scripthelper.context.ScriptContext

A XUL ScriptContext interface.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default void	echo(java.lang.String message) Echo a message.
default void	echo(java.lang.String message, java.lang.String htmlColor) Echo a message with a specified color.
default void	error(java.lang.String message) Error a message.
XULScriptHelper	getHelper() Return the script helper.
ScriptManager	getScriptManager() Return the ScriptManager.
default void	jsConstructor() This Method jsConstructor is mandatory to be able to construct the Object as a javascript object.
void	setScriptManager(ScriptManager manager) Set the ScriptManager.

Methods inherited from interface org.scripthelper.context.ScriptContext

__step__, abort, clearTab, echo, echo, getPath, getScriptFile, getScriptLogger, getScriptSource, getScriptWrapper, setLogger, setProgress, setScriptSource, setScriptWrapper, setTab

Method Detail

jsConstructor

default void jsConstructor()

This Method jsConstructor is mandatory to be able to construct the Object as a javascript object. However, it does nothing, and you don't have to override it.

setScriptManager

void setScriptManager(ScriptManager manager)

Set the ScriptManager.

Parameters:

manager - the ScriptManager

getScriptManager

ScriptManager getScriptManager()

Return the ScriptManager.

Returns:

the ScriptManager

getHelper

XULScriptHelper getHelper()

Return the script helper.

Specified by:

getHelper in interface org.scripthelper.context.ScriptContext

Returns:

the script helper

echo

default void echo(java.lang.String message)

Echo a message.

Specified by:

echo in interface org.scripthelper.context.ScriptContext

Parameters:

message - the message text

echo

default void echo(java.lang.String message,
                  java.lang.String htmlColor)

Echo a message with a specified color.

Specified by:

echo in interface org.scripthelper.context.ScriptContext

Parameters:

message - the message text

htmlColor - the message color

error

default void error(java.lang.String message)

Error a message.

Specified by:

error in interface org.scripthelper.context.ScriptContext

Parameters:

message - the message text