org.assertj.swing.fixture

Class JTableFixture

java.lang.Object

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

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

org.assertj.swing.fixture.AbstractJPopupMenuInvokerFixture<JTableFixture,JTable,JTableDriver>

org.assertj.swing.fixture.JTableFixture

All Implemented Interfaces:

JComponentFixture<JTableFixture>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<JTableFixture>

public class JTableFixture
extends AbstractJPopupMenuInvokerFixture<JTableFixture,JTable,JTableDriver>

Supports functional testing of JTables.

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

Author:

Alex Ruiz, Yvonne Wang, Fabien Barbero, Andriy Tsykholyas, Christian Rösch

Field Summary

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

BACKGROUND_PROPERTY, FONT_PROPERTY, FOREGROUND_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JTableFixture(Robot robot, JTable target) Creates a new JTableFixture.
JTableFixture(Robot robot, String tableName) Creates a new JTableFixture.

Method Summary

Modifier and Type	Method and Description
ColorFixture	backgroundAt(TableCell cell) Returns a fixture that verifies the background color of the given table cell.
JTableCellFixture	cell(Pattern valuePattern) Returns a JTableCellFixture wrapping the table cell whose value matches the given regular expression pattern.
JTableCellFixture	cell(String value) Returns a JTableCellFixture wrapping the table cell whose value matches the given one.
JTableCellFixture	cell(TableCell cell) Returns a JTableCellFixture wrapping the table cell specified by the given row and column.
JTableCellFixture	cell(TableCellFinder cellFinder) Returns a JTableCellFixture wrapping the table cell found by the given TableCellFinder.
JTableFixture	click(TableCell cell, MouseButton button) Simulates a user clicking a cell in this fixture's JTable once, using the specified mouse button.
JTableFixture	click(TableCell cell, MouseClickInfo mouseClickInfo) Simulates a user clicking a cell in this fixture's JTable, using the specified mouse button the given number of times.
int	columnIndexFor(Object columnName) Returns the index of the column in this fixture's JTable whose name matches the given one.
String[][]	contents()
protected JTableDriver	createDriver(Robot robot)
JTableFixture	drag(TableCell cell) Simulates a user dragging an item from this fixture's JTable.
JTableFixture	drop(TableCell cell) Simulates a user dropping an item to this fixture's JTable.
JTableFixture	enterValue(TableCell cell, String value) Enters the given value in the given cell of this fixture's JTable, using this fixture's JTableCellWriter.
FontFixture	fontAt(TableCell cell) Returns a fixture that verifies the font of the given table cell.
ColorFixture	foregroundAt(TableCell cell) Returns a fixture that verifies the foreground color of the given table cell.
Point	pointAt(TableCell cell) Converts the given cell into a coordinate pair.
void	replaceCellReader(JTableCellReader cellReader)
void	replaceCellWriter(JTableCellWriter cellWriter)
JTableFixture	requireCellValue(TableCell cell, Pattern pattern) Asserts that the value of the given cell matches the given regular expression pattern.
JTableFixture	requireCellValue(TableCell cell, String value) Asserts that the value of the given cell matches the given value.
JTableFixture	requireColumnCount(int expected) Asserts that this fixture's JTable has the given number of columns.
JTableFixture	requireColumnNamed(String columnName) Asserts that this fixture's JTable contains a column whose name matches the given one.
JTableFixture	requireContents(String[][] contents) Asserts that the String representation of the cell values in this fixture's JTable is equal to the given String array.
JTableFixture	requireEditable(TableCell cell) Asserts that the given cell in this fixture's JTable is editable.
JTableFixture	requireNoSelection() Verifies that this fixture's JTable does not have any selection.
JTableFixture	requireNotEditable(TableCell cell) Asserts that the given cell in this fixture's JTable is not editable.
JTableFixture	requireRowCount(int expected) Asserts that this fixture's JTable has the given number of rows.
JTableFixture	requireSelectedRows(int... rows) Asserts that the set of selected rows in this fixture's JTable contains to the given row indices.
int	rowCount() Returns the number of rows that can be shown in this fixture's JTable, given unlimited space.
JTableFixture	selectCell(TableCell cell) Simulates a user selecting the given cell (row and column) of this fixture's JTable.
JTableFixture	selectCells(TableCell... cells) Simulates a user selecting the given cells of this fixture's JTable.
String	selectionValue() Returns the String representation of the selected cell in this fixture's JTable, using this fixture's JTableCellReader.
JTableFixture	selectRows(int... rows) Simulates a user selecting the given rows in this fixture's JTable.
JPopupMenuFixture	showPopupMenuAt(TableCell cell) Shows a pop-up menu at the given cell.
JTableHeaderFixture	tableHeader()
JTableFixture	unselectCell(TableCell cell) Simulates a user unselecting the given cell (row and column) of this fixture's JTable.
JTableFixture	unselectCells(TableCell... cells) Simulates a user unselecting the given cells of this fixture's JTable.
JTableFixture	unselectRows(int... rows) Simulates a user unselecting the given rows in this fixture's JTable.
String	valueAt(TableCell cell) Returns the String representation of the value of a cell in this fixture's JTable, using this fixture's JTableCellReader.

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, 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

