org.assertj.swing.driver

Class JOptionPaneDriver

java.lang.Object

org.assertj.swing.driver.ComponentDriver

org.assertj.swing.driver.ContainerDriver

org.assertj.swing.driver.JComponentDriver

org.assertj.swing.driver.JOptionPaneDriver

@InternalApi
public class JOptionPaneDriver
extends JComponentDriver

Supports functional testing of JOptionPanes.

Note: This class is intended for internal use only. Please use the classes in the package org.assertj.swing.fixture in your tests.

Author:

Alex Ruiz

Field Summary

Fields inherited from class org.assertj.swing.driver.ComponentDriver

robot

Constructor Summary

Constructors

Constructor and Description
JOptionPaneDriver(Robot robot) Creates a new JOptionPaneDriver.

Method Summary

Methods

Modifier and Type	Method and Description
JButton	buttonWithText(JOptionPane optionPane, Pattern pattern) Finds a button in the JOptionPane whose text matches the given regular expression pattern.
JButton	buttonWithText(JOptionPane optionPane, String text) Finds a button in the JOptionPane containing the given text.
JButton	cancelButton(JOptionPane optionPane) Finds the "Cancel" button in the JOptionPane.
JButton	noButton(JOptionPane optionPane) Finds the "No" button in the JOptionPane.
JButton	okButton(JOptionPane optionPane) Finds the "OK" button in the JOptionPane.
void	requireErrorMessage(JOptionPane optionPane) Asserts that the JOptionPane is displaying an error message.
void	requireInformationMessage(JOptionPane optionPane) Asserts that the JOptionPane is displaying an information message.
void	requireMessage(JOptionPane optionPane, Object message) Asserts that the title of the JOptionPane matches the given value.
void	requireMessage(JOptionPane optionPane, Pattern pattern) Asserts that the title of the JOptionPane matches the given regular expression pattern.
void	requireOptions(JOptionPane optionPane, Object[] options) Asserts that the JOptionPane has the given options.
void	requirePlainMessage(JOptionPane optionPane) Asserts that the JOptionPane is displaying a plain message.
void	requireQuestionMessage(JOptionPane optionPane) Asserts that the JOptionPane is displaying a question.
void	requireTitle(JOptionPane optionPane, Pattern pattern) Asserts that the title in the given JOptionPane matches the given regular expression pattern.
void	requireTitle(JOptionPane optionPane, String title) Asserts that the title in the given JOptionPane matches the given value.
void	requireWarningMessage(JOptionPane optionPane) Asserts that the JOptionPane is displaying a warning message.
String	title(JOptionPane optionPane) Returns the title of the given JOptionPane.
JButton	yesButton(JOptionPane optionPane) Finds the "Yes" button in the JOptionPane.

Methods inherited from class org.assertj.swing.driver.JComponentDriver

clientProperty, invokeAction, isVisible, isVisible, requireToolTip, requireToolTip, scrollToVisible

Methods inherited from class org.assertj.swing.driver.ContainerDriver

doResizeHeight, doResizeWidth, isResizable, move, resize

Methods inherited from class org.assertj.swing.driver.ComponentDriver

backgroundOf, checkInEdtEnabledAndShowing, click, click, click, click, click, doubleClick, drag, dragOver, drop, focus, focusAndWaitForFocusGain, fontOf, foregroundOf, invokePopupMenu, invokePopupMenu, moveMouseIgnoringAnyError, moveMouseIgnoringAnyError, performAccessibleActionOf, pressAndReleaseKey, pressAndReleaseKey, pressAndReleaseKeys, pressKey, propertyName, releaseKey, requireDisabled, requireEnabled, requireEnabled, requireFocused, requireNotVisible, requireSize, requireVisible, rightClick, settings, waitForShowing

Methods inherited from class java.lang.Object

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

Constructor Detail

JOptionPaneDriver

public JOptionPaneDriver(@Nonnull
                 Robot robot)

Creates a new JOptionPaneDriver.

Parameters:

robot - the robot to use to simulate user input.

Method Detail

requireTitle

@RunsInEDT
public void requireTitle(@Nonnull
                          JOptionPane optionPane,
                          @Nullable
                          String title)

Asserts that the title in the given JOptionPane matches the given value.

Parameters:

optionPane - the target JOptionPane.

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

Throws:

AssertionError - if the JOptionPane does not have the given title.

requireTitle

@RunsInEDT
public void requireTitle(@Nonnull
                          JOptionPane optionPane,
                          @Nonnull
                          Pattern pattern)

Asserts that the title in the given JOptionPane matches the given regular expression pattern.

Parameters:

optionPane - the target JOptionPane.

pattern - the regular expression pattern to match.

Throws:

NullPointerException - if the given regular expression pattern is null.

AssertionError - if the JOptionPane does not have the given title.

