org.assertj.swing.fixture

Class JTreeFixture

java.lang.Object

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

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

org.assertj.swing.fixture.AbstractJPopupMenuInvokerFixture<JTreeFixture,JTree,JTreeDriver>

org.assertj.swing.fixture.JTreeFixture

All Implemented Interfaces:

EditableComponentFixture<JTreeFixture>, JComponentFixture<JTreeFixture>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<JTreeFixture>

public class JTreeFixture
extends AbstractJPopupMenuInvokerFixture<JTreeFixture,JTree,JTreeDriver>
implements EditableComponentFixture<JTreeFixture>

Supports functional testing of JTrees.

TreePaths can be specified using Strings. For example, for the following tree:

 root
   |
   -- node1
      |
      -- node1.1
 

we can identify the node "node1.1" as follows:

   root/node1/node1.1
 

The default path separator is "/". It can be changed by calling replaceSeparator(String).

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

Author:

Keith Coughtrey, 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
JTreeFixture(Robot robot, JTree target) Creates a new JTreeFixture.
JTreeFixture(Robot robot, String treeName) Creates a new JTreeFixture.

Method Summary

Methods

Modifier and Type	Method and Description
JTreeFixture	clickPath(String path) Clicks the given path, expanding parent nodes if necessary.
JTreeFixture	clickPath(String path, MouseButton button) Clicks the given path, expanding parent nodes if necessary.
JTreeFixture	clickPath(String path, MouseClickInfo mouseClickInfo) Clicks the given path, expanding parent nodes if necessary.
JTreeFixture	clickRow(int row) Clicks the given row.
JTreeFixture	clickRow(int row, MouseButton button) Clicks the given row.
JTreeFixture	clickRow(int row, MouseClickInfo mouseClickInfo) Clicks the given row.
JTreeFixture	collapsePath(String path) Simulates a user collapsing the tree node at the given path.
JTreeFixture	collapseRow(int row) Simulates a user collapsing the tree node at the given row.
protected JTreeDriver	createDriver(Robot robot)
JTreeFixture	doubleClickPath(String path) Double-clicks the given path.
JTreeFixture	doubleClickRow(int row) Double-clicks the given row.
JTreeFixture	drag(int row) Simulates a user dragging a row from this fixture's JTree.
JTreeFixture	drag(String path) Simulates a user dragging an item from this fixture's JTree.
JTreeFixture	drop(int row) Simulates a user dropping an item into this fixture's JTree.
JTreeFixture	drop(String path) Simulates a user dropping an item into this fixture's JTree.
JTreeFixture	expandPath(String path) Simulates a user expanding the tree node at the given path.
JTreeFixture	expandRow(int row) Simulates a user expanding the tree node at the given row.
JTreeRowFixture	node(int row) Returns a fixture that manages the node specified by the given row.
JTreePathFixture	node(String path) Returns a fixture that manages the node specified by the given path.
JTreeFixture	replaceCellReader(JTreeCellReader cellReader) Updates the implementation of JTreeCellReader to use when comparing internal values of a JTree and the values expected in a test.
JTreeFixture	replaceSeparator(String separator) Updates the separator to use when converting TreePaths to Strings.
JTreeFixture	requireEditable() Asserts that this fixture's JTree is editable.
JTreeFixture	requireNoSelection() Asserts that this fixture's JTree's does not have any selection.
JTreeFixture	requireNotEditable() Asserts that this fixture's JTree is not editable.
JTreeFixture	requireSelection(int... rows) Asserts that this fixture's JTree's selected rows are equal to the given one.
JTreeFixture	requireSelection(String... paths) Asserts that this fixture's JTree selection is equal to the given paths.
JTreeFixture	rightClickPath(String path) Right-clicks the given path, expanding parent nodes if necessary.
JTreeFixture	rightClickRow(int row) Right-clicks the given row.
JTreeFixture	selectPath(String path) Selects the given path, expanding parent nodes if necessary.
JTreeFixture	selectPaths(String... paths) Select the given paths, expanding parent nodes if necessary.
JTreeFixture	selectRow(int row) Simulates a user selecting the tree node at the given row.
JTreeFixture	selectRows(int... rows) Simulates a user selecting the tree nodes at the given rows.
String	separator()
JPopupMenuFixture	showPopupMenuAt(int row) Shows a pop-up menu at the position of the node in the given row.
JPopupMenuFixture	showPopupMenuAt(String path) Shows a pop-up menu at the position of the last node in the given path.
JTreeFixture	toggleRow(int row) Simulates a user toggling the open/closed state of the tree node at the given row.
String	valueAt(int row) Returns the String representation of the given row.
String	valueAt(String path) Returns the String representation of the node at the given path.

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

