org.safs.model.commands

Class EngineComponentCommands

java.lang.Object

org.safs.model.commands.EngineComponentCommands

public class EngineComponentCommands
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLEARHIGHLIGHTEDDIALOG_KEYWORD "ClearHighlightedDialog"
static java.lang.String	CLEARREFERENCECACHE_KEYWORD "ClearReferenceCache"
static java.lang.String	ENABLEDOMAINS_KEYWORD "EnableDomains"
static java.lang.String	GETACCESSIBLENAME_KEYWORD "GetAccessibleName"
static java.lang.String	GETCAPTION_KEYWORD "GetCaption"
static java.lang.String	GETCHILDCOUNT_KEYWORD "GetChildCount"
static java.lang.String	GETCHILDREN_KEYWORD "GetChildren"
static java.lang.String	GETCLASSINDEX_KEYWORD "GetClassIndex"
static java.lang.String	GETCLASSNAME_KEYWORD "GetClassname"
static java.lang.String	GETCOMPONENTRECTANGLE_KEYWORD "GetComponentRectangle"
static java.lang.String	GETCURRENTWINDOW_KEYWORD "GetCurrentWindow"
static java.lang.String	GETID_KEYWORD "GetId"
static java.lang.String	GETLEVEL_KEYWORD "GetLevel"
static java.lang.String	GETMATCHINGCHILDKEYSATPOINT_KEYWORD "GetMatchingChildKeysAtPoint"
static java.lang.String	GETMATCHINGCHILDOBJECTS_KEYWORD "GetMatchingChildObjects"
static java.lang.String	GETMATCHINGPARENTOBJECT_KEYWORD "GetMatchingParentObject"
static java.lang.String	GETMATCHINGPATHOBJECT_KEYWORD "GetMatchingPathObject"
static java.lang.String	GETNAME_KEYWORD "GetName"
static java.lang.String	GETNONACCESSIBLENAME_KEYWORD "GetNonAccessibleName"
static java.lang.String	GETPROPERTY_KEYWORD "GetProperty"
static java.lang.String	GETPROPERTYNAMES_KEYWORD "GetPropertyNames"
static java.lang.String	GETSTRINGDATA_KEYWORD "GetStringData"
static java.lang.String	GETSUPERCLASSNAMES_KEYWORD "GetSuperClassnames"
static java.lang.String	GETTEXT_KEYWORD "GetText"
static java.lang.String	GETTOPLEVELCOUNT_KEYWORD "GetTopLevelCount"
static java.lang.String	GETTOPLEVELWINDOWS_KEYWORD "GetTopLevelWindows"
static java.lang.String	GETTOPWINDOWHANDLE_KEYWORD "GetTopWindowHandle"
static java.lang.String	HIGHLIGHTMATCHINGCHILDOBJECT_KEYWORD "HighlightMatchingChildObject"
static java.lang.String	HIGHLIGHTMATCHINGCHILDOBJECTBYKEY_KEYWORD "HighlightMatchingChildObjectByKey"
static java.lang.String	ISENABLED_KEYWORD "IsEnabled"
static java.lang.String	ISMATCHINGPATH_KEYWORD "IsMatchingPath"
static java.lang.String	ISSHOWING_KEYWORD "IsShowing"
static java.lang.String	ISTOPLEVELPOPUPCONTAINER_KEYWORD "IsTopLevelPopupContainer"
static java.lang.String	ISVALID_KEYWORD "IsValid"
static java.lang.String	SETACTIVEWINDOW_KEYWORD "SetActiveWindow"

Method Summary

