org.uispec4j
Class Panel

java.lang.Object
  org.uispec4j.AbstractUIComponent
      org.uispec4j.Panel

All Implemented Interfaces:

UIComponent

Direct Known Subclasses:

Table.Cell, Window

public class Panel
extends AbstractUIComponent

General container for UI components.

This class offers a set of "getXxx" methods for retrieving the different kinds of UIComponent instances laid out in a GUI panel.

It also provides a set of generic find/get methods, with the following naming logic:

• 'find...' stands for a unitary search that returns null when nothing was found
• 'getXxxComponent' stands for a unitary search that throws an exception when nothing was found
• 'getXxxComponents' stands for plural search and returns an empty array when nothing was found
• 'getXxxComponents' stands for plural search and returns an empty array when nothing was found
• 'containsXxxComponents' returns an assertion for checking the presence of a component

NOTE: A Panel can be created from any AWT Container, but when a Panel is searched with the getPanel(String) method only components of type JPanel JInternalFrame, etc. will be considered.

See Also:

Finding Components

Field Summary

static java.lang.Class[]	SWING_CLASSES
static java.lang.String	TYPE_NAME

Constructor Summary

Panel(java.awt.Container container)

Method Summary

Assertion	containsComponent(ComponentMatcher matcher)
Assertion	containsLabel(java.lang.String text) Checks that the panel contains a given non-editable text.
<T extends java.awt.Component> Assertion	containsSwingComponent(java.lang.Class<T> swingComponentClass)
<T extends java.awt.Component> Assertion	containsSwingComponent(java.lang.Class<T> swingComponentClass, java.lang.String name)
<T extends UIComponent> Assertion	containsUIComponent(java.lang.Class<T> uicomponentClass)
<T extends UIComponent> Assertion	containsUIComponent(java.lang.Class<T> uiComponentClass, java.lang.String name)
<T extends java.awt.Component> T	findSwingComponent(java.lang.Class<T> swingComponentClass)
<T extends java.awt.Component> T	findSwingComponent(java.lang.Class<T> swingComponentClass, java.lang.String componentName)
java.awt.Component	findSwingComponent(ComponentMatcher matcher)
<T extends UIComponent> T	findUIComponent(java.lang.Class<T> uiComponentClass)
<T extends UIComponent> T	findUIComponent(java.lang.Class<T> uiComponentClass, java.lang.String name)
UIComponent	findUIComponent(ComponentMatcher matcher)
java.awt.Container	getAwtComponent() Returns the Java GUI component represented by this object.
java.awt.Container	getAwtContainer()
Button	getButton()
Button	getButton(ComponentMatcher matcher)
Button	getButton(java.lang.String name)
CheckBox	getCheckBox()
CheckBox	getCheckBox(ComponentMatcher matcher)
CheckBox	getCheckBox(java.lang.String name)
ComboBox	getComboBox()
ComboBox	getComboBox(ComponentMatcher matcher)
ComboBox	getComboBox(java.lang.String name)
DateSpinner	getDateSpinner()
DateSpinner	getDateSpinner(ComponentMatcher matcher)
DateSpinner	getDateSpinner(java.lang.String componentName)
java.lang.String	getDescriptionTypeName() Returns the name of the component as it will appear in the XML representation returned by UIComponent.getDescription().
Desktop	getDesktop()
Desktop	getDesktop(ComponentMatcher matcher)
Desktop	getDesktop(java.lang.String name)
TextBox	getInputTextBox() Retrieves input-only text boxes.
TextBox	getInputTextBox(java.lang.String name) Retrieves input-only text boxes.
ListBox	getListBox()
ListBox	getListBox(ComponentMatcher matcher)
ListBox	getListBox(java.lang.String name)
ListSpinner	getListSpinner()
ListSpinner	getListSpinner(ComponentMatcher matcher)
ListSpinner	getListSpinner(java.lang.String componentName)
NumberSpinner	getNumberSpinner()
NumberSpinner	getNumberSpinner(ComponentMatcher matcher)
NumberSpinner	getNumberSpinner(java.lang.String componentName)
Panel	getPanel()
Panel	getPanel(ComponentMatcher matcher)
Panel	getPanel(java.lang.String name)
PasswordField	getPasswordField()
PasswordField	getPasswordField(ComponentMatcher matcher)
PasswordField	getPasswordField(java.lang.String componentName)
ProgressBar	getProgressBar()
ProgressBar	getProgressBar(ComponentMatcher matcher)
ProgressBar	getProgressBar(java.lang.String name)
RadioButton	getRadioButton()
RadioButton	getRadioButton(ComponentMatcher matcher)
RadioButton	getRadioButton(java.lang.String name)
Slider	getSlider()
Slider	getSlider(ComponentMatcher matcher)
Slider	getSlider(java.lang.String name)
Spinner	getSpinner()
Spinner	getSpinner(ComponentMatcher matcher)
Spinner	getSpinner(java.lang.String name)
java.awt.Component[]	getSwingComponents(java.lang.Class swingComponentClass)
java.awt.Component[]	getSwingComponents(java.lang.Class swingComponentClass, java.lang.String name)
java.awt.Component[]	getSwingComponents(ComponentMatcher matcher)
TabGroup	getTabGroup()
TabGroup	getTabGroup(ComponentMatcher matcher)
TabGroup	getTabGroup(java.lang.String name)
Table	getTable()
Table	getTable(ComponentMatcher matcher)
Table	getTable(java.lang.String name)
TextBox	getTextBox()
TextBox	getTextBox(ComponentMatcher matcher)
TextBox	getTextBox(java.lang.String name)
ToggleButton	getToggleButton()
ToggleButton	getToggleButton(ComponentMatcher matcher)
ToggleButton	getToggleButton(java.lang.String name)
Tree	getTree()
Tree	getTree(ComponentMatcher matcher)
Tree	getTree(java.lang.String name)
UIComponent[]	getUIComponents(java.lang.Class uiComponentClass)
UIComponent[]	getUIComponents(java.lang.Class uiComponentClass, java.lang.String name)
UIComponent[]	getUIComponents(ComponentMatcher matcher)

