org.assertj.swing.fixture

Class AbstractComponentFixture<S,C extends Component,D extends ComponentDriver>

java.lang.Object

org.assertj.swing.fixture.AbstractComponentFixture<S,C,D>

Type Parameters:

S - used to simulate "self types." For more information please read "Emulating 'self types' using Java Generics to simplify fluent API implementation."

C - the type of Component that this fixture can manage.

D - the type of ComponentDriver that this fixture uses internally.

All Implemented Interfaces:

MouseInputSimulationFixture<S>

Direct Known Subclasses:

AbstractContainerFixture, AbstractJComponentFixture

public abstract class AbstractComponentFixture<S,C extends Component,D extends ComponentDriver>
extends Object
implements MouseInputSimulationFixture<S>

Supports functional testing of AWT and Swing Components.

Author:

Alex Ruiz, Yvonne Wang

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BACKGROUND_PROPERTY Name of the property "background".
protected static String	FONT_PROPERTY Name of the property "font".
protected static String	FOREGROUND_PROPERTY Name of the property "foreground".

Constructor Summary

Constructors

Constructor and Description
AbstractComponentFixture(Class<S> selfType, Robot robot, C target) Creates a new AbstractComponentFixture.
AbstractComponentFixture(Class<S> selfType, Robot robot, Class<? extends C> type) Creates a new AbstractComponentFixture.
AbstractComponentFixture(Class<S> selfType, Robot robot, String name, Class<? extends C> type) Creates a new AbstractComponentFixture.

Method Summary

Modifier and Type	Method and Description
ColorFixture	background()
S	click() Simulates a user clicking this fixture's Component.
S	click(MouseButton button) Simulates a user clicking this fixture's Component.
S	click(MouseClickInfo mouseClickInfo) Simulates a user clicking this fixture's Component.
protected abstract D	createDriver(Robot robot)
S	doubleClick() Simulates a user double-clicking this fixture's Component.
protected D	driver()
S	drop() Simulates a user dropping an item to this fixture's Component.
boolean	equals(Object obj)
S	focus() Gives input focus to this fixture's Component.
FontFixture	font()
ColorFixture	foreground()
int	hashCode()
boolean	isEnabled() Indicates whether this fixture's Component is enabled.
protected S	myself()
S	pressAndReleaseKey(KeyPressInfo keyPressInfo) Simulates a user pressing given key with the given modifiers on this fixture's Component.
S	pressAndReleaseKeys(int... keyCodes) Simulates a user pressing and releasing the given keys on this fixture's Component.
S	pressKey(int keyCode) Simulates a user pressing the given key on this fixture's Component.
S	pressKeyWhileRunning(int keyCode, Runnable runnable) Simulates a user pressing the given key on this fixture's Component, running the given runnable and releasing the key again.
S	releaseKey(int keyCode) Simulates a user releasing the given key on this fixture's Component.
void	replaceDriverWith(D driver)
S	requireDisabled() Asserts that this fixture's Component is disabled.
S	requireEnabled() Asserts that this fixture's Component is enabled.
S	requireEnabled(Timeout timeout) Asserts that this fixture's Component is enabled.
S	requireFocused() Asserts that this fixture's Component has input focus.
S	requireNotVisible() Asserts that this fixture's Component is not visible.
protected boolean	requireShowing() Returns whether showing components are the only ones participating in a component lookup.
S	requireVisible() Asserts that this fixture's Component is visible.
S	rightClick() Simulates a user right-clicking this fixture's Component.
Robot	robot()
C	target() Returns the GUI component in this fixture.
<T extends C> T	targetCastedTo(Class<T> type) Returns this fixture's Component casted to the given sub-type.

Methods inherited from class java.lang.Object

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

Field Detail

FONT_PROPERTY

protected static final String FONT_PROPERTY

Name of the property "font".

See Also:

Constant Field Values

BACKGROUND_PROPERTY

protected static final String BACKGROUND_PROPERTY

Name of the property "background".

See Also:

Constant Field Values

FOREGROUND_PROPERTY

