Package org.fest.swing.driver

Class JScrollBarDriver

java.lang.Object

org.fest.swing.driver.ComponentDriver

org.fest.swing.driver.ContainerDriver

org.fest.swing.driver.JComponentDriver

org.fest.swing.driver.JScrollBarDriver

public class JScrollBarDriver
extends JComponentDriver

Understands functional testing of JScrollBars:

• user input simulation
• state verification
• property value query

This class is intended for internal use only. Please use the classes in the package org.fest.swing.fixture in your tests.

Field Summary

Fields

Modifier and Type	Field	Description
private final JScrollBarLocation	location
private static final String	VALUE_PROPERTY

Fields inherited from class org.fest.swing.driver.ComponentDriver

robot

Constructor Summary

Constructors

Constructor	Description
JScrollBarDriver(Robot robot)	Creates a new JScrollBarDriver.

Method Summary

Modifier and Type	Method	Description
private static Point	blockLocation(JScrollBar scrollBar, JScrollBarLocation location, int times)
void	requireValue(JScrollBar scrollBar, int value)	Asserts that the value of the JScrollBar is equal to the given one.
private void	scroll(JScrollBar scrollBar, int position, GenericRange<Point> points)
private void	scroll(JScrollBar scrollBar, Pair<Point,Integer> scrollInfo)
void	scrollBlockDown(JScrollBar scrollBar)	Scrolls down (or right) one block (usually a page).
void	scrollBlockDown(JScrollBar scrollBar, int times)	Scrolls down (or right) one block (usually a page,) the given number of times.
private static Pair<Point,Integer>	scrollBlockInfo(JScrollBar scrollBar, JScrollBarLocation location, int times)
void	scrollBlockUp(JScrollBar scrollBar)	Scrolls up (or left) one block (usually a page).
void	scrollBlockUp(JScrollBar scrollBar, int times)	Scrolls up (or left) one block (usually a page,) the given number of times.
private static GenericRange<Point>	scrollInfo(JScrollBar scrollBar, JScrollBarLocation location, int position)
void	scrollTo(JScrollBar scrollBar, int position)	Scrolls to the given position.
void	scrollToMaximum(JScrollBar scrollBar)	Scrolls to the maximum position of the given JScrollBar.
void	scrollToMinimum(JScrollBar scrollBar)	Scrolls to the minimum position of the given JScrollBar.
void	scrollUnitDown(JScrollBar scrollBar)	Scrolls down (or right) one unit (usually a line).
void	scrollUnitDown(JScrollBar scrollBar, int times)	Scrolls down (or right) one unit (usually a line,) the given number of times.
private static Pair<Point,Integer>	scrollUnitInfo(JScrollBar scrollBar, JScrollBarLocation location, int times)
void	scrollUnitUp(JScrollBar scrollBar)	Scrolls up (or left) one unit (usually a line).
void	scrollUnitUp(JScrollBar scrollBar, int times)	Scrolls up (or left) one unit (usually a line,) the given number of times.
private void	setValueProperty(JScrollBar scrollBar, int value)
private void	simulateScrolling(JScrollBar scrollBar, GenericRange<Point> points)
private static Pair<Point,Integer>	validateAndFindScrollBlockInfo(JScrollBar scrollBar, JScrollBarLocation location, int times)
private static GenericRange<Point>	validateAndFindScrollInfo(JScrollBar scrollBar, JScrollBarLocation location, int position)
private static Pair<Integer,GenericRange<Point>>	validateAndFindScrollToMaximumInfo(JScrollBar scrollBar, JScrollBarLocation location)
private static Pair<Integer,GenericRange<Point>>	validateAndFindScrollToMinimumInfo(JScrollBar scrollBar, JScrollBarLocation location)
private static Pair<Point,Integer>	validateAndFindScrollUnitInfo(JScrollBar scrollBar, JScrollBarLocation location, int times)
private static void	validatePosition(JScrollBar scrollBar, int position)
private void	validateTimes(int times, String action)

Methods inherited from class org.fest.swing.driver.JComponentDriver

clientProperty, invokeAction, isVisible, isVisible, requireToolTip, requireToolTip, scrollToVisible

Methods inherited from class org.fest.swing.driver.ContainerDriver

move, resize, resizeHeight, resizeWidth

Methods inherited from class org.fest.swing.driver.ComponentDriver

assertIsEnabledAndShowing, click, click, click, click, click, doubleClick, drag, dragOver, drop, focus, focusAndWaitForFocusGain, invokePopupMenu, invokePopupMenu, moveMouseIgnoringAnyError, moveMouseIgnoringAnyError, performAccessibleActionOf, pressAndReleaseKey, pressAndReleaseKey, pressAndReleaseKeys, pressKey, propertyName, releaseKey, requireDisabled, requireEnabled, requireEnabled, requireFocused, requireNotVisible, requireSize, requireVisible, rightClick, settings, waitForShowing

Methods inherited from class java.lang.Object

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

Field Details

VALUE_PROPERTY

private static final String VALUE_PROPERTY

See Also:

• Constant Field Values

location

private final JScrollBarLocation location

Constructor Details

JScrollBarDriver

public JScrollBarDriver(Robot robot)

Creates a new JScrollBarDriver.

Parameters:

robot - the robot to use to simulate user input.

Method Details

scrollUnitUp

public void scrollUnitUp(JScrollBar scrollBar)

Scrolls up (or left) one unit (usually a line).

Parameters:

scrollBar - the target JScrollBar.

scrollUnitUp

public void scrollUnitUp(JScrollBar scrollBar,
 int times)

Scrolls up (or left) one unit (usually a line,) the given number of times.

Parameters:

scrollBar - the target JScrollBar.

times - the number of times to scroll up one unit.

Throws:

IllegalArgumentException - if times is less than or equal to zero.

IllegalStateException - if the JScrollBar is disabled.

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

scrollUnitDown

public void scrollUnitDown(JScrollBar scrollBar)

Scrolls down (or right) one unit (usually a line).

Parameters:

scrollBar - the target JScrollBar.

scrollUnitDown

public void scrollUnitDown(JScrollBar scrollBar,
 int times)

Scrolls down (or right) one unit (usually a line,) the given number of times.

Parameters:

scrollBar - the target JScrollBar.

times - the number of times to scroll down one unit.

Throws:

IllegalArgumentException - if times is less than or equal to zero.

IllegalStateException - if the JScrollBar is disabled.

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

validateAndFindScrollUnitInfo

@RunsInEDT
private static Pair<Point,Integer> validateAndFindScrollUnitInfo(JScrollBar scrollBar,
 JScrollBarLocation location,
 int times)

scrollUnitInfo

@RunsInCurrentThread
private static Pair<Point,Integer> scrollUnitInfo(JScrollBar scrollBar,
 JScrollBarLocation location,
 int times)

scrollBlockUp

@RunsInEDT
public void scrollBlockUp(JScrollBar scrollBar)

Scrolls up (or left) one block (usually a page).

Parameters:

scrollBar - the target JScrollBar.

scrollBlockUp

@RunsInEDT
public void scrollBlockUp(JScrollBar scrollBar,
 int times)

Scrolls up (or left) one block (usually a page,) the given number of times.

Parameters:

scrollBar - the target JScrollBar.

times - the number of times to scroll up one block.

Throws:

IllegalArgumentException - if times is less than or equal to zero.

IllegalStateException - if the JScrollBar is disabled.

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

scrollBlockDown

@RunsInEDT
public void scrollBlockDown(JScrollBar scrollBar)

Scrolls down (or right) one block (usually a page).

Parameters:

scrollBar - the target JScrollBar.

scrollBlockDown

@RunsInEDT
public void scrollBlockDown(JScrollBar scrollBar,
 int times)

Scrolls down (or right) one block (usually a page,) the given number of times.

Parameters:

scrollBar - the target JScrollBar.

times - the number of times to scroll down one block.

Throws:

IllegalArgumentException - if times is less than or equal to zero.

IllegalStateException - if the JScrollBar is disabled.

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

validateTimes

private void validateTimes(int times,
 String action)

validateAndFindScrollBlockInfo

@RunsInEDT
private static Pair<Point,Integer> validateAndFindScrollBlockInfo(JScrollBar scrollBar,
 JScrollBarLocation location,
 int times)

scrollBlockInfo

@RunsInCurrentThread
private static Pair<Point,Integer> scrollBlockInfo(JScrollBar scrollBar,
 JScrollBarLocation location,
 int times)

blockLocation

@RunsInCurrentThread
private static Point blockLocation(JScrollBar scrollBar,
 JScrollBarLocation location,
 int times)

scroll

@RunsInEDT
private void scroll(JScrollBar scrollBar,
 Pair<Point,Integer> scrollInfo)

scrollToMaximum

@RunsInEDT
public void scrollToMaximum(JScrollBar scrollBar)

Scrolls to the maximum position of the given JScrollBar.

Parameters:

scrollBar - the target JScrollBar.

Throws:

IllegalStateException - if the JScrollBar is disabled.

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

validateAndFindScrollToMaximumInfo

@RunsInEDT
private static Pair<Integer,GenericRange<Point>> validateAndFindScrollToMaximumInfo(JScrollBar scrollBar,
 JScrollBarLocation location)

scrollToMinimum

@RunsInEDT
public void scrollToMinimum(JScrollBar scrollBar)

Scrolls to the minimum position of the given JScrollBar.

Parameters:

scrollBar - the target JScrollBar.

Throws:

IllegalStateException - if the JScrollBar is disabled.

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

validateAndFindScrollToMinimumInfo

@RunsInEDT
private static Pair<Integer,GenericRange<Point>> validateAndFindScrollToMinimumInfo(JScrollBar scrollBar,
 JScrollBarLocation location)

scrollTo

@RunsInEDT
public void scrollTo(JScrollBar scrollBar,
 int position)

Scrolls to the given position.

Parameters:

scrollBar - the target JScrollBar.

position - the position to scroll to.

Throws:

IllegalStateException - if the JScrollBar is disabled.

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

IllegalArgumentException - if the given position is not within the JScrollBar bounds.

validateAndFindScrollInfo

@RunsInEDT
private static GenericRange<Point> validateAndFindScrollInfo(JScrollBar scrollBar,
 JScrollBarLocation location,
 int position)

validatePosition

@RunsInCurrentThread
private static void validatePosition(JScrollBar scrollBar,
 int position)

scrollInfo

@RunsInCurrentThread
private static GenericRange<Point> scrollInfo(JScrollBar scrollBar,
 JScrollBarLocation location,
 int position)

scroll

private void scroll(JScrollBar scrollBar,
 int position,
 GenericRange<Point> points)

simulateScrolling

@RunsInEDT
private void simulateScrolling(JScrollBar scrollBar,
 GenericRange<Point> points)

setValueProperty

@RunsInEDT
private void setValueProperty(JScrollBar scrollBar,
 int value)

requireValue

@RunsInEDT
public void requireValue(JScrollBar scrollBar,
 int value)

Asserts that the value of the JScrollBar is equal to the given one.

Parameters:

scrollBar - the target JScrollBar.

value - the expected value.

Throws:

AssertionError - if the value of the JScrollBar is not equal to the given one.