org.assertj.swing.fixture

Class AbstractWindowFixture<S,C extends Window,D extends WindowDriver>

java.lang.Object

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

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

org.assertj.swing.fixture.AbstractWindowFixture<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 Container that this fixture can manage.

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

All Implemented Interfaces:

ComponentContainerFixture, JPopupMenuInvokerFixture, MouseInputSimulationFixture<S>, WindowLikeContainerFixture<S>

Direct Known Subclasses:

DialogFixture, FrameFixture

public abstract class AbstractWindowFixture<S,C extends Window,D extends WindowDriver>
extends AbstractContainerFixture<S,C,D>
implements WindowLikeContainerFixture<S>, JPopupMenuInvokerFixture

Supports functional testing of Window.

Author:

Alex Ruiz

Field Summary

Fields inherited from class org.assertj.swing.fixture.AbstractComponentFixture

BACKGROUND_PROPERTY, FONT_PROPERTY, FOREGROUND_PROPERTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Cleans up any used resources (keyboard, mouse, open windows and ScreenLock) used by this robot.
void	close() Simulates a user closing this fixture's Window.
S	moveTo(Point p) Simulates a user moving this fixture's Window to the given point.
S	moveToBack() If the given Window is visible, sends it to the back and may cause it to lose focus or activation if it is the focused or active.
S	moveToFront() If fixture's Window is visible, brings it to the front and may make it the focused one.
S	requireSize(Dimension size) Asserts that the size of this fixture's Window is equal to given one.
S	resizeHeightTo(int height) Simulates a user resizing vertically this fixture's Window.
S	resizeTo(Dimension size) Simulates a user resizing this fixture's Window.
S	resizeWidthTo(int width) Simulates a user resizing horizontally this fixture's Window.
S	show() Shows this fixture's Window.
S	show(Dimension size) Shows this fixture's Window, resized to the given size.
JPopupMenuFixture	showPopupMenu() Shows a pop-up menu using this fixture's Window as the invoker of the pop-up menu.
JPopupMenuFixture	showPopupMenuAt(Point p) Shows a pop-up menu at the given point using this fixture's Window as the invoker of the pop-up menu.

Methods inherited from class org.assertj.swing.fixture.AbstractContainerFixture

button, button, button, checkBox, checkBox, checkBox, comboBox, comboBox, comboBox, defaultDialogLookupTimeout, dialog, dialog, dialog, dialog, dialog, dialog, fileChooser, fileChooser, fileChooser, fileChooser, fileChooser, fileChooser, find, findByName, findByType, finder, internalFrame, internalFrame, internalFrame, label, label, label, list, list, list, menuItem, menuItem, menuItemWithPath, optionPane, optionPane, panel, panel, panel, progressBar, progressBar, progressBar, radioButton, radioButton, radioButton, scrollBar, scrollBar, scrollBar, scrollPane, scrollPane, scrollPane, slider, slider, slider, spinner, spinner, spinner, splitPane, splitPane, splitPane, tabbedPane, tabbedPane, tabbedPane, table, table, table, textBox, textBox, textBox, toggleButton, toggleButton, toggleButton, toolBar, toolBar, toolBar, tree, tree, tree, with

Methods inherited from class org.assertj.swing.fixture.AbstractComponentFixture

background, click, click, click, createDriver, doubleClick, driver, drop, equals, focus, font, foreground, hashCode, isEnabled, myself, pressAndReleaseKey, pressAndReleaseKeys, pressKey, pressKeyWhileRunning, releaseKey, replaceDriverWith, requireDisabled, requireEnabled, requireEnabled, requireFocused, requireNotVisible, requireShowing, requireVisible, rightClick, robot, target, targetCastedTo

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWindowFixture

public AbstractWindowFixture(@Nonnull
                             Class<S> selfType,
                             @Nonnull
                             Class<? extends C> type)

Creates a new AbstractWindowFixture. This constructor creates a new Robot containing the current AWT hierarchy.

Parameters:

selfType - the "self type."

type - the type of Window to find using the created Robot.

Throws:

NullPointerException - if the given Window type is null.

ComponentLookupException - if a Window having a matching type could not be found.

ComponentLookupException - if more than one Window having a matching type is found.

See Also:

BasicRobot.robotWithCurrentAwtHierarchy()

AbstractWindowFixture

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

Creates a new AbstractWindowFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on a Window.

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

Throws:

NullPointerException - if the given robot is null.

NullPointerException - if the given Window type is null.

ComponentLookupException - if a Window having a matching type could not be found.

ComponentLookupException - if more than one Window having a matching type is found.

AbstractWindowFixture

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

Creates a new AbstractWindowFixture. This constructor creates a new Robot containing the current AWT hierarchy.

Parameters:

selfType - the "self type."