protected static final String FOREGROUND_PROPERTY

Name of the property "foreground".

See Also:

Constant Field Values

Constructor Detail

AbstractComponentFixture

public AbstractComponentFixture(@Nonnull
                                Class<S> selfType,
                                @Nonnull
                                Robot robot,
                                @Nonnull
                                Class<? extends C> type)

Creates a new AbstractComponentFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on a Component.

type - the type of the Component to find using the given Robot.

Throws:

NullPointerException - if robot is null.

NullPointerException - if type is null.

ComponentLookupException - if a matching component could not be found.

ComponentLookupException - if more than one matching component is found.

AbstractComponentFixture

public AbstractComponentFixture(@Nonnull
                                Class<S> selfType,
                                @Nonnull
                                Robot robot,
                                @Nullable
                                String name,
                                @Nonnull
                                Class<? extends C> type)

Creates a new AbstractComponentFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on a Component.

name - the name of the Component to find using the given Robot.

type - the type of the Component to find using the given Robot.

Throws:

NullPointerException - if robot is null.

NullPointerException - if type is null.

ComponentLookupException - if a matching component could not be found.

ComponentLookupException - if more than one matching component is found.

AbstractComponentFixture

public AbstractComponentFixture(@Nonnull
                                Class<S> selfType,
                                @Nonnull
                                Robot robot,
                                @Nonnull
                                C target)

Creates a new AbstractComponentFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on the given Component.

target - the Component to be managed by this fixture.

Throws:

NullPointerException - if selfType is null.

NullPointerException - if robot is null.

NullPointerException - if target is null.

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

createDriver

@Nonnull
protected abstract D createDriver(@Nonnull
                                           Robot robot)

driver

@Nonnull
protected final D driver()

replaceDriverWith

public final void replaceDriverWith(@Nonnull
                                    D driver)

click

@Nonnull
public final S click()

Simulates a user clicking this fixture's Component.

Specified by:

click in interface MouseInputSimulationFixture<S>

Returns:

this fixture.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

click

@Nonnull
public final S click(@Nonnull
                              MouseButton button)

Simulates a user clicking this fixture's Component.

Specified by:

click in interface MouseInputSimulationFixture<S>

Parameters:

button - the button to click.

Returns:

this fixture.

Throws:

NullPointerException - if the given MouseButton is null.

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

click

@Nonnull
public final S click(@Nonnull
                              MouseClickInfo mouseClickInfo)

Simulates a user clicking this fixture's Component.

Specified by:

click in interface MouseInputSimulationFixture<S>

Parameters:

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

Returns:

this fixture.

Throws:

NullPointerException - if the given MouseClickInfo is null.

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

doubleClick

@Nonnull
public final S doubleClick()

Simulates a user double-clicking this fixture's Component.

Specified by:

doubleClick in interface MouseInputSimulationFixture<S>

Returns:

this fixture.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

drop

@Nonnull
public final S drop()

Simulates a user dropping an item to this fixture's Component.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

ActionFailedException - if there is no drag action in effect.

rightClick

@Nonnull
public final S rightClick()

Simulates a user right-clicking this fixture's Component.

Specified by:

rightClick in interface MouseInputSimulationFixture<S>

Returns:

this fixture.

Throws:

IllegalStateException - if Settings.clickOnDisabledComponentsAllowed() is false and this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

focus

@Nonnull
public final S focus()

Gives input focus to this fixture's Component.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

pressAndReleaseKey

@Nonnull
public final S pressAndReleaseKey(@Nonnull
                                           KeyPressInfo keyPressInfo)

Simulates a user pressing given key with the given modifiers on this fixture's Component. Modifiers is a mask from the available AWT InputEvent masks.

Parameters:

keyPressInfo - specifies the key and modifiers to press.

Returns:

this fixture.

Throws:

NullPointerException - if the given KeyPressInfo is null.

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

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

See Also:

KeyPressInfo

pressAndReleaseKeys

@Nonnull
public final S pressAndReleaseKeys(@Nonnull
                                            int... keyCodes)

