org.assertj.swing.fixture

Class JPanelFixture

java.lang.Object

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

org.assertj.swing.fixture.AbstractContainerFixture<JPanelFixture,JPanel,JComponentDriver>

org.assertj.swing.fixture.JPanelFixture

All Implemented Interfaces:

ComponentContainerFixture, JComponentFixture<JPanelFixture>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<JPanelFixture>

public class JPanelFixture
extends AbstractContainerFixture<JPanelFixture,JPanel,JComponentDriver>
implements JComponentFixture<JPanelFixture>, JPopupMenuInvokerFixture

Supports functional testing of JPanels.

Author:

Alex Ruiz, Yvonne Wang

Field Summary

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

BACKGROUND_PROPERTY, FONT_PROPERTY, FOREGROUND_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JPanelFixture(Robot robot, JPanel target) Creates a new JPanelFixture.
JPanelFixture(Robot robot, String panelName) Creates a new JPanelFixture.

Method Summary

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

JPanelFixture

public JPanelFixture(@Nonnull
                     Robot robot,
                     @Nonnull
                     String panelName)

Creates a new JPanelFixture.

Parameters:

robot - performs simulation of user events on a JPanel.

panelName - the name of the JPanel to find using the given Robot.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a matching JPanel could not be found.

ComponentLookupException - if more than one matching JPanel is found.

JPanelFixture

public JPanelFixture(@Nonnull
                     Robot robot,
                     @Nonnull
                     JPanel target)

Creates a new JPanelFixture.

Parameters:

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

target - the JPanel to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

Method Detail

createDriver

@Nonnull
protected JComponentDriver createDriver(@Nonnull
                                                 Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JPanelFixture,JPanel,JComponentDriver>

requireToolTip

@Nonnull
public JPanelFixture requireToolTip(@Nullable
                                             String expected)

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

Specified by:

requireToolTip in interface JComponentFixture<JPanelFixture>

Parameters:

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

Returns:

this fixture.

Throws:

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

requireToolTip

@Nonnull
public JPanelFixture requireToolTip(@Nonnull
                                             Pattern pattern)

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

Specified by:

requireToolTip in interface JComponentFixture<JPanelFixture>

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 JPanel does not match the given regular expression.

clientProperty

@Nullable
public Object clientProperty(@Nonnull
                                       Object key)

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

Specified by:

clientProperty in interface JComponentFixture<JPanelFixture>

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 JPopupMenuFixture showPopupMenu()

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

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

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

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(@Nonnull
                                                  Point p)

Shows a pop-up menu at the given point using this fixture's JPanel 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 JPanel is disabled.

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

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