org.assertj.swing.fixture

Class JComboBoxFixture

java.lang.Object

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

org.assertj.swing.fixture.AbstractJComponentFixture<S,T,D>

org.assertj.swing.fixture.AbstractJPopupMenuInvokerFixture<JComboBoxFixture,JComboBox,JComboBoxDriver>

org.assertj.swing.fixture.JComboBoxFixture

All Implemented Interfaces:

EditableComponentFixture<JComboBoxFixture>, ItemGroupFixture<JComboBoxFixture>, JComponentFixture<JComboBoxFixture>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<JComboBoxFixture>

public class JComboBoxFixture
extends AbstractJPopupMenuInvokerFixture<JComboBoxFixture,JComboBox,JComboBoxDriver>
implements EditableComponentFixture<JComboBoxFixture>, ItemGroupFixture<JComboBoxFixture>

Supports functional testing of JComboBoxes.

The conversion between the values given in tests and the values being displayed by a JComboBox renderer is performed by a JComboBoxCellReader. This fixture uses a JComboBoxCellReader by default.

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
JComboBoxFixture(Robot robot, JComboBox target) Creates a new JComboBoxFixture.
JComboBoxFixture(Robot robot, String comboBoxName) Creates a new JComboBoxFixture.

Method Summary

Methods

Modifier and Type	Method and Description
JComboBoxFixture	clearSelection() Clears the selection in this fixture's JComboBox.
String[]	contents()
protected JComboBoxDriver	createDriver(Robot robot)
JComboBoxFixture	enterText(String text) Simulates a user entering the specified text in this fixture's JComboBox.
JList	list() Finds and returns the JList in the pop-up raised by this fixture's JComboBox.
void	replaceCellReader(JComboBoxCellReader cellReader)
JComboBoxFixture	replaceText(String text) Simulates a user entering the specified text in the JComboBox, replacing any text.
JComboBoxFixture	requireEditable() Asserts that this fixture's JComboBox is editable.
JComboBoxFixture	requireItemCount(int expected) Verifies that this fixture's JComboBox has the expected number of items
JComboBoxFixture	requireNoSelection() Verifies that this fixture's JComboBox does not have any selection.
JComboBoxFixture	requireNotEditable() Asserts that this fixture's JComboBox is not editable.
JComboBoxFixture	requireSelection(int index) Verifies that the index of the selected item in this fixture's JComboBox is equal to the given value.
JComboBoxFixture	requireSelection(Pattern pattern) Verifies that the String representation of the selected item in this fixture's JComboBox matches the given regular expression pattern.
JComboBoxFixture	requireSelection(String value) Verifies that the String representation of the selected item in this fixture's JComboBox matches the given text.
JComboBoxFixture	selectAllText() Simulates a user selecting the text in the JComboBox.
String	selectedItem() Returns the selected value of this fixture's JComboBox as plain text.
JComboBoxFixture	selectItem(int index) Simulates a user selecting an item in this fixture's JComboBox.
JComboBoxFixture	selectItem(Pattern pattern) Simulates a user selecting an item in this fixture's JComboBox.
JComboBoxFixture	selectItem(String text) Simulates a user selecting an item in this fixture's JComboBox.
String	valueAt(int index) Returns the String representation of the value of an item in this fixture's JComboBox, using this fixture's JComboBoxCellReader.

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

showPopupMenu, showPopupMenuAt

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

clientProperty, requireToolTip, requireToolTip

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JComboBoxFixture

public JComboBoxFixture(@Nonnull
                Robot robot,
                @Nonnull
                JComboBox target)

Creates a new JComboBoxFixture.

Parameters:

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

target - the JComboBox to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

JComboBoxFixture

public JComboBoxFixture(@Nonnull
                Robot robot,
                @Nullable
                String comboBoxName)

Creates a new JComboBoxFixture.

Parameters:

robot - performs simulation of user events on a JComboBox.

comboBoxName - the name of the JComboBox to find using the given Robot.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a matching JComboBox could not be found.

ComponentLookupException - if more than one matching JComboBox is found.

Method Detail

createDriver

