mmarquee.automation.controls

Class AutomationContainer

java.lang.Object

mmarquee.automation.controls.AutomationBase

mmarquee.automation.controls.AutomationContainer

Direct Known Subclasses:

AutomationPanel, AutomationReBar, AutomationRibbonCommandBar, AutomationRibbonWorkPane, AutomationStatusBar, AutomationTab, AutomationTitleBar, AutomationToolBar, AutomationWindow

public class AutomationContainer
extends AutomationBase

Created by inpwt on 28/01/2016. Encapsulates the functionality of 'containers' i.e. elemenst that host other elements

Field Summary

Fields inherited from class mmarquee.automation.controls.AutomationBase

automation, element, user32

Constructor Summary

Constructors

Constructor and Description
AutomationContainer(AutomationElement element) Constructor for AutomationContainer

Method Summary

Modifier and Type	Method and Description
void	dumpUI() Dumps the control tree, used for exploring interfaces
AutomationAppBar	getAppBar(int index) Get the AppBar associated with the given index
AutomationButton	getButton(int index) Gets the button control associated with the given index
AutomationButton	getButton(String name) Gets the button control associated with the given name
AutomationButton	getButtonByAutomationId(String id) Gets the button using the automation ID
AutomationCalendar	getCalendar(int index) Gets the calendar control associated with the given index
AutomationCheckbox	getCheckbox(int index) Gets the checkbox associated with the given index
AutomationComboBox	getCombobox(int index) Gets the combobox control associated with the given name
AutomationComboBox	getCombobox(String name) Gets the combobox control associated with the given name
protected AutomationElement	getControlByAutomationId(String automationId, int controlType) Gets the control by the control type and automation ID
protected AutomationElement	getControlByControlType(int index, int id, String controlName) Gets the control by the control type, for s given control index
protected AutomationElement	getControlByControlType(String name, int id) Gets the control by the control type
protected AutomationElement	getControlByControlType(String name, int id, String controlName) Gets the control by the control type, for s given control index.
AutomationCustom	getCustom(String name) Get the AutomationCustom element associated with the given name
AutomationDataGrid	getDataGrid(int index) Gets the String Grid control associated with the given index
AutomationDataGrid	getDataGrid(int index, String controlName) Gets the String Grid control associated with the given index, with a specific control name
AutomationDocument	getDocument(int index) Gets the document associated with the given index
AutomationEditBox	getEditBox(int index) Gets the Editbox control associated with the given index
AutomationEditBox	getEditBox(String name) Gets the Editbox control associated with the given name
AutomationHyperlink	getHyperlink(int index) Gets the hyperlink control associated with the given index
AutomationImage	getImage(String name) Get the AutomationImage associated with the given name
AutomationList	getListItem(int index) Gets the list control associated with the given index
AutomationMaskedEdit	getMaskedEdit(int index) Gets the (JHC) Masked Edit control associated with the given index
AutomationMaskedEdit	getMaskedEdit(String name) Gets the (JHC) Masked Edit control associated with the given index
AutomationPanel	getPanel(int index) Gets the panel control associated with the given index
AutomationPanel	getPanel(String name) Gets the panel control associated with the given name
AutomationEditBox	getPasswordEditBox(int index) Gets the EditBox (with password marking) associated with the given index
AutomationProgressBar	getProgressBar(int index) Gets the ProgressBar control associated with the given index
AutomationProgressBar	getProgressBar(String name) Gets the ProgressBar control associated with the given index
AutomationRadioButton	getRadioButton(int index) Gets the radio button control associated with the given index
AutomationReBar	getReBar(int index) Gets the AutomationReBar associated with this index
AutomationRibbonBar	getRibbonBar() Get the RibbonBar associated this container
AutomationSlider	getSlider(int index) Gets the slider control associated with the given index
AutomationSlider	getSlider(String name) Gets the slider control associated with the given index
AutomationSpinner	getSpinner(String name) Get the AutomationSpinner element associated with the given name
AutomationSplitButton	getSplitButton(String name) Get the AutomationSplitButton associated with the given name
AutomationTab	getTab(int index) Gets the Tab control associated with the given index
AutomationTextBox	getTextBox(int index) Gets the text box control associated with the given index
AutomationToolBar	getToolBar(int index) Get the ToolBar associated with the given index
AutomationToolBar	getToolBar(String name) Get the ToolBar associated with the given name
AutomationTreeView	getTreeView(int index) Gets the treeview control associated with the given index
AutomationTreeView	getTreeView(String name) Gets the treeview control associated with the given name