Methods inherited from class org.uispec4j.AbstractUIComponent

addAttributes, backgroundEquals, backgroundNear, foregroundEquals, foregroundNear, getContainer, getContainer, getDescription, getDescription, getLabel, getName, getSubDescription, isEnabled, isVisible, pressKey, releaseKey, typeKey

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

See Also:

Constant Field Values

SWING_CLASSES

public static final java.lang.Class[] SWING_CLASSES

Constructor Detail

Panel

public Panel(java.awt.Container container)

Method Detail

getDescriptionTypeName

public java.lang.String getDescriptionTypeName()

Description copied from interface: UIComponent

Returns the name of the component as it will appear in the XML representation returned by UIComponent.getDescription().

getAwtComponent

public java.awt.Container getAwtComponent()

Description copied from interface: UIComponent

Returns the Java GUI component represented by this object.

getAwtContainer

public java.awt.Container getAwtContainer()

getButton

public Button getButton(java.lang.String name)
                 throws ItemNotFoundException,
                        ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getButton

public Button getButton()
                 throws ItemNotFoundException,
                        ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getButton

public Button getButton(ComponentMatcher matcher)
                 throws ItemNotFoundException,
                        ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getToggleButton

public ToggleButton getToggleButton(java.lang.String name)
                             throws ItemNotFoundException,
                                    ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getToggleButton

public ToggleButton getToggleButton()
                             throws ItemNotFoundException,
                                    ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getToggleButton

public ToggleButton getToggleButton(ComponentMatcher matcher)
                             throws ItemNotFoundException,
                                    ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getCheckBox

