public class BeanShell
extends java.lang.Object
When run from jEdit, BeanShell code has access to the following predefined variables:
view
- the currently active View
.editPane
- the currently active EditPane
.textArea
- the edit pane's JEditTextArea
.buffer
- the edit pane's Buffer
.wm
- the view's DockableWindowManager
.scriptPath
- the path name of the currently executing
BeanShell script.Constructor and Description |
---|
BeanShell() |
Modifier and Type | Method and Description |
---|---|
static java.lang.Object |
_eval(View view,
NameSpace namespace,
java.lang.String command)
Evaluates the specified BeanShell expression.
|
static void |
_runScript(View view,
java.lang.String path,
java.io.Reader in,
boolean ownNamespace)
Runs a BeanShell script.
|
static void |
_runScript(View view,
java.lang.String path,
java.io.Reader in,
NameSpace namespace)
Runs a BeanShell script.
|
static BshMethod |
cacheBlock(java.lang.String id,
java.lang.String code,
boolean namespace)
Caches a block of code, returning a handle that can be passed to
runCachedBlock().
|
static java.lang.Object |
eval(View view,
NameSpace namespace,
java.lang.String command)
Evaluates the specified BeanShell expression.
|
static void |
evalSelection(View view,
JEditTextArea textArea)
Evaluates the text selected in the specified text area.
|
static NameSpace |
getNameSpace() |
static boolean |
isScriptRunning() |
static java.lang.Object |
runCachedBlock(BshMethod method,
View view,
NameSpace namespace)
Runs a cached block of code in the specified namespace.
|
static void |
runScript(View view,
java.lang.String path,
java.io.Reader in,
boolean ownNamespace)
Runs a BeanShell script.
|
static void |
runScript(View view,
java.lang.String path,
java.io.Reader in,
NameSpace namespace)
Runs a BeanShell script.
|
static void |
showEvaluateDialog(View view)
Prompts for a BeanShell expression to evaluate.
|
static void |
showEvaluateLinesDialog(View view)
Evaluates the specified script for each selected line.
|
public static void evalSelection(View view, JEditTextArea textArea)
view
- The viewtextArea
- The text areapublic static void showEvaluateDialog(View view)
view
- the Viewpublic static void showEvaluateLinesDialog(View view)
view
- The viewpublic static void runScript(View view, java.lang.String path, java.io.Reader in, boolean ownNamespace)
If the in
parameter is non-null, the script is
read from that stream; otherwise it is read from the file identified
by path
.
The scriptPath
BeanShell variable is set to the path
name of the script.
view
- The view. Within the script, references to
buffer
, textArea
and editPane
are determined with reference to this parameter.path
- The script file's VFS path.in
- The reader to read the script from, or null
.ownNamespace
- If set to false
, methods and
variables defined in the script will be available to all future
uses of BeanShell; if set to true
, they will be lost as
soon as the script finishes executing. jEdit uses a value of
false
when running startup scripts, and a value of
true
when running all other macros.public static void runScript(View view, java.lang.String path, java.io.Reader in, NameSpace namespace)
If the in
parameter is non-null, the script is
read from that stream; otherwise it is read from the file identified
by path
.
The scriptPath
BeanShell variable is set to the path
name of the script.
view
- The view. Within the script, references to
buffer
, textArea
and editPane
are determined with reference to this parameter.path
- The script file's VFS path.in
- The reader to read the script from, or null
.namespace
- The namespace to run the script in.public static void _runScript(View view, java.lang.String path, java.io.Reader in, boolean ownNamespace) throws java.lang.Exception
If the in
parameter is non-null, the script is
read from that stream; otherwise it is read from the file identified
by path
.
The scriptPath
BeanShell variable is set to the path
name of the script.
view
- The view. Within the script, references to
buffer
, textArea
and editPane
are determined with reference to this parameter.path
- The script file's VFS path.in
- The reader to read the script from, or null
.ownNamespace
- If set to false
, methods and
variables defined in the script will be available to all future
uses of BeanShell; if set to true
, they will be lost as
soon as the script finishes executing. jEdit uses a value of
false
when running startup scripts, and a value of
true
when running all other macros.java.lang.Exception
- instances are thrown when various BeanShell errors
occurpublic static void _runScript(View view, java.lang.String path, java.io.Reader in, NameSpace namespace) throws java.lang.Exception
If the in
parameter is non-null, the script is
read from that stream; otherwise it is read from the file identified
by path
.
The scriptPath
BeanShell variable is set to the path
name of the script.
view
- The view. Within the script, references to
buffer
, textArea
and editPane
are determined with reference to this parameter.path
- The script file's VFS path.in
- The reader to read the script from, or null
.namespace
- The namespace to run the script in.java.lang.Exception
- instances are thrown when various BeanShell errors
occurpublic static java.lang.Object eval(View view, NameSpace namespace, java.lang.String command)
view
- The view. Within the script, references to
buffer
, textArea
and editPane
are determined with reference to this parameter.namespace
- The namespacecommand
- The expressionpublic static java.lang.Object _eval(View view, NameSpace namespace, java.lang.String command) throws java.lang.Exception
eval()
, this method passes any exceptions to the caller.view
- The view. Within the script, references to
buffer
, textArea
and editPane
are determined with reference to this parameter.namespace
- The namespacecommand
- The expressionjava.lang.Exception
- instances are thrown when various BeanShell
errors occurpublic static BshMethod cacheBlock(java.lang.String id, java.lang.String code, boolean namespace) throws java.lang.Exception
id
- An identifier. If null, a unique identifier is generatedcode
- The codenamespace
- If true, the namespace will be setjava.lang.Exception
- instances are thrown when various BeanShell errors
occurpublic static java.lang.Object runCachedBlock(BshMethod method, View view, NameSpace namespace) throws java.lang.Exception
method
- The method instance returned by cacheBlock()view
- The viewnamespace
- The namespace to run the code injava.lang.Exception
- instances are thrown when various BeanShell
errors occurpublic static boolean isScriptRunning()
public static NameSpace getNameSpace()