Methods inherited from class mmarquee.automation.controls.AutomationBase

createAndCondition, createAutomationIdPropertyCondition, createControlTypeCondition, createFalseCondition, createNamePropertyCondition, createOrCondition, createTrueCondition, findAll, findAll, findAll, findAllBuildCache, findFirst, findFirstBuildCache, getAcceleratorKey, getAriaRole, getBoundingRectangle, getClickablePoint, getExpandCollapsePattern, getFramework, getFrameworkId, getGridPattern, getInvokePattern, getItemStatus, getNativeWindowHandle, getOrientation, getProcessId, getProviderDescription, getRangePattern, getRuntimeId, getSelectionPattern, getSelectItemPattern, getTablePattern, getTextPattern, getTogglePattern, getValuePattern, getWindowPattern, isDockPatternAvailable, isEnabled, isExpandCollapsePatternAvailable, isGridItemPatternAvailable, isGridPatternAvailable, isInvokePatternAvailable, isMultipleViewPatternAvailable, isOffScreen, isRangeValuePatternAvailable, isScrollItemPatternAvailable, isScrollPatternAvailable, isSelectionItemPatternAvailable, isSelectionPatternAvailable, isTableItemPatternAvailable, isTablePatternAvailable, isTextPatternAvailable, isTogglePatternAvailable, isTransformPatternAvailable, isValuePatternAvailable, isWindowPatternAvailable, name, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomationContainer

public AutomationContainer(AutomationElement element)

Constructor for AutomationContainer

Parameters:

element - The underlying element

Method Detail

getControlByControlType

protected AutomationElement getControlByControlType(int index,
                                                    int id,
                                                    String controlName)

Gets the control by the control type, for s given control index

Parameters:

index - Index of the control

id - Control type

controlName - The control name to use

Returns:

The matching element

getControlByControlType

protected AutomationElement getControlByControlType(String name,
                                                    int id,
                                                    String controlName)
                                             throws ElementNotFoundException

Gets the control by the control type, for s given control index. There is probably a much better way of doing this

Parameters:

name - Name of the control

id - Control type

controlName - The control name to use

Returns:

The matching element

Throws:

ElementNotFoundException - Did not find the element

getControlByControlType

protected AutomationElement getControlByControlType(String name,
                                                    int id)
                                             throws ElementNotFoundException

Gets the control by the control type

Parameters:

name - Name to use

id - Control type

Returns:

The matching element

Throws:

ElementNotFoundException - Did not find the element

getControlByAutomationId

protected AutomationElement getControlByAutomationId(String automationId,
                                                     int controlType)
                                              throws ElementNotFoundException

Gets the control by the control type and automation ID

Parameters:

automationId - Name to use

controlType - Control type

Returns:

The matching element

Throws:

ElementNotFoundException - Did not find the element

getCheckbox

public AutomationCheckbox getCheckbox(int index)

Gets the checkbox associated with the given index

Parameters:

index - Index of the control

Returns:

AutomationCheckbox that represents the found control

getTab

public AutomationTab getTab(int index)

Gets the Tab control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getEditBox

public AutomationEditBox getEditBox(int index)

Gets the Editbox control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getPasswordEditBox

public AutomationEditBox getPasswordEditBox(int index)

Gets the EditBox (with password marking) associated with the given index

Parameters:

index - The index

Returns:

The found control

getProgressBar

public AutomationProgressBar getProgressBar(int index)

Gets the ProgressBar control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getProgressBar

public AutomationProgressBar getProgressBar(String name)
                                     throws ElementNotFoundException

Gets the ProgressBar control associated with the given index

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getEditBox

public AutomationEditBox getEditBox(String name)
                             throws ElementNotFoundException

Gets the Editbox control associated with the given name

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getSlider

public AutomationSlider getSlider(int index)

Gets the slider control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getSlider

public AutomationSlider getSlider(String name)
                           throws ElementNotFoundException

Gets the slider control associated with the given index

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getMaskedEdit

public AutomationMaskedEdit getMaskedEdit(int index)

Gets the (JHC) Masked Edit control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getMaskedEdit

public AutomationMaskedEdit getMaskedEdit(String name)
                                   throws ElementNotFoundException

Gets the (JHC) Masked Edit control associated with the given index

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getRadioButton