JTableFixture

public JTableFixture(@Nonnull
                     Robot robot,
                     @Nonnull
                     JTable target)

Creates a new JTableFixture.

Parameters:

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

target - the JTable to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

JTableFixture

public JTableFixture(@Nonnull
                     Robot robot,
                     @Nullable
                     String tableName)

Creates a new JTableFixture.

Parameters:

robot - performs simulation of user events on a JTable.

tableName - the name of the JTable to find using the given Robot.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a matching JTable could not be found. Or if more than one matching JTable is found.

Method Detail

createDriver

@Nonnull
protected JTableDriver createDriver(@Nonnull
                                             Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JTableFixture,JTable,JTableDriver>

fontAt

public FontFixture fontAt(@Nonnull
                          TableCell cell)

Returns a fixture that verifies the font of the given table cell.

Parameters:

cell - the given table cell.

Returns:

a fixture that verifies the font of the given table cell.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

backgroundAt

@Nonnull
public ColorFixture backgroundAt(@Nonnull
                                          TableCell cell)

Returns a fixture that verifies the background color of the given table cell.

Parameters:

cell - the given table cell.

Returns:

a fixture that verifies the background color of the given table cell.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

foregroundAt

@Nonnull
public ColorFixture foregroundAt(@Nonnull
                                          TableCell cell)

Returns a fixture that verifies the foreground color of the given table cell.

Parameters:

cell - the given table cell.

Returns:

a fixture that verifies the foreground color of the given table cell.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

cell

@Nonnull
public JTableCellFixture cell(String value)

Returns a JTableCellFixture wrapping the table cell whose value matches the given one.

Parameters:

value - the value of the cell to look for. It can be a regular expression.

Returns:

a JTableCellFixture wrapping the table cell whose value matches the given one.

Throws:

ActionFailedException - if a cell with a matching value cannot be found.

cell

@Nonnull
public JTableCellFixture cell(@Nonnull
                                       Pattern valuePattern)

Returns a JTableCellFixture wrapping the table cell whose value matches the given regular expression pattern.

Parameters:

valuePattern - the regular expression pattern to match.

Returns:

a JTableCellFixture wrapping the table cell whose value matches the given regular expression pattern.

Throws:

NullPointerException - if the given regular expression pattern is null.

ActionFailedException - if a cell with a matching value cannot be found.

cell

@Nonnull
public JTableCellFixture cell(@Nonnull
                                       TableCellFinder cellFinder)

Returns a JTableCellFixture wrapping the table cell found by the given TableCellFinder.

Parameters:

cellFinder - knows how to find a cell.

Returns:

a JTableCellFixture wrapping the table cell found by the given TableCellFinder

Throws:

NullPointerException - if the TableCellFinder is null.

ActionFailedException - if a matching cell could not be found.

IndexOutOfBoundsException - if the row or column indices in the found cell are out of bounds.

cell

@Nonnull
public JTableCellFixture cell(@Nonnull
                                       TableCell cell)

Returns a JTableCellFixture wrapping the table cell specified by the given row and column.

Parameters:

cell - the cell of interest.

Returns:

a JTableCellFixture wrapping the table cell specified by the given row and column.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

tableHeader

@Nonnull
public JTableHeaderFixture tableHeader()

Returns:

a JTableHeaderFixture wrapping the JTableHeader in this fixture's JTable.

Throws:

AssertionError - if the JTableHeader in this fixture's JTable is null.

selectionValue

@Nullable
public String selectionValue()

Returns the String representation of the selected cell in this fixture's JTable, using this fixture's JTableCellReader. Returns null if one can not be obtained or if the JTable does not have any selected cell.

Returns:

the String representation of the selected cell.

See Also:

replaceCellReader(JTableCellReader)

pointAt

@Nonnull
public Point pointAt(@Nonnull
                              TableCell cell)

Converts the given cell into a coordinate pair.

Parameters:

cell - the given cell.

Returns:

the coordinates of the given cell.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

contents

@Nonnull
public String[][] contents()

Returns:

the String representation of the cells in the cells in this fixture's JTable, using this fixture's JTableCellReader.

See Also:

replaceCellReader(JTableCellReader)

rowCount

public int rowCount()

Returns the number of rows that can be shown in this fixture's JTable, given unlimited space.

Returns:

the number of rows shown in this fixture's JTable.

See Also:

JTable.getRowCount()

valueAt

@Nullable
public String valueAt(@Nonnull
                                TableCell cell)

Returns the String representation of the value of a cell in this fixture's JTable, using this fixture's JTableCellReader.

Parameters:

cell - the given cell.

Returns:

the String representation of the value of a cell in this fixture's JTable.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

See Also:

replaceCellReader(JTableCellReader)

selectCell

@Nonnull
public JTableFixture selectCell(@Nonnull
                                         TableCell cell)

Simulates a user selecting the given cell (row and column) of this fixture's JTable.

Parameters:

cell - the cell to select.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

selectCells

@Nonnull
public JTableFixture selectCells(@Nonnull
                                          TableCell... cells)

Simulates a user selecting the given cells of this fixture's JTable.

Parameters:

cells - the cells to select.

Returns:

this fixture.

Throws:

NullPointerException - if cells is null or empty.

IllegalArgumentException - if cells is null or empty.

IllegalStateException - if this fixture's JTable is disabled.

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

NullPointerException - if any element in cells is null.

IndexOutOfBoundsException - if any of the indices of any of the cells are out of bounds.

selectRows

@Nonnull
public JTableFixture selectRows(@Nonnull
                                         int... rows)

Simulates a user selecting the given rows in this fixture's JTable.

Parameters:

rows - the indices of the row to select.

Returns:

this fixture.

Throws:

NullPointerException - if the given array of indices is null.

IllegalArgumentException - if the given array of indices is empty.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the given indices is out of bounds.

unselectCell

@Nonnull
public JTableFixture unselectCell(@Nonnull
                                           TableCell cell)

Simulates a user unselecting the given cell (row and column) of this fixture's JTable.

Parameters:

cell - the cell to unselect.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

unselectCells

@Nonnull
public JTableFixture unselectCells(@Nonnull
                                            TableCell... cells)

Simulates a user unselecting the given cells of this fixture's JTable.

Parameters:

cells - the cells to unselect.

Returns:

this fixture.

Throws:

NullPointerException - if cells is null or empty.

IllegalArgumentException - if cells is null or empty.

IllegalStateException - if this fixture's JTable is disabled.

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

NullPointerException - if any element in cells is null.

IndexOutOfBoundsException - if any of the indices of any of the cells are out of bounds.

unselectRows

@Nonnull
public JTableFixture unselectRows(@Nonnull
                                           int... rows)

Simulates a user unselecting the given rows in this fixture's JTable.

Parameters:

rows - the indices of the row to unselect.

Returns:

this fixture.

Throws:

NullPointerException - if the given array of indices is null.

IllegalArgumentException - if the given array of indices is empty.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the given indices is out of bounds.

drag

@Nonnull
public JTableFixture drag(@Nonnull
                                   TableCell cell)

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

Parameters:

cell - the cell to drag.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

drop

@Nonnull
public JTableFixture drop(@Nonnull
                                   TableCell cell)

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

Parameters:

cell - the cell to drop the dragging item into.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

click

@Nonnull
public JTableFixture click(@Nonnull
                                    TableCell cell,
                                    @Nonnull
                                    MouseButton button)

Simulates a user clicking a cell in this fixture's JTable once, using the specified mouse button.

Parameters:

cell - the cell to click.

button - the mouse button to use.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

click

@Nonnull
public JTableFixture click(@Nonnull
                                    TableCell cell,
                                    @Nonnull
                                    MouseClickInfo mouseClickInfo)

Simulates a user clicking a cell in this fixture's JTable, using the specified mouse button the given number of times.

Parameters:

cell - the cell to click.

mouseClickInfo - specifies the mouse button to use and how many times to click.

Returns:

this fixture.

Throws:

NullPointerException - if the given MouseClickInfo is null.

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

enterValue

@Nonnull
public JTableFixture enterValue(@Nonnull
                                         TableCell cell,
                                         @Nonnull
                                         String value)

Enters the given value in the given cell of this fixture's JTable, using this fixture's JTableCellWriter. If you need more flexibility for editing cell, please see JTableCellFixture.editor().

Parameters:

cell - the given cell.

value - the given value.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

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

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

ActionFailedException - if this fixture's JTableCellValueReader is unable to enter the given value.

See Also:

replaceCellWriter(JTableCellWriter), JTableCellFixture.editor()

replaceCellReader

public void replaceCellReader(@Nonnull
                              JTableCellReader cellReader)

requireRowCount

@Nonnull
public JTableFixture requireRowCount(int expected)

Asserts that this fixture's JTable has the given number of rows.

Parameters:

expected - the expected number of rows.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JTable does not have the given number of rows.

requireSelectedRows

@Nonnull
public JTableFixture requireSelectedRows(@Nonnull
                                                  int... rows)

Asserts that the set of selected rows in this fixture's JTable contains to the given row indices. The given row indices can be a subset of all the selected rows in a JTable.

Parameters:

rows - the indices of the rows expected to be selected.

Returns:

this fixture.

Throws:

AssertionError - if the set of selected rows in this fixture's JTable (if any) do not contain the given indices.

requireColumnCount

@Nonnull
public JTableFixture requireColumnCount(int expected)

Asserts that this fixture's JTable has the given number of columns.

Parameters:

expected - the expected number of columns.

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JTable does not have the given number of columns.

requireEditable

@Nonnull
public JTableFixture requireEditable(@Nonnull
                                              TableCell cell)

Asserts that the given cell in this fixture's JTable is editable.

Parameters:

cell - the given cell.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

AssertionError - if the given cell is not editable.

requireNotEditable

@Nonnull
public JTableFixture requireNotEditable(@Nonnull
                                                 TableCell cell)

Asserts that the given cell in this fixture's JTable is not editable.

Parameters:

cell - the given cell.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

AssertionError - if the given cell is editable.

requireNoSelection

@Nonnull
public JTableFixture requireNoSelection()

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

Returns:

this fixture.

Throws:

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

requireCellValue

@Nonnull
public JTableFixture requireCellValue(@Nonnull
                                               TableCell cell,
                                               @Nullable
                                               String value)

Asserts that the value of the given cell matches the given value.

Parameters:

cell - the given table cell.

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

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

AssertionError - if the value of the given cell does not match the given value.

requireCellValue

@Nonnull
public JTableFixture requireCellValue(@Nonnull
                                               TableCell cell,
                                               @Nonnull
                                               Pattern pattern)

Asserts that the value of the given cell matches the given regular expression pattern.

Parameters:

cell - the given table cell.

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

NullPointerException - if the cell is null.

NullPointerException - if the given regular expression pattern is null.

IndexOutOfBoundsException - if any of the indices (row and column) is out of bounds.

AssertionError - if the value of the given cell does not match the given regular expression pattern.

requireContents

@Nonnull
public JTableFixture requireContents(@Nonnull
                                              String[][] contents)

Asserts that the String representation of the cell values in this fixture's JTable is equal to the given String array. This method uses this fixture's JTableCellReader to read the values of the table cells as Strings.

Parameters:

contents - the expected String representation of the cell values in this fixture's JTable.

Returns:

this fixture.

See Also:

replaceCellReader(JTableCellReader)

replaceCellWriter

public void replaceCellWriter(JTableCellWriter cellWriter)

columnIndexFor

public int columnIndexFor(@Nonnull
                          Object columnName)

Returns the index of the column in this fixture's JTable whose name matches the given one.

Parameters:

columnName - the name of the column to look for.

Returns:

the index of the column whose name matches the given one.

Throws:

ActionFailedException - if a column with a matching name could not be found.

requireColumnNamed

public JTableFixture requireColumnNamed(String columnName)

Asserts that this fixture's JTable contains a column whose name matches the given one.

Parameters:

columnName - the name of the column to look for.

Returns:

this fixture.

Throws:

ActionFailedException - if a column with a matching name could not be found.

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(@Nonnull
                                                  TableCell cell)

Shows a pop-up menu at the given cell.

Parameters:

cell - the table cell where to show the pop-up menu.

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

NullPointerException - if the cell is null.

IllegalStateException - if this fixture's JTable is disabled.

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

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