org.assertj.swing.fixture

Class JOptionPaneFixture

java.lang.Object

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

org.assertj.swing.fixture.AbstractContainerFixture<JOptionPaneFixture,JOptionPane,JOptionPaneDriver>

org.assertj.swing.fixture.JOptionPaneFixture

All Implemented Interfaces:

ComponentContainerFixture, MouseInputSimulationFixture<JOptionPaneFixture>

public class JOptionPaneFixture
extends AbstractContainerFixture<JOptionPaneFixture,JOptionPane,JOptionPaneDriver>

Supports functional testing of JOptionPanes.

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
JOptionPaneFixture(Robot robot) Creates a new JOptionPaneFixture.
JOptionPaneFixture(Robot robot, JOptionPane target) Creates a new JOptionPaneFixture.

Method Summary

Modifier and Type	Method and Description
JButtonFixture	buttonWithText(Pattern pattern) Finds and returns a fixture wrapping a button (this fixture's JOptionPane) matching the given text.
JButtonFixture	buttonWithText(String text) Finds and returns a fixture wrapping a button (this fixture's JOptionPane) matching the given text.
JButtonFixture	cancelButton() Returns a fixture wrapping the "Cancel" button in this fixture's JOptionPane.
protected JOptionPaneDriver	createDriver(Robot robot)
JButtonFixture	noButton() Returns a fixture wrapping the "No" button in this fixture's JOptionPane.
JButtonFixture	okButton() Returns a fixture wrapping the "OK" button in this fixture's JOptionPane.
JOptionPaneFixture	requireErrorMessage() Asserts that this fixture's JOptionPane is displaying an error message.
JOptionPaneFixture	requireInformationMessage() Asserts that this fixture's JOptionPane is displaying an information message.
JOptionPaneFixture	requireMessage(Object message) Asserts that the message of this fixture's JOptionPane matches the given value.
JOptionPaneFixture	requireMessage(Pattern pattern) Asserts that the message of this fixture's JOptionPane matches the given regular expression pattern.
JOptionPaneFixture	requireOptions(Object[] options) Asserts that this fixture's JOptionPane has the given options.
JOptionPaneFixture	requirePlainMessage() Asserts that this fixture's JOptionPane is displaying a plain message.
JOptionPaneFixture	requireQuestionMessage() Asserts that this fixture's JOptionPane is displaying a question.
JOptionPaneFixture	requireTitle(Pattern pattern) Asserts that the title of this fixture's JOptionPane matches the given regular expression pattern.
JOptionPaneFixture	requireTitle(String title) Asserts that the title of this fixture's JOptionPane matches the given value.
JOptionPaneFixture	requireWarningMessage() Asserts that this fixture's JOptionPane is displaying a warning message.
String	title()
JButtonFixture	yesButton() Returns a fixture wrapping the "Yes" button in this fixture's JOptionPane.

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

JOptionPaneFixture

public JOptionPaneFixture(@Nonnull
                          Robot robot)

Creates a new JOptionPaneFixture.

Parameters:

robot - finds a showing JOptionPane, which will be managed by this fixture.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a showing JOptionPane could not be found.

ComponentLookupException - if more than one showing JOptionPane is found.

JOptionPaneFixture

public JOptionPaneFixture(@Nonnull
                          Robot robot,
                          @Nonnull
                          JOptionPane target)

Creates a new JOptionPaneFixture.

Parameters:

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

target - the JOptionPane to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

IllegalArgumentException - if target is null.

Method Detail

createDriver

@Nonnull
protected JOptionPaneDriver createDriver(@Nonnull
                                                  Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JOptionPaneFixture,JOptionPane,JOptionPaneDriver>

title

@Nullable
public String title()

Returns:

the title of this fixture's JOptionPane.

okButton

@Nonnull
public JButtonFixture okButton()

Returns a fixture wrapping the "OK" button in this fixture's JOptionPane. This method is locale-independent and platform-independent.

Returns:

a fixture wrapping the "OK" button.

Throws:

ComponentLookupException - if the a "OK" button cannot be found.

cancelButton

@Nonnull
public JButtonFixture cancelButton()

Returns a fixture wrapping the "Cancel" button in this fixture's JOptionPane. This method is locale-independent and platform-independent.

Returns:

a fixture wrapping the "Cancel" button.

Throws:

ComponentLookupException - if the a "Cancel" button cannot be found.

yesButton

@Nonnull
public JButtonFixture yesButton()

Returns a fixture wrapping the "Yes" button in this fixture's JOptionPane. This method is locale-independent and platform-independent.

Returns:

a fixture wrapping the "Yes" button.

Throws:

ComponentLookupException - if the a "Yes" button cannot be found.

noButton

@Nonnull
public JButtonFixture noButton()

Returns a fixture wrapping the "No" button in this fixture's JOptionPane. This method is locale-independent and platform-independent.

Returns:

a fixture wrapping the "No" button.

Throws:

ComponentLookupException - if the a "No" button cannot be found.

buttonWithText

@Nonnull
public JButtonFixture buttonWithText(@Nullable
                                              String text)

Finds and returns a fixture wrapping a button (this fixture's JOptionPane) matching the given text.

Parameters:

text - the text of the button to find. It can be a regular expression.

Returns:

a fixture wrapping a button matching the given text.

Throws:

ComponentLookupException - if the a button with the given text cannot be found.

buttonWithText

@Nonnull
public JButtonFixture buttonWithText(@Nonnull
                                              Pattern pattern)

Finds and returns a fixture wrapping a button (this fixture's JOptionPane) matching the given text.

Parameters:

pattern - the regular expression pattern to match.

Returns:

a fixture wrapping a button matching the given regular expression pattern.

Throws:

NullPointerException - if the given regular expression pattern is null.

ComponentLookupException - if the a button with the given text cannot be found.

requireErrorMessage

@Nonnull
public JOptionPaneFixture requireErrorMessage()

Asserts that this fixture's JOptionPane is displaying an error message.

Returns:

this fixture.

requireInformationMessage

@Nonnull
public JOptionPaneFixture requireInformationMessage()

Asserts that this fixture's JOptionPane is displaying an information message.

Returns:

this fixture.

requireWarningMessage

@Nonnull
public JOptionPaneFixture requireWarningMessage()

Asserts that this fixture's JOptionPane is displaying a warning message.

Returns:

this fixture.

requireQuestionMessage

@Nonnull
public JOptionPaneFixture requireQuestionMessage()

Asserts that this fixture's JOptionPane is displaying a question.

Returns:

this fixture.

requirePlainMessage

@Nonnull
public JOptionPaneFixture requirePlainMessage()

Asserts that this fixture's JOptionPane is displaying a plain message.

Returns:

this fixture.

requireTitle

@Nonnull
public JOptionPaneFixture requireTitle(@Nullable
                                                String title)

Asserts that the title of this fixture's JOptionPane matches the given value.

Parameters:

title - the title to match. It can be a regular expression.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JOptionPaneFixture does not have the given title.

requireTitle

@Nonnull
public JOptionPaneFixture requireTitle(@Nonnull
                                                Pattern pattern)

Asserts that the title of this fixture's JOptionPane matches the given regular expression pattern.

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given regular expression is null.

AssertionError - if this fixture's JOptionPaneFixture does not have the given title.

requireMessage

@Nonnull
public JOptionPaneFixture requireMessage(@Nullable
                                                  Object message)

Asserts that the message of this fixture's JOptionPane matches the given value.

Parameters:

message - the message to verify. If it is a String, it can be specified as a regular expression.

Returns:

this fixture.

Throws:

AssertionError - if the message in this fixture's JOptionPaneFixture is not equal to or does not match the given message.

requireMessage

@Nonnull
public JOptionPaneFixture requireMessage(@Nonnull
                                                  Pattern pattern)

Asserts that the message of this fixture's JOptionPane matches the given regular expression pattern. If the message in the JOptionPane is not a String, this method will use the toString representation of such message.

Parameters:

pattern - the regular expression to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given regular expression pattern is null.

AssertionError - if the message in this fixture's JOptionPaneFixture does not match the given regular expression pattern.

requireOptions

@Nonnull
public JOptionPaneFixture requireOptions(@Nonnull
                                                  Object[] options)

Asserts that this fixture's JOptionPane has the given options.

Parameters:

options - the options to verify.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JOptionPaneFixture does not have the given options.