org.assertj.swing.jide.grids.driver

Class AbstractComboBoxDriver

java.lang.Object

org.assertj.swing.driver.ComponentDriver

org.assertj.swing.driver.ContainerDriver

org.assertj.swing.driver.JComponentDriver

org.assertj.swing.jide.grids.driver.AbstractComboBoxDriver

Direct Known Subclasses:

ListComboBoxDriver

public class AbstractComboBoxDriver
extends JComponentDriver

A driver for an AbstractComboBox. This is loosely based on the JComboBoxDriver class so a familiar usage pattern will exist between Swing combo boxes and JIDE combo boxes.

Author:

Peter Murray

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractComboBoxCellReader	_cellReader

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

robot

Constructor Summary

Constructors

Constructor and Description
AbstractComboBoxDriver(Robot robot)

Method Summary

Modifier and Type	Method and Description
protected boolean	areEqual(com.jidesoft.combobox.AbstractComboBox combo, Object o1, Object o2)
void	cellReader(AbstractComboBoxCellReader newCellReader) Updates the implementation of AbstractComboBoxCellReader to use when comparing internal values of a ListComboBox and the values expected in a test.
void	clickPopupButton(com.jidesoft.combobox.AbstractComboBox comboBox)
protected String	convertElementToString(com.jidesoft.combobox.AbstractComboBox comboBox, Object o) Converts an object that may be present in the ComboBox into a String representation.
void	deleteText(com.jidesoft.combobox.AbstractComboBox comboBox) Deletes the text of the AbstractComboBox.
void	enterText(com.jidesoft.combobox.AbstractComboBox comboBox, String text) Simulates a user entering the specified text in the AbstractComboBox.
String	getEditorText(com.jidesoft.combobox.AbstractComboBox comboBox)
protected Component	getInteractionComponent(Component c) Obtains the component that the user will interact with, which could be the actual combo box, or the editor component, depending upon the state of the combo box.
String	getStringRepresentation(com.jidesoft.combobox.AbstractComboBox box, Object o)
protected boolean	isDropDownVisible(com.jidesoft.combobox.AbstractComboBox comboBox)
protected Object	itemAt(com.jidesoft.combobox.AbstractComboBox comboBox, int index)
void	pressAndReleaseKey(Component c, int keyCode, int[] modifiers) We need to cater for the editor component if we are editable.
void	pressAndReleaseKey(Component c, KeyPressInfo keyPressInfo) We need to cater for the editor component if we are editable.
void	pressAndReleaseKeys(Component c, int... keyCodes) We need to cater for the editor component if we are editable.
void	pressKey(Component c, int keyCode) Simulates a user pressing given key on the Component.
void	releaseKey(Component c, int keyCode) Simulates a user releasing the given key on the Component.
void	replaceText(com.jidesoft.combobox.AbstractComboBox comboBox, String text) Simulates a user entering the specified text in the AbstractComboBox, replacing any text.
void	requireEditable(com.jidesoft.combobox.AbstractComboBox comboBox) Asserts that the given AbstractComboBox is editable.
void	requireEditorText(com.jidesoft.combobox.AbstractComboBox comboBox, String requiredText)
void	requireEnabled(com.jidesoft.combobox.AbstractComboBox comboBox)
void	requireNoSelection(com.jidesoft.combobox.AbstractComboBox comboBox)
void	requireNotEditable(com.jidesoft.combobox.AbstractComboBox comboBox) Asserts that the given AbstractComboBox is not editable.
void	requireNotEnabled(com.jidesoft.combobox.AbstractComboBox comboBox)
void	requirePopupVisible(com.jidesoft.combobox.AbstractComboBox target, boolean visible)
void	requireSelection(com.jidesoft.combobox.AbstractComboBox comboBox, String value)
void	selectAllText(com.jidesoft.combobox.AbstractComboBox comboBox) Simulates a user selecting the text in the AbstractComboBox.
protected String	selectedIndexProperty(com.jidesoft.combobox.AbstractComboBox comboBox)
protected int	size(com.jidesoft.combobox.AbstractComboBox comboBox)

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

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

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

