org.micromanager

Interface ScriptController

public interface ScriptController

Provides access to some utility methods for use in the Beanshell scripting panel. Accessible via "mm.scripter()" or "mm.getScriptController()".

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScriptController.ScriptStoppedException This exception signifies that the Beanshell interpreter has a stop request pending, which prevents most interactions with the system.

Method Summary

Modifier and Type	Method and Description
void	clearMessageWindow() Clears scripting console output window.
void	message(java.lang.String text) Displays text in the scripting console output window.
void	resetInterpreter() Clears all methods and variables defined in the script interpreter.
void	runFile(java.io.File file) Execute the script located in the given file.

Method Detail

runFile

void runFile(java.io.File file)

Execute the script located in the given file.

Parameters:

file - File containing the script to be run.

message

void message(java.lang.String text)
      throws ScriptController.ScriptStoppedException

Displays text in the scripting console output window.

Parameters:

text - Text to be displayed in the scripting console output window.

Throws:

ScriptController.ScriptStoppedException - if the script panel has been requested to stop execution.

clearMessageWindow

void clearMessageWindow()
                 throws ScriptController.ScriptStoppedException

Clears scripting console output window.

Throws:

ScriptController.ScriptStoppedException - if the script panel has been requested to stop execution.

resetInterpreter

void resetInterpreter()
               throws ScriptController.ScriptStoppedException

Clears all methods and variables defined in the script interpreter.

Throws:

ScriptController.ScriptStoppedException - if the script panel has been requested to stop execution.