name - the name of the Window to find.

type - the type of Window to find using the created Robot.

Throws:

NullPointerException - if the given Window type is null.

ComponentLookupException - if a Window having a matching name could not be found.

ComponentLookupException - if more than one Window having a matching name is found.

See Also:

BasicRobot.robotWithCurrentAwtHierarchy()

AbstractWindowFixture

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

Creates a new AbstractWindowFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on a Window.

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

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

Throws:

NullPointerException - if the given robot is null.

NullPointerException - if the given Window type is null.

ComponentLookupException - if a Window having a matching name could not be found.

ComponentLookupException - if more than one Window having a matching name is found.

AbstractWindowFixture

public AbstractWindowFixture(@Nonnull
                             Class<S> selfType,
                             @Nonnull
                             C target)

Creates a new AbstractWindowFixture. This constructor creates a new Robot containing the current AWT hierarchy.

Parameters:

selfType - the "self type."

target - the Window to be managed by this fixture.

Throws:

NullPointerException - if the given target Window is null.

AbstractWindowFixture

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

Creates a new AbstractWindowFixture.

Parameters:

selfType - the "self type."

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

target - the Window to be managed by this fixture.

Throws:

NullPointerException - if the given robot is null.

NullPointerException - if the given target Window is null.

Method Detail

moveTo

@Nonnull
public final S moveTo(@Nonnull
                               Point p)

Simulates a user moving this fixture's Window to the given point.

Specified by:

moveTo in interface WindowLikeContainerFixture<S>

Parameters:

p - the point to move this fixture's Window to.

Returns:

this fixture.

Throws:

ActionFailedException - if the Window is not movable.

ActionFailedException - if the given Window is not showing on the screen.

moveToFront

@Nonnull
public final S moveToFront()

If fixture's Window is visible, brings it to the front and may make it the focused one.

Specified by:

moveToFront in interface WindowLikeContainerFixture<S>

Returns:

this fixture.

moveToBack

@Nonnull
public final S moveToBack()

If the given Window is visible, sends it to the back and may cause it to lose focus or activation if it is the focused or active.

Specified by:

moveToBack in interface WindowLikeContainerFixture<S>

Returns:

this fixture.

requireSize

@Nonnull
public final S requireSize(@Nonnull
                                    Dimension size)

Asserts that the size of this fixture's Window is equal to given one.

Specified by:

requireSize in interface WindowLikeContainerFixture<S>

Parameters:

size - the given size to match.

Returns:

this fixture.

Throws:

AssertionError - if the size of this fixture's Window is not equal to the given size.

resizeHeightTo

@Nonnull
public final S resizeHeightTo(int height)

Simulates a user resizing vertically this fixture's Window.

Specified by:

resizeHeightTo in interface WindowLikeContainerFixture<S>

Parameters:

height - the height that this fixture's Window should have after being resized.

Returns:

this fixture.

Throws:

ActionFailedException - if the Window is not resizable.

resizeTo

@Nonnull
public final S resizeTo(@Nonnull
                                 Dimension size)

Simulates a user resizing this fixture's Window.

Specified by:

resizeTo in interface WindowLikeContainerFixture<S>

Parameters:

size - the size that the target window should have after being resized.

Returns:

this fixture.

Throws:

ActionFailedException - if the Window is not resizable.

resizeWidthTo

@Nonnull
public final S resizeWidthTo(int width)

Simulates a user resizing horizontally this fixture's Window.

Specified by:

resizeWidthTo in interface WindowLikeContainerFixture<S>

Parameters:

width - the width that this fixture's Window should have after being resized.

Returns:

this fixture.

Throws:

ActionFailedException - if the Window is not resizable.

show

@Nonnull
public final S show()

Shows this fixture's Window.

Returns:

this fixture.

show

@Nonnull
public final S show(@Nonnull
                             Dimension size)

Shows this fixture's Window, resized to the given size.

Parameters:

size - the size to resize this fixture's Window to.

Returns:

this fixture.

showPopupMenu

@Nonnull
public final JPopupMenuFixture showPopupMenu()

Shows a pop-up menu using this fixture's Window as the invoker of the pop-up menu.

Specified by:

showPopupMenu in interface JPopupMenuInvokerFixture

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

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

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

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

showPopupMenuAt

@Nonnull
public final JPopupMenuFixture showPopupMenuAt(@Nonnull
                                                        Point p)

Shows a pop-up menu at the given point using this fixture's Window as the invoker of the pop-up menu.

Specified by:

showPopupMenuAt in interface JPopupMenuInvokerFixture

Parameters:

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

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

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

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

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

close

public final void close()

Simulates a user closing this fixture's Window.

Specified by:

close in interface WindowLikeContainerFixture<S>

cleanUp

public final void cleanUp()

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