mmarquee.automation.controls

Class AutomationBase

java.lang.Object

mmarquee.automation.controls.AutomationBase

Direct Known Subclasses:

AutomationAppBar, AutomationApplication, AutomationButton, AutomationCalendar, AutomationCheckbox, AutomationComboBox, AutomationContainer, AutomationCustom, AutomationDataGrid, AutomationDataGridCell, AutomationDocument, AutomationEditBox, AutomationHyperlink, AutomationImage, AutomationList, AutomationListItem, AutomationMainMenu, AutomationMenu, AutomationMenuItem, AutomationProgressBar, AutomationRadioButton, AutomationSlider, AutomationSpinner, AutomationSystemMenu, AutomationTabItem, AutomationTextBox, AutomationTreeView, AutomationTreeViewItem

public abstract class AutomationBase
extends Object

Created by inpwt on 26/01/2016. The base for automation.

Field Summary

Fields

Modifier and Type	Field and Description
protected UIAutomation	automation
protected AutomationElement	element
protected com.sun.jna.platform.win32.User32	user32

Constructor Summary

Constructors

Constructor and Description
AutomationBase(AutomationElement element) Constructor for the AutomationBase class

Method Summary

Modifier and Type	Method and Description
AndCondition	createAndCondition(Condition condition1, Condition condition2) Creates an AND condition
AutomationIdCondition	createAutomationIdPropertyCondition(String automationId) Creats an automation ID property condition
ControlIdCondition	createControlTypeCondition(int id) Creates a control type property condition
FalseCondition	createFalseCondition() Creates a false condition
NameCondition	createNamePropertyCondition(String name) Creates a name property condition
OrCondition	createOrCondition(Condition condition1, Condition condition2) Creates an OR condition
TrueCondition	createTrueCondition() Creates a true condition
protected List<AutomationElement>	findAll() Finds all of the elements that are associated with this element
protected List<AutomationElement>	findAll(TreeScope scope) Finds all of the elements that are associated with the given condition.
protected List<AutomationElement>	findAll(TreeScope scope, Condition condition) Finds all of the elements that are associated with the given condition.
List<AutomationElement>	findAllBuildCache(CacheRequest cacheRequest) Find all, but from the cache
protected AutomationElement	findFirst(TreeScope scope, Condition condition) Finds the first match for the condition
protected AutomationElement	findFirstBuildCache(CacheRequest cacheRequest)
String	getAcceleratorKey() Gets the current accelerator key for th element
String	getAriaRole() Gets the ARIA role of the element
com.sun.jna.platform.win32.WinDef.RECT	getBoundingRectangle() Gets the bounding rectangle of the control
com.sun.jna.platform.win32.WinDef.POINT	getClickablePoint() Gets a clickable point for the control This is manufactured by getting the bouning rect and finding the middle point.
protected ExpandCollapse	getExpandCollapsePattern() Gets the expand/collapse pattern for this control
Object	getFramework() Gets the framework used by the element
String	getFrameworkId() Gets the current framework ID for the element
protected Grid	getGridPattern() Gets the grid pattern for this control
protected Invoke	getInvokePattern() Gets the invoke pattern for this control
String	getItemStatus() Gets the current item status
com.sun.jna.platform.win32.WinDef.HWND	getNativeWindowHandle() Get the native window handle
OrientationType	getOrientation() The current orientation of the element
Object	getProcessId() Gets the processID of the element
String	getProviderDescription() Gets the current provider description
protected Range	getRangePattern() Gets the rangevalue pattern for this control
int[]	getRuntimeId() Gets the runtime id
protected Selection	getSelectionPattern() Gets the selection pattern for this control
protected SelectionItem	getSelectItemPattern() Gets the selectItem pattern for this control
protected Table	getTablePattern() Gets the table pattern for this control
protected Text	getTextPattern() Gets the text pattern for this control
protected Toggle	getTogglePattern() Gets the toggle pattern for this control
protected Value	getValuePattern() Gets the value pattern for this control
protected Window	getWindowPattern() Gets the window pattern for this control
protected boolean	isDockPatternAvailable()
boolean	isEnabled() Is the control enabled
protected boolean	isExpandCollapsePatternAvailable()
protected boolean	isGridItemPatternAvailable()
protected boolean	isGridPatternAvailable()
protected boolean	isInvokePatternAvailable()
protected boolean	isMultipleViewPatternAvailable()
protected boolean	isOffScreen() Is the control off screen?
protected boolean	isRangeValuePatternAvailable()
protected boolean	isScrollItemPatternAvailable()
protected boolean	isScrollPatternAvailable()
protected boolean	isSelectionItemPatternAvailable()
protected boolean	isSelectionPatternAvailable()
protected boolean	isTableItemPatternAvailable()
protected boolean	isTablePatternAvailable()
protected boolean	isTextPatternAvailable()
protected boolean	isTogglePatternAvailable()
protected boolean	isTransformPatternAvailable()
protected boolean	isValuePatternAvailable()
protected boolean	isWindowPatternAvailable()
String	name() Gets the name associated with this element
void	setName(String name) Sets the name of the element

