A B C D E F G H I L M N P R S T W X

A

actionPerformed(ActionEvent) - Method in class simkin.examples.applet.MsgBox
 
actionPerformed(ActionEvent) - Method in class simkin.examples.applet.SimkinXMLApplet
This method is called when the Run button is pressed
actionPerformed(ActionEvent) - Method in class simkin.examples.applet.ScriptedDialog
this method catches button clicks and calls methods
actionPerformed(ActionEvent) - Method in class simkin.examples.dialog.ScriptedDialog
this method catches button clicks and calls methods
actionPerformed(ActionEvent) - Method in class simkin.examples.dialog.MsgBox
 
addChild(TreeNode) - Method in class simkin.TreeNode
Adds a node to the list of this node's children
addElement(String) - Method in class simkin.XMLElementObject
adds a new element with the given tag name to this element
addGlobalVariable(String, Object) - Method in class simkin.Interpreter
Adds a global variable to the current list
addStrings(String, String) - Static method in class simkin.Interpreter
Adds two strings together efficiently
addStrings(String, String, String) - Static method in class simkin.Interpreter
Adds three strings together efficiently
Age - Variable in class simkin.examples.person.Person
This is a public field - giving the person's age
ArrayExample - class simkin.examples.array.ArrayExample.
This class shows how an array can be accessed by a Simkin script, where the array is stored in an XML file, or as a Java array
ArrayExample(InputStream) - Constructor for class simkin.examples.array.ArrayExample
constructor just passes the XML input stream to its parent

B

boolData() - Method in class simkin.TreeNode
Returns this node's data as a boolean
boolValue(Object) - Static method in class simkin.Interpreter
This method converts the given value into a boolean value

C

clone() - Method in class simkin.TreeNode
this method returns a cloned version of this node - it performs a deep copy
close() - Method in class simkin.examples.applet.ScriptedDialog
This method closes the dialog - because it is public it can be called from Simkin scripts
close() - Method in class simkin.examples.dialog.ScriptedDialog
This method closes the dialog - because it is public it can be called from Simkin scripts
containsElement(String) - Method in class simkin.XMLElementObject
returns true if this element contains an element with the given tag name
copyAttributesInto(Element) - Method in class simkin.XMLElementObject
This method clears the other elements attributes and copies from ours into it
copyItems(TreeNode) - Method in class simkin.TreeNode
this function performs a deep copy from the children of another node into this one
copyItemsInto(Element) - Method in class simkin.XMLElementObject
Clears the other element and does a deep copy of the children of this node into that one

D

data() - Method in class simkin.TreeNode
Returns this node's data
data(String) - Method in class simkin.TreeNode
sets this node's data
dump() - Method in class simkin.XMLElementObject
This method writes the entire XML element out to the tracer
dump() - Method in class simkin.TreeNodeObject
This method writes the entire node tree to stdout

E

enumerate() - Method in class simkin.XMLElementObject
This method returns an object which can iterate over all the immediate child elements of this element
enumerate() - Method in class simkin.TreeNodeObject
This method returns an object which can iterate over all the immediate child node of this node
enumerate(String) - Method in class simkin.XMLElementObject
This method returns an object which can iterate over all the immediate child elements of this element whose tagname matches the one given
enumerate(String) - Method in class simkin.TreeNodeObject
This method returns an object which can iterate over all the immediate child nodes of this node whose label matches the one given
equals(Object) - Method in class simkin.XMLElementObject
tests for equality with another object, using the string value
equals(Object) - Method in class simkin.TreeNodeObject
 
Executable - interface simkin.Executable.
This interface is implemented by objects which want to override the method and field access which uses Java introspection by default.
ExecutableRoot - class simkin.ExecutableRoot.
This class provides an implementation of the Executable interface which can be conveniently extended
ExecutableRoot() - Constructor for class simkin.ExecutableRoot
 
executeCode(String) - Method in class simkin.examples.applet.SimkinXMLApplet
 
executeParseTree(String, Object, ParseNode, Object[]) - Method in class simkin.Interpreter
This method executes a piece of Simkin code from a parse tree.
ExecuteResult - class simkin.ExecuteResult.
This class is used by the Interpreter to return the result of an execute() method.
executeString(String, Object, String, Object[]) - Method in class simkin.Interpreter
This method executes a piece of Simkin code within a string
executeStringExternalParams(String, Object, Vector, String, Object[]) - Method in class simkin.Interpreter
This method executes a piece of Simkin code within a string, it assumes that the parameters have been defined outside the statement block.

F

