org.assertj.swing.fixture

Class JListFixture

java.lang.Object

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

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

org.assertj.swing.fixture.AbstractJPopupMenuInvokerFixture<JListFixture,JList,JListDriver>

org.assertj.swing.fixture.JListFixture

All Implemented Interfaces:

ItemGroupFixture<JListFixture>, JComponentFixture<JListFixture>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<JListFixture>

public class JListFixture
extends AbstractJPopupMenuInvokerFixture<JListFixture,JList,JListDriver>
implements ItemGroupFixture<JListFixture>

Supports functional testing of JLists.

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

Author:

Alex Ruiz, Yvonne Wang, Fabien Barbero

Field Summary

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

BACKGROUND_PROPERTY, FONT_PROPERTY, FOREGROUND_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JListFixture(Robot robot, JList target) Creates a new JListFixture.
JListFixture(Robot robot, String listName) Creates a new JListFixture.

Method Summary

Methods

Modifier and Type	Method and Description
JListFixture	clearSelection() Clears the selection in this fixture's JList.
JListFixture	clickItem(int index) Simulates a user clicking an item in this fixture's JList.
JListFixture	clickItem(Pattern pattern) Simulates a user clicking an item in this fixture's JList.
JListFixture	clickItem(String text) Simulates a user clicking an item in this fixture's JList.
String[]	contents() Returns the String representation of the elements in this fixture's JList, using this fixture's JListCellReader.
protected JListDriver	createDriver(Robot robot)
JListFixture	drag(int index) Simulates a user dragging an item from this fixture's JList.
JListFixture	drag(Pattern pattern) Simulates a drag operation at the location of the first item in this fixture's JList matching the given regular expression pattern.
JListFixture	drag(String text) Simulates a drag operation at the location of the first item in this fixture's JList matching the given value.
JListFixture	drop(int index) Simulates a user dropping an item to this fixture's JList.
JListFixture	drop(Pattern pattern) Ends a drag operation at the location of the first item matching the given regular expression pattern.
JListFixture	drop(String text) Ends a drag operation at the location of the first item matching the given value.
JListItemFixture	item(int index) Returns a fixture that manages the list item specified by the given index.
JListItemFixture	item(Pattern pattern) Returns a fixture that manages the list item whose text matches the given regular expression pattern.
JListItemFixture	item(String text) Returns a fixture that manages the list item specified by the given text.
void	replaceCellReader(JListCellReader cellReader)
JListFixture	requireItemCount(int expected) Verifies that this fixture's JList has the expected number of items
JListFixture	requireNoSelection() Verifies that this fixture's JList does not have any selection.
JListFixture	requireSelectedItems(int... indices) Verifies that the given item indices are selected in this fixture's JList.
JListFixture	requireSelectedItems(Pattern[] patterns) Verifies that the String representations of the selected items in this fixture's JList match the given regular expression patterns.
JListFixture	requireSelectedItems(String... items) Verifies that the String representations of the selected items in this fixture's JList match the given text items.
JListFixture	requireSelection(int index) Verifies that the index of the selected item in this fixture's JList is equal to the given value.
JListFixture	requireSelection(Pattern pattern) Verifies that the String representation of the selected item in this fixture's JList matches the given regular expression pattern.
JListFixture	requireSelection(String text) Verifies that the String representation of the selected item in this fixture's JList matches the given text.
String[]	selection() Returns the String representation of the selected elements in this fixture's JList, using this fixture's JListCellReader.
JListFixture	selectItem(int index) Simulates a user selecting an item in this fixture's JList.
JListFixture	selectItem(Pattern pattern) Simulates a user selecting an item in this fixture's JList.
JListFixture	selectItem(String text) Simulates a user selecting an item in this fixture's JList.
JListFixture	selectItems(int... indices) Simulates a user selecting the specified items in this fixture's JList.
JListFixture	selectItems(Pattern... patterns) Simulates a user selecting the specified items in this fixture's JList.
JListFixture	selectItems(Range.From from, Range.To to) Simulates a user selecting the items (in the specified range) in this fixture's JList.
JListFixture	selectItems(String... items) Simulates a user selecting the specified items in this fixture's JList.
JPopupMenuFixture	showPopupMenuAt(int index) Shows a pop-up menu at the location of the specified item in this fixture's JList.
JPopupMenuFixture	showPopupMenuAt(Pattern pattern) Shows a pop-up menu at the location of the first item matching the given regular expression pattern in this fixture's JList.
JPopupMenuFixture	showPopupMenuAt(String text) Shows a pop-up menu at the location of the first item matching the given value in this fixture's JList.
String	valueAt(int index) Returns the String representation of the value of an item in this fixture's JList, using this fixture's JListCellReader.

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

JListFixture

public JListFixture(@Nonnull
            Robot robot,
            @Nullable
            String listName)

Creates a new JListFixture.

Parameters:

robot - performs simulation of user events on a JList.

listName - the name of the JList to find using the given Robot.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a matching JList could not be found.

ComponentLookupException - if more than one matching JList is found.

JListFixture

