jwrapper.jwutils.swing

Class JWAutomate

java.lang.Object

jwrapper.jwutils.swing.JWAutomate

public class JWAutomate
extends java.lang.Object

API to automatically discover (visible) Swing components and drive common ones.

Constructor Summary

Constructors

Constructor and Description
JWAutomate()

Method Summary

Modifier and Type	Method and Description
static java.awt.image.BufferedImage	capture(java.awt.Component comp, boolean shadow) Dump a screenshot of one component as a PNG image, including a small drop shadow
static void	deselectJTable(java.awt.Component parent) Remove all selections in the first JTable found inside the component
static void	dumpScreenshots(java.awt.Component[] parent, java.io.File html, boolean visibleOnly, java.lang.Class[] ignoreList) Create PNG screenshots for all components within the specified component (including the component itself) and create an HTML file listing all of them for easy perusal.
static java.util.ArrayList<javax.swing.JComponent>	findAll(java.awt.Component parent, java.lang.Class type) Find all visible components of this type inside the parent component hierarchy
static java.util.ArrayList<javax.swing.JComponent>	findAll(java.awt.Component parent, java.lang.String text, java.lang.Class type) Find all visible components of this type which contain the specified text (case insensitive)
static java.util.ArrayList<javax.swing.JComponent>	findAllTT(java.awt.Component parent, java.lang.String text, java.lang.Class type) Find all visible components of this type which contain the specified text (case insensitive) in its ToolTip
static java.util.ArrayList<javax.swing.JComponent>	findEverything(java.awt.Component c)
static void	findEverything(java.awt.Component c, java.util.ArrayList<javax.swing.JComponent> list)
static javax.swing.JComponent	findFirst(java.awt.Component parent, java.lang.Class type) Find the first visible component of this type inside the parent component hierarchy
static javax.swing.JComponent	findFirst(java.awt.Component parent, java.lang.String text, java.lang.Class type) Find the first visible component of this type which contains the specified text (case insensitive)
static javax.swing.JComponent	findFirstTT(java.awt.Component parent, java.lang.String text, java.lang.Class type) Find the first visible component of this type which contains the specified text (case insensitive) in its ToolTip
static int	getJTableSize(java.awt.Component parent) Get the row count of the first JTable found inside the component
static int	getListSize(java.awt.Component parent) Get the size of the first JList found inside the component
static void	hitButton(java.awt.Component parent, java.lang.String text) Click the first AbstractButton (JButton, JToggleButton etc) found inside the component which contains the specified text
static void	hitButtonTT(java.awt.Component parent, java.lang.String text) Click the first AbstractButton (JButton, JToggleButton etc) found inside the component which contains the specified text in its ToolTip
static void	hitJTable(java.awt.Component parent) Select the first row in the first JTable found inside the component
static void	hitList(java.awt.Component parent) Click the first list entry in the first JList found inside the component
static void	hitList(java.awt.Component parent, java.lang.String text) Click the list entry which contains the specified text in the first JList found inside the component
static void	hitMenu(java.awt.Component parent, java.lang.String text) Click the menu item which contains the specified text in the first JMenu found inside the component
static java.awt.Component	hitTab(java.awt.Component parent, java.lang.String text) Click the tab which contains the specified text in the first JTabbedPane found inside the component
static void	layoutComponent(java.awt.Component c)
static void	nextJTable(java.awt.Component parent) Select the next row in the first JTable found inside the component
static void	nextList(java.awt.Component parent) Click the next list entry in the first JList found inside the component
static boolean	scrollDownPage(java.awt.Component parent) Scroll down one page (visible extent) in the first JScrollPane found inside the component
static boolean	scrollUpPage(java.awt.Component parent) Scroll up one page (visible extent) in the first JScrollPane found inside the component
static void	sleep(long millis) Sleeps without throwing an InterruptedException
static void	sleepMins(double mins) Sleeps without throwing an InterruptedException

Methods inherited from class java.lang.Object

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

Constructor Detail

JWAutomate

public JWAutomate()

Method Detail

dumpScreenshots

public static void dumpScreenshots(java.awt.Component[] parent,
                                   java.io.File html,
                                   boolean visibleOnly,
                                   java.lang.Class[] ignoreList)
                            throws java.io.FileNotFoundException,
                                   java.io.IOException

Create PNG screenshots for all components within the specified component (including the component itself) and create an HTML file listing all of them for easy perusal.

Parameters:

parent -

html -

visibleOnly -

Throws:

java.io.FileNotFoundException

java.io.IOException

layoutComponent

public static void layoutComponent(java.awt.Component c)

capture

public static java.awt.image.BufferedImage capture(java.awt.Component comp,
                                                   boolean shadow)

Dump a screenshot of one component as a PNG image, including a small drop shadow

Parameters:

comp -

Returns:

the PNG data of the component screenshot

findFirst

public static javax.swing.JComponent findFirst(java.awt.Component parent,
                                               java.lang.Class type)

Find the first visible component of this type inside the parent component hierarchy

Parameters:

parent - the parent component to search in, this can also be a match

type - the class of the component to match, for example AbstractButton.class or JTable.class

Returns:

the first matching visible component

findAll