FileName - Variable in class simkin.examples.dialog.ScriptedDialog
the name of the XML file
findChild(Element, int) - Static method in class simkin.XMLElementObject
returns the nth child element
findChild(Element, String) - Static method in class simkin.XMLElementObject
returns a child element
findChild(Element, String, String, String) - Static method in class simkin.XMLElementObject
returns a child element with the given attribute set to the given value
findChild(String) - Method in class simkin.TreeNode
finds the first child with the given label - returns null if none found
findChild(String, String) - Method in class simkin.TreeNode
finds the first child with the given label and data - returns null if none found
findChildBoolData(String) - Method in class simkin.TreeNode
returns the data of the first child with the given label as a boolean
findChildBoolData(String, boolean) - Method in class simkin.TreeNode
returns the data of the first child with the given label as a boolean
findChildData(String) - Method in class simkin.TreeNode
returns the data of the first child with the given label
findChildData(String, String) - Method in class simkin.TreeNode
returns the data of the first child with the given label
findChildIntData(String) - Method in class simkin.TreeNode
returns the data of the first child with the given label as an integer
findChildIntData(String, int) - Method in class simkin.TreeNode
returns the data of the first child with the given label as a boolean
findGlobalVariable(String) - Method in class simkin.Interpreter
looks for the given global variable.
floatValue(Object) - Static method in class simkin.Interpreter
This method converts the given value into a double value

G

g_FileMagic - Static variable in class simkin.TreeNode
 
g_FileVersion - Static variable in class simkin.TreeNode
 
g_Tracing - Static variable in class simkin.Tracer
This variable controls whether the output is printed to stdout or not - by default the value is true
getAttribute(String) - Method in class simkin.XMLElementObject
This method returns the value of an attribute attached to this element.
getData(Element) - Static method in class simkin.XMLElementObject
retrieves the text data from an element
getElement() - Method in class simkin.XMLElementObject
This method returns the XML Element being held by the object.
getInterpreter() - Static method in class simkin.Interpreter
This method returns the global interpreter associated with all method calls.
getItems() - Method in class simkin.TreeNode
this function returns the list of children of this node
getIterator() - Method in class simkin.TreeNode
This method returns an iterator that can be used to iterate over the children of this node
getMessage() - Method in class simkin.ParseException
This method returns a message about the nature of a syntax error.
getNode() - Method in class simkin.TreeNodeObject
 
getParseTree() - Method in class simkin.ExecuteResult
Returns the parse tree for the method, which can be cached and passed to a faster execute() method
getResult() - Method in class simkin.ExecuteResult
Returns the method call result
getText(String) - Method in class simkin.examples.applet.ScriptedDialog
This method returns the text in a text control - because it is public it can be called from Simkin scripts
getText(String) - Method in class simkin.examples.dialog.ScriptedDialog
This method returns the text in a text control - because it is public it can be called from Simkin scripts
getType() - Method in interface simkin.ParseNode
 
getValue(String, String) - Method in class simkin.ExecutableRoot
This method calls the Interpreter's reflectiveGetValue method
getValue(String, String) - Method in class simkin.XMLElementObject
Retrieves a field from the XML.
getValue(String, String) - Method in class simkin.Interpreter
Returns the value of the "tracing" variable - e.g.
getValue(String, String) - Method in class simkin.TreeNodeObject
this method retrieves a value from the in-memory treenode object.
getValue(String, String) - Method in interface simkin.Executable
Called to get the value of a field
getValueAt(Object, String) - Method in class simkin.ExecutableRoot
This method does nothing at this level
getValueAt(Object, String) - Method in class simkin.XMLElementObject
Retrieves the nth child element from this element.
getValueAt(Object, String) - Method in class simkin.Interpreter
Returns null - this is not a collection
getValueAt(Object, String) - Method in class simkin.TreeNodeObject
this method retrieves a value from the in-memory treenode object.
getValueAt(Object, String) - Method in interface simkin.Executable
Called to get the value of an object in this collection

H

hasMoreElements() - Method in class simkin.TreeNodeIterator
This function returns true if the iteration has not yet been finished
HelloWorld - class simkin.examples.helloworld.HelloWorld.
This class shows the simplest possible application which just prints "Hello World"
HelloWorld() - Constructor for class simkin.examples.helloworld.HelloWorld
 

I

intData() - Method in class simkin.TreeNode
Returns this node's data as an integer
Interpreter - class simkin.Interpreter.
This class represents the Simkin interpreter.
Interpreter() - Constructor for class simkin.Interpreter
Default constructor - adds a global variable pointing to this interpreter
intValue(Object) - Static method in class simkin.Interpreter
This method converts the given value into an integer value