JTreeFixture

public JTreeFixture(@Nonnull
            Robot robot,
            @Nonnull
            JTree target)

Creates a new JTreeFixture.

Parameters:

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

target - the JTree to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

JTreeFixture

public JTreeFixture(@Nonnull
            Robot robot,
            @Nullable
            String treeName)

Creates a new JTreeFixture.

Parameters:

robot - performs simulation of user events on a JTree.

treeName - the name of the JTree to find using the given Robot.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a matching JTree could not be found.

ComponentLookupException - if more than one matching JTree is found.

Method Detail

createDriver

@Nonnull
protected JTreeDriver createDriver(@Nonnull
                               Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JTreeFixture,JTree,JTreeDriver>

clickRow

@Nonnull
public JTreeFixture clickRow(int row)

Clicks the given row.

Parameters:

row - the given row.

Returns:

this fixture.

Throws:

IllegalStateException - if the JTree is disabled.

IllegalStateException - if the JTree is not showing on the screen.

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

clickRow

@Nonnull
public JTreeFixture clickRow(int row,
                            @Nonnull
                            MouseButton button)

Clicks the given row.

Parameters:

row - the given row.

button - the mouse button to use.

Returns:

this fixture.

Throws:

NullPointerException - if the button is null.

IllegalStateException - if the JTree is disabled.

IllegalStateException - if the JTree is not showing on the screen.

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

clickRow

@Nonnull
public JTreeFixture clickRow(int row,
                            @Nonnull
                            MouseClickInfo mouseClickInfo)

Clicks the given row.

Parameters:

row - the given row.

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

Returns:

this fixture.

Throws:

NullPointerException - if the given MouseClickInfo is null.

IllegalStateException - if the JTree is disabled.

IllegalStateException - if the JTree is not showing on the screen.

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

clickPath

@Nonnull
public JTreeFixture clickPath(@Nonnull
                             String path)

Clicks the given path, expanding parent nodes if necessary.

Parameters:

path - the given path.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

clickPath

@Nonnull
public JTreeFixture clickPath(@Nonnull
                             String path,
                             @Nonnull
                             MouseButton button)

Clicks the given path, expanding parent nodes if necessary.

Parameters:

path - the given path.

button - the mouse button to use.

Returns:

this fixture.

Throws:

NullPointerException - if the button is null.

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

clickPath

@Nonnull
public JTreeFixture clickPath(@Nonnull
                             String path,
                             @Nonnull
                             MouseClickInfo mouseClickInfo)

Clicks the given path, expanding parent nodes if necessary.

Parameters:

path - the given path.

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

Returns:

this fixture.

Throws:

NullPointerException - if the given MouseClickInfo is null.

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

doubleClickRow

@Nonnull
public JTreeFixture doubleClickRow(int row)

Double-clicks the given row.

Parameters:

row - the given row.

Returns:

this fixture.

Throws:

IllegalStateException - if the JTree is disabled.

IllegalStateException - if the JTree is not showing on the screen.

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

doubleClickPath

@Nonnull
public JTreeFixture doubleClickPath(@Nonnull
                                   String path)

Double-clicks the given path.

Parameters:

path - the given path.

Returns:

this fixture.

Throws:

IllegalStateException - if the JTree is disabled.

IllegalStateException - if the JTree is not showing on the screen.

LocationUnavailableException - if the given path cannot be found.

rightClickRow

@Nonnull
public JTreeFixture rightClickRow(int row)

Right-clicks the given row.

Parameters:

row - the given row.

Returns:

this fixture.

Throws:

IllegalStateException - if the JTree is disabled.

IllegalStateException - if the JTree is not showing on the screen.

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

rightClickPath

@Nonnull
public JTreeFixture rightClickPath(@Nonnull
                                  String path)

Right-clicks the given path, expanding parent nodes if necessary.

Parameters:

path - the given path.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

drag

@Nonnull
public JTreeFixture drag(int row)

Simulates a user dragging a row from this fixture's JTree.

Parameters:

row - the index of the row to drag.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

drop

@Nonnull
public JTreeFixture drop(int row)

Simulates a user dropping an item into this fixture's JTree.

Parameters:

row - the row to drop the item to.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

ActionFailedException - if there is no drag action in effect.

drag

@Nonnull
public JTreeFixture drag(@Nonnull
                        String path)

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

Parameters:

path - the path corresponding to the item to drag.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

drop

@Nonnull
public JTreeFixture drop(@Nonnull
                        String path)

Simulates a user dropping an item into this fixture's JTree.

Parameters:

path - the path corresponding to the item relative to the drop point.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

ActionFailedException - if there is no drag action in effect.

selectRow

@Nonnull
public JTreeFixture selectRow(int row)

Simulates a user selecting the tree node at the given row.

Parameters:

row - the index of the row to select.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

selectRows

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

Simulates a user selecting the tree nodes at the given rows.

Parameters:

rows - the indices of the rows to select.

Returns:

this fixture.

Throws:

NullPointerException - if the array of rows is null.

IllegalArgumentException - if the array of rows is empty.

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for any of the given rows cannot be found.

selectPath

@Nonnull
public JTreeFixture selectPath(@Nonnull
                              String path)

Selects the given path, expanding parent nodes if necessary. Unlike clickPath(String), this method will not click the path if it is already selected.

Parameters:

path - the path to select.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

selectPaths

@Nonnull
public JTreeFixture selectPaths(@Nonnull
                               String... paths)

Select the given paths, expanding parent nodes if necessary.

Parameters:

paths - the paths to select.

Returns:

this fixture.

Throws:

NullPointerException - if the array of rows is null.

IllegalArgumentException - if the array of rows is empty.

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the any of the given paths cannot be found.

toggleRow

@Nonnull
public JTreeFixture toggleRow(int row)

Simulates a user toggling the open/closed state of the tree node at the given row.

Parameters:

row - the index of the row to toggle.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

ActionFailedException - if this method fails to toggle the row.

expandRow

@Nonnull
public JTreeFixture expandRow(int row)

Simulates a user expanding the tree node at the given row.

Parameters:

row - the index of the row to expand.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

ActionFailedException - if this method fails to expand the row.

collapseRow

@Nonnull
public JTreeFixture collapseRow(int row)

Simulates a user collapsing the tree node at the given row.

Parameters:

row - the index of the row to collapse.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

ActionFailedException - if this method fails to collapse the row.

expandPath

@Nonnull
public JTreeFixture expandPath(@Nonnull
                              String path)

Simulates a user expanding the tree node at the given path.

Parameters:

path - the path of the row to expand.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

ActionFailedException - if this method fails to expand the path.

collapsePath

@Nonnull
public JTreeFixture collapsePath(@Nonnull
                                String path)

Simulates a user collapsing the tree node at the given path.

Parameters:

path - the path of the row to collapse.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

LocationUnavailableException - if the given path cannot be found.

ActionFailedException - if this method fails to collapse the path.

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(int row)

Shows a pop-up menu at the position of the node in the given row.

Parameters:

row - the index of the row invoking the pop-up menu.

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

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

LocationUnavailableException - if a tree path for the given row cannot be found.

showPopupMenuAt

@Nonnull
public JPopupMenuFixture showPopupMenuAt(@Nonnull
                                        String path)

Shows a pop-up menu at the position of the last node in the given path. The last node in the given path will be made visible (by expanding the parent node(s)) if it is not visible.

Parameters:

path - the path of the node invoking the pop-up menu.

Returns:

a fixture that manages the displayed pop-up menu.

Throws:

IllegalStateException - if this fixture's JTree is disabled.

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

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

LocationUnavailableException - if the given path cannot be found.

requireEditable

@Nonnull
public JTreeFixture requireEditable()

Asserts that this fixture's JTree is editable.

Specified by:

requireEditable in interface EditableComponentFixture<JTreeFixture>

Returns:

this fixture.

Throws:

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

requireNotEditable

@Nonnull
public JTreeFixture requireNotEditable()

Asserts that this fixture's JTree is not editable.

Specified by:

requireNotEditable in interface EditableComponentFixture<JTreeFixture>

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JTree is editable.

requireSelection

@Nonnull
public JTreeFixture requireSelection(@Nonnull
                                    int... rows)

Asserts that this fixture's JTree's selected rows are equal to the given one.

Parameters:

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

Returns:

this fixture.

Throws:

NullPointerException - if the array of row indices is null.

AssertionError - if this fixture's JTree selection is not equal to the given rows.

requireSelection

@Nonnull
public JTreeFixture requireSelection(@Nonnull
                                    String... paths)

Asserts that this fixture's JTree selection is equal to the given paths.

Parameters:

paths - the given paths, expected to be selected.

Returns:

this fixture.

Throws:

NullPointerException - if the array of paths is null.

LocationUnavailableException - if any of the given path cannot be found.

AssertionError - if this fixture's JTree selection is not equal to the given paths.

requireNoSelection

@Nonnull
public JTreeFixture requireNoSelection()

Asserts that this fixture's JTree's does not have any selection.

Returns:

this fixture.

Throws:

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

separator

public String separator()

Returns:

the separator to use when converting TreePaths to Strings.

replaceSeparator

@Nonnull
public JTreeFixture replaceSeparator(@Nonnull
                                    String separator)

Updates the separator to use when converting TreePaths to Strings. The default value is "/".

Parameters:

separator - the new separator.

Returns:

this fixture.

Throws:

NullPointerException - if the given separator is null.

replaceCellReader

@Nonnull
public JTreeFixture replaceCellReader(@Nonnull
                                     JTreeCellReader cellReader)

Updates the implementation of JTreeCellReader to use when comparing internal values of a JTree and the values expected in a test. The default implementation to use is BasicJTreeCellReader.

Parameters:

cellReader - the new JTreeCellValueReader to use.

Returns:

this fixture.

Throws:

NullPointerException - if cellReader is null.

node

@Nonnull
public JTreeRowFixture node(int row)

Returns a fixture that manages the node specified by the given row.

Parameters:

row - the given row.

Returns:

a fixture that manages the node specified by the given row.

Throws:

IndexOutOfBoundsException - if the given index is less than zero or equal than or greater than the number of visible rows in the JTree.

node

@Nonnull
public JTreePathFixture node(@Nonnull
                            String path)

Returns a fixture that manages the node specified by the given path.

Parameters:

path - the given path.

Returns:

a fixture that manages the node specified by the given path.

Throws:

LocationUnavailableException - if the given path cannot be found.

valueAt

@Nullable
public String valueAt(int row)

Returns the String representation of the given row.

Parameters:

row - the given row.

Returns:

the String representation of the node at the given path.

Throws:

IndexOutOfBoundsException - if the given row is less than zero or equal than or greater than the number of visible rows in the JTree.

LocationUnavailableException - if a tree path for the given row cannot be found.

valueAt

@Nullable
public String valueAt(@Nonnull
                      String path)

Returns the String representation of the node at the given path.

Parameters:

path - the given path.

Returns:

the String representation of the node at the given path.

Throws:

LocationUnavailableException - if the given path cannot be found.