mesquite.lib
Class Puppeteer

java.lang.Object
  mesquite.lib.Puppeteer

public class Puppeteer

extends java.lang.Object

An object that handles scripting. Puppeteers are the main contollers of scripts (saved in Mesquite blocks of NEXUS files, or used to clone windows, or in macros). It creates its own thread to pass commands.

Constructor Summary

Puppeteer(MesquiteModule ownerModule)

Method Summary

void	applyMacroFile(java.lang.String fileName, Commandable obj, CommandRecord commandRec) Apply macro file to given commandable
void	dialogScript(java.lang.Object baseObject, java.awt.Frame f, java.lang.String objectToCommand) Calls up a dialog box in which the user can enter a script to be sent to the passed object.
void	execute(java.lang.Object baseObject, java.lang.String commands, MesquiteInteger pos, java.lang.String endString, boolean skip) Execute the passed string of commands (currently at string location 'pos') until the String "endString' is reached, skipping commands if the skip flag is set.
void	execute(java.lang.Object baseObject, java.lang.String commands, MesquiteInteger pos, java.lang.String endString, boolean skip, NexusBlock nblock, MesquiteFile file) Execute the passed string of commands (currently at string location 'pos') until the String "endString' is reached, skipping commands if the skip flag is set.
void	execute(java.lang.Object baseObject, java.lang.String commands, MesquiteInteger pos, java.lang.String endString, boolean skip, NexusBlock nblock, MesquiteFile file, CommandRecord commandRec) Execute the passed string of commands (currently at string location 'pos') until the String "endString' is reached, skipping commands if the skip flag is set.
void	finalize()
protected void	returningPage(MesquiteModule pagedModule) This is for the paging system, which may be defunct.
java.lang.Object	sendCommands(java.lang.Object mb, java.lang.String block, MesquiteInteger stringPos, java.lang.String endString, boolean skip, NexusBlock nb, CommandRecord commandRec, CommandChecker checker)
void	sendCommandsOnNewThread(java.lang.Object baseObject, java.lang.String commands, MesquiteInteger pos, java.lang.String endString, boolean skip, NexusBlock nblock) Sends commands to the object, but on a new thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

Puppeteer

public Puppeteer(MesquiteModule ownerModule)

Method Detail

dialogScript

public void dialogScript(java.lang.Object baseObject,
                         java.awt.Frame f,
                         java.lang.String objectToCommand)

Calls up a dialog box in which the user can enter a script to be sent to the passed object.

execute

public void execute(java.lang.Object baseObject,
                    java.lang.String commands,
                    MesquiteInteger pos,
                    java.lang.String endString,
                    boolean skip,
                    NexusBlock nblock,
                    MesquiteFile file,
                    CommandRecord commandRec)

Execute the passed string of commands (currently at string location 'pos') until the String "endString' is reached, skipping commands if the skip flag is set. The NexusBlock is passed currently only so that the commands may assign it a title

execute

public void execute(java.lang.Object baseObject,
                    java.lang.String commands,
                    MesquiteInteger pos,
                    java.lang.String endString,
                    boolean skip,
                    NexusBlock nblock,
                    MesquiteFile file)

Execute the passed string of commands (currently at string location 'pos') until the String "endString' is reached, skipping commands if the skip flag is set. The NexusBlock is passed currently only so that the commands may assign it a title

execute

public void execute(java.lang.Object baseObject,
                    java.lang.String commands,
                    MesquiteInteger pos,
                    java.lang.String endString,
                    boolean skip)

Execute the passed string of commands (currently at string location 'pos') until the String "endString' is reached, skipping commands if the skip flag is set.

applyMacroFile

public void applyMacroFile(java.lang.String fileName,
                           Commandable obj,
                           CommandRecord commandRec)

Apply macro file to given commandable

returningPage

protected void returningPage(MesquiteModule pagedModule)

This is for the paging system, which may be defunct.

sendCommandsOnNewThread

public void sendCommandsOnNewThread(java.lang.Object baseObject,
                                    java.lang.String commands,
                                    MesquiteInteger pos,
                                    java.lang.String endString,
                                    boolean skip,
                                    NexusBlock nblock)

Sends commands to the object, but on a new thread.

sendCommands

public java.lang.Object sendCommands(java.lang.Object mb,
                                     java.lang.String block,
                                     MesquiteInteger stringPos,
                                     java.lang.String endString,
                                     boolean skip,
                                     NexusBlock nb,
                                     CommandRecord commandRec,
                                     CommandChecker checker)

finalize

public void finalize()
              throws java.lang.Throwable

Throws:

java.lang.Throwable