Modifier and Type	Method and Description
static EngineCommand	clearHighlightedDialog() Clean the highlight rectangle.
static EngineCommand	clearReferenceCache() Clear the Object reference cache used in a remote engine.
static EngineCommand	enableDomains(java.lang.String domains) Enable searching domains.
static EngineCommand	getAccessibleName(java.lang.String component) Get the AccessibleName of the component, if any.
static EngineCommand	getCaption(java.lang.String component) Get the Caption of a component, if any.
static EngineCommand	getChildCount(java.lang.String component) Get the number of children, if any, for the provided container component.
static EngineCommand	getChildren(java.lang.String component) Get references to the children, if any, for the provided container component.
static EngineCommand	getClassIndex(java.lang.String component) Get the ClassIndex of the component, if any.
static EngineCommand	getClassname(java.lang.String component) Get the Classname of a component.
static EngineCommand	getComponentRectangle(java.lang.String componentKey) Find the component according to Component Test Object's key and get its screen location.
static EngineCommand	getCurrentWindow() Return a reference to the top-most active (Window) with focus.
static EngineCommand	getId(java.lang.String component) Get the ID of a component, if any.
static EngineComponentCommands	getInstance() public Singleton to access class static methods via instance
static EngineCommand	getLevel(java.lang.String component) Get the Z-order of a component--usually a Window.
static EngineCommand	getMatchingChildKeysAtPoint(java.lang.String[] parameters) According to screen location, find the test object at that point and return all matching keys in cache.
static EngineCommand	getMatchingChildKeysAtPoint(java.lang.String windowKey, java.lang.String componentLocationX, java.lang.String componentLocationY) According to screen location, find the test object at that point and return all matching keys in cache.
static EngineCommand	getMatchingChildObjects(java.lang.String[] parameters) Retrieve an array of child objects that match a recognition string.
static EngineCommand	getMatchingChildObjects(java.lang.String component, java.lang.String recognition) Retrieve an array of child objects that match a recognition string.
static EngineCommand	getMatchingParentObject(java.lang.String recognition) Get a reference to the toplevel Window\Parent that matches the recognition string provided.
static EngineCommand	getMatchingPathObject(java.lang.String[] parameters) Get the subitem object\node matching the provided Path.
static EngineCommand	getMatchingPathObject(java.lang.String component, java.lang.String path) Get the subitem object\node matching the provided Path.
static EngineCommand	getName(java.lang.String component) Get the Name (AccessibleName or Name) of the component, if any.
static EngineCommand	getNonAccessibleName(java.lang.String component) Get the non-AccessibleName (Name except for AccessibleName) of the component, if any.
static EngineCommand	getProperty(java.lang.String[] parameters) Get the value of a specific property from a component.
static EngineCommand	getProperty(java.lang.String component, java.lang.String property) Get the value of a specific property from a component.
static EngineCommand	getPropertyNames(java.lang.String component) Get the names of all available properties for a component.
static EngineCommand	getStringData(java.lang.String component) Get the values, text, or data associated with the component.
static EngineCommand	getSuperClassnames(java.lang.String component) Get the hierarchy of superclasses for the component.
static EngineCommand	getText(java.lang.String component) Get the (text) value of a component, if any.
static EngineCommand	getTopLevelCount() Get the number of visible top-level items (Windows?) for the engine.
static EngineCommand	getTopLevelWindows() Return references to all known top-level items (Windows).
static EngineCommand	getTopWindowHandle(java.lang.String componentKey) Get the Windows native handle of the top window containing the component.
static EngineCommand	highlightMatchingChildObject(java.lang.String[] parameters) Find the component according to Recognition String and highlight it.
static EngineCommand	highlightMatchingChildObject(java.lang.String windowRS, java.lang.String componentRS) Find the component according to Recognition String and highlight it.
static EngineCommand	highlightMatchingChildObjectByKey(java.lang.String[] parameters) Find the component according to Window/Component Test Object's key and highlight it.
static EngineCommand	highlightMatchingChildObjectByKey(java.lang.String windowKey, java.lang.String componentKey) Find the component according to Window/Component Test Object's key and highlight it.
static EngineCommand	isEnabled(java.lang.String component) Is the component Enabled (vs.
static EngineCommand	isMatchingPath(java.lang.String[] parameters) Determine if there is a matching Path object.
static EngineCommand	isMatchingPath(java.lang.String component, java.lang.String path) Determine if there is a matching Path object.
static EngineCommand	isShowing(java.lang.String component) Is the component visible? Returns text "true" if the component is set to be visible.
static EngineCommand	isTopLevelPopupContainer(java.lang.String component) Is the component a top-level Popup Container? Should return text "true" if the component is.
static EngineCommand	isValid(java.lang.String component) Does the component still exist as a valid object? Should return text "true" if the component is still valid.
static EngineCommand	setActiveWindow(java.lang.String component) Make the component the active (topmost?) Window or Component.

Methods inherited from class java.lang.Object

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

Field Detail

CLEARHIGHLIGHTEDDIALOG_KEYWORD

public static final java.lang.String CLEARHIGHLIGHTEDDIALOG_KEYWORD

"ClearHighlightedDialog"

See Also:

Constant Field Values

CLEARREFERENCECACHE_KEYWORD

public static final java.lang.String CLEARREFERENCECACHE_KEYWORD

"ClearReferenceCache"

See Also:

Constant Field Values

ENABLEDOMAINS_KEYWORD

public static final java.lang.String ENABLEDOMAINS_KEYWORD

"EnableDomains"

See Also:

Constant Field Values

GETACCESSIBLENAME_KEYWORD

public static final java.lang.String GETACCESSIBLENAME_KEYWORD

"GetAccessibleName"

See Also:

Constant Field Values

GETCAPTION_KEYWORD

public static final java.lang.String GETCAPTION_KEYWORD

"GetCaption"

See Also:

Constant Field Values

GETCHILDCOUNT_KEYWORD

public static final java.lang.String GETCHILDCOUNT_KEYWORD

"GetChildCount"

See Also:

Constant Field Values

GETCHILDREN_KEYWORD

public static final java.lang.String GETCHILDREN_KEYWORD

"GetChildren"

See Also:

Constant Field Values

GETCLASSINDEX_KEYWORD

public static final java.lang.String GETCLASSINDEX_KEYWORD

"GetClassIndex"

See Also:

Constant Field Values

GETCLASSNAME_KEYWORD

public static final java.lang.String GETCLASSNAME_KEYWORD

"GetClassname"

See Also:

Constant Field Values

GETCOMPONENTRECTANGLE_KEYWORD

public static final java.lang.String GETCOMPONENTRECTANGLE_KEYWORD

"GetComponentRectangle"

See Also:

Constant Field Values

GETCURRENTWINDOW_KEYWORD

public static final java.lang.String GETCURRENTWINDOW_KEYWORD

"GetCurrentWindow"

See Also:

Constant Field Values

GETID_KEYWORD

public static final java.lang.String GETID_KEYWORD

"GetId"

See Also:

Constant Field Values

GETLEVEL_KEYWORD

public static final java.lang.String GETLEVEL_KEYWORD

"GetLevel"

See Also:

Constant Field Values

GETMATCHINGCHILDKEYSATPOINT_KEYWORD

public static final java.lang.String GETMATCHINGCHILDKEYSATPOINT_KEYWORD

"GetMatchingChildKeysAtPoint"

See Also:

Constant Field Values

GETMATCHINGCHILDOBJECTS_KEYWORD

public static final java.lang.String GETMATCHINGCHILDOBJECTS_KEYWORD

"GetMatchingChildObjects"

See Also:

Constant Field Values

GETMATCHINGPARENTOBJECT_KEYWORD

public static final java.lang.String GETMATCHINGPARENTOBJECT_KEYWORD

"GetMatchingParentObject"

See Also:

Constant Field Values

GETMATCHINGPATHOBJECT_KEYWORD

public static final java.lang.String GETMATCHINGPATHOBJECT_KEYWORD

"GetMatchingPathObject"

See Also:

Constant Field Values

GETNAME_KEYWORD

public static final java.lang.String GETNAME_KEYWORD

"GetName"

See Also:

Constant Field Values

GETNONACCESSIBLENAME_KEYWORD

public static final java.lang.String GETNONACCESSIBLENAME_KEYWORD

"GetNonAccessibleName"

See Also:

Constant Field Values

GETPROPERTY_KEYWORD

public static final java.lang.String GETPROPERTY_KEYWORD

"GetProperty"

See Also:

Constant Field Values

GETPROPERTYNAMES_KEYWORD

public static final java.lang.String GETPROPERTYNAMES_KEYWORD

"GetPropertyNames"

See Also:

Constant Field Values

GETSTRINGDATA_KEYWORD

public static final java.lang.String GETSTRINGDATA_KEYWORD

"GetStringData"

See Also:

Constant Field Values

GETSUPERCLASSNAMES_KEYWORD

public static final java.lang.String GETSUPERCLASSNAMES_KEYWORD

"GetSuperClassnames"

See Also:

Constant Field Values

GETTEXT_KEYWORD

public static final java.lang.String GETTEXT_KEYWORD

"GetText"

See Also:

Constant Field Values

GETTOPLEVELCOUNT_KEYWORD

public static final java.lang.String GETTOPLEVELCOUNT_KEYWORD

"GetTopLevelCount"

See Also:

Constant Field Values

GETTOPLEVELWINDOWS_KEYWORD

public static final java.lang.String GETTOPLEVELWINDOWS_KEYWORD

"GetTopLevelWindows"

See Also:

Constant Field Values

GETTOPWINDOWHANDLE_KEYWORD

public static final java.lang.String GETTOPWINDOWHANDLE_KEYWORD

"GetTopWindowHandle"

See Also:

Constant Field Values

HIGHLIGHTMATCHINGCHILDOBJECT_KEYWORD

public static final java.lang.String HIGHLIGHTMATCHINGCHILDOBJECT_KEYWORD

"HighlightMatchingChildObject"

See Also:

Constant Field Values

HIGHLIGHTMATCHINGCHILDOBJECTBYKEY_KEYWORD

public static final java.lang.String HIGHLIGHTMATCHINGCHILDOBJECTBYKEY_KEYWORD

"HighlightMatchingChildObjectByKey"

See Also:

Constant Field Values

ISENABLED_KEYWORD

public static final java.lang.String ISENABLED_KEYWORD

"IsEnabled"

See Also:

Constant Field Values

ISMATCHINGPATH_KEYWORD

public static final java.lang.String ISMATCHINGPATH_KEYWORD

"IsMatchingPath"

See Also:

Constant Field Values

ISSHOWING_KEYWORD

public static final java.lang.String ISSHOWING_KEYWORD

"IsShowing"

See Also:

Constant Field Values

ISTOPLEVELPOPUPCONTAINER_KEYWORD

public static final java.lang.String ISTOPLEVELPOPUPCONTAINER_KEYWORD

"IsTopLevelPopupContainer"

See Also:

Constant Field Values

ISVALID_KEYWORD

public static final java.lang.String ISVALID_KEYWORD

"IsValid"

See Also:

Constant Field Values

SETACTIVEWINDOW_KEYWORD

public static final java.lang.String SETACTIVEWINDOW_KEYWORD

"SetActiveWindow"

See Also:

Constant Field Values

Method Detail

getInstance

public static EngineComponentCommands getInstance()

public Singleton to access class static methods via instance

clearHighlightedDialog

public static EngineCommand clearHighlightedDialog()

Clean the highlight rectangle.
                Clean the highlight rectangle. When a component is highlighted, a red rectangle may be drawn by us around
                that component, this keyword is used to clean that rectangle.
                

Supporting Engines:

• Rational RobotJ
• Google Android

clearReferenceCache

public static EngineCommand clearReferenceCache()

Clear the Object reference cache used in a remote engine.
                Clear the Object reference cache used in a remote engine. 
                When a driver or controller requests a unique reference for a remote Object the Object and a String 
                Key are stored in an internal cache in the remote engine.  This command instructs the remote engine 
                to clear its internal cache of Objects and Keys.
                

Supporting Engines:

• AutomatedQA TestComplete
• Google Android

enableDomains

public static EngineCommand enableDomains(java.lang.String domains)

Enable searching domains.
                Enable the domains for searching target main window within these domains.
                Up to now, RobotJ engine supports Java, DotNet, Win, Html, SWT and Flex.
                

Supporting Engines:

• Rational RobotJ

Parameters:

domains - Optional:NOA string that contains at least one domain.

getAccessibleName

public static EngineCommand getAccessibleName(java.lang.String component)

Get the AccessibleName of the component, if any.
                If no AccessibleName is present the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getCaption

public static EngineCommand getCaption(java.lang.String component)

Get the Caption of a component, if any.
                Normally, this is only valid for window or child window components.  
                If no caption is present, or the component does not support captions, the 
                engine should return "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getChildCount

public static EngineCommand getChildCount(java.lang.String component)

Get the number of children, if any, for the provided container component.
                This is only valid for windows and other containers of child components.
                If no children are present (or supported) then the returned count should be 0.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getChildren

public static EngineCommand getChildren(java.lang.String component)

Get references to the children, if any, for the provided container component.
                Normally, this is only valid for windows or other container components.  
                If no children exist then an empty string is returned.  If children are present then 
                a single string of separated values is returned.  The first character in the 
                returned string defines the delimiter character used to separate child references.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getClassIndex

public static EngineCommand getClassIndex(java.lang.String component)

Get the ClassIndex of the component, if any.
                If no ClassIndex is present the engine should return "0".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getClassname

public static EngineCommand getClassname(java.lang.String component)

Get the Classname of a component.
                If no classname is returned, or the domain does not support "classes", the 
                engine should return "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getComponentRectangle

public static EngineCommand getComponentRectangle(java.lang.String componentKey)

Find the component according to Component Test Object's key and get its screen location.
                Find the component according to Component Test Object's key and get its screen location. The component's
                screen location is returned as a string "UpLeftX, UpLeftY, Width, Height". 
                

Supporting Engines:

• Rational RobotJ

Parameters:

componentKey - Optional:NOA string represents the key of component's Test Object.

getCurrentWindow

public static EngineCommand getCurrentWindow()

Return a reference to the top-most active (Window) with focus.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            ^TCAFS.UID.Count  = [Number of UID References created last]
            ^TCAFS.UID.1      = [First UID Reference created]
            
                

Supporting Engines:

• Google Android
• AutomatedQA TestComplete

getId

public static EngineCommand getId(java.lang.String component)

Get the ID of a component, if any.
                If no ID is present, or the component does not support IDs, the 
                engine should return "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getLevel

public static EngineCommand getLevel(java.lang.String component)

Get the Z-order of a component--usually a Window.
                Level is generally considered to be the Z-Order information of the object--where in 
                the Window Z-Order the object (usually a Window) resides.
                Level is combined with another recognition method when the other method does not uniquely identify 
                the windows. For example, if there are multiple windows with the same caption, and Caption is the 
                recognition method being used. The Level qualifier specifies which one of the similarly-identified 
                windows should be targeted for the action, based on the Windows' Z-Order. The first window is a
                ssigned "Level=1", the second "Level=2", and so on. Level serves as a clarifier only and is used                
                only after all other methods have been attempted.
                
                If the Level cannot be determined then the engine should return -1.
                
            

Supporting Engines:

• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getMatchingChildKeysAtPoint

public static EngineCommand getMatchingChildKeysAtPoint(java.lang.String windowKey,
                                                        java.lang.String componentLocationX,
                                                        java.lang.String componentLocationY)

According to screen location, find the test object at that point and return all matching keys in cache.
                According to screen location, find the test object at that point and return all matching keys in cache. The keys
                will be separaged by a separator, the separator is determinated dynamically and it may be "," "|" ":" ";" "_" "#" "!"
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

windowKey - Optional:NOA string represents the key of window's Test Object.

componentLocationX - Optional:NOA string represents the component's x location on screen.

componentLocationY - Optional:NOA string represents the component's y location on screen.

getMatchingChildKeysAtPoint

public static EngineCommand getMatchingChildKeysAtPoint(java.lang.String[] parameters)

According to screen location, find the test object at that point and return all matching keys in cache.
                According to screen location, find the test object at that point and return all matching keys in cache. The keys
                will be separaged by a separator, the separator is determinated dynamically and it may be "," "|" ":" ";" "_" "#" "!"
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

parameters - Optional:NO An array containing the following parameters:

windowKey -- Optional:NOA string represents the key of window's Test Object.
componentLocationX -- Optional:NOA string represents the component's x location on screen.
componentLocationY -- Optional:NOA string represents the component's y location on screen.

getMatchingChildObjects

public static EngineCommand getMatchingChildObjects(java.lang.String component,
                                                    java.lang.String recognition)

Retrieve an array of child objects that match a recognition string.
                Normally, this is only valid for window or other container components.  
                If no matching child objects exist then the engine should return 
                "".
                
                Returns a character delimited string of child references. The first character in the returned string 
                defines the delimiter used to separate the items. 
                
                Currently, the engine command processors only support returning the first child matching the recognition string.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

recognition - Optional:NORecognition string describing the children to find.

getMatchingChildObjects

public static EngineCommand getMatchingChildObjects(java.lang.String[] parameters)

Retrieve an array of child objects that match a recognition string.
                Normally, this is only valid for window or other container components.  
                If no matching child objects exist then the engine should return 
                "".
                
                Returns a character delimited string of child references. The first character in the returned string 
                defines the delimiter used to separate the items. 
                
                Currently, the engine command processors only support returning the first child matching the recognition string.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

parameters - Optional:NO An array containing the following parameters:

component -- Optional:NOAn object reference or proxy reference to the component.
recognition -- Optional:NORecognition string describing the children to find.

getMatchingParentObject

public static EngineCommand getMatchingParentObject(java.lang.String recognition)

Get a reference to the toplevel Window\Parent that matches the recognition string provided.
                Locate a toplevel Window\Parent matching the recognition string and return a unique 
                reference to that component.  If no match is found the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

recognition - Optional:NORecognition string describing the Window\Parent to find.

getMatchingPathObject

public static EngineCommand getMatchingPathObject(java.lang.String component,
                                                  java.lang.String path)

Get the subitem object\node matching the provided Path.
                Normally, this is only valid for components whose subitems, nodes, or children are located 
                by Path syntax: Root->Branch->Leaf.  This is often the case for Menus, MenuItems, and Tree nodes.
                
                If no match is found the engine should return: 
                "".
                
                

Supporting Engines:

• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

path - Optional:NOThe Path object\node to locate relative to the Component.

getMatchingPathObject

public static EngineCommand getMatchingPathObject(java.lang.String[] parameters)

Get the subitem object\node matching the provided Path.
                Normally, this is only valid for components whose subitems, nodes, or children are located 
                by Path syntax: Root->Branch->Leaf.  This is often the case for Menus, MenuItems, and Tree nodes.
                
                If no match is found the engine should return: 
                "".
                
                

Supporting Engines:

• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

component -- Optional:NOAn object reference or proxy reference to the component.
path -- Optional:NOThe Path object\node to locate relative to the Component.

getName

public static EngineCommand getName(java.lang.String component)

Get the Name (AccessibleName or Name) of the component, if any. The AccessibleName shall be found first and returned, if any.
                If no Name is present the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getNonAccessibleName

public static EngineCommand getNonAccessibleName(java.lang.String component)

Get the non-AccessibleName (Name except for AccessibleName) of the component, if any.
                If no non-AccessibleName is present the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getProperty

public static EngineCommand getProperty(java.lang.String component,
                                        java.lang.String property)

Get the value of a specific property from a component.
                Retrieves the value of the specified property.  Property names are case-sensitive.
                If the property name provided is invalid or unsupported the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

property - Optional:NOThe property name to retrieve.

getProperty

public static EngineCommand getProperty(java.lang.String[] parameters)

Get the value of a specific property from a component.
                Retrieves the value of the specified property.  Property names are case-sensitive.
                If the property name provided is invalid or unsupported the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

component -- Optional:NOAn object reference or proxy reference to the component.
property -- Optional:NOThe property name to retrieve.

getPropertyNames

public static EngineCommand getPropertyNames(java.lang.String component)

Get the names of all available properties for a component.
                Returns a delimited string list of case-sensitive property names for the component.  
                The first character in the string is the delimiter used to separate each 
                property name in the list.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getStringData

public static EngineCommand getStringData(java.lang.String component)

Get the values, text, or data associated with the component.
                This is returned as a String containing a delimited list of values forming a 
                2D array or table of values.  The first character in the string specifies the 
                delimiter used to separate values.  The first value between delimiters specifies 
                the number of rows of data.  The second value between delimiters specifies the number of 
                columns of data.  This is immediately followed by all the values separated by delimiters.
                
                Example return string showing a single value (1 row and 1 column): ",1,1,MyValue"
                
                Missing values are represented simply by two delimiters back-to-back with no value 
                between them.
                
                Example return string of 3 rows with 2 columns with missing values in the last two rows:
                
                ",3,2,a,b,,d,e,"
                
                Whitespace in a value is retained.  Everything between delimiters is treated as 
                part of the value.
                
                If there is no retrievable text or data the engine should return 
                "".
                
                

Supporting Engines:

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getSuperClassnames

public static EngineCommand getSuperClassnames(java.lang.String component)

Get the hierarchy of superclasses for the component.
                Returns a delimited string list of case-sensitive classnames for the component.  
                The first character in the string is the delimiter used to separate each 
                classname in the hierarchy.  
                If there is no superclass or hierarchy the engine will return a delimited 
                list of one value--the component's classname.  (Ex: ",Html.BUTTON")
                                
                When a superclass hierarchy does exist the first value after the delimiter 
                is the component's classname.  Each delimited value after that goes one higher 
                in the hierarchy until the topmost superclass has been processed.
                (Ex: ",CustomButton,java.awt.Button,java.awt.Component,java.lang.Object")
                
                If the component itself has no classname and no hierarchy (unusual!) then 
                the engine should simply return an empty, 0-length string.
                
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getText

public static EngineCommand getText(java.lang.String component)

Get the (text) value of a component, if any.
                If the component does not have text or any "value" the engine should return 
                "".
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
                

Supporting Engines:

• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

getTopLevelCount

public static EngineCommand getTopLevelCount()

Get the number of visible top-level items (Windows?) for the engine.
                Returns the number of visible top-level items, or 0.  Not all engines can see all items. 
                For example, Selenium only looks for Web clients.  Some engines may only look for 
                Java clients, etc..  Some engines can see other top-level items that are not 
                Windows--like Processes, or Threads, etc...
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            
                

Supporting Engines:

• Google Android
• Rational RobotJ
• AutomatedQA TestComplete

getTopLevelWindows

public static EngineCommand getTopLevelWindows()

Return references to all known top-level items (Windows).
                The engine can only return references to those top-level items it has 
                knowledge of.  Not all engines can see all items. 
                For example, Selenium only looks for Web clients.  Some engines may only look for 
                Java clients, etc..  Some engines can see other top-level items that are not 
                Windows--like Processes, or Threads, etc...
                
                The engine's array of objects will be returned as a delimited list of fields. 
                The first character in the String will identify the separator used between 
                each reference.  If no top level windows were found then the engine will return 
                an empty string.
                
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.UID.Count  = [Number of UID References created last]
            ^TCAFS.UID.1      = [First UID Reference created]
            ^TCAFS.UID.n      = [UID Reference number n]            
            
                

Supporting Engines:

• Google Android
• AutomatedQA TestComplete
• Rational RobotJ

getTopWindowHandle

public static EngineCommand getTopWindowHandle(java.lang.String componentKey)

Get the Windows native handle of the top window containing the component.
                Get the Windows native handle of the top window containing the component. 
                

Supporting Engines:

• Rational RobotJ

Parameters:

componentKey - Optional:NOA string represents the key of component's Test Object.

highlightMatchingChildObject

public static EngineCommand highlightMatchingChildObject(java.lang.String windowRS,
                                                         java.lang.String componentRS)

Find the component according to Recognition String and highlight it.
                According to the Window's and Component's Recognition String, find the Component Test Object
                and highlight it by a red rectangle. 
                

Supporting Engines:

• Rational RobotJ

Parameters:

windowRS - Optional:NOA string represents the window's Recognition String.

componentRS - Optional:NOA string represents the component's Recognition String.

highlightMatchingChildObject

public static EngineCommand highlightMatchingChildObject(java.lang.String[] parameters)

Find the component according to Recognition String and highlight it.
                According to the Window's and Component's Recognition String, find the Component Test Object
                and highlight it by a red rectangle. 
                

Supporting Engines:

• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

windowRS -- Optional:NOA string represents the window's Recognition String.
componentRS -- Optional:NOA string represents the component's Recognition String.

highlightMatchingChildObjectByKey

public static EngineCommand highlightMatchingChildObjectByKey(java.lang.String windowKey,
                                                              java.lang.String componentKey)

Find the component according to Window/Component Test Object's key and highlight it.
                According to the Window's and Component's Test Object key, get the Component Test Object and highlight it 
                by a red rectangle. 
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

windowKey - Optional:NOA string represents the key of window's Test Object.

componentKey - Optional:NOA string represents the key of component's Test Object.

highlightMatchingChildObjectByKey

public static EngineCommand highlightMatchingChildObjectByKey(java.lang.String[] parameters)

Find the component according to Window/Component Test Object's key and highlight it.
                According to the Window's and Component's Test Object key, get the Component Test Object and highlight it 
                by a red rectangle. 
                

Supporting Engines:

• Rational RobotJ
• Google Android

Parameters:

parameters - Optional:NO An array containing the following parameters:

windowKey -- Optional:NOA string represents the key of window's Test Object.
componentKey -- Optional:NOA string represents the key of component's Test Object.

isEnabled

public static EngineCommand isEnabled(java.lang.String component)

Is the component Enabled (vs. disabled)? 
                Should return text "true" if the component is Enabled. 
                Return text "false" if it is not.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            
                

Supporting Engines:

• AutomatedQA TestComplete
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

isMatchingPath

public static EngineCommand isMatchingPath(java.lang.String component,
                                           java.lang.String path)

Determine if there is a matching Path object.
                
                Normally, this is only valid for components whose subitems, nodes, or 
                children are found by Path syntax: Root->Branch->Leaf.  This is often 
                the case for Menus, MenuItems, and Tree nodes.
                
                Returns text "true" if an object matching the provided Path was found.  
                Returns text "false" if no such object was found.
                

Supporting Engines:

• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to a component.

path - Optional:NOThe Path to locate relative to the Component.

isMatchingPath

public static EngineCommand isMatchingPath(java.lang.String[] parameters)

Determine if there is a matching Path object.
                
                Normally, this is only valid for components whose subitems, nodes, or 
                children are found by Path syntax: Root->Branch->Leaf.  This is often 
                the case for Menus, MenuItems, and Tree nodes.
                
                Returns text "true" if an object matching the provided Path was found.  
                Returns text "false" if no such object was found.
                

Supporting Engines:

• Rational RobotJ

Parameters:

parameters - Optional:NO An array containing the following parameters:

component -- Optional:NOAn object reference or proxy reference to a component.
path -- Optional:NOThe Path to locate relative to the Component.

isShowing

public static EngineCommand isShowing(java.lang.String component)

Is the component visible?
                Returns text "true" if the component is set to be visible.
                Returns text "false" if the component is set to be hidden or 
                otherwise is not visible.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            
               

Supporting Engines:

• AutomatedQA TestComplete
• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

isTopLevelPopupContainer

public static EngineCommand isTopLevelPopupContainer(java.lang.String component)

Is the component a top-level Popup Container? 
                Should return text "true" if the component is. Return text "false" if it is not.
                Different domains or environs will have different classes or types that are Popup Windows or 
                Popup containers.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            
                

Supporting Engines:

• AutomatedQA TestComplete
• Google Android

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

isValid

public static EngineCommand isValid(java.lang.String component)

Does the component still exist as a valid object?
                Should return text "true" if the component is still valid. 
                Return text "false" if it is not.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            
                

Supporting Engines:

• AutomatedQA TestComplete
• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.

setActiveWindow

public static EngineCommand setActiveWindow(java.lang.String component)

Make the component the active (topmost?) Window or Component.
                Normally, this is only valid for window or child window components.  
                There is currently nothing defined to be returned by this command.
            
            The Android Engine also persists these values as SAFS variables.
            
            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            
            See DEngineCommandProcessor.setStatusVars().
            
            
            The TestComplete Engine (TCAFS) also persists these values as SAFS variables.
                        
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            
               

Supporting Engines:

• AutomatedQA TestComplete
• Google Android
• Rational RobotJ

Parameters:

component - Optional:NOAn object reference or proxy reference to the component.