Package org.omegat.gui.scripting

Class ScriptingWindow

java.lang.Object

org.omegat.gui.scripting.ScriptingWindow

public class ScriptingWindow
extends Object

Scripting window

Constructor Summary

Constructors

Constructor	Description
ScriptingWindow()
ScriptingWindow(JFrame frame)

Method Summary

Modifier and Type	Method	Description
void	addContent(Component content)
void	cancelCurrentScript()	Cancel the currently running script, if any.
void	cancelScriptQueue()
org.omegat.gui.scripting.ScriptingWindow.ScriptWorker	createScriptWorker(String scriptString, ScriptItem scriptItem, Map<String,Object> additionalBindings)
void	dispose()
void	executeScript(ScriptItem scriptItem)
void	executeScript(ScriptItem scriptItem, Map<String,Object> bindings)
void	executeScript(ScriptItem scriptItem, Map<String,Object> bindings, boolean cancelQueue)
void	executeScripts(List<ScriptItem> scriptItems)
void	executeScripts(List<ScriptItem> scriptItems, Map<String,Object> bindings)
void	executeScripts(List<ScriptItem> scriptItems, Map<String,Object> bindings, boolean cancelQueue)	Execute scripts sequentially to make sure they don't interrupt each other.
Frame	getParent()
File	getScriptsFolder()
String	getSelectedText()

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptingWindow

public ScriptingWindow()

ScriptingWindow

public ScriptingWindow(JFrame frame)

Method Details

getParent

public Frame getParent()

addContent

public void addContent(Component content)

dispose

public void dispose()

getScriptsFolder

@VisibleForTesting
public File getScriptsFolder()

executeScript

public void executeScript(ScriptItem scriptItem)

executeScript

public void executeScript(ScriptItem scriptItem,
 Map<String,Object> bindings)

executeScript

public void executeScript(ScriptItem scriptItem,
 Map<String,Object> bindings,
 boolean cancelQueue)

executeScripts

public void executeScripts(List<ScriptItem> scriptItems,
 Map<String,Object> bindings,
 boolean cancelQueue)

Execute scripts sequentially to make sure they don't interrupt each other.

Parameters:

scriptItems - List of script to execute.

bindings - Additional bindings to pass to the executed script.

cancelQueue - If true, the run queue is cleared before running the scripts.

executeScripts

public void executeScripts(List<ScriptItem> scriptItems)

executeScripts

public void executeScripts(List<ScriptItem> scriptItems,
 Map<String,Object> bindings)

createScriptWorker

public org.omegat.gui.scripting.ScriptingWindow.ScriptWorker createScriptWorker(String scriptString,
 ScriptItem scriptItem,
 Map<String,Object> additionalBindings)

cancelCurrentScript

public void cancelCurrentScript()

Cancel the currently running script, if any.

Note! Canceling the worker does not do anything in and of itself. The running script must poll for interruption with e.g. Thread.interrupted().

See Also:

• StackOverflow answer about interrupting scripts

cancelScriptQueue

public void cancelScriptQueue()

getSelectedText

public String getSelectedText()