Simulates a user pressing and releasing the given keys on this fixture's Component.

Parameters:

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

Returns:

this fixture.

Throws:

NullPointerException - if the given array of codes is null.

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

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

See Also:

KeyEvent

pressKey

@Nonnull
public final S pressKey(int keyCode)

Simulates a user pressing the given key on this fixture's Component.

Parameters:

keyCode - the code of the key to press.

Returns:

this fixture.

Throws:

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

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

See Also:

pressKeyWhileRunning(int, Runnable), KeyEvent

pressKeyWhileRunning

@Nonnull
public final S pressKeyWhileRunning(int keyCode,
                                             @Nonnull
                                             Runnable runnable)

Simulates a user pressing the given key on this fixture's Component, running the given runnable and releasing the key again.

Parameters:

keyCode - the code of the key to press.

runnable - the Runnable to run while the key is pressed

Returns:

this fixture.

Throws:

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

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

See Also:

pressKey(int), KeyEvent

releaseKey

@Nonnull
public final S releaseKey(int keyCode)

Simulates a user releasing the given key on this fixture's Component.

Parameters:

keyCode - the code of the key to release.

Returns:

this fixture.

Throws:

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

IllegalStateException - if this fixture's Component is disabled.

IllegalStateException - if this fixture's Component is not showing on the screen.

See Also:

KeyEvent

requireFocused

@Nonnull
public final S requireFocused()

Asserts that this fixture's Component has input focus.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's Component does not have input focus.

requireEnabled

@Nonnull
public final S requireEnabled()

Asserts that this fixture's Component is enabled.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's Component is disabled.

requireEnabled

@Nonnull
public final S requireEnabled(@Nonnull
                                       Timeout timeout)

Asserts that this fixture's Component is enabled.

Parameters:

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

Returns:

this fixture.

Throws:

WaitTimedOutError - if this fixture's Component is never enabled.

requireDisabled

@Nonnull
public final S requireDisabled()

Asserts that this fixture's Component is disabled.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's Component is enabled.

requireVisible

@Nonnull
public final S requireVisible()

Asserts that this fixture's Component is visible.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's Component is not visible.

requireNotVisible

@Nonnull
public final S requireNotVisible()

Asserts that this fixture's Component is not visible.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's Component is visible.

requireShowing

protected boolean requireShowing()

Returns whether showing components are the only ones participating in a component lookup. The returned value is obtained from the component lookup scope stored in this fixture's Robot.

Returns:

true if only showing components can participate in a component lookup, false otherwise.

font

@Nonnull
public final FontFixture font()

Returns:

a fixture that checks properties of the font of this fixture's Component.

background

@Nonnull
public final ColorFixture background()

Returns:

a fixture that checks properties of the background color of this fixture's Component.

foreground

@Nonnull
public final ColorFixture foreground()

Returns:

a fixture that checks properties of the foreground color of this fixture's Component.

isEnabled

public final boolean isEnabled()

Indicates whether this fixture's Component is enabled.

Returns:

true if this fixture's Component is enabled; false otherwise.

targetCastedTo

@Nonnull
public final <T extends C> T targetCastedTo(@Nonnull
                                                     Class<T> type)

Returns this fixture's Component casted to the given sub-type.

Type Parameters:

T - the type that the managed Component will be casted to.

Parameters:

type - the class for the type of component.

Returns:

this fixture's Component casted to the given sub-type.

Throws:

AssertionError - if this fixture's Component is not an instance of the given type.

target

@Nonnull
public final C target()

Returns the GUI component in this fixture.

Note: Access to the GUI component returned by this method must be executed in the event dispatch thread (EDT). To do so, please execute a GuiQuery or GuiTask (depending on what you need to do), inside a GuiActionRunner. To learn more about Swing threading, please read the Swing Threading Policy.

Returns:

the GUI component in this fixture.

robot

@Nonnull
public final Robot robot()

Returns:

the Robot that simulates user events on target().

myself

@Nonnull
protected final S myself()

Returns:

this casted to the "self type".