title

@RunsInEDT
@Nullable
public String title(@Nonnull
                              JOptionPane optionPane)

Returns the title of the given JOptionPane.

Parameters:

optionPane - the target JOptionPane.

Returns:

the title of the given JOptionPane.

requireMessage

@RunsInEDT
public void requireMessage(@Nonnull
                            JOptionPane optionPane,
                            @Nullable
                            Object message)

Asserts that the title of the JOptionPane matches the given value. If the given value is a regular expression and the message in the JOptionPane is not a String, this method will use the toString representation of such message. message in the JOptionPane is not a String, this method will use the toString representation of such message.

Parameters:

optionPane - the target JOptionPane.

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

Throws:

AssertionError - if the message in the JOptionPane is not equal to or does not match the given message.

requireMessage

@RunsInEDT
public void requireMessage(@Nonnull
                            JOptionPane optionPane,
                            @Nonnull
                            Pattern pattern)

Asserts that the title of the 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:

optionPane - the target JOptionPane.

pattern - the regular expression to match.

Throws:

NullPointerException - if the given regular expression pattern is null.

AssertionError - if the message in the JOptionPaneFixture does not match the given regular expression pattern.

requireOptions

@RunsInEDT
public void requireOptions(@Nonnull
                            JOptionPane optionPane,
                            @Nonnull
                            Object[] options)

Asserts that the JOptionPane has the given options.

Parameters:

optionPane - the target JOptionPane.

options - the options to verify.

Throws:

AssertionError - if the JOptionPane does not have the given options.

okButton

@RunsInEDT
@Nonnull
public JButton okButton(@Nonnull
                                 JOptionPane optionPane)

Finds the "OK" button in the JOptionPane. This method is independent of locale and platform.

Parameters:

optionPane - the target JOptionPane.

Returns:

the "OK" button.

Throws:

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

cancelButton

@RunsInEDT
@Nonnull
public JButton cancelButton(@Nonnull
                                     JOptionPane optionPane)

Finds the "Cancel" button in the JOptionPane. This method is independent of locale and platform.

Parameters:

optionPane - the target JOptionPane.

Returns:

the "Cancel" button.

Throws:

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

yesButton

@RunsInEDT
@Nonnull
public JButton yesButton(@Nonnull
                                  JOptionPane optionPane)

Finds the "Yes" button in the JOptionPane. This method is independent of locale and platform.

Parameters:

optionPane - the target JOptionPane.

Returns:

the "Yes" button.

Throws:

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

noButton

@RunsInEDT
@Nonnull
public JButton noButton(@Nonnull
                                 JOptionPane optionPane)

Finds the "No" button in the JOptionPane. This method is independent of locale and platform.

Parameters:

optionPane - the target JOptionPane.

Returns:

the "No" button.

Throws:

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

buttonWithText

@RunsInEDT
@Nonnull
public JButton buttonWithText(@Nonnull
                                       JOptionPane optionPane,
                                       @Nullable
                                       String text)

Finds a button in the JOptionPane containing the given text.

Parameters:

optionPane - the target JOptionPane.

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

Returns:

a button containing the given text.

Throws:

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

buttonWithText

@RunsInEDT
@Nonnull
public JButton buttonWithText(@Nonnull
                                       JOptionPane optionPane,
                                       @Nonnull
                                       Pattern pattern)

Finds a button in the JOptionPane whose text matches the given regular expression pattern.

Parameters:

optionPane - the target JOptionPane.

pattern - the regular expression pattern to match.

Returns:

a button containing the given text.

Throws:

NullPointerException - if the given regular expression pattern is null.

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

requireErrorMessage

@RunsInEDT
public void requireErrorMessage(@Nonnull
                                 JOptionPane optionPane)

Asserts that the JOptionPane is displaying an error message.

Parameters:

optionPane - the target JOptionPane.

requireInformationMessage

@RunsInEDT
public void requireInformationMessage(@Nonnull
                                       JOptionPane optionPane)

Asserts that the JOptionPane is displaying an information message.

Parameters:

optionPane - the target JOptionPane.

requireWarningMessage

@RunsInEDT
public void requireWarningMessage(@Nonnull
                                   JOptionPane optionPane)

Asserts that the JOptionPane is displaying a warning message.

Parameters:

optionPane - the target JOptionPane.

requireQuestionMessage

@RunsInEDT
public void requireQuestionMessage(@Nonnull
                                    JOptionPane optionPane)

Asserts that the JOptionPane is displaying a question.

Parameters:

optionPane - the target JOptionPane.

requirePlainMessage

@RunsInEDT
public void requirePlainMessage(@Nonnull
                                 JOptionPane optionPane)

Asserts that the JOptionPane is displaying a plain message.

Parameters:

optionPane - the target JOptionPane.