org.assertj.swing.driver

Class ComponentDriver

java.lang.Object

org.assertj.swing.driver.ComponentDriver

Direct Known Subclasses:

ContainerDriver, JAppletDriver

@InternalApi
public class ComponentDriver
extends Object

Supports functional testing of AWT or Swing Components.

Note: This class is intended for internal use only. Please use the classes in the package org.assertj.swing.fixture in your tests.

Author:

Alex Ruiz

Field Summary

Fields

Modifier and Type	Field and Description
protected Robot	robot

Constructor Summary

Constructors

Constructor and Description
ComponentDriver(Robot robot) Creates a new ComponentDriver.

Method Summary

Modifier and Type	Method and Description
Color	backgroundOf(Component c) Returns the background color of the given AWT or Swing Component.
protected void	checkClickAllowed(Component c) Verifies that the given AWT or Swing Component is enabled and showing on the screen.
protected static void	checkInEdtEnabledAndShowing(Component c) Verifies that the given AWT or Swing Component is enabled and showing on the screen.
protected static void	checkInEdtShowing(Component c) Verifies that the given AWT or Swing Component is showing on the screen.
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, MouseClickInfo mouseClickInfo) 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	doubleClick(Component c) Simulates a user double-clicking the given AWT or Swing Component.
protected void	drag(Component c, Point where) Performs a drag action at the given point.
protected void	dragOver(Component c, Point where) Move the mouse appropriately to get from the source to the destination.
protected void	drop(Component c, Point where) Ends a drag operation, releasing the mouse button over the given target location.
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.
Font	fontOf(Component c) Returns the font of the given AWT or Swing Component.
Color	foregroundOf(Component c) Returns the foreground color of the given AWT or Swing Component.
JPopupMenu	invokePopupMenu(Component c) Shows a pop-up menu using the given AWT or Swing Component as the invoker of the pop-up menu.
JPopupMenu	invokePopupMenu(Component c, Point p) Shows a pop-up menu at the given point using the given AWT or Swing Component as the invoker of the pop-up menu.
protected void	moveMouseIgnoringAnyError(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.
protected void	moveMouseIgnoringAnyError(Component c, Point p) Simulates a user moving the mouse pointer to the given coordinates relative to the given AWT or Swing Component.
protected void	performAccessibleActionOf(Component c) Performs the AccessibleAction in the given AWT or Swing Component's event queue.
void	pressAndReleaseKey(Component c, int keyCode, int[] modifiers) Simulates a user pressing and releasing the given key on the AWT or Swing Component.
void	pressAndReleaseKey(Component c, KeyPressInfo keyPressInfo) Simulates a user pressing and releasing the given key on the AWT or Swing Component.
void	pressAndReleaseKeys(Component c, int... keyCodes) Simulates a user pressing and releasing the given keys on the AWT or Swing Component.
void	pressKey(Component c, int keyCode) Simulates a user pressing given key on the AWT or Swing Component.
void	pressKeyWhileRunning(Component c, int keyCode, Runnable runnable) Simulates a user pressing given key on the AWT or Swing Component, running the given runnable and releasing the key again.
static org.assertj.core.description.Description	propertyName(Component c, String propertyName) Formats the name of a property of the given AWT or Swing Component by concatenating the value obtained from Formatting.format(Component) with the given property name.
void	releaseKey(Component c, int keyCode) Simulates a user releasing the given key on the AWT or Swing Component.
void	requireDisabled(Component c) Asserts that the AWT or Swing Component is disabled.
void	requireEnabled(Component c) Asserts that the AWT or Swing Component is enabled.
void	requireEnabled(Component c, Timeout timeout) Asserts that the AWT or Swing Component is enabled.
void	requireFocused(Component c) Asserts that the AWT or Swing Component has input focus.
void	requireNotVisible(Component c) Asserts that the AWT or Swing Component is not visible.
void	requireSize(Component c, Dimension size) Asserts that the size of the AWT or Swing Component is equal to given one.
void	requireVisible(Component c) Asserts that the AWT or Swing Component is visible.
void	rightClick(Component c) Simulates a user right-clicking the given AWT or Swing Component.
protected Settings	settings()
protected boolean	waitForShowing(Component c, long timeout) Wait the given number of milliseconds for the AWT or Swing Component to be showing and ready.

Methods inherited from class java.lang.Object

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

Field Detail

robot

protected final Robot robot

Constructor Detail

ComponentDriver

public ComponentDriver(@Nonnull
                       Robot robot)

Creates a new ComponentDriver.

Parameters:

robot - the robot to use to simulate user input.

Method Detail

click

@RunsInEDT
public 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:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

click

@RunsInEDT
public 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:

NullPointerException - if the given MouseButton is null.

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

click

@RunsInEDT
public void click(@Nonnull
                             Component c,
                             @Nonnull
                             MouseClickInfo mouseClickInfo)

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.

mouseClickInfo - specifies the button to click and the times the button should be clicked.

Throws:

NullPointerException - if the given MouseClickInfo is null.

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

doubleClick

@RunsInEDT
public void doubleClick(@Nonnull
                                   Component c)

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

Parameters:

c - the Component to click on.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

rightClick

@RunsInEDT
public void rightClick(@Nonnull
                                  Component c)

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

Parameters:

c - the Component to click on.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

click

@RunsInEDT
public 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:

NullPointerException - if the given MouseButton is null.

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

click

@RunsInEDT
public 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 position where to click.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

settings

@Nonnull
protected Settings settings()

requireSize

@RunsInEDT
public void requireSize(@Nonnull
                                   Component c,
                                   @Nonnull
                                   Dimension size)

Asserts that the size of the AWT or Swing Component is equal to given one.

Parameters:

c - the target Component.

size - the given size to match.

Throws:

AssertionError - if the size of the Component is not equal to the given size.

requireVisible

@RunsInEDT
public void requireVisible(@Nonnull
                                      Component c)

Asserts that the AWT or Swing Component is visible.

Parameters:

c - the target Component.

Throws:

AssertionError - if the Component is not visible.

requireNotVisible

@RunsInEDT
public void requireNotVisible(@Nonnull
                                         Component c)

Asserts that the AWT or Swing Component is not visible.

Parameters:

c - the target Component.

Throws:

AssertionError - if the Component is visible.

requireFocused

@RunsInEDT
public void requireFocused(@Nonnull
                                      Component c)

Asserts that the AWT or Swing Component has input focus.

Parameters:

c - the target Component.

Throws:

AssertionError - if the Component does not have input focus.

requireEnabled

@RunsInEDT
public void requireEnabled(@Nonnull
                                      Component c)

Asserts that the AWT or Swing Component is enabled.

Parameters:

c - the target Component.

Throws:

AssertionError - if the Component is disabled.

requireEnabled

@RunsInEDT
public void requireEnabled(@Nonnull
                                      Component c,
                                      @Nonnull
                                      Timeout timeout)

Asserts that the AWT or Swing Component is enabled.

Parameters:

c - the target Component.

timeout - the time this fixture will wait for the Component to be enabled.

Throws:

WaitTimedOutError - if the Component is never enabled.

requireDisabled

@RunsInEDT
public void requireDisabled(@Nonnull
                                       Component c)

Asserts that the AWT or Swing Component is disabled.

Parameters:

c - the target Component.

Throws:

AssertionError - if the Component is enabled.

pressAndReleaseKeys

@RunsInEDT
public void pressAndReleaseKeys(@Nonnull
                                           Component c,
                                           @Nonnull
                                           int... keyCodes)

Simulates a user pressing and releasing the given keys on the AWT or Swing Component.

Parameters:

c - the target Component.

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

Throws:

NullPointerException - if the given array of codes is null.

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

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

See Also:

KeyEvent

pressAndReleaseKey

@RunsInEDT
public void pressAndReleaseKey(@Nonnull
                                          Component c,
                                          @Nonnull
                                          KeyPressInfo keyPressInfo)

Simulates a user pressing and releasing the given key on the AWT or Swing Component. Modifiers is a mask from the available AWT InputEvent masks.

Parameters:

c - the target Component.

keyPressInfo - specifies the key and modifiers to press.

Throws:

NullPointerException - if the given KeyPressInfo is null.

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

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

See Also:

KeyEvent, InputEvent

pressAndReleaseKey

@RunsInEDT
public void pressAndReleaseKey(@Nonnull
                                          Component c,
                                          int keyCode,
                                          @Nonnull
                                          int[] modifiers)

Simulates a user pressing and releasing the given key on the AWT or Swing Component. Modifiers is a mask from the available AWT InputEvent masks.

Parameters:

c - the target Component.

keyCode - the code of the key to press.

modifiers - the given modifiers.

Throws:

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

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

See Also:

KeyEvent, InputEvent

pressKey

@RunsInEDT
public void pressKey(@Nonnull
                                Component c,
                                int keyCode)

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

Parameters:

c - the target Component.

keyCode - the code of the key to press.

Throws:

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

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

See Also:

#pressKeyWhileRunning(Component, int), KeyEvent

pressKeyWhileRunning

@RunsInEDT
public void pressKeyWhileRunning(@Nonnull
                                            Component c,
                                            int keyCode,
                                            @Nonnull
                                            Runnable runnable)

Simulates a user pressing given key on the AWT or Swing Component, running the given runnable and releasing the key again.

Parameters:

c - the target Component.

keyCode - the code of the key to press.

Throws:

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

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

See Also:

pressKey(Component, int), KeyEvent

releaseKey

@RunsInEDT
public void releaseKey(@Nonnull
                                  Component c,
                                  int keyCode)

Simulates a user releasing the given key on the AWT or Swing Component.

Parameters:

c - the target Component.

keyCode - the code of the key to release.

Throws:

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

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

See Also:

KeyEvent

focusAndWaitForFocusGain

@RunsInEDT
public 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.

Throws:

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

focus

@RunsInEDT
public 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.

Throws:

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

drag

@RunsInEDT
protected final void drag(@Nonnull
                                     Component c,
                                     @Nonnull
                                     Point where)

Performs a drag action at the given point.

Parameters:

c - the target Component.

where - the point where to start the drag action.

drop

@RunsInEDT
protected final void drop(@Nonnull
                                     Component c,
                                     @Nonnull
                                     Point where)

Ends a drag operation, releasing the mouse button over the given target location.

This method is tuned for native drag/drop operations, so if you get odd behavior, you might try using a simple Robot.moveMouse(Component, int, int) and Robot.releaseMouseButtons().

Parameters:

c - the target Component.

where - the point where the drag operation ends.

Throws:

ActionFailedException - if there is no drag action in effect.

dragOver

protected final void dragOver(@Nonnull
                              Component c,
                              @Nonnull
                              Point where)

Move the mouse appropriately to get from the source to the destination. Enter/exit events will be generated where appropriate.

Parameters:

c - the target Component.

where - the point to drag over.

performAccessibleActionOf

@RunsInCurrentThread
protected final void performAccessibleActionOf(@Nonnull
                                                                    Component c)

Performs the AccessibleAction in the given AWT or Swing Component's event queue.

Note: This method is accessed in the current executing thread. Such thread may or may not be the event dispatch thread (EDT). Client code must call this method from the EDT.

Parameters:

c - the given Component.

Throws:

ActionFailedException - if something goes wrong.

waitForShowing

@RunsInCurrentThread
protected final boolean waitForShowing(@Nonnull
                                                            Component c,
                                                            long timeout)

Wait the given number of milliseconds for the AWT or Swing Component to be showing and ready. Returns false if the operation times out.

Note: This method is accessed in the current executing thread. Such thread may or may not be the event dispatch thread (EDT). Client code must call this method from the EDT.

Parameters:

c - the given Component.

timeout - the time in milliseconds to wait for the Component to be showing and ready.

Returns:

true if the Component is showing and ready, false otherwise.

invokePopupMenu

@RunsInEDT
 @Nonnull
public JPopupMenu invokePopupMenu(@Nonnull
                                                       Component c)

Shows a pop-up menu using the given AWT or Swing Component as the invoker of the pop-up menu.

Parameters:

c - the invoker of the JPopupMenu.

Returns:

the displayed pop-up menu.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

ComponentLookupException - if a pop-up menu cannot be found.

invokePopupMenu

@RunsInEDT
 @Nonnull
public JPopupMenu invokePopupMenu(@Nonnull
                                                       Component c,
                                                       @Nonnull
                                                       Point p)

Shows a pop-up menu at the given point using the given AWT or Swing Component as the invoker of the pop-up menu.

Parameters:

c - the invoker of the JPopupMenu.

p - the given point where to show the pop-up menu.

Returns:

the displayed pop-up menu.

Throws:

NullPointerException - if the given point is null.

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

ComponentLookupException - if a pop-up menu cannot be found.

checkInEdtEnabledAndShowing

@RunsInEDT
protected static void checkInEdtEnabledAndShowing(@Nonnull
                                                             Component c)

Verifies that the given AWT or Swing Component is enabled and showing on the screen.

Parameters:

c - the Component to check.

Throws:

IllegalStateException - if the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

checkInEdtShowing

@RunsInEDT
protected static void checkInEdtShowing(@Nonnull
                                                   Component c)

Verifies that the given AWT or Swing Component is showing on the screen.

Parameters:

c - the Component to check.

Throws:

IllegalStateException - if the Component is not showing on the screen.

checkClickAllowed

@RunsInEDT
protected void checkClickAllowed(@Nonnull
                                            Component c)

Verifies that the given AWT or Swing Component is enabled and showing on the screen.

Parameters:

c - the Component to check.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and the Component is disabled.

IllegalStateException - if the Component is not showing on the screen.

propertyName

@RunsInEDT
 @Nonnull
public static org.assertj.core.description.Description propertyName(@Nonnull
                                                                                         Component c,
                                                                                         @Nonnull
                                                                                         String propertyName)

Formats the name of a property of the given AWT or Swing Component by concatenating the value obtained from Formatting.format(Component) with the given property name.

Parameters:

c - the given Component.

propertyName - the name of the property.

Returns:

the description of a property belonging to a Component.

See Also:

ComponentFormatter, Formatting.format(Component)

moveMouseIgnoringAnyError

@RunsInEDT
protected final void moveMouseIgnoringAnyError(@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. This method will not throw any exceptions if the it was not possible to move the mouse pointer.

Parameters:

c - the given Component.

p - coordinates relative to the given Component.

moveMouseIgnoringAnyError

@RunsInEDT
protected final void moveMouseIgnoringAnyError(@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. This method will not throw any exceptions if the it was not possible to move the mouse pointer.

Parameters:

c - the given Component.

x - horizontal coordinate relative to the given Component.

y - vertical coordinate relative to the given Component.

fontOf

@RunsInEDT
 @Nonnull
public Font fontOf(@Nonnull
                                        Component c)

Returns the font of the given AWT or Swing Component.

Parameters:

c - the given Component.

Returns:

the font of the given Component.

backgroundOf

@RunsInEDT
 @Nonnull
public Color backgroundOf(@Nonnull
                                               Component c)

Returns the background color of the given AWT or Swing Component.

Parameters:

c - the given Component.

Returns:

the background color of the given Component.

foregroundOf

@RunsInEDT
 @Nonnull
public Color foregroundOf(@Nonnull
                                               Component c)

Returns the foreground color of the given AWT or Swing Component.

Parameters:

c - the given Component.

Returns:

the foreground color of the given Component.