Package org.omegat.gui.scripting

Class ScriptRunner

java.lang.Object

org.omegat.gui.scripting.ScriptRunner

public final class ScriptRunner
extends Object

Scripting window entry point.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SCRIPT
static final String	SCRIPT_GUI_FUNCTION_NAME	Scripts that want to run on the Event Dispatch Thread should define a top-level function with this name and NOT evaluate it.
static final String	VAR_CONSOLE
static final String	VAR_CORE
static final String	VAR_EDITOR
static final String	VAR_GLOSSARY
static final String	VAR_MAINWINDOW
static final String	VAR_PROJECT
static final String	VAR_RESOURCES

Method Summary

Modifier and Type	Method	Description
static Object	executeScript(String script, ScriptEngine engine, Map<String,Object> additionalBindings)	Execute a script with a given engine and bindings.
static String	executeScript(String script, ScriptItem item, Map<String,Object> additionalBindings)	Execute a script either in string form or, if script is null, as read from the file associated with the supplied ScriptItem.
static String	executeScript(ScriptItem item, Map<String,Object> additionalBindings)	Execute as read from the file associated with the supplied ScriptItem.
static List<String>	getAvailableScriptExtensions()
static List<ScriptEngineFactory>	getEngineFactories()
static ScriptEngineManager	getManager()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SCRIPT_GUI_FUNCTION_NAME

public static final String SCRIPT_GUI_FUNCTION_NAME

Scripts that want to run on the Event Dispatch Thread should define a top-level function with this name and NOT evaluate it.

See Also:

• Constant Field Values

DEFAULT_SCRIPT

public static final String DEFAULT_SCRIPT

See Also:

• Constant Field Values

VAR_CONSOLE

public static final String VAR_CONSOLE

See Also:

• Constant Field Values

VAR_MAINWINDOW

public static final String VAR_MAINWINDOW

See Also:

• Constant Field Values

VAR_GLOSSARY

public static final String VAR_GLOSSARY

See Also:

• Constant Field Values

VAR_CORE

public static final String VAR_CORE

See Also:

• Constant Field Values

VAR_EDITOR

public static final String VAR_EDITOR

See Also:

• Constant Field Values

VAR_PROJECT

public static final String VAR_PROJECT

See Also:

• Constant Field Values

VAR_RESOURCES

public static final String VAR_RESOURCES

See Also:

• Constant Field Values

Method Details

executeScript

public static String executeScript(ScriptItem item,
 Map<String,Object> additionalBindings)
                            throws IOException,
ScriptException

Execute as read from the file associated with the supplied ScriptItem. This is a convenience method for AbstractScriptRunner.executeScript(String, ScriptItem, Map).

Parameters:

item - The associated ScriptItem. Must not be null. If script is null, the script content will be read from the associated file. The script engine will be resolved from the filename. The resource bundle associated with the item will be included in the bindings as VAR_RESOURCES.

additionalBindings - A map of bindings that will be included along with other bindings

Returns:

result string.

Throws:

IOException - when I/O error occurred.

ScriptException - when script engine raises error.

executeScript

public static String executeScript(String script,
 ScriptItem item,
 Map<String,Object> additionalBindings)
                            throws IOException,
ScriptException

Execute a script either in string form or, if script is null, as read from the file associated with the supplied ScriptItem. The engine is resolved via the filename extension associated with item (defaults to DEFAULT_SCRIPT).

This is a convenience method for executeScript(String, ScriptEngine, Map).

Parameters:

script - The script in string form. Can be null.

item - The associated ScriptItem. Must not be null. If script is null, the script content will be read from the associated file. The script engine will be resolved from the filename. The resource bundle associated with the item will be included in the bindings as VAR_RESOURCES.

additionalBindings - A map of bindings that will be included along with other bindings

Returns:

result string.

Throws:

IOException - when I/O error occurred.

ScriptException - when script engine raises error.

getManager

public static ScriptEngineManager getManager()

getEngineFactories

public static List<ScriptEngineFactory> getEngineFactories()

executeScript

public static Object executeScript(String script,
 ScriptEngine engine,
 Map<String,Object> additionalBindings)
                            throws ScriptException

Execute a script with a given engine and bindings.

Parameters:

script - The script in string form

engine - The engine

additionalBindings - A map of bindings that will be included along with other bindings

Returns:

The evaluation result

Throws:

ScriptException - when script engine raises error.

getAvailableScriptExtensions

public static List<String> getAvailableScriptExtensions()