public JListFixture(@Nonnull
            Robot robot,
            @Nonnull
            JList target)

Creates a new JListFixture.

Parameters:

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

target - the JList to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

Method Detail

createDriver

@Nonnull
protected JListDriver createDriver(@Nonnull
                               Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JListFixture,JList,JListDriver>

valueAt

@Nullable
public String valueAt(int index)

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

Specified by:

valueAt in interface ItemGroupFixture<JListFixture>

Parameters:

index - the index of the item to return.

Returns:

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

Throws:

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

See Also:

replaceCellReader(JListCellReader)

contents

@Nonnull
public String[] contents()

Returns the String representation of the elements in this fixture's JList, using this fixture's JListCellReader.

Specified by:

contents in interface ItemGroupFixture<JListFixture>

Returns:

the String representation of the elements in this fixture's JList.

See Also:

replaceCellReader(JListCellReader)

selection

@Nonnull
public String[] selection()

Returns the String representation of the selected elements in this fixture's JList, using this fixture's JListCellReader.

Returns:

the String representation of the selected elements in this fixture's JList.

See Also:

replaceCellReader(JListCellReader)

item

@Nonnull
public JListItemFixture item(int index)

Returns a fixture that manages the list item specified by the given index.

Parameters:

index - of the item.

Returns:

a fixture that manages the list item specified by the given index.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

item

@Nonnull
public JListItemFixture item(@Nullable
                            String text)

Returns a fixture that manages the list item specified by the given text.

Parameters:

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

Returns:

a fixture that manages the list item specified by the given text.

Throws:

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

item

@Nonnull
public JListItemFixture item(@Nonnull
                            Pattern pattern)

Returns a fixture that manages the list item whose text matches the given regular expression pattern.

Parameters:

pattern - the regular expression pattern to match.

Returns:

a fixture that manages the list item whose text matches the given regular expression pattern.

Throws:

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

NullPointerException - if the given regular expression pattern is null.

clearSelection

@Nonnull
public JListFixture clearSelection()

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

Specified by:

clearSelection in interface ItemGroupFixture<JListFixture>

Returns:

this fixture.

selectItem

@Nonnull
public JListFixture selectItem(int index)

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

Specified by:

selectItem in interface ItemGroupFixture<JListFixture>

Parameters:

index - the index of the item to select.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

See Also:

item(int), JListItemFixture.select()

selectItem

@Nonnull
public JListFixture selectItem(@Nullable
                              String text)

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

Specified by:

selectItem in interface ItemGroupFixture<JListFixture>

Parameters:

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

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

See Also:

item(String), JListItemFixture.select(), replaceCellReader(JListCellReader)

selectItem

@Nonnull
public JListFixture selectItem(@Nonnull
                              Pattern pattern)

Simulates a user selecting an item in this fixture's JList. The value of the item to select must match the given regular expression pattern.

Specified by:

selectItem in interface ItemGroupFixture<JListFixture>

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

NullPointerException - if the given regular expression pattern is null.

See Also:

item(Pattern), JListItemFixture.select(), replaceCellReader(JListCellReader)

requireSelection

@Nonnull
public JListFixture requireSelection(@Nullable
                                    String text)

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

Specified by:

requireSelection in interface ItemGroupFixture<JListFixture>

Parameters:

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

Returns:

this fixture.

Throws:

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

See Also:

replaceCellReader(JListCellReader)

requireSelection

@Nonnull
public JListFixture requireSelection(@Nonnull
                                    Pattern pattern)

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

Specified by:

requireSelection in interface ItemGroupFixture<JListFixture>

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

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

NullPointerException - if the given regular expression pattern is null.

See Also:

replaceCellReader(JListCellReader)

requireSelection

@Nonnull
public JListFixture requireSelection(int index)

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

Specified by:

requireSelection in interface ItemGroupFixture<JListFixture>

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 JListFixture requireNoSelection()

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

Specified by:

requireNoSelection in interface ItemGroupFixture<JListFixture>

Returns:

this fixture.

Throws:

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

requireItemCount

@Nonnull
public JListFixture requireItemCount(int expected)

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

Specified by:

requireItemCount in interface ItemGroupFixture<JListFixture>

Parameters:

expected - the expected number of items.

Returns:

this fixture.

Throws:

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

selectItems

@Nonnull
public JListFixture selectItems(@Nonnull
                               Range.From from,
                               @Nonnull
                               Range.To to)

Simulates a user selecting the items (in the specified range) in this fixture's JList.

Parameters:

from - the starting point of the selection.

to - the last item to select (inclusive.)

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

IndexOutOfBoundsException - if the any index is negative or greater than the index of the last item in the JList.

selectItems

@Nonnull
public JListFixture selectItems(@Nonnull
                               int... indices)

Simulates a user selecting the specified items in this fixture's JList.

Parameters:

indices - the indices of the items to select.

Returns:

this fixture.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

IndexOutOfBoundsException - if any of the indices is negative or greater than the index of the last item in the JList.

IllegalStateException - if this fixture's JList is disabled.

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

selectItems

@Nonnull
public JListFixture selectItems(@Nonnull
                               String... items)

Simulates a user selecting the specified items in this fixture's JList. The items to select should match the given values.

Parameters:

items - the text of the items to select. Each String can be a regular expression.

Returns:

this fixture.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

IllegalStateException - if this fixture's JList is disabled.

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

LocationUnavailableException - if an element matching the any of the given values cannot be found.

See Also:

replaceCellReader(JListCellReader)

selectItems

@Nonnull
public JListFixture selectItems(@Nonnull
                               Pattern... patterns)

Simulates a user selecting the specified items in this fixture's JList. The items to select should select the given regular expression patterns.

Parameters:

patterns - the regular expression patterns to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given array is null.

NullPointerException - if any of the regular expression patterns is null.

IllegalArgumentException - if the given array is empty.

IllegalStateException - if this fixture's JList is disabled.

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

LocationUnavailableException - if an element matching the any of the given regular expression patterns cannot be found.

See Also:

replaceCellReader(JListCellReader)

clickItem

@Nonnull
public JListFixture clickItem(int index)

Simulates a user clicking an item in this fixture's JList.

Parameters:

index - the index of the item to clicking.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

See Also:

item(int), JListItemFixture.click()

clickItem

public JListFixture clickItem(@Nullable
                     String text)

Simulates a user clicking an item in this fixture's JList.

Parameters:

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

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

See Also:

item(String), JListItemFixture.select(), replaceCellReader(JListCellReader)

clickItem

@Nonnull
public JListFixture clickItem(@Nonnull
                             Pattern pattern)

Simulates a user clicking an item in this fixture's JList. The value of the item to select must match the given regular expression pattern.

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

NullPointerException - if the given regular expression pattern is null.

See Also:

item(Pattern), JListItemFixture.select(), replaceCellReader(JListCellReader)

requireSelectedItems

@Nonnull
public JListFixture requireSelectedItems(@Nonnull
                                        int... indices)

Verifies that the given item indices are selected in this fixture's JList.

Parameters:

indices - the expected indices of the selected items.

Returns:

this fixture.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

AssertionError - if the selection in this fixture's JList does not match the given one.

requireSelectedItems

@Nonnull
public JListFixture requireSelectedItems(@Nonnull
                                        String... items)

Verifies that the String representations of the selected items in this fixture's JList match the given text items.

Parameters:

items - text items to match. Each String can be a regular expression.

Returns:

this fixture.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

AssertionError - if the selected items do not match the given text items.

See Also:

replaceCellReader(JListCellReader)

requireSelectedItems

@Nonnull
public JListFixture requireSelectedItems(@Nonnull
                                        Pattern[] patterns)

Verifies that the String representations of the selected items in this fixture's JList match the given regular expression patterns.

Parameters:

patterns - the regular expression patterns to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given array is null.

IllegalArgumentException - if the given array is empty.

NullPointerException - if any of the patterns in the given array is null.

AssertionError - if the selected items do not match the given regular expression patterns.

See Also:

replaceCellReader(JListCellReader)

drag

@Nonnull
public JListFixture drag(int index)

Simulates a user dragging an item from this fixture's JList.

Parameters:

index - the index of the item to drag.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

drop

@Nonnull
public JListFixture drop(int index)

Simulates a user dropping an item to this fixture's JList.

Parameters:

index - the index of the item to drop.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

ActionFailedException - if there is no drag action in effect.

drag

@Nonnull
public JListFixture drag(@Nullable
                        String text)

Simulates a drag operation at the location of the first item in this fixture's JList matching the given value.

Parameters:

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

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

drop

@Nonnull
public JListFixture drop(@Nullable
                        String text)

Ends a drag operation at the location of the first item matching the given value.

Parameters:

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

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

ActionFailedException - if there is no drag action in effect.

drag

@Nonnull
public JListFixture drag(@Nonnull
                        Pattern pattern)

Simulates a drag operation at the location of the first item in this fixture's JList matching the given regular expression pattern.

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

NullPointerException - if the given regular expression pattern in null.

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

drop

@Nonnull
public JListFixture drop(@Nonnull
                        Pattern pattern)

Ends a drag operation at the location of the first item matching the given regular expression pattern.

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

NullPointerException - if the given regular expression pattern in null.

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

ActionFailedException - if there is no drag action in effect.

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(int index)

Shows a pop-up menu at the location of the specified item in this fixture's JList.

Parameters:

index - the index of the item.

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

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

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(@Nullable
                                        String text)

Shows a pop-up menu at the location of the first item matching the given value in this fixture's JList.

Parameters:

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

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

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

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

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(@Nonnull
                                        Pattern pattern)

Shows a pop-up menu at the location of the first item matching the given regular expression pattern in this fixture's JList.

Parameters:

pattern - the regular expression pattern to match.

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

IllegalStateException - if this fixture's JList is disabled.

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

NullPointerException - if the given regular expression pattern is null.

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

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

replaceCellReader

public void replaceCellReader(@Nonnull
                     JListCellReader cellReader)