public AutomationRadioButton getRadioButton(int index)

Gets the radio button control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getTextBox

public AutomationTextBox getTextBox(int index)

Gets the text box control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getCombobox

public AutomationComboBox getCombobox(int index)
                               throws ElementNotFoundException

Gets the combobox control associated with the given name

Parameters:

index - Index of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getCombobox

public AutomationComboBox getCombobox(String name)
                               throws ElementNotFoundException

Gets the combobox control associated with the given name

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getButton

public AutomationButton getButton(String name)
                           throws ElementNotFoundException

Gets the button control associated with the given name

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getButtonByAutomationId

public AutomationButton getButtonByAutomationId(String id)
                                         throws ElementNotFoundException

Gets the button using the automation ID

Parameters:

id - The automation id

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getButton

public AutomationButton getButton(int index)

Gets the button control associated with the given index

Parameters:

index - The index of the button

Returns:

The AutomationButton

getDataGrid

public AutomationDataGrid getDataGrid(int index,
                                      String controlName)

Gets the String Grid control associated with the given index, with a specific control name

Parameters:

index - Index of the control

controlName* -

Returns:

The found control

getDataGrid

public AutomationDataGrid getDataGrid(int index)

Gets the String Grid control associated with the given index

Parameters:

index - The index to look for

Returns:

The string grid

getDocument

public AutomationDocument getDocument(int index)

Gets the document associated with the given index

Parameters:

index - Index of the control

Returns:

The document control

getHyperlink

public AutomationHyperlink getHyperlink(int index)

Gets the hyperlink control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getTreeView

public AutomationTreeView getTreeView(int index)

Gets the treeview control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getTreeView

public AutomationTreeView getTreeView(String name)
                               throws ElementNotFoundException

Gets the treeview control associated with the given name

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getListItem

public AutomationList getListItem(int index)

Gets the list control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getCalendar

public AutomationCalendar getCalendar(int index)

Gets the calendar control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getPanel

public AutomationPanel getPanel(int index)

Gets the panel control associated with the given index

Parameters:

index - Index of the control

Returns:

The found control

getPanel

public AutomationPanel getPanel(String name)
                         throws ElementNotFoundException

Gets the panel control associated with the given name

Parameters:

name - Name of the control

Returns:

The found control

Throws:

ElementNotFoundException - Did not find the element

getAppBar

public AutomationAppBar getAppBar(int index)

Get the AppBar associated with the given index

Parameters:

index - The index

Returns:

The AutomationAppBar

getToolBar

public AutomationToolBar getToolBar(String name)
                             throws ElementNotFoundException

Get the ToolBar associated with the given name

Parameters:

name - The name

Returns:

The AutomationToolBar

Throws:

ElementNotFoundException - Did not find the element

getToolBar

public AutomationToolBar getToolBar(int index)

Get the ToolBar associated with the given index

Parameters:

index - The index

Returns:

The AutomationToolBar

getRibbonBar

public AutomationRibbonBar getRibbonBar()

Get the RibbonBar associated this container

Returns:

The AutomationRibbonBar

getReBar

public AutomationReBar getReBar(int index)

Gets the AutomationReBar associated with this index

Parameters:

index - The index

Returns:

The control wrapper

getSplitButton

public AutomationSplitButton getSplitButton(String name)
                                     throws ElementNotFoundException

Get the AutomationSplitButton associated with the given name

Parameters:

name - The name to look for

Returns:

The AutomationSplitButton

Throws:

ElementNotFoundException - Did not find the element

getImage

public AutomationImage getImage(String name)
                         throws ElementNotFoundException

Get the AutomationImage associated with the given name

Parameters:

name - The name to look for

Returns:

The AutomationImage

Throws:

ElementNotFoundException - Did not find the element

getSpinner

public AutomationSpinner getSpinner(String name)
                             throws ElementNotFoundException

Get the AutomationSpinner element associated with the given name

Parameters:

name - The name to look for

Returns:

The AutomationSpinner control

Throws:

ElementNotFoundException - Did not find the element

getCustom

public AutomationCustom getCustom(String name)
                           throws ElementNotFoundException

Get the AutomationCustom element associated with the given name

Parameters:

name - The name to look for

Returns:

The AutomationCustom

Throws:

ElementNotFoundException - Did not find the element

dumpUI

public void dumpUI()

Dumps the control tree, used for exploring interfaces