org.assertj.swing.fixture

Class AbstractSwingContainerFixture<S,C extends JComponent,D extends JComponentDriver>

java.lang.Object

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

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

org.assertj.swing.fixture.AbstractSwingContainerFixture<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 JComponentDriver that this fixture uses internally.

All Implemented Interfaces:

ComponentContainerFixture, JComponentFixture<S>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<S>

Direct Known Subclasses:

JToolBarFixture

public abstract class AbstractSwingContainerFixture<S,C extends JComponent,D extends JComponentDriver>
extends AbstractContainerFixture<S,C,D>
implements JComponentFixture<S>, JPopupMenuInvokerFixture

Supports functional testing of Swing Containers.

Author:

Yvonne Wang, 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
AbstractSwingContainerFixture(Class<S> selfType, Robot robot, C target) Creates a new AbstractSwingContainerFixture.
AbstractSwingContainerFixture(Class<S> selfType, Robot robot, Class<? extends C> type) Creates a new AbstractSwingContainerFixture.
AbstractSwingContainerFixture(Class<S> selfType, Robot robot, String name, Class<? extends C> type) Creates a new AbstractSwingContainerFixture.

Method Summary

Modifier and Type	Method and Description
Object	clientProperty(Object key) Returns the client property stored in this fixture's JScrollPane, under the given key.
S	requireToolTip(Pattern pattern) Asserts that the toolTip in this fixture's JScrollPane matches the given regular expression pattern.
S	requireToolTip(String expected) Asserts that the toolTip in this fixture's JScrollPane matches the given value.
JPopupMenuFixture	showPopupMenu() Shows a pop-up menu using this fixture's JScrollPane 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 JScrollPane 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

AbstractSwingContainerFixture

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

Creates a new AbstractSwingContainerFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on a Container.

type - the type of the Container 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.

See Also:

ComponentFinder.findByType(Class)

AbstractSwingContainerFixture

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

Creates a new AbstractSwingContainerFixture.

Parameters:

selfType - the "self type."

robot - performs simulation of user events on a Container.

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

type - the type of the Container 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.

See Also:

ComponentFinder.findByName(String, Class)

AbstractSwingContainerFixture

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

Creates a new AbstractSwingContainerFixture.

Parameters:

selfType - the "self type."

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

target - the Container to be.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

Method Detail

requireToolTip

@Nonnull
public final S requireToolTip(@Nullable
                                       String expected)

Asserts that the toolTip in this fixture's JScrollPane matches the given value.

Specified by:

requireToolTip in interface JComponentFixture<S>

Parameters:

expected - the given value. It can be a regular expression.

Returns:

this fixture.

Throws:

AssertionError - if the toolTip in this fixture's JScrollPane does not match the given value.

requireToolTip

@Nonnull
public final S requireToolTip(@Nonnull
                                       Pattern pattern)

Asserts that the toolTip in this fixture's JScrollPane matches the given regular expression pattern.

Specified by:

requireToolTip in interface JComponentFixture<S>

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given regular expression pattern is null.

AssertionError - if the toolTip in this fixture's JScrollPane does not match the given regular expression.

clientProperty

@Nullable
public final Object clientProperty(@Nonnull
                                             Object key)

Returns the client property stored in this fixture's JScrollPane, under the given key.

Specified by:

clientProperty in interface JComponentFixture<S>

Parameters:

key - the key to use to retrieve the client property.

Returns:

the value of the client property stored under the given key, or null if the property was not found.

Throws:

NullPointerException - if the given key is null.

showPopupMenu

@Nonnull
public final JPopupMenuFixture showPopupMenu()

Shows a pop-up menu using this fixture's JScrollPane 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 JScrollPane is disabled.

IllegalStateException - if this fixture's JScrollPane 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 JScrollPane 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 JScrollPane is disabled.

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

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