doResizeHeight, doResizeWidth, isResizable, move, resize

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

backgroundOf, checkClickAllowed, checkInEdtEnabledAndShowing, checkInEdtShowing, click, click, click, click, click, doubleClick, drag, dragOver, drop, focus, focusAndWaitForFocusGain, fontOf, foregroundOf, invokePopupMenu, invokePopupMenu, moveMouseIgnoringAnyError, moveMouseIgnoringAnyError, performAccessibleActionOf, propertyName, 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 Detail

_cellReader

protected AbstractComboBoxCellReader _cellReader

Constructor Detail

AbstractComboBoxDriver

public AbstractComboBoxDriver(Robot robot)

Method Detail

deleteText

@RunsInEDT
public void deleteText(com.jidesoft.combobox.AbstractComboBox comboBox)

Deletes the text of the AbstractComboBox.

Parameters:

comboBox - the target AbstractComboBox.

Throws:

IllegalStateException - if the AbstractComboBox is disabled.

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

replaceText

@RunsInEDT
public void replaceText(com.jidesoft.combobox.AbstractComboBox comboBox,
                                   String text)

Simulates a user entering the specified text in the AbstractComboBox, replacing any text. This action is executed only if the AbstractComboBox is editable.

Parameters:

comboBox - the target AbstractComboBox.

text - the text to enter.

Throws:

IllegalStateException - if the AbstractComboBox is disabled.

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

IllegalStateException - if the AbstractComboBox is not editable.

selectAllText

@RunsInEDT
public void selectAllText(com.jidesoft.combobox.AbstractComboBox comboBox)

Simulates a user selecting the text in the AbstractComboBox. This action is executed only if the AbstractComboBox is editable.

Parameters:

comboBox - the target AbstractComboBox.

Throws:

IllegalStateException - if the AbstractComboBox is disabled.

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

IllegalStateException - if the AbstractComboBox is not editable.

pressAndReleaseKeys

@RunsInEDT
public void pressAndReleaseKeys(Component c,
                                           int... keyCodes)

We need to cater for the editor component if we are editable. When typing into an editable AbstractComboBox, the focus will move to the Editor, not the ComboBox instance which will result in AssertJ-Swing failing on waiting for focus to move to the comboBox.

Overrides:

pressAndReleaseKeys in class ComponentDriver

Parameters:

c - the target component.

keyCodes - one or more codes of the keys to press.

pressAndReleaseKey

@RunsInEDT
public void pressAndReleaseKey(Component c,
                                          KeyPressInfo keyPressInfo)

We need to cater for the editor component if we are editable. When typing into an editable AbstractComboBox, the focus will move to the Editor, not the ComboBox instance which will result in AssertJ-Swing failing on waiting for focus to move to the comboBox.

Overrides:

pressAndReleaseKey in class ComponentDriver

Parameters:

c - the target component.

keyPressInfo - specifies the key and modifiers to press.

pressAndReleaseKey

@RunsInEDT
public void pressAndReleaseKey(Component c,
                                          int keyCode,
                                          int[] modifiers)

We need to cater for the editor component if we are editable. When typing into an editable AbstractComboBox, the focus will move to the Editor, not the ComboBox instance which will result in AssertJ-Swing failing on waiting for focus to move to the comboBox.

Overrides:

pressAndReleaseKey in class ComponentDriver

Parameters:

c - the target component.

keyCode - the code of the key to press.

modifiers - the given modifiers.

pressKey

@RunsInEDT
public void pressKey(Component c,
                                int keyCode)

Simulates a user pressing given key on the Component.

Overrides:

pressKey in class ComponentDriver

Parameters:

c - the target component.

keyCode - the code of the key to press.

Throws:

IllegalArgumentException - if the given code is not a valid key code.

IllegalStateException - if the Component is disabled, or is not showing on the screen.

See Also:

KeyEvent

releaseKey

@RunsInEDT
public void releaseKey(Component c,
                                  int keyCode)

Simulates a user releasing the given key on the Component.

Overrides:

releaseKey in class ComponentDriver