public CheckBox getCheckBox(java.lang.String name)
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getCheckBox

public CheckBox getCheckBox()
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getCheckBox

public CheckBox getCheckBox(ComponentMatcher matcher)
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getPanel

public Panel getPanel()
               throws ItemNotFoundException,
                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getPanel

public Panel getPanel(java.lang.String name)
               throws ItemNotFoundException,
                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getPanel

public Panel getPanel(ComponentMatcher matcher)
               throws ItemNotFoundException,
                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getProgressBar

public ProgressBar getProgressBar(java.lang.String name)
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getProgressBar

public ProgressBar getProgressBar()
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getProgressBar

public ProgressBar getProgressBar(ComponentMatcher matcher)
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getDesktop

public Desktop getDesktop(java.lang.String name)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getDesktop

public Desktop getDesktop()
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getDesktop

public Desktop getDesktop(ComponentMatcher matcher)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTextBox

public TextBox getTextBox(java.lang.String name)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTextBox

public TextBox getTextBox()
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTextBox

public TextBox getTextBox(ComponentMatcher matcher)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getInputTextBox

public TextBox getInputTextBox(java.lang.String name)
                        throws ComponentAmbiguityException,
                               ItemNotFoundException

Retrieves input-only text boxes. This is useful for avoiding ambiguity exceptions when the input text boxes are laid out near labels, as in most forms.

"Input text boxes" are defined as subclasses of the JTextComponent class - in other words, JLabel components are excluded from the search. Please note that the is is not necessarily visible from the user, since JTextComponent subclasses can be customized to look as ordinary, read-only labels.

Throws:

ComponentAmbiguityException

ItemNotFoundException

getInputTextBox

public TextBox getInputTextBox()
                        throws ComponentAmbiguityException,
                               ItemNotFoundException

Retrieves input-only text boxes.

Throws:

ComponentAmbiguityException

ItemNotFoundException

See Also:

getInputTextBox(String)

getTabGroup

public TabGroup getTabGroup(java.lang.String name)
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTabGroup

public TabGroup getTabGroup()
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTabGroup

public TabGroup getTabGroup(ComponentMatcher matcher)
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getComboBox

public ComboBox getComboBox(java.lang.String name)
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getComboBox

public ComboBox getComboBox()
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getComboBox

public ComboBox getComboBox(ComponentMatcher matcher)
                     throws ItemNotFoundException,
                            ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getSpinner

public Spinner getSpinner()
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getSpinner

public Spinner getSpinner(java.lang.String name)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getSpinner

public Spinner getSpinner(ComponentMatcher matcher)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getDateSpinner

public DateSpinner getDateSpinner()
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getDateSpinner

public DateSpinner getDateSpinner(java.lang.String componentName)

getDateSpinner

public DateSpinner getDateSpinner(ComponentMatcher matcher)

getListSpinner

public ListSpinner getListSpinner()
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getListSpinner

public ListSpinner getListSpinner(java.lang.String componentName)

getListSpinner

public ListSpinner getListSpinner(ComponentMatcher matcher)

getNumberSpinner

public NumberSpinner getNumberSpinner()
                               throws ItemNotFoundException,
                                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getNumberSpinner

public NumberSpinner getNumberSpinner(java.lang.String componentName)

getNumberSpinner

public NumberSpinner getNumberSpinner(ComponentMatcher matcher)

getSlider

public Slider getSlider()
                 throws ItemNotFoundException,
                        ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getSlider

public Slider getSlider(java.lang.String name)
                 throws ItemNotFoundException,
                        ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getSlider

public Slider getSlider(ComponentMatcher matcher)
                 throws ItemNotFoundException,
                        ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTable

public Table getTable(java.lang.String name)
               throws ItemNotFoundException,
                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTable

public Table getTable()
               throws ItemNotFoundException,
                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTable

public Table getTable(ComponentMatcher matcher)
               throws ItemNotFoundException,
                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTree

public Tree getTree(java.lang.String name)
             throws ItemNotFoundException,
                    ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTree

public Tree getTree()
             throws ItemNotFoundException,
                    ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getTree

public Tree getTree(ComponentMatcher matcher)
             throws ItemNotFoundException,
                    ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getRadioButton

public RadioButton getRadioButton(java.lang.String name)
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getRadioButton

public RadioButton getRadioButton()
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getRadioButton

public RadioButton getRadioButton(ComponentMatcher matcher)
                           throws ItemNotFoundException,
                                  ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getListBox

public ListBox getListBox(java.lang.String name)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getListBox

public ListBox getListBox()
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getListBox

public ListBox getListBox(ComponentMatcher matcher)
                   throws ItemNotFoundException,
                          ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getPasswordField

public PasswordField getPasswordField()
                               throws ItemNotFoundException,
                                      ComponentAmbiguityException

Throws:

ItemNotFoundException

ComponentAmbiguityException

getPasswordField

public PasswordField getPasswordField(ComponentMatcher matcher)

getPasswordField

public PasswordField getPasswordField(java.lang.String componentName)

getUIComponents

public UIComponent[] getUIComponents(java.lang.Class uiComponentClass)

getUIComponents

public UIComponent[] getUIComponents(java.lang.Class uiComponentClass,
                                     java.lang.String name)

getUIComponents

public UIComponent[] getUIComponents(ComponentMatcher matcher)

findUIComponent

public <T extends UIComponent> T findUIComponent(java.lang.Class<T> uiComponentClass)
                                      throws ComponentAmbiguityException

Throws:

ComponentAmbiguityException

findUIComponent

public <T extends UIComponent> T findUIComponent(java.lang.Class<T> uiComponentClass,
                                                 java.lang.String name)
                                      throws ComponentAmbiguityException

Throws:

ComponentAmbiguityException

findUIComponent

public UIComponent findUIComponent(ComponentMatcher matcher)
                            throws ComponentAmbiguityException

Throws:

ComponentAmbiguityException

getSwingComponents

public java.awt.Component[] getSwingComponents(java.lang.Class swingComponentClass)

getSwingComponents

public java.awt.Component[] getSwingComponents(java.lang.Class swingComponentClass,
                                               java.lang.String name)

getSwingComponents

public java.awt.Component[] getSwingComponents(ComponentMatcher matcher)

findSwingComponent

public <T extends java.awt.Component> T findSwingComponent(java.lang.Class<T> swingComponentClass)
                                                throws ComponentAmbiguityException

Throws:

ComponentAmbiguityException

findSwingComponent

public <T extends java.awt.Component> T findSwingComponent(java.lang.Class<T> swingComponentClass,
                                                           java.lang.String componentName)
                                                throws ComponentAmbiguityException

Throws:

ComponentAmbiguityException

findSwingComponent

public java.awt.Component findSwingComponent(ComponentMatcher matcher)
                                      throws ComponentAmbiguityException

Throws:

ComponentAmbiguityException

containsUIComponent

public <T extends UIComponent> Assertion containsUIComponent(java.lang.Class<T> uicomponentClass)

containsSwingComponent

public <T extends java.awt.Component> Assertion containsSwingComponent(java.lang.Class<T> swingComponentClass)

containsUIComponent

public <T extends UIComponent> Assertion containsUIComponent(java.lang.Class<T> uiComponentClass,
                                                             java.lang.String name)

containsSwingComponent

public <T extends java.awt.Component> Assertion containsSwingComponent(java.lang.Class<T> swingComponentClass,
                                                                       java.lang.String name)

containsComponent

public Assertion containsComponent(ComponentMatcher matcher)

containsLabel

public Assertion containsLabel(java.lang.String text)

Checks that the panel contains a given non-editable text. This method is mainly suited for checking displayed messages in popped-up dialogs. NB: Only JLabel components are taken into account.