@Nonnull
protected JComboBoxDriver createDriver(@Nonnull
                                   Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JComboBoxFixture,JComboBox,JComboBoxDriver>

contents

@Nonnull
public String[] contents()

Specified by:

contents in interface ItemGroupFixture<JComboBoxFixture>

Returns:

the String representation of the elements in this fixture's JComboBox, using this fixture's JComboBoxCellReader.

See Also:

replaceCellReader(JComboBoxCellReader)

clearSelection

@Nonnull
public JComboBoxFixture clearSelection()

Clears the selection in this fixture's JComboBox. Since this method does not simulate user input, it does not verifies that this fixture's JComboBox is enabled and showing.

Specified by:

clearSelection in interface ItemGroupFixture<JComboBoxFixture>

Returns:

this fixture.

selectItem

@Nonnull
public JComboBoxFixture selectItem(int index)

Simulates a user selecting an item in this fixture's JComboBox.

Specified by:

selectItem in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

index - the index of the item to select.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JComboBox is disabled.

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

IndexOutOfBoundsException - if the given index is negative or greater than the index of the last item in the JComboBox.

selectItem

@Nonnull
public JComboBoxFixture selectItem(@Nullable
                                  String text)

Simulates a user selecting an item in this fixture's JComboBox. The text of the item to select must match the given String. Such text is retrieved by this fixture's JComboBoxCellReader.

Specified by:

selectItem in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

text - the text of the item to select. It can be a regular expression.

Returns:

this fixture.

Throws:

LocationUnavailableException - if an element matching the given text cannot be found.

IllegalStateException - if this fixture's JComboBox is disabled.

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

See Also:

replaceCellReader(JComboBoxCellReader)

selectItem

@Nonnull
public JComboBoxFixture selectItem(@Nonnull
                                  Pattern pattern)

Simulates a user selecting an item in this fixture's JComboBox. The text of the item to select must match the given regular expression pattern. Such text is retrieved by this fixture's JComboBoxCellReader.

Specified by:

selectItem in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

LocationUnavailableException - if an element matching the given pattern cannot be found.

IllegalStateException - if this fixture's JComboBox is disabled.

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

NullPointerException - if the given regular expression pattern is null.

See Also:

replaceCellReader(JComboBoxCellReader)

valueAt

@Nullable
public String valueAt(int index)

Returns the String representation of the value of an item in this fixture's JComboBox, using this fixture's JComboBoxCellReader.

Specified by:

valueAt in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

index - the index of the item to return.

Returns:

the String representation of the value of an item in this fixture's JComboBox.

Throws:

IndexOutOfBoundsException - if the given index is negative or greater than the index of the last item in the JComboBox.

See Also:

replaceCellReader(JComboBoxCellReader)

requireSelection

@Nonnull
public JComboBoxFixture requireSelection(@Nullable
                                        String value)

Verifies that the String representation of the selected item in this fixture's JComboBox matches the given text.

Specified by:

requireSelection in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

value - the text to match. It can be a regular expression.

Returns:

this fixture.

Throws:

AssertionError - if the selected item does not match the given text.

See Also:

replaceCellReader(JComboBoxCellReader)

requireSelection

@Nonnull
public JComboBoxFixture requireSelection(@Nonnull
                                        Pattern pattern)

Verifies that the String representation of the selected item in this fixture's JComboBox matches the given regular expression pattern.

Specified by:

requireSelection in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given regular expression pattern is null.

AssertionError - if the selected item does not match the given regular expression pattern.

See Also:

replaceCellReader(JComboBoxCellReader)

requireSelection

@Nonnull
public JComboBoxFixture requireSelection(int index)

Verifies that the index of the selected item in this fixture's JComboBox is equal to the given value.

Specified by:

requireSelection in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

index - the expected selection index.

Returns:

this fixture.

Throws:

AssertionError - if the selected index is not equal to the given one.

requireNoSelection

@Nonnull
public JComboBoxFixture requireNoSelection()

Verifies that this fixture's JComboBox does not have any selection.

Specified by:

requireNoSelection in interface ItemGroupFixture<JComboBoxFixture>

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JComboBox has a selection.

requireItemCount

@Nonnull
public JComboBoxFixture requireItemCount(int expected)

Verifies that this fixture's JComboBox has the expected number of items

Specified by:

requireItemCount in interface ItemGroupFixture<JComboBoxFixture>

Parameters:

expected - the expected number of items.

Returns:

this fixture.

Throws:

AssertionError - if the number of items in this fixture's JComboBox is not equal to the expected one.

selectedItem

@Nullable
public String selectedItem()

Returns the selected value of this fixture's JComboBox as plain text. This method returns null if the {code JComboBox} does not have any selection.

Returns:

the selected value of this fixture's {code JComboBox} as plain text, or null if the {code JComboBox} does not have any selection.

requireEditable

@Nonnull
public JComboBoxFixture requireEditable()

Asserts that this fixture's JComboBox is editable.

Specified by:

requireEditable in interface EditableComponentFixture<JComboBoxFixture>

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JComboBox is not editable.

requireNotEditable

@Nonnull
public JComboBoxFixture requireNotEditable()

Asserts that this fixture's JComboBox is not editable.

Specified by:

requireNotEditable in interface EditableComponentFixture<JComboBoxFixture>

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JComboBox is editable.

replaceText

@Nonnull
public JComboBoxFixture replaceText(@Nonnull
                                   String text)

Simulates a user entering the specified text in the JComboBox, replacing any text. This action is executed only if the JComboBox is editable.

Parameters:

text - the text to enter.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JComboBox is disabled.

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

IllegalStateException - if this fixture's JComboBox is not editable.

selectAllText

@Nonnull
public JComboBoxFixture selectAllText()

Simulates a user selecting the text in the JComboBox. This action is executed only if the JComboBox is editable.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JComboBox is disabled.

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

IllegalStateException - if this fixture's JComboBox is not editable.

enterText

@Nonnull
public JComboBoxFixture enterText(@Nonnull
                                 String text)

Simulates a user entering the specified text in this fixture's JComboBox. This action is executed only if the JComboBox is editable.

Parameters:

text - the text to enter.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JComboBox is disabled.

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

IllegalStateException - if this fixture's JComboBox is not editable.

ActionFailedException - if this fixture's JComboBox does not have an editor.

list

@Nonnull
public JList list()

Finds and returns the JList in the pop-up raised by this fixture's JComboBox.

Returns:

the JList in the pop-up raised by this fixture's JComboBox.

Throws:

ComponentLookupException - if the JList in the pop-up could not be found.

replaceCellReader

public void replaceCellReader(@Nonnull
                     JComboBoxCellReader cellReader)