Parameters:

c - the target component.

keyCode - the code of the key to release.

Throws:

IllegalArgumentException - if the given code is not a valid key code.

IllegalStateException - if the Component is disabled, or is not showing on the screen.

See Also:

KeyEvent

requireSelection

public void requireSelection(com.jidesoft.combobox.AbstractComboBox comboBox,
                             String value)

enterText

@RunsInEDT
public void enterText(com.jidesoft.combobox.AbstractComboBox comboBox,
                                 String text)

Simulates a user entering the specified text in the AbstractComboBox. This action is executed only if the AbstractComboBox is editable.

Parameters:

comboBox - the target AbstractComboBox.

text - the text to enter.

Throws:

IllegalStateException - if the AbstractComboBox is disabled.

IllegalStateException - if the AbstractComboBox is not editable or is not showing on the screen.

requireEditable

@RunsInEDT
public void requireEditable(com.jidesoft.combobox.AbstractComboBox comboBox)

Asserts that the given AbstractComboBox is editable.

Parameters:

comboBox - the target AbstractComboBox.

Throws:

AssertionError - if the AbstractComboBox is not editable.

requireNotEditable

@RunsInEDT
public void requireNotEditable(com.jidesoft.combobox.AbstractComboBox comboBox)

Asserts that the given AbstractComboBox is not editable.

Parameters:

comboBox - the given AbstractComboBox.

Throws:

AssertionError - if the AbstractComboBox is editable.

requireNotEnabled

@RunsInEDT
public void requireNotEnabled(com.jidesoft.combobox.AbstractComboBox comboBox)

requireEnabled

@RunsInEDT
public void requireEnabled(com.jidesoft.combobox.AbstractComboBox comboBox)

getStringRepresentation

public String getStringRepresentation(com.jidesoft.combobox.AbstractComboBox box,
                                      Object o)

getEditorText

public String getEditorText(com.jidesoft.combobox.AbstractComboBox comboBox)

requireEditorText

public void requireEditorText(com.jidesoft.combobox.AbstractComboBox comboBox,
                              String requiredText)

requireNoSelection

public void requireNoSelection(com.jidesoft.combobox.AbstractComboBox comboBox)

convertElementToString

protected String convertElementToString(com.jidesoft.combobox.AbstractComboBox comboBox,
                                        Object o)

Converts an object that may be present in the ComboBox into a String representation.

Parameters:

comboBox - The comboBox to convert the object for.

o - The object to convert into a String.

Returns:

The object passed in converted in to a String so that it would appear as it would to a user selecting the value in the ComboBox.

isDropDownVisible

protected boolean isDropDownVisible(com.jidesoft.combobox.AbstractComboBox comboBox)

size

protected int size(com.jidesoft.combobox.AbstractComboBox comboBox)

itemAt

protected Object itemAt(com.jidesoft.combobox.AbstractComboBox comboBox,
                        int index)

areEqual

protected boolean areEqual(com.jidesoft.combobox.AbstractComboBox combo,
                           Object o1,
                           Object o2)

selectedIndexProperty

protected String selectedIndexProperty(com.jidesoft.combobox.AbstractComboBox comboBox)

cellReader

public void cellReader(AbstractComboBoxCellReader newCellReader)

Updates the implementation of AbstractComboBoxCellReader to use when comparing internal values of a ListComboBox and the values expected in a test.

Parameters:

newCellReader - the new ListComboBoxCellValueReader to use.

Throws:

IllegalArgumentException - if newCellReader is null.

clickPopupButton

@RunsInEDT
public void clickPopupButton(com.jidesoft.combobox.AbstractComboBox comboBox)

getInteractionComponent

@RunsInEDT
protected Component getInteractionComponent(Component c)

Obtains the component that the user will interact with, which could be the actual combo box, or the editor component, depending upon the state of the combo box.

Parameters:

c - The Component to obtain the interactive component from.

Returns:

The Component that the user is to interact with.

requirePopupVisible

public void requirePopupVisible(com.jidesoft.combobox.AbstractComboBox target,
                                boolean visible)