org.assertj.swing.core

Interface Robot

All Known Implementing Classes:

BasicRobot

public interface Robot

Simulates user input on an AWT or Swing Component.

Author:

Alex Ruiz, Yvonne Wang

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanUp() Cleans up any used resources (keyboard, mouse, open windows and ScreenLock) used by this Robot.
void	cleanUpWithoutDisposingWindows() Cleans up any used resources (keyboard, mouse and ScreenLock) used by this Robot.
void	click(Component c) Simulates a user clicking once the given AWT or Swing Component using the left mouse button.
void	click(Component c, MouseButton button) Simulates a user clicking once the given AWT or Swing Component using the given mouse button.
void	click(Component c, MouseButton button, int times) Simulates a user clicking the given mouse button, the given times on the given AWT or Swing Component.
void	click(Component c, Point where) Simulates a user clicking at the given position on the given AWT or Swing Component.
void	click(Component c, Point where, MouseButton button, int times) Simulates a user clicking the given mouse button, the given times at the given position on the given AWT or Swing Component.
void	click(Point where, MouseButton button, int times) Simulates a user clicking the given mouse button, the given times at the given absolute coordinates.
void	close(Window w) Simulates a user closing the given AWT or Swing Window.
void	doubleClick(Component c) Simulates a user double-clicking the given AWT or Swing Component.
void	enterText(String text) Simulates a user entering the given text.
JPopupMenu	findActivePopupMenu()
ComponentFinder	finder()
void	focus(Component c) Gives input focus to the given AWT or Swing Component.
void	focusAndWaitForFocusGain(Component c) Gives input focus to the given AWT or Swing Component and waits until the Component has focus.
ComponentHierarchy	hierarchy()
boolean	isActive() Indicates whether this Robot is active.
boolean	isDragging() Indicates whether the robot is currently in a dragging operation.
boolean	isReadyForInput(Component c) Indicates whether the given AWT or Swing Component is ready for input.
void	jitter(Component c) Makes the mouse pointer show small quick jumpy movements on the given AWT or Swing Component.
void	jitter(Component c, Point where) Makes the mouse pointer show small quick jumpy movements on the given AWT or Swing Component at the given point.
void	moveMouse(Component c) Simulates a user moving the mouse pointer to the center of the given AWT or Swing Component.
void	moveMouse(Component c, int x, int y) Simulates a user moving the mouse pointer to the given coordinates relative to the given AWT or Swing Component.
void	moveMouse(Component c, Point p) Simulates a user moving the mouse pointer to the given coordinates relative to the given AWT or Swing Component.
void	moveMouse(int x, int y) Simulates a user moving the mouse pointer to the given coordinates.
void	moveMouse(Point p) Simulates a user moving the mouse pointer to the given coordinates.
void	pressAndReleaseKey(int keyCode, int... modifiers) Type the given key code with the given modifiers.
void	pressAndReleaseKeys(int... keyCodes) Simulates a user pressing and releasing the given keys.
void	pressKey(int keyCode) Simulates a user pressing given key.
void	pressModifiers(int modifierMask) Presses the appropriate modifiers corresponding to the given mask.
void	pressMouse(Component c, Point where) Simulates a user pressing the left mouse button on the given AWT or Swing Component.
void	pressMouse(Component c, Point where, MouseButton button) Simulates a user pressing the given mouse button on the given AWT or Swing Component.
void	pressMouse(MouseButton button) Simulates a user pressing a mouse button.
void	pressMouse(Point where, MouseButton button) Simulates a user pressing the given mouse button on the given coordinates.
ComponentPrinter	printer()
void	releaseKey(int keyCode) Simulates a user releasing the given key.
void	releaseModifiers(int modifierMask) Releases the appropriate modifiers corresponding to the given mask.
void	releaseMouse(MouseButton button) Releases the given mouse button.
void	releaseMouseButtons() Releases any mouse button(s) used by the robot.
void	requireNoJOptionPaneIsShowing() Ensures that there is no JOptionPane showing, and potentially blocking GUI tests.
void	rightClick(Component c) Simulates a user right-clicking the given AWT or Swing Component.
void	rotateMouseWheel(Component c, int amount) Moves the mouse pointer over to the given AWT or Swing Component and rotates the scroll wheel on wheel-equipped mice.
void	rotateMouseWheel(int amount) Rotates the scroll wheel on wheel-equipped mice.
Settings	settings()
JPopupMenu	showPopupMenu(Component invoker) Shows a JPopupMenu.
JPopupMenu	showPopupMenu(Component invoker, Point location) Shows a JPopupMenu at the given coordinates.
void	showWindow(Window w) Safely display an AWT or Swing Window with proper EDT synchronization.
void	showWindow(Window w, Dimension size) Safely display an AWT or Swing Window with proper EDT synchronization.
void	showWindow(Window w, Dimension size, boolean pack) Safely display an AWT or Swing Window with proper EDT synchronization.
void	type(char character) Types the given character.
void	waitForIdle() Wait for an idle AWT event queue.

