com.axway.ats.uiengine.engine

Class SwingEngine

java.lang.Object

com.axway.ats.uiengine.internal.engine.AbstractEngine

com.axway.ats.uiengine.engine.SwingEngine

public class SwingEngine
extends AbstractEngine

Field Summary

Fields inherited from class com.axway.ats.uiengine.internal.engine.AbstractEngine

elementsFactory, uiDriver

Constructor Summary

Constructors

Constructor and Description
SwingEngine(UiDriver uiDriver)

Method Summary

Modifier and Type	Method and Description
SwingButton	getButton(String mapId)
SwingButton	getButton(UiElementProperties properties)
SwingCheckBox	getCheckBox(String mapId)
SwingCheckBox	getCheckBox(UiElementProperties properties)
SwingComboBox	getComboBox(String mapId)
SwingComboBox	getComboBox(UiElementProperties properties)
SwingComponent	getComponent(String mapId)
SwingComponent	getComponent(UiElementProperties properties)
String	getComponentHierarchy()
SwingFileBrowse	getFileBrowse()
SwingLabel	getLabel(String mapId)
SwingLabel	getLabel(UiElementProperties properties)
SwingMenuItem	getMenuItem(String mapId)
SwingMenuItem	getMenuItem(UiElementProperties properties)
SwingMultiSelectList	getMultiSelectList(String mapId)
SwingMultiSelectList	getMultiSelectList(UiElementProperties properties)
SwingOptionPane	getOptionPane()
SwingPopupMenu	getPopupMenu(String mapId)
SwingPopupMenu	getPopupMenu(UiElementProperties properties)
SwingRadioButton	getRadioButton(String mapId)
SwingRadioButton	getRadioButton(UiElementProperties properties)
SwingSingleSelectList	getSingleSelectList(String mapId)
SwingSingleSelectList	getSingleSelectList(UiElementProperties properties)
SwingSpinner	getSpinner(String mapId)
SwingSpinner	getSpinner(UiElementProperties properties)
SwingTabbedPane	getTabbedPane(String mapId)
SwingTabbedPane	getTabbedPane(UiElementProperties properties)
SwingTable	getTable(String mapId)
SwingTable	getTable(UiElementProperties properties)
SwingTextArea	getTextArea(String mapId)
SwingTextArea	getTextArea(UiElementProperties properties)
SwingToggleButton	getToggleButton(String mapId)
SwingToggleButton	getToggleButton(UiElementProperties properties)
SwingTree	getTree(String mapId)
SwingTree	getTree(UiElementProperties properties)
SwingElementState	getUtilsElementState(UiElement uiElement)
void	goToContainer(String containerMapId) Set active container under the current window
void	goToContainer(UiElementProperties containerProperties) Set active container under the current window
void	goToMainContainer() Sets active container to the current window, i.e.
void	goToMainWindow() Set current window to work with.
void	goToWindow(String windowTitle, boolean isDialog) Set current window to work with.
void	goToWindow(String windowTitle, boolean isDialog, int timeout) Set current window to work with.
void	useComponentInspector() Whether to use component inspector tool, which logs the selected component type, its available properties and calculates its index in the component hierarchy tree in the scope of the current container. The tool works with mouse click action only.

Methods inherited from class com.axway.ats.uiengine.internal.engine.AbstractEngine

getMapSection, loadMapFile, setMapSection

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingEngine

public SwingEngine(UiDriver uiDriver)

Method Detail

getUtilsElementState

public SwingElementState getUtilsElementState(UiElement uiElement)

Parameters:

uiElement - the element to work with

Returns:

a utility class for checking the state of element

getButton

