edu.illinois.ncsa.isda.softwareserver

Class MonkeyScript

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.MonkeyScript

public class MonkeyScript
extends Object

A class representing an monkey script.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
MonkeyScript() Class constructor.
MonkeyScript(String filename) Class constructor.
MonkeyScript(String filename, Vector<String> arguments) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(BufferedImage image, int index) Add an argument to be typed in when executed (note this versions enforces a required desktop!).
void	addArgument(int index) Add an argument to be typed in when executed.
void	addClick(BufferedImage image, int x, int y) Add a mouse click.
void	addCommand(String command) Add a command to execute.
void	addDesktop(BufferedImage image) Add a desktop image to the script.
void	addDoubleClick(BufferedImage image, int x, int y) Add a mouse double click.
void	addKey(char c) Add characters as input from the keyboard.
void	addLine(String line) Add a line to the script.
void	addNegativeArea(int[] box) Add a negative area for the NEXT captured desktop image!
void	addPositiveArea(int[] box) Add a positive area for the NEXT captured desktop image!
void	addTarget(int[][] image) Add a target image to the script.
void	addTargetClick(int[][] image, int x0, int y0, int x, int y) Add a target mouse click.
void	addText(BufferedImage image, String text) Add text input from the keyboard (note this versions enforces a required desktop!).
void	addText(String text) Add text input from the keyboard.
void	addToLastLine(char c) Add a character to the last line of the script.
void	execute() Execute the script.
String	getAlias() Get the script alias.
String	getName() Get the name of the script.
Vector<int[]>	getNegativeAreas() Get the current set of negative areas.
String	getOperation() Get the operation the script performs.
Vector<int[]>	getPositiveAreas() Get the current set of positive areas.
void	lastClickToDoubleClick() Upgrade the last single click to a double click.
String	lastLine() Get the last line of the script.
int	length() Get the number of lines in the script.
void	load(String filename) Load a script.
static void	main(String[] args) A main to execute a monkey script from the command line.
void	print() Display this script.
void	save(String path) Save the script to the given path.
void	set(int index, String line) Set a line of the script.
void	setAlias(String alias) Set the script alias.
void	setOperation(String operation) Set the operation the script will perform.
void	startFocusThief(int focus_thief_delay) Start up an iconified JFrame for the sole purpose of stealing screen focus when needed.
boolean	stealFocus(int desktop_index) Steal window focus as best as possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonkeyScript

public MonkeyScript()

Class constructor.

MonkeyScript

public MonkeyScript(String filename)

Class constructor.

Parameters:

filename - the filename of the script to load

MonkeyScript

public MonkeyScript(String filename,
            Vector<String> arguments)

Class constructor.

Parameters:

filename - the filename of the script to load

arguments - the arguments to use when executing the script

Method Detail

startFocusThief

public void startFocusThief(int focus_thief_delay)

Start up an iconified JFrame for the sole purpose of stealing screen focus when needed.

Parameters:

focus_thief_delay - the time in milliseconds to wait before trying to use the focus thief when executing a stalled script

setAlias

public void setAlias(String alias)

Set the script alias.

Parameters:

alias - the script alias

setOperation

public void setOperation(String operation)

Set the operation the script will perform.

Parameters:

operation - the script operation

getAlias

public String getAlias()

Get the script alias.

Returns:

the script alias

getOperation

public String getOperation()

Get the operation the script performs.

Returns:

the script operation

getName

public String getName()

Get the name of the script.

Returns:

the script name

length

public int length()

Get the number of lines in the script.

Returns:

the number of lines in the script

addLine

public void addLine(String line)

Add a line to the script.

Parameters:

line - the line to add

addToLastLine

public void addToLastLine(char c)

Add a character to the last line of the script.

Parameters:

c - the character to add

addDesktop

public void addDesktop(BufferedImage image)

Add a desktop image to the script.

Parameters:

image - the image to add

addPositiveArea

public void addPositiveArea(int[] box)

Add a positive area for the NEXT captured desktop image!

Parameters:

box - the bounding box of the desired area as (minx, miny, maxx, maxy)

addNegativeArea

public void addNegativeArea(int[] box)

Add a negative area for the NEXT captured desktop image!

Parameters:

box - the bounding box of the desired area as (minx, miny, maxx, maxy)

addTarget

public void addTarget(int[][] image)

Add a target image to the script.

Parameters:

image - the image to add

addCommand

public void addCommand(String command)

Add a command to execute.

Parameters:

command - the command to execute

addClick

public void addClick(BufferedImage image,
            int x,
            int y)

Add a mouse click.

Parameters:

image - the desktop before the click

x - the x-coordinate

y - the y-coordinate

addTargetClick

public void addTargetClick(int[][] image,
                  int x0,
                  int y0,
                  int x,
                  int y)

Add a target mouse click.

Parameters:

image - the target with which the click is in reference to

x0 - the x-coordinate of the target location

y0 - the y-coordinate of the target locaiton

x - the x-coordinate of the click on the desktop

y - the y-coordinate of the click on the desktop

addDoubleClick

public void addDoubleClick(BufferedImage image,
                  int x,
                  int y)

Add a mouse double click.

Parameters:

image - the desktop before the click

x - the x-coordinate

y - the y-coordinate

lastClickToDoubleClick

public void lastClickToDoubleClick()

Upgrade the last single click to a double click. Note: Last action should be a "Click" if this was a double click event in Java

addKey

public void addKey(char c)

Add characters as input from the keyboard.

Parameters:

c - the character to add

addText

public void addText(String text)

Add text input from the keyboard.

Parameters:

text - the text to add

addText

public void addText(BufferedImage image,
           String text)

Add text input from the keyboard (note this versions enforces a required desktop!).

Parameters:

image - the desktop before the click

text - the text to add

addArgument

public void addArgument(int index)

Add an argument to be typed in when executed.

Parameters:

index - the argument index

addArgument

public void addArgument(BufferedImage image,
               int index)

Add an argument to be typed in when executed (note this versions enforces a required desktop!).

Parameters:

image - the desktop before the click

index - the argument index

set

public void set(int index,
       String line)

Set a line of the script.

Parameters:

index - the index of the line to set

line - the new line

lastLine

public String lastLine()

Get the last line of the script.

Returns:

the last line of the script

getPositiveAreas

public Vector<int[]> getPositiveAreas()

Get the current set of positive areas.

Returns:

the set of positive areas for the next captured image

getNegativeAreas

public Vector<int[]> getNegativeAreas()

Get the current set of negative areas.

Returns:

the set of negative areas for the next captured image

save

public void save(String path)

Save the script to the given path.

Parameters:

path - the path to save the script to

load

public void load(String filename)

Load a script.

Parameters:

filename - the filename of the script

print

public void print()

Display this script.

stealFocus

public boolean stealFocus(int desktop_index)

Steal window focus as best as possible.

Parameters:

desktop_index - the index of the current required desktop image

Returns:

true if an attempt was made

execute

public void execute()

Execute the script.

main

public static void main(String[] args)

A main to execute a monkey script from the command line.

Parameters:

args - command line arguments