Method Detail

hierarchy

@Nonnull
ComponentHierarchy hierarchy()

Returns:

the ComponentHierarchy being used by this robot.

finder

@Nonnull
ComponentFinder finder()

Returns:

the ComponentFinder being used by this robot.

printer

@Nonnull
ComponentPrinter printer()

Returns:

the ComponentPrinter being used by this robot.

showWindow

void showWindow(@Nonnull
              Window w)

Safely display an AWT or Swing Window with proper EDT synchronization. This method blocks until the Window is showing and ready for input.

Parameters:

w - the window to display.

showWindow

void showWindow(@Nonnull
              Window w,
              @Nonnull
              Dimension size)

Safely display an AWT or Swing Window with proper EDT synchronization. This method blocks until the Window is showing and ready for input.

Parameters:

w - the window to display.

size - the size of the window to display.

showWindow

void showWindow(@Nonnull
              Window w,
              @Nullable
              Dimension size,
              boolean pack)

Safely display an AWT or Swing Window with proper EDT synchronization. This method blocks until the Window is showing. This method will return even when the window is a modal dialog, since the show method is called on the event dispatch thread (EDT.) The Window will be packed if the pack flag is set, and set to the given size if it is non-null.

Modal dialogs may be shown with this method without blocking.

Parameters:

w - the window to display.

size - the size of the window to display. A null value indicates that the window does not need to be resized.

pack - flag that indicates if the window should be packed or not. By packed we mean calling w.pack().

close

void close(@Nonnull
         Window w)

Simulates a user closing the given AWT or Swing Window.

Parameters:

w - the Window to close.

focus

void focus(@Nonnull
         Component c)

Gives input focus to the given AWT or Swing Component. Note that the Component may not yet have focus when this method returns.

Parameters:

c - the Component to give focus to.

focusAndWaitForFocusGain

void focusAndWaitForFocusGain(@Nonnull
                            Component c)

Gives input focus to the given AWT or Swing Component and waits until the Component has focus.

Parameters:

c - the Component to give focus to.

cleanUp

void cleanUp()

Cleans up any used resources (keyboard, mouse, open windows and ScreenLock) used by this Robot.

cleanUpWithoutDisposingWindows

void cleanUpWithoutDisposingWindows()

Cleans up any used resources (keyboard, mouse and ScreenLock) used by this Robot. This method does not dispose any open windows.

Note: The preferred method to use to clean up resources is cleanUp(). Using cleanUpWithoutDisposingWindows() may leave many windows open after each test. Use it on very special cases. Please read bug 138 for more details.

click

void click(@Nonnull
         Component c)

Simulates a user clicking once the given AWT or Swing Component using the left mouse button.

Parameters:

c - the Component to click on.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

rightClick

void rightClick(@Nonnull
              Component c)

Simulates a user right-clicking the given AWT or Swing Component.

Parameters:

c - the Component to click on.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

click

void click(@Nonnull
         Component c,
         @Nonnull
         MouseButton button)

Simulates a user clicking once the given AWT or Swing Component using the given mouse button.

Parameters:

c - the Component to click on.

button - the mouse button to use.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

doubleClick

void doubleClick(@Nonnull
               Component c)

Simulates a user double-clicking the given AWT or Swing Component.

Parameters:

c - the Component to click on.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

click

void click(@Nonnull
         Component c,
         @Nonnull
         MouseButton button,
         int times)

Simulates a user clicking the given mouse button, the given times on the given AWT or Swing Component.

Parameters:

c - the Component to click on.

button - the mouse button to click.

times - the number of times to click the given mouse button.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

click

void click(@Nonnull
         Component c,
         @Nonnull
         Point where)

Simulates a user clicking at the given position on the given AWT or Swing Component.

Parameters:

c - the Component to click on.

where - the given coordinates, relative to the given Component.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

click

void click(@Nonnull
         Component c,
         @Nonnull
         Point where,
         @Nonnull
         MouseButton button,
         int times)

Simulates a user clicking the given mouse button, the given times at the given position on the given AWT or Swing Component.

Parameters:

c - the Component to click on.

where - the given coordinates, relative to the given Component.

button - the mouse button to click.

times - the number of times to click the given mouse button.

Throws:

ActionFailedException - if the Component to click is out of the boundaries of the screen.

click

void click(@Nonnull
         Point where,
         @Nonnull
         MouseButton button,
         int times)

Simulates a user clicking the given mouse button, the given times at the given absolute coordinates.

Parameters:

where - the coordinates where to click.

button - the mouse button to click.

times - the number of times to click the given mouse button.

pressMouse

void pressMouse(@Nonnull
              MouseButton button)

Simulates a user pressing a mouse button.

Parameters:

button - the mouse button to press.

pressMouse

void pressMouse(@Nonnull
              Component c,
              @Nonnull
              Point where)

Simulates a user pressing the left mouse button on the given AWT or Swing Component.

Parameters:

c - the Component to click on.

where - the given coordinates, relative to the given Component.

pressMouse

void pressMouse(@Nonnull
              Component c,
              @Nonnull
              Point where,
              @Nonnull
              MouseButton button)

Simulates a user pressing the given mouse button on the given AWT or Swing Component.

Parameters:

c - the Component to click on.

where - the given coordinates, relative to the given Component.

button - the mouse button to press.

pressMouse

void pressMouse(@Nonnull
              Point where,
              @Nonnull
              MouseButton button)

Simulates a user pressing the given mouse button on the given coordinates.

Parameters:

where - the position where to press the given mouse button.

button - the mouse button to press.

moveMouse

void moveMouse(@Nonnull
             Component c)

Simulates a user moving the mouse pointer to the center of the given AWT or Swing Component.

Parameters:

c - the given Component.

moveMouse

void moveMouse(@Nonnull
             Component c,
             @Nonnull
             Point p)

Simulates a user moving the mouse pointer to the given coordinates relative to the given AWT or Swing Component.

Parameters:

c - the given Component.

p - the given coordinates, relative to the given Component.

Throws:

ActionFailedException - if the given Component is not showing and ready for input.

moveMouse

void moveMouse(@Nonnull
             Component c,
             int x,
             int y)

Simulates a user moving the mouse pointer to the given coordinates relative to the given AWT or Swing Component.

Parameters:

c - the given Component.

x - X coordinate, relative to the given Component.

y - Y coordinate, relative to the given Component.

Throws:

ActionFailedException - if the given Component is not showing and ready for input.

moveMouse

void moveMouse(@Nonnull
             Point p)

Simulates a user moving the mouse pointer to the given coordinates.

Parameters:

p - the given coordinates.

moveMouse

void moveMouse(int x,
             int y)

Simulates a user moving the mouse pointer to the given coordinates.

Parameters:

x - X coordinate.

y - Y coordinate.

releaseMouse

void releaseMouse(@Nonnull
                MouseButton button)

Releases the given mouse button.

Parameters:

button - the mouse button to release.

releaseMouseButtons

void releaseMouseButtons()

Releases any mouse button(s) used by the robot.

rotateMouseWheel

void rotateMouseWheel(@Nonnull
                    Component c,
                    int amount)

Moves the mouse pointer over to the given AWT or Swing Component and rotates the scroll wheel on wheel-equipped mice.

Parameters:

c - the given Component.

amount - number of "notches" to move the mouse wheel. Negative values indicate movement up/away from the user, while positive values indicate movement down/towards the user.

rotateMouseWheel

void rotateMouseWheel(int amount)

Rotates the scroll wheel on wheel-equipped mice.

Parameters:

amount - number of "notches" to move the mouse wheel. Negative values indicate movement up/away from the user, while positive values indicate movement down/towards the user.

jitter

void jitter(@Nonnull
          Component c)

Makes the mouse pointer show small quick jumpy movements on the given AWT or Swing Component.

Parameters:

c - the given Component.

jitter

void jitter(@Nonnull
          Component c,
          @Nonnull
          Point where)

Makes the mouse pointer show small quick jumpy movements on the given AWT or Swing Component at the given point.

Parameters:

c - the given Component.

