Save This Page
Home » openjdk-7 » java » awt » [javadoc | source]
java.awt
public class: Robot [javadoc | source]
java.lang.Object
   java.awt.Robot
This class is used to generate native system input events for the purposes of test automation, self-running demos, and other applications where control of the mouse and keyboard is needed. The primary purpose of Robot is to facilitate automated testing of Java platform implementations.

Using the class to generate input events differs from posting events to the AWT event queue or AWT components in that the events are generated in the platform's native input queue. For example, Robot.mouseMove will actually move the mouse cursor instead of just generating mouse move events.

Note that some platforms require special privileges or extensions to access low-level input control. If the current platform configuration does not allow input control, an AWTException will be thrown when trying to construct Robot objects. For example, X-Window systems will throw the exception if the XTEST 2.2 standard extension is not supported (or not enabled) by the X server.

Applications that use Robot for purposes other than self-testing should handle these error conditions gracefully.

Nested Class Summary:
static class  Robot.RobotDisposer   
Constructor:
 public Robot() throws AWTException 
    Constructs a Robot object in the coordinate system of the primary screen.

    Throws:
    AWTException - if the platform configuration does not allow low-level input control. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true
    SecurityException - if createRobot permission is not granted
    Also see:
    java.awt.GraphicsEnvironment#isHeadless
    SecurityManager#checkPermission
    AWTPermission
 public Robot(GraphicsDevice screen) throws AWTException 
    Creates a Robot for the given screen device. Coordinates passed to Robot method calls like mouseMove and createScreenCapture will be interpreted as being in the same coordinate system as the specified screen. Note that depending on the platform configuration, multiple screens may either:
    • share the same coordinate system to form a combined virtual screen
    • use different coordinate systems to act as independent screens
    This constructor is meant for the latter case.

    If screen devices are reconfigured such that the coordinate system is affected, the behavior of existing Robot objects is undefined.

    Parameters:
    screen - A screen GraphicsDevice indicating the coordinate system the Robot will operate in.
    Throws:
    AWTException - if the platform configuration does not allow low-level input control. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.
    IllegalArgumentException - if screen is not a screen GraphicsDevice.
    SecurityException - if createRobot permission is not granted
    Also see:
    java.awt.GraphicsEnvironment#isHeadless
    GraphicsDevice
    SecurityManager#checkPermission
    AWTPermission
Method from java.awt.Robot Summary:
createScreenCapture,   delay,   getAutoDelay,   getPixelColor,   isAutoWaitForIdle,   keyPress,   keyRelease,   mouseMove,   mousePress,   mouseRelease,   mouseWheel,   setAutoDelay,   setAutoWaitForIdle,   toString,   waitForIdle
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.Robot Detail:
 public synchronized BufferedImage createScreenCapture(Rectangle screenRect) 
    Creates an image containing pixels read from the screen. This image does not include the mouse cursor.
 public synchronized  void delay(int ms) 
    Sleeps for the specified time. To catch any InterruptedExceptions that occur, Thread.sleep() may be used instead.
 public synchronized int getAutoDelay() 
    Returns the number of milliseconds this Robot sleeps after generating an event.
 public synchronized Color getPixelColor(int x,
    int y) 
    Returns the color of a pixel at the given screen coordinates.
 public synchronized boolean isAutoWaitForIdle() 
    Returns whether this Robot automatically invokes waitForIdle after generating an event.
 public synchronized  void keyPress(int keycode) 
    Presses a given key. The key should be released using the keyRelease method.

    Key codes that have more than one physical key associated with them (e.g. KeyEvent.VK_SHIFT could mean either the left or right shift key) will map to the left key.

 public synchronized  void keyRelease(int keycode) 
    Releases a given key.

    Key codes that have more than one physical key associated with them (e.g. KeyEvent.VK_SHIFT could mean either the left or right shift key) will map to the left key.

 public synchronized  void mouseMove(int x,
    int y) 
    Moves mouse pointer to given screen coordinates.
 public synchronized  void mousePress(int buttons) 
    Presses one or more mouse buttons. The mouse buttons should be released using the #mouseRelease(int) method.
 public synchronized  void mouseRelease(int buttons) 
    Releases one or more mouse buttons.
 public synchronized  void mouseWheel(int wheelAmt) 
    Rotates the scroll wheel on wheel-equipped mice.
 public synchronized  void setAutoDelay(int ms) 
    Sets the number of milliseconds this Robot sleeps after generating an event.
 public synchronized  void setAutoWaitForIdle(boolean isOn) 
    Sets whether this Robot automatically invokes waitForIdle after generating an event.
 public synchronized String toString() 
    Returns a string representation of this Robot.
 public synchronized  void waitForIdle() 
    Waits until all events currently on the event queue have been processed.