public static java.util.ArrayList<javax.swing.JComponent> findAll(java.awt.Component parent,
                                                                  java.lang.Class type)

Find all visible components of this type inside the parent component hierarchy

Parameters:

parent - the parent component to search in, this can also be a match

type - the class of the component to match, for example AbstractButton.class or JTable.class

Returns:

a list of all matching visible components

findFirst

public static javax.swing.JComponent findFirst(java.awt.Component parent,
                                               java.lang.String text,
                                               java.lang.Class type)

Find the first visible component of this type which contains the specified text (case insensitive)

Parameters:

parent - the parent component to search in, this can also be a match

type - the class of the component to match, for example AbstractButton.class or JTable.class

Returns:

the first matching visible component

findFirstTT

public static javax.swing.JComponent findFirstTT(java.awt.Component parent,
                                                 java.lang.String text,
                                                 java.lang.Class type)

Find the first visible component of this type which contains the specified text (case insensitive) in its ToolTip

Parameters:

parent - the parent component to search in, this can also be a match

type - the class of the component to match, for example AbstractButton.class or JTable.class

Returns:

the first matching visible component

findAll

public static java.util.ArrayList<javax.swing.JComponent> findAll(java.awt.Component parent,
                                                                  java.lang.String text,
                                                                  java.lang.Class type)

Find all visible components of this type which contain the specified text (case insensitive)

Parameters:

parent - the parent component to search in, this can also be a match

type - the class of the component to match, for example AbstractButton.class or JTable.class

Returns:

a list of all matching visible components

findAllTT

public static java.util.ArrayList<javax.swing.JComponent> findAllTT(java.awt.Component parent,
                                                                    java.lang.String text,
                                                                    java.lang.Class type)

Find all visible components of this type which contain the specified text (case insensitive) in its ToolTip

Parameters:

parent - the parent component to search in, this can also be a match

type - the class of the component to match, for example AbstractButton.class or JTable.class

Returns:

a list of all matching visible components

deselectJTable

public static void deselectJTable(java.awt.Component parent)

Remove all selections in the first JTable found inside the component

Parameters:

parent - the JTable or container of a JTable

hitJTable

public static void hitJTable(java.awt.Component parent)

Select the first row in the first JTable found inside the component

Parameters:

parent - the JTable or container of a JTable

getJTableSize

public static int getJTableSize(java.awt.Component parent)

Get the row count of the first JTable found inside the component

Parameters:

parent - the JTable or container of a JTable

nextJTable

public static void nextJTable(java.awt.Component parent)

Select the next row in the first JTable found inside the component

Parameters:

parent - the JTable or container of a JTable

scrollDownPage

public static boolean scrollDownPage(java.awt.Component parent)

Scroll down one page (visible extent) in the first JScrollPane found inside the component

Parameters:

parent - the ScrollPane or container of a ScrollPane

scrollUpPage

public static boolean scrollUpPage(java.awt.Component parent)

Scroll up one page (visible extent) in the first JScrollPane found inside the component

Parameters:

parent - the ScrollPane or container of a ScrollPane

hitButton

public static void hitButton(java.awt.Component parent,
                             java.lang.String text)

Click the first AbstractButton (JButton, JToggleButton etc) found inside the component which contains the specified text

Parameters:

parent - the AbstractButton or container of a AbstractButton

text - the text to match in the button text

hitButtonTT

public static void hitButtonTT(java.awt.Component parent,
                               java.lang.String text)

Click the first AbstractButton (JButton, JToggleButton etc) found inside the component which contains the specified text in its ToolTip

Parameters:

parent - the AbstractButton or container of a AbstractButton

text - the text to match in the button text

sleep

public static void sleep(long millis)

Sleeps without throwing an InterruptedException

sleepMins

public static void sleepMins(double mins)

Sleeps without throwing an InterruptedException

hitTab

public static java.awt.Component hitTab(java.awt.Component parent,
                                        java.lang.String text)

Click the tab which contains the specified text in the first JTabbedPane found inside the component

Parameters:

parent - the JTabbedPane or container of a JTabbedPane

text - the text to match in the tab text

hitMenu

public static void hitMenu(java.awt.Component parent,
                           java.lang.String text)

Click the menu item which contains the specified text in the first JMenu found inside the component

Parameters:

parent - the JMenu or container of a JMenu

text - the text to match in the menu item text

hitList

public static void hitList(java.awt.Component parent)

Click the first list entry in the first JList found inside the component

Parameters:

parent - the JList or container of a JList

getListSize

public static int getListSize(java.awt.Component parent)

Get the size of the first JList found inside the component

Parameters:

parent - the JList or container of a JList

nextList

public static void nextList(java.awt.Component parent)

Click the next list entry in the first JList found inside the component

Parameters:

parent - the JList or container of a JList

hitList

public static void hitList(java.awt.Component parent,
                           java.lang.String text)

Click the list entry which contains the specified text in the first JList found inside the component

Parameters:

parent - the JList or container of a JList

text - the text to match in the tab text

findEverything

public static java.util.ArrayList<javax.swing.JComponent> findEverything(java.awt.Component c)

findEverything

public static void findEverything(java.awt.Component c,
                                  java.util.ArrayList<javax.swing.JComponent> list)