L

label() - Method in class simkin.TreeNode
Returns this node's label
label(String) - Method in class simkin.TreeNode
Changes this node's label
load(InputStream) - Method in class simkin.XMLExecutable
This method causes the XML to be reloaded

M

main(String[]) - Static method in class simkin.examples.scriptloader.ScriptLoader
Entry point for the ScripLoader application.
main(String[]) - Static method in class simkin.examples.helloworld.HelloWorld
 
main(String[]) - Static method in class simkin.examples.person.Person
Entry point - executes the script
main(String[]) - Static method in class simkin.examples.dialog.ScriptedDialog
pick up the name of the dialog file from the command line, and then create an instance of ScriptedDialog from the XML file name
main(String[]) - Static method in class simkin.examples.array.ArrayExample
load up the xml file named in the command line into an ArrayExample object and then run the main method
method(String, Object[]) - Method in class simkin.ExecutableRoot
The following methods are supported directly by this class:
method(String, Object[]) - Method in class simkin.XMLElementObject
this method attempts to execute a method stored in the XML.
method(String, Object[]) - Method in class simkin.Interpreter
The interpreter does not expose any methods to Simkin scripts
method(String, Object[]) - Method in class simkin.TreeNodeObject
this method attempts to find the named method within the in-memory treenode object.
method(String, Object[]) - Method in interface simkin.Executable
Called if a Simkin script calls a method on this object.
moveItemsFrom(TreeNode) - Method in class simkin.TreeNode
this function moves the children from the given node into this node
MsgBox - class simkin.examples.applet.MsgBox.
This class shows a simple message box
MsgBox - class simkin.examples.dialog.MsgBox.
This class shows a simple message box
msgBox(String) - Method in class simkin.examples.applet.ScriptedDialog
This method shows a message box - because it is public it can be called from Simkin scripts
msgBox(String) - Method in class simkin.examples.dialog.ScriptedDialog
This method shows a message box - because it is public it can be called from Simkin scripts

N

Name - Variable in class simkin.examples.person.Person
This is a public field - giving the person's name
nativeArray - Variable in class simkin.examples.array.ArrayExample
this java array is public, and therefore accessible to the Simkin scripts
next() - Method in class simkin.TreeNodeObjectEnumerator
returns the next object in the enumeration - or null if there are no more
next() - Method in class simkin.XMLElementObjectEnumerator
returns the next object in the enumeration - or null if there are no more
nextElement() - Method in class simkin.TreeNodeIterator
this function returns the next element in the iteration
nthChild(int) - Method in class simkin.TreeNode
This method returns the nth child at this node
nthChildData(int) - Method in class simkin.TreeNode
this method returns the data of the nth child
nthChildIntData(int, int) - Method in class simkin.TreeNode
this method returns the data of the nth child as an integer
Null - class simkin.Null.
This class is used to instantiate a single instance of the "null" object
Null() - Constructor for class simkin.Null
 
numChildren() - Method in class simkin.TreeNode
This method returns the number of children in the list at this node

P

parse(String, String) - Method in class simkin.Interpreter
This method parses a string full of Simkin code and returns the parse tree.
ParseException - exception simkin.ParseException.
This class represents an error thrown during the parsing of some Simkin script.
parseExternalParams(String, Vector, String) - Method in class simkin.Interpreter
This method parses a string of Simkin statements, excluding parameters and enclosing braces.
ParseNode - interface simkin.ParseNode.
ParseNode - this interface is implements by nodes in the parse tree
Person - class simkin.examples.person.Person.
This program shows how a Simkin script can access fields and methods within any Java object
Person() - Constructor for class simkin.examples.person.Person
 

R

read(InputStream) - Static method in class simkin.TreeNode
This function attempts to read a TreeNode from the given stream.
reflectiveGetValue(Object, String) - Method in class simkin.Interpreter
This function attempts to retrieve a public Java field using reflection
reflectiveMethodCall(Object, String, Object[]) - Method in class simkin.Interpreter
This function attempts to make a public method call on a Java object by using reflection
reflectiveSetValue(Object, String, Object) - Method in class simkin.Interpreter
This function attempts to set a public Java field using reflection
reload() - Method in class simkin.examples.dialog.ScriptedDialog
this method makes the dialog reload itself from the XML stream
reload(InputStream) - Method in class simkin.examples.applet.ScriptedDialog
this method makes the dialog reload itself from the XML stream
removeChild(TreeNode) - Method in class simkin.TreeNode
This function removes the given node from the list of children
removeGlobalVariable(String) - Method in class simkin.Interpreter
Removes a global variable from the current list
reset() - Method in class simkin.TreeNodeObjectEnumerator
This method resets the enumeration to the beginning - you can now iterate over the list again
reset() - Method in class simkin.XMLElementObjectEnumerator
This method resets the enumeration to the beginning - you can now iterate over the list again
run(String) - Method in class simkin.examples.dialog.ScriptedDialog
This method runs a command - because it is public it can be called from Simkin scripts
runtimeError(String) - Static method in class simkin.Interpreter
this method is called when there is a runtime error and throws a RuntimeException

