org.assertj.swing.driver

Class JTreeLocation

java.lang.Object

org.assertj.swing.driver.JTreeLocation

public final class JTreeLocation
extends Object

A visible location on a JTree. A row index or a Stringified TreePath (i.e. each TreePath component is a String) or a TreePath of Object may be used to indicate the location. Note that if a TreePath is used, the entire path leading up to the designated node must be viewable at the time the location is used.

Author:

Alex Ruiz

Constructor Summary

Constructors

Constructor and Description
JTreeLocation()

Method Summary

Methods

Modifier and Type	Method and Description
int	checkRowInBounds(JTree tree, int row) Validates that the given row index is valid.
Pair<Rectangle,Point>	pathBoundsAndCoordinates(JTree tree, TreePath path) Returns the bounds and visible coordinates of the given path.
TreePath	pathFor(JTree tree, int row) Returns the path for the given row.
Pair<Rectangle,Point>	rowBoundsAndCoordinates(JTree tree, int row) Returns the bounds and visible coordinates of the given row.

Methods inherited from class java.lang.Object

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

Constructor Detail

JTreeLocation

public JTreeLocation()

Method Detail

rowBoundsAndCoordinates

@RunsInCurrentThread
@Nonnull
public Pair<Rectangle,Point> rowBoundsAndCoordinates(@Nonnull
                                                                        JTree tree,
                                                                        int row)

Returns the bounds and visible coordinates of the given row.

Note: This method is accessed in the current executing thread. Such thread may or may not be the event dispatch thread (EDT.) Client code must call this method from the EDT.

Parameters:

tree - the target JTree.

row - the given row.

Returns:

the the bounds and visible coordinates of the given row.

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.

pathFor

@RunsInCurrentThread
@Nonnull
public TreePath pathFor(@Nonnull
                                           JTree tree,
                                           int row)

Returns the path for the given row.

Note: This method is accessed in the current executing thread. Such thread may or may not be the event dispatch thread (EDT.) Client code must call this method from the EDT.

Parameters:

tree - the target JTree.

row - the given row.

Returns:

the path for the given row.

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.

checkRowInBounds

@RunsInCurrentThread
public int checkRowInBounds(@Nonnull
                                       JTree tree,
                                       int row)

Validates that the given row index is valid.

Note: This method is accessed in the current executing thread. Such thread may or may not be the event dispatch thread (EDT.) Client code must call this method from the EDT.

Parameters:

tree - the target JTree.

row - the row index to validate.

Returns:

the validated row index.

Throws:

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

pathBoundsAndCoordinates

@RunsInCurrentThread
@Nonnull
public Pair<Rectangle,Point> pathBoundsAndCoordinates(@Nonnull
                                                                         JTree tree,
                                                                         @Nonnull
                                                                         TreePath path)

Returns the bounds and visible coordinates of the given path.

Note: This method is accessed in the current executing thread. Such thread may or may not be the event dispatch thread (EDT.) Client code must call this method from the EDT.

Parameters:

tree - the target JTree.

path - the given path.

Returns:

the bounds and visible coordinates of the given path.

Throws:

LocationUnavailableException - if any part of the path is not visible.