public SwingButton getButton(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingButton instance

getButton

public SwingButton getButton(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingButton instance

getMenuItem

public SwingMenuItem getMenuItem(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingMenuItem instance

getMenuItem

public SwingMenuItem getMenuItem(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingMenuItem instance

getPopupMenu

public SwingPopupMenu getPopupMenu(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingPopupMenu instance

getPopupMenu

public SwingPopupMenu getPopupMenu(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingPopupMenu instance

getTextArea

public SwingTextArea getTextArea(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingTextArea instance

getTextArea

public SwingTextArea getTextArea(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingTextArea instance

getTree

public SwingTree getTree(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingTree instance

getTree

public SwingTree getTree(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingTree instance

getSingleSelectList

public SwingSingleSelectList getSingleSelectList(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingSingleSelectList instance

getSingleSelectList

public SwingSingleSelectList getSingleSelectList(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingSingleSelectList instance

getMultiSelectList

public SwingMultiSelectList getMultiSelectList(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingMultiSelectList instance

getMultiSelectList

public SwingMultiSelectList getMultiSelectList(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingMultiSelectList instance

getComboBox

public SwingComboBox getComboBox(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingComboBox instance

getComboBox

public SwingComboBox getComboBox(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingComboBox instance

getComponent

public SwingComponent getComponent(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingComponent instance

getComponent

public SwingComponent getComponent(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingComponent instance

getOptionPane

public SwingOptionPane getOptionPane()

Returns:

a new SwingOptionPane instance

getFileBrowse

public SwingFileBrowse getFileBrowse()

Returns:

a new SwingFileBrowse instance

getCheckBox

public SwingCheckBox getCheckBox(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingCheckBox instance

getCheckBox

public SwingCheckBox getCheckBox(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingCheckBox instance

getToggleButton

public SwingToggleButton getToggleButton(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingToggleButton instance

getToggleButton

public SwingToggleButton getToggleButton(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingToggleButton instance

getRadioButton

public SwingRadioButton getRadioButton(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingRadioButton instance

getRadioButton

public SwingRadioButton getRadioButton(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingRadioButton instance

getTable

public SwingTable getTable(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingTable instance

getTable

public SwingTable getTable(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingTable instance

getLabel

public SwingLabel getLabel(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingLabel instance

getLabel

public SwingLabel getLabel(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingLabel instance

getSpinner

public SwingSpinner getSpinner(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingSpinner instance

getSpinner

public SwingSpinner getSpinner(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingSpinner instance

getTabbedPane

public SwingTabbedPane getTabbedPane(String mapId)

Parameters:

mapId - the element's map id

Returns:

a new SwingTabbedPane instance

getTabbedPane

public SwingTabbedPane getTabbedPane(UiElementProperties properties)

Parameters:

properties - properties describing this element

Returns:

a new SwingTabbedPane instance

goToMainWindow

public void goToMainWindow()

Set current window to work with.

Throws:

ElementNotFoundException - if the frame/dialog is not found or several are found with such title

goToWindow

public void goToWindow(String windowTitle,
                       boolean isDialog)
                throws ElementNotFoundException

Set current window to work with. Window can be frame or dialog.

Parameters:

windowTitle - the window title

isDialog - if the window is dialog or not( i.e. frame)

Throws:

ElementNotFoundException - if the frame/dialog is not found

goToWindow

public void goToWindow(String windowTitle,
                       boolean isDialog,
                       int timeout)
                throws ElementNotFoundException

Set current window to work with. Window can be frame or dialog.

Parameters:

windowTitle - the window title

isDialog - if the window is dialog or not( i.e. frame)

timeout - maximum time to wait for the window to appear. Measured in milliseconds

Throws:

ElementNotFoundException - if the frame/dialog is not found

goToContainer

public void goToContainer(UiElementProperties containerProperties)

Set active container under the current window

Parameters:

containerProperties - UiElementProperties which contains the container 'name' or 'title' property

Throws:

ElementNotFoundException - if the container element is not found

goToContainer

public void goToContainer(String containerMapId)

Set active container under the current window

Parameters:

containerMapId - container element mapId. The element requires 'name' or 'title' property.

Throws:

ElementNotFoundException - if the container element is not found

goToMainContainer

public void goToMainContainer()

Sets active container to the current window, i.e. goes to top of current window.

getComponentHierarchy

public String getComponentHierarchy()

Returns:

current container component hierarchy as String

useComponentInspector

public void useComponentInspector()

Whether to use component inspector tool, which logs the selected component type, its available properties and calculates its index in the component hierarchy tree in the scope of the current container.
The tool works with mouse click action only.