S

save(OutputStream) - Method in class simkin.XMLExecutable
Call this method to save the state of the object back to a stream
sayHello() - Method in class simkin.examples.person.Person
This is a public method - it can be called from Simkin
ScriptedDialog - class simkin.examples.applet.ScriptedDialog.
This class shows how you can use Simkin to show dialogs described in an XML script
ScriptedDialog - class simkin.examples.dialog.ScriptedDialog.
This class shows how you can use Simkin to show dialogs described in script
ScriptedDialog(InputStream) - Constructor for class simkin.examples.applet.ScriptedDialog
 
ScriptedDialog(String) - Constructor for class simkin.examples.dialog.ScriptedDialog
 
ScriptedExecutable - class simkin.ScriptedExecutable.
This class is a base class for objects which store data and Simkin code in an associated TreeNode file
ScriptedExecutable(String) - Constructor for class simkin.ScriptedExecutable
this constructor reads in the treenode file named and stores it as an instance variable
ScriptLoader - class simkin.examples.scriptloader.ScriptLoader.
This Java program loads XML files containing Simkin script.
ScriptLoader() - Constructor for class simkin.examples.scriptloader.ScriptLoader
 
setAttribute(String, String) - Method in class simkin.XMLElementObject
Sets an attribute on this node
setChild(TreeNode) - Method in class simkin.TreeNode
replaces the first child with a matching label with the contents of the given node.
setData(Element, String) - Static method in class simkin.XMLElementObject
sets the text data for a node by looking for the first CDATA and TEXT child node
setFocus(String) - Method in class simkin.examples.applet.ScriptedDialog
This method sets the focus to a particular control - because it is public it can be called from Simkin scripts
setFocus(String) - Method in class simkin.examples.dialog.ScriptedDialog
This method sets the focus to a particular control - because it is public it can be called from Simkin scripts
setInterpreter(Interpreter) - Static method in class simkin.Interpreter
Sets a global interpreter to be used for method calls - you can use this to override the Interpreter with your own derived classes
setTracer(TraceCallback) - Static method in class simkin.ExecutableRoot
This method sets the object which will receive trace calls when a trace is requested by a subclass
setValue(String, String, Object) - Method in class simkin.ExecutableRoot
This method calls the Interpreter's reflectiveSetValue method
setValue(String, String, Object) - Method in class simkin.XMLElementObject
sets the value of an item in the element.
setValue(String, String, Object) - Method in class simkin.Interpreter
Used to set the "tracing" variable - for example in Simkin:
setValue(String, String, Object) - Method in class simkin.TreeNodeObject
this method stores a value in the in-memory treenode object.
setValue(String, String, Object) - Method in interface simkin.Executable
Called to set the value of a field.
setValueAt(Object, String, Object) - Method in class simkin.ExecutableRoot
This method does nothing at this level
setValueAt(Object, String, Object) - Method in class simkin.XMLElementObject
sets the value of an item in the element.
setValueAt(Object, String, Object) - Method in class simkin.Interpreter
Does nothing - this is not a collection
setValueAt(Object, String, Object) - Method in class simkin.TreeNodeObject
this method stores a value in the in-memory treenode object.
setValueAt(Object, String, Object) - Method in interface simkin.Executable
Called to set an object into this collection.
simkin - package simkin
This package contains the Simkin interpreter and base classes.
simkin.examples.applet - package simkin.examples.applet
This package contains an example of Simkin running within an applet, and providing a means of creating a dialog box.
simkin.examples.array - package simkin.examples.array
This package contains an example of a Simkin script using array index operators.
simkin.examples.dialog - package simkin.examples.dialog
This package contains an example of Simkin being used to construct a dynamic dialog with behaviour
simkin.examples.helloworld - package simkin.examples.helloworld
This package contains a very simple program using Simkin, which just displays "Hello World"
simkin.examples.person - package simkin.examples.person
This package contains an example of a Simkin script calling into a Java class
simkin.examples.scriptloader - package simkin.examples.scriptloader
This package contains a simple Java application which loads and runs an XML file.
SimkinXMLApplet - class simkin.examples.applet.SimkinXMLApplet.
 