where - the given point.

enterText

void enterText(@Nonnull
             String text)

Simulates a user entering the given text. Note that this method the key strokes to the AWT or Swing Component that has input focus.

Parameters:

text - the text to enter.

type

void type(char character)

Types the given character. Note that this method sends the key strokes to the AWT or Swing Component that has input focus.

Parameters:

character - the character to type.

pressAndReleaseKey

void pressAndReleaseKey(int keyCode,
                      @Nonnull
                      int... modifiers)

Type the given key code with the given modifiers. Modifiers is a mask from the available java.awt.event.InputEvent masks.

Parameters:

keyCode - the code of the key to press.

modifiers - the given modifiers.

Throws:

IllegalArgumentException - if the given code is not a valid key code.

pressAndReleaseKeys

void pressAndReleaseKeys(@Nonnull
                       int... keyCodes)

Simulates a user pressing and releasing the given keys. This method does not affect the current focus.

Parameters:

keyCodes - one or more codes of the keys to press.

Throws:

IllegalArgumentException - if any of the given codes is not a valid key code.

See Also:

KeyEvent

pressKey

void pressKey(int keyCode)

Simulates a user pressing given key. This method does not affect the current focus.

Parameters:

keyCode - the code of the key to press.

Throws:

IllegalArgumentException - if the given code is not a valid key code.

See Also:

KeyEvent

releaseKey

void releaseKey(int keyCode)

Simulates a user releasing the given key. This method does not affect the current focus.

Parameters:

keyCode - the code of the key to release.

Throws:

IllegalArgumentException - if the given code is not a valid key code.

See Also:

KeyEvent

pressModifiers

void pressModifiers(int modifierMask)

Presses the appropriate modifiers corresponding to the given mask. Use mask values from java.awt.event.InputEvent.

Parameters:

modifierMask - the given mask.

See Also:

InputEvent

releaseModifiers

void releaseModifiers(int modifierMask)

Releases the appropriate modifiers corresponding to the given mask. Use mask values from java.awt.event.InputEvent.

Parameters:

modifierMask - the given mask.

See Also:

InputEvent

waitForIdle

void waitForIdle()

Wait for an idle AWT event queue. Note that this is different from the implementation of java.awt.Robot.waitForIdle(), which may have events on the queue when it returns. Do NOT use this method if there are animations or other continual refreshes happening, since in that case it may never return.

Throws:

IllegalThreadStateException - if this method is called from the event dispatch thread (EDT.)

isDragging

boolean isDragging()

Indicates whether the robot is currently in a dragging operation.

Returns:

true if the robot is currently in a dragging operation, false otherwise.

isReadyForInput

boolean isReadyForInput(@Nonnull
                      Component c)

Indicates whether the given AWT or Swing Component is ready for input.

Parameters:

c - the given Component.

Returns:

true if the given Component is ready for input, false otherwise.

Throws:

ActionFailedException - if the given Component does not have a Window ancestor.

showPopupMenu

@Nonnull
JPopupMenu showPopupMenu(@Nonnull
                               Component invoker)

Shows a JPopupMenu.

Parameters:

invoker - the Component to invoke the JPopupMenu from.

Returns:

the displayed JPopupMenu.

Throws:

ComponentLookupException - if a JPopupMenu cannot be found.

showPopupMenu

@Nonnull
JPopupMenu showPopupMenu(@Nonnull
                               Component invoker,
                               @Nonnull
                               Point location)

Shows a JPopupMenu at the given coordinates.

Parameters:

invoker - the Component to invoke the JPopupMenu from.

location - the given coordinates for the JPopupMenu.

Returns:

the displayed JPopupMenu.

Throws:

ComponentLookupException - if a JPopupMenu cannot be found.

findActivePopupMenu

@Nullable
JPopupMenu findActivePopupMenu()

Returns:

the currently active JPopupMenu or null, if no pop-up is currently showing.

requireNoJOptionPaneIsShowing

void requireNoJOptionPaneIsShowing()

Ensures that there is no JOptionPane showing, and potentially blocking GUI tests.

Throws:

AssertionError - if there is one or more JOptionPanes showing on the screen.

settings

@Nonnull
Settings settings()

Returns:

the configuration settings for this Robot.

isActive

boolean isActive()

Indicates whether this Robot is active. Being "active" means that cleanUp() has not been called yet.

Returns:

true if this Robot is active, false otherwise.