prajna.gui

Class DemoRobot

java.lang.Object

java.awt.Robot

prajna.gui.DemoRobot

public class DemoRobot
extends java.awt.Robot

This class is designed to provide an automated demonstration for a graphical application. By reading a script from an XML script file, a sequence of commands can be provided in advance, so anyone can demo a particular application without knowledge of how it works.

The XML file is specified as a command-line argument. Type java DemoRobot scriptFile.xml to run the demonstration using scriptFile.xml. This XML file can contain the following elements:

• moveTo X=number Y=number steps=number: move the cursor to (X, Y) in the specified number of steps. Each step takes .1 second. The default is 10 steps.
• dragTo button=1, 2, or 3 X=number Y=number steps=number: move the cursor to (X, Y) in the specified number of steps. Each step takes .1 second. The default is 10 steps.
• enterText text=String: enter the specified string.
• click button=1, 2, or 3: click the left, middle, or right mouse button
• click button=[1-3] count=num: click the mouse button num times (useful for double-clicking)
• showHint hint=text millis=num: show a popup text hint where the cursor currently is, for num milliseconds.
• sleep millis=num: wait for num milliseconds

The following is a sample xml script file:

 <demoScript className="prajna.demo.TimeFlowDemo"
         width="600" height="600">
     <enterText text="MD197" />
     <moveTo x="280" y="230" steps="10" />
     <click button="1" />
     <moveTo x="470" y="100" steps="40" />
     <click button="1" />
     <click button="3" />
     <sleep millis="2000" />
     <moveTo x="505" y="115" steps="5" />
     <click button="1" />
     <moveTo x="400" y="30" steps="10" />
     <click button="1" count="2" />
     <enterText text="MD216" />
     <moveTo x="180" y="130" steps="15" />
     <showHint hint="Are we there yet?"
         millis="5000" />
     <moveTo x="280" y="230" steps="10" />
 </demoScript>
 

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DemoRobot() Creates a new DemoRobot object.

Method Summary

Methods

Modifier and Type	Method and Description
void	click(int button) Click the appropriate mouse button.
void	click(int button, int count) Click the appropriate mouse button.
void	dragTo(int xCoord, int yCoord) Click and drag the cursor to the specified location.
void	dragTo(int button, int xCoord, int yCoord, int steps) Click and drag the cursor to the specified location.
void	enterText(java.lang.String text) Enters text from the keyboard.
javax.swing.JFrame	getTopFrame()
boolean	isPaused()
void	loadScript(java.lang.String xmlFile) Loads a script from an XML file.
static void	main(java.lang.String[] args) Main method to run the DemoRobot
void	moveTo(int xCoord, int yCoord, int steps) Move to the specified point in the appropriate number of steps.
void	moveTo(java.awt.Point pt, int steps) Move to the specified point in the appropriate number of steps
void	playScript() Plays through the demo script.
void	setPaused(boolean pauseFlag)
void	showHint(java.lang.String text, int millis) Displays a pop-up message for descriptive text.
boolean	startApp() Start the application that has been set up.

Methods inherited from class java.awt.Robot

createScreenCapture, delay, getAutoDelay, getPixelColor, isAutoWaitForIdle, keyPress, keyRelease, mouseMove, mousePress, mouseRelease, mouseWheel, setAutoDelay, setAutoWaitForIdle, toString, waitForIdle

Methods inherited from class java.lang.Object

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

Constructor Detail

DemoRobot

public DemoRobot()
          throws java.awt.AWTException

Creates a new DemoRobot object.

Throws:

java.awt.AWTException - if the platform configuration does not allow low-level input control. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true

Method Detail

click

public void click(int button)

Click the appropriate mouse button. Button 1 is the Left button, Button 2 is the middle button, and button 3 is the right button.

Parameters:

button - the mouse button to click

click

public void click(int button,
         int count)

Click the appropriate mouse button. Button 1 is the Left button, Button 2 is the middle button, and button 3 is the right button. The button is clicked count times.

Parameters:

button - the mouse button to click

count - the number of repeat clicks.

dragTo

public void dragTo(int xCoord,
          int yCoord)

Click and drag the cursor to the specified location. Defaults to using the left mouse button and 10 steps for the drag.

Parameters:

xCoord - the destination X coordinate

yCoord - the destination Y coordinate

dragTo

public void dragTo(int button,
          int xCoord,
          int yCoord,
          int steps)

Click and drag the cursor to the specified location. Uses the specified mouse button and number of steps

Parameters:

button - the mouse button to hold down while dragging

xCoord - the destination X coordinate

yCoord - the destination Y coordinate

steps - the number of steps to use

enterText

public void enterText(java.lang.String text)

Enters text from the keyboard. The keys are sent to the underlying application, and caught by whatever component has focus.

Parameters:

text - The text string to enter

getTopFrame

public javax.swing.JFrame getTopFrame()

Returns:

the topFrame

isPaused

public boolean isPaused()

Returns:

the paused

loadScript

public void loadScript(java.lang.String xmlFile)
                throws java.lang.Exception

Loads a script from an XML file. The script should conform to the format indicated above.

Parameters:

xmlFile - the XML file to load

Throws:

java.lang.Exception - Any exception generated from the effort to load the XML file.

moveTo

public void moveTo(int xCoord,
          int yCoord,
          int steps)

Move to the specified point in the appropriate number of steps. Each step will take approximately 100 milliseconds.

Parameters:

xCoord - the destination X coordinate

yCoord - the destination Y coordinate

steps - the number of steps to use

moveTo

public void moveTo(java.awt.Point pt,
          int steps)

Move to the specified point in the appropriate number of steps

Parameters:

pt - the destination point

steps - the number of steps to use

playScript

public void playScript()

Plays through the demo script.

setPaused

public void setPaused(boolean pauseFlag)

Parameters:

pauseFlag - the paused to set

showHint

public void showHint(java.lang.String text,
            int millis)

Displays a pop-up message for descriptive text. The message will be displayed for a short period of time at the current cursor location, then removed from the display

Parameters:

text - the text hint to display

millis - how long to display the text (in milliseconds)

startApp

public boolean startApp()

Start the application that has been set up.

Returns:

If the application was started successfully

main

public static void main(java.lang.String[] args)

Main method to run the DemoRobot

Parameters:

args - a list of string arguments. There should be one argument - the name of the XML file containing the demo script