SimkinXMLApplet() - Constructor for class simkin.examples.applet.SimkinXMLApplet
 
SimkinXMLElement - class simkin.SimkinXMLElement.
This class is used to create additional XML elements that are added to an XML document
SimkinXMLElement(String) - Constructor for class simkin.SimkinXMLElement
 
start() - Method in class simkin.examples.applet.SimkinXMLApplet
Called when the applet starts
stop() - Method in class simkin.examples.applet.SimkinXMLApplet
Called when the applet is closed

T

tagName() - Method in class simkin.XMLElementObject
this method returns the tag name of this object (taken from the code element)
toString() - Method in class simkin.XMLElementObject
 
toString() - Method in class simkin.TreeNodeObject
 
trace(Exception) - Static method in class simkin.Tracer
This method dumps the given exception to stdout (if g_Tracing is true)
trace(String) - Method in interface simkin.TraceCallback
this method is called when objects derived from ExecutableRoot wish to generate a trace message.
trace(String) - Static method in class simkin.Tracer
This method causes the given message to be printed to stdout (if g_Tracing is true)
trace(String) - Method in class simkin.examples.applet.SimkinXMLApplet
This is called to show a trace message in the listbox
TraceCallback - interface simkin.TraceCallback.
This interface is implemented by objects which provide a tracing facility for ExecutableRoot.
Tracer - class simkin.Tracer.
This class provides an interface to System.out.println
Tracer() - Constructor for class simkin.Tracer
 
TreeNode - class simkin.TreeNode.
This class encapsulates a single node in a tree
TreeNode() - Constructor for class simkin.TreeNode
default constructor - blank label, data and an empty list of children
TreeNode(String) - Constructor for class simkin.TreeNode
Constructor - passing a label
TreeNode(String, boolean) - Constructor for class simkin.TreeNode
Constructor - passing a label and data, which is converted to String
TreeNode(String, int) - Constructor for class simkin.TreeNode
Constructor - passing a label and data, which is converted to String
TreeNode(String, String) - Constructor for class simkin.TreeNode
Constructor - passing a label and data
TreeNodeIterator - class simkin.TreeNodeIterator.
This class provides a means of iterating over the children of a TreeNode
TreeNodeIterator(TreeNode) - Constructor for class simkin.TreeNodeIterator
Constructor - is passed a TreeNode whose children will be iterated
TreeNodeObject - class simkin.TreeNodeObject.
This class provides and Executable interface to a TreeNode
TreeNodeObject(TreeNode) - Constructor for class simkin.TreeNodeObject
Constructor
TreeNodeObjectEnumerator - class simkin.TreeNodeObjectEnumerator.
This class enumerates the elements in an TreeNodeObject
TreeNodeObjectEnumerator(TreeNodeObject) - Constructor for class simkin.TreeNodeObjectEnumerator
Constructor - enumerates over every child node of this object
TreeNodeObjectEnumerator(TreeNodeObject, String) - Constructor for class simkin.TreeNodeObjectEnumerator
Constructor - enumerates over children of this object with the matching tag

W

write(OutputStream, boolean) - Method in class simkin.TreeNode
This method writes the current node out to an output stream.

X

XMLElementObject - class simkin.XMLElementObject.
This object is a container for an XML element, and exposes an interface to it to Simkin The class implements methods from the Executable interface.
XMLElementObject() - Constructor for class simkin.XMLElementObject
Default Constructor
XMLElementObject(Element) - Constructor for class simkin.XMLElementObject
Constructor which takes an Element
XMLElementObjectEnumerator - class simkin.XMLElementObjectEnumerator.
This class enumerates the elements in an XMLElementObject
XMLElementObjectEnumerator(XMLElementObject) - Constructor for class simkin.XMLElementObjectEnumerator
Constructor - enumerates over every child node of this object
XMLElementObjectEnumerator(XMLElementObject, String) - Constructor for class simkin.XMLElementObjectEnumerator
Constructor - enumerates over children of this object with the matching tag
XMLExecutable - class simkin.XMLExecutable.
This class is a base class for objects which store their data and methods in an XML document
XMLExecutable() - Constructor for class simkin.XMLExecutable
Default Constructor.
XMLExecutable(InputStream) - Constructor for class simkin.XMLExecutable
Constructor taking an input stream containing an XML document

A B C D E F G H I L M N P R S T W X