Methods inherited from class java.lang.Object

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

Field Detail

element

protected AutomationElement element

automation

protected UIAutomation automation

user32

protected final com.sun.jna.platform.win32.User32 user32

Constructor Detail

AutomationBase

public AutomationBase(AutomationElement element)

Constructor for the AutomationBase class

Parameters:

element - Element to use

Method Detail

isDockPatternAvailable

protected boolean isDockPatternAvailable()

isExpandCollapsePatternAvailable

protected boolean isExpandCollapsePatternAvailable()

isGridItemPatternAvailable

protected boolean isGridItemPatternAvailable()

isMultipleViewPatternAvailable

protected boolean isMultipleViewPatternAvailable()

isInvokePatternAvailable

protected boolean isInvokePatternAvailable()

isGridPatternAvailable

protected boolean isGridPatternAvailable()

isRangeValuePatternAvailable

protected boolean isRangeValuePatternAvailable()

isScrollPatternAvailable

protected boolean isScrollPatternAvailable()

isSelectionItemPatternAvailable

protected boolean isSelectionItemPatternAvailable()

isScrollItemPatternAvailable

protected boolean isScrollItemPatternAvailable()

isWindowPatternAvailable

protected boolean isWindowPatternAvailable()

isTextPatternAvailable

protected boolean isTextPatternAvailable()

isTableItemPatternAvailable

protected boolean isTableItemPatternAvailable()

isTablePatternAvailable

protected boolean isTablePatternAvailable()

isSelectionPatternAvailable

protected boolean isSelectionPatternAvailable()

isTransformPatternAvailable

protected boolean isTransformPatternAvailable()

isTogglePatternAvailable

protected boolean isTogglePatternAvailable()

isValuePatternAvailable

protected boolean isValuePatternAvailable()

isOffScreen

protected boolean isOffScreen()

Is the control off screen?

Returns:

Off screen?

getClickablePoint

public com.sun.jna.platform.win32.WinDef.POINT getClickablePoint()

Gets a clickable point for the control This is manufactured by getting the bouning rect and finding the middle point.

Returns:

The clickable point

getProcessId

public Object getProcessId()

Gets the processID of the element

Returns:

The processId for the element

getFramework

public Object getFramework()

Gets the framework used by the element

Returns:

The framework object (really a string)

name

public String name()

Gets the name associated with this element

Returns:

The name of the element

setName

public void setName(String name)

Sets the name of the element

Parameters:

name - The name to be set.

findAll

protected List<AutomationElement> findAll()

Finds all of the elements that are associated with this element

Returns:

List List of elements

findFirst

protected AutomationElement findFirst(TreeScope scope,
                                      Condition condition)
                               throws ElementNotFoundException

Finds the first match for the condition

Parameters:

scope - The scope of where to look

condition - The condition to use

Returns:

The found AutomationElement

Throws:

ElementNotFoundException - No elements found

findAll

protected List<AutomationElement> findAll(TreeScope scope)

Finds all of the elements that are associated with the given condition.

Parameters:

scope - The scope of where to look

Returns:

List list of all the elements found

createTrueCondition

public TrueCondition createTrueCondition()

Creates a true condition

Returns:

The true condition

createFalseCondition

public FalseCondition createFalseCondition()

Creates a false condition

Returns:

The condition

createNamePropertyCondition

public NameCondition createNamePropertyCondition(String name)

Creates a name property condition

Parameters:

name - The name to use

Returns:

The condition

createAutomationIdPropertyCondition

public AutomationIdCondition createAutomationIdPropertyCondition(String automationId)

Creats an automation ID property condition

Parameters:

automationId - The automation ID to use

Returns:

The condition

createControlTypeCondition

public ControlIdCondition createControlTypeCondition(int id)

Creates a control type property condition

Parameters:

id - The control type to use

Returns:

The condition

createOrCondition

public OrCondition createOrCondition(Condition condition1,
                                     Condition condition2)

Creates an OR condition

Parameters:

condition1 - First condition

condition2 - Second condition

Returns:

The Or Condition

createAndCondition

public AndCondition createAndCondition(Condition condition1,
                                       Condition condition2)

Creates an AND condition

Parameters:

condition1 - First condition

condition2 - Second condition

Returns:

The And condition

findAll

protected List<AutomationElement> findAll(TreeScope scope,
                                          Condition condition)

Finds all of the elements that are associated with the given condition.

Parameters:

scope - The scope of where to look

condition - The condition to check

Returns:

IUIAutomationElementArray

getSelectItemPattern

protected SelectionItem getSelectItemPattern()
                                      throws PatternNotFoundException

Gets the selectItem pattern for this control

Returns:

Returns ths IUIAutomationSelectionItemPattern associated with this control

Throws:

PatternNotFoundException - Pattern not found

getSelectionPattern

protected Selection getSelectionPattern()
                                 throws PatternNotFoundException

Gets the selection pattern for this control

Returns:

Returns ths IUIAutomationSelectionPattern associated with this control

Throws:

PatternNotFoundException - Pattern not found

getValuePattern

protected Value getValuePattern()
                         throws PatternNotFoundException

Gets the value pattern for this control

Returns:

Returns ths IUIAutomationValuePattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getRangePattern

protected Range getRangePattern()
                         throws PatternNotFoundException

Gets the rangevalue pattern for this control

Returns:

Returns ths IUIAutomationRangeValuePattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getTablePattern

protected Table getTablePattern()
                         throws PatternNotFoundException

Gets the table pattern for this control

Returns:

Returns ths IUIAutomationTablePattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getWindowPattern

protected Window getWindowPattern()
                           throws PatternNotFoundException

Gets the window pattern for this control

Returns:

Returns ths IUIAutomationWindowPattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getExpandCollapsePattern

protected ExpandCollapse getExpandCollapsePattern()
                                           throws PatternNotFoundException

Gets the expand/collapse pattern for this control

Returns:

Returns ths IUIAutomationExpandCollapsePattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getGridPattern

protected Grid getGridPattern()
                       throws PatternNotFoundException

Gets the grid pattern for this control

Returns:

Returns ths IUIAutomationGridPattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getTogglePattern

protected Toggle getTogglePattern()
                           throws PatternNotFoundException

Gets the toggle pattern for this control

Returns:

Returns ths IUIAutomationTogglePattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getInvokePattern

protected Invoke getInvokePattern()
                           throws PatternNotFoundException

Gets the invoke pattern for this control

Returns:

Returns ths IUIAutomationInvokePattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

getTextPattern

protected Text getTextPattern()
                       throws PatternNotFoundException

Gets the text pattern for this control

Returns:

Returns ths IUIAutomationTextPattern associated with this control

Throws:

PatternNotFoundException - Pattern is not found

isEnabled

public boolean isEnabled()

Is the control enabled

Returns:

Enabled?

getBoundingRectangle

public com.sun.jna.platform.win32.WinDef.RECT getBoundingRectangle()

Gets the bounding rectangle of the control

Returns:

The bounding rectangle

getNativeWindowHandle

public com.sun.jna.platform.win32.WinDef.HWND getNativeWindowHandle()

Get the native window handle

Returns:

The handle

getAriaRole

public String getAriaRole()

Gets the ARIA role of the element

Returns:

The ARIA role

getOrientation

public OrientationType getOrientation()

The current orientation of the element

Returns:

The orientation

getRuntimeId

public int[] getRuntimeId()
                   throws sun.reflect.generics.reflectiveObjects.NotImplementedException

Gets the runtime id

Returns:

The runtime id

Throws:

sun.reflect.generics.reflectiveObjects.NotImplementedException - Throws big error, so not implemented

getFrameworkId

public String getFrameworkId()

Gets the current framework ID for the element

Returns:

The framework id

getProviderDescription

public String getProviderDescription()

Gets the current provider description

Returns:

The provider description

getItemStatus

public String getItemStatus()

Gets the current item status

Returns:

The item status

getAcceleratorKey

public String getAcceleratorKey()

Gets the current accelerator key for th element

Returns:

The key

findAllBuildCache

public List<AutomationElement> findAllBuildCache(CacheRequest cacheRequest)

Find all, but from the cache

Parameters:

cacheRequest - The cache request

Returns:

The found collection of elements

findFirstBuildCache

protected AutomationElement findFirstBuildCache(CacheRequest cacheRequest)
                                         throws ElementNotFoundException

Throws:

ElementNotFoundException