org.safs.jrex

Class JREXGUIUtilities

java.lang.Object

org.safs.STAFRequester

org.safs.DDGUIUtilities

org.safs.jrex.JREXGUIUtilities

public class JREXGUIUtilities
extends DDGUIUtilities

Field Summary

Fields inherited from class org.safs.DDGUIUtilities

appmaps, DEBUG_MESSAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, GENERIC_MESSAGE, log, PASSED_MESSAGE, trdata, WARNING_MESSAGE, WARNING_OK_MESSAGE

Fields inherited from class org.safs.STAFRequester

staf

Constructor Summary

Constructors

Constructor and Description
JREXGUIUtilities()
JREXGUIUtilities(STAFHelper helper, JREXTestRecordData data, LogUtilities log) Constructor providing the STAFHelper needed by the instance for proper operation.
JREXGUIUtilities(STAFHelper helper, LogUtilities log) Constructor providing the STAFHelper needed by the instance for proper operation.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	extractListItems(java.lang.Object obj, java.lang.String countProp, java.lang.String itemProp) Extract items from a List or Array type of object property.
Tree	extractMenuBarItems(java.lang.Object obj) Extract a menu hierarchy from a MenuBar pseudo-object reference.
Tree	extractMenuItems(java.lang.Object obj) Extract a menu hierarchy from a object.
java.lang.Object	findPropertyMatchedChild(java.lang.Object obj, java.lang.String property, java.lang.String bench, boolean exactMatch) Attempt to locate a child object based on a matching property value.
ApplicationMap	getAppMap(java.lang.String mapname) required implementation for superclass
java.lang.String	getListItem(java.lang.Object obj, int i, java.lang.String itemProp) Get a single list item from a List or Array type of object property.
boolean	registerAppMap(java.lang.String mapname, java.lang.String mapfile) Store a named AppMap that has been successfully opened or found already opened.
int	setActiveWindow(java.lang.String appMapName, java.lang.String windowName, java.lang.String compName) "Activate" the specified component's topmost parent.
int	waitForObject(java.lang.String appMapName, java.lang.String windowName, java.lang.String compName, long secTimeout) Wait up to a maximum timeout value for the specified component to "exist".

Methods inherited from class org.safs.DDGUIUtilities

clearAllAppMapCaches, clearAppMapCache, createAppMapInstance, getLogUtilities, getTestRecordData, isAppMapRegistered, openAppMap, registerAppMap, setLogUtilities, setTestRecordData

Methods inherited from class org.safs.STAFRequester

getSTAFHelper, setSTAFHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

JREXGUIUtilities

public JREXGUIUtilities()

JREXGUIUtilities

public JREXGUIUtilities(STAFHelper helper,
                LogUtilities log)

Constructor providing the STAFHelper needed by the instance for proper operation.

Parameters:

helper - The STAFHelper for performing STAF requests.

JREXGUIUtilities

public JREXGUIUtilities(STAFHelper helper,
                JREXTestRecordData data,
                LogUtilities log)

Constructor providing the STAFHelper needed by the instance for proper operation.

Parameters:

helper - The STAFHelper for performing STAF requests.

Method Detail

registerAppMap

public boolean registerAppMap(java.lang.String mapname,
                     java.lang.String mapfile)

Description copied from class: DDGUIUtilities

Store a named AppMap that has been successfully opened or found already opened. This will create an AppMapInstance to store in our local cache.

Overrides:

registerAppMap in class DDGUIUtilities

Parameters:

mapname - -- the name by which the ApplicationMap will be known.

mapfile - -- the ApplicationMap to store with the given mapname.

getAppMap

public ApplicationMap getAppMap(java.lang.String mapname)

required implementation for superclass

Overrides:

getAppMap in class DDGUIUtilities

Parameters:

mapname - -- the name by which the ApplicationMap will be known.

Returns:

null if not found, which generally means it hasn't been successfully registered or opened.

waitForObject

public int waitForObject(java.lang.String appMapName,
                java.lang.String windowName,
                java.lang.String compName,
                long secTimeout)
                  throws SAFSObjectNotFoundException

Description copied from class: DDGUIUtilities

Wait up to a maximum timeout value for the specified component to "exist".

Specified by:

waitForObject in class DDGUIUtilities

Parameters:

appMapName - name of AppMap used to lookup component.

windowName - name of Window in AppMap.

compName - name of Window Component in AppMap. If the Window IS the desired Component, then both windowName and compName will be the same.

secTimeout - maximum wait in seconds

Returns:

status 0 if successful; thrown exceptions if not. Other return codes may be implementation specific.

Throws:

SAFSObjectNotFoundException - if the component or its parent cannot be found.

setActiveWindow

public int setActiveWindow(java.lang.String appMapName,
                  java.lang.String windowName,
                  java.lang.String compName)
                    throws SAFSObjectNotFoundException

Description copied from class: DDGUIUtilities

"Activate" the specified component's topmost parent.

Specified by:

setActiveWindow in class DDGUIUtilities

Parameters:

appMapName - name of AppMap used to lookup component.

windowName - name of Window in AppMap.

compName - name of Window Component in AppMap. If the Window IS the desired Component, then both windowName and compName will be the same.

Returns:

status 0 if successful; thrown exceptions if not. Other return codes may be implementation specific.

Throws:

SAFSObjectNotFoundException - if the component or its parent cannot be found.

extractListItems

public java.util.List extractListItems(java.lang.Object obj,
                              java.lang.String countProp,
                              java.lang.String itemProp)
                                throws SAFSException

Description copied from class: DDGUIUtilities

Extract items from a List or Array type of object property.

Specified by:

extractListItems in class DDGUIUtilities

Returns:

List

Throws:

SAFSException

getListItem

public java.lang.String getListItem(java.lang.Object obj,
                           int i,
                           java.lang.String itemProp)
                             throws SAFSException

Description copied from class: DDGUIUtilities

Get a single list item from a List or Array type of object property.

Specified by:

getListItem in class DDGUIUtilities

Returns:

String

Throws:

SAFSException

extractMenuBarItems

public Tree extractMenuBarItems(java.lang.Object obj)
                         throws SAFSException

Description copied from class: DDGUIUtilities

Extract a menu hierarchy from a MenuBar pseudo-object reference. Often this can be served by the extracMenuItems function. This is generally for JMenuBars.

Specified by:

extractMenuBarItems in class DDGUIUtilities

Returns:

org.safs.Tree

Throws:

SAFSException

extractMenuItems

public Tree extractMenuItems(java.lang.Object obj)
                      throws SAFSException

Description copied from class: DDGUIUtilities

Extract a menu hierarchy from a object. This is generally for JPopupMenus, JMenus, and JMenuItems (JMenu is subclass of JMenuItem).

Specified by:

extractMenuItems in class DDGUIUtilities

Returns:

org.safs.Tree

Throws:

SAFSException

findPropertyMatchedChild

public java.lang.Object findPropertyMatchedChild(java.lang.Object obj,
                                        java.lang.String property,
                                        java.lang.String bench,
                                        boolean exactMatch)
                                          throws SAFSObjectNotFoundException

Description copied from class: DDGUIUtilities

Attempt to locate a child object based on a matching property value. The check can require an exactMatch; or, a case-insensitive partial substring match if the exactMatch parameter is false. (Can use StringUtils.isCaseContainsMatch)

Specified by:

findPropertyMatchedChild in class DDGUIUtilities

Parameters:

obj - -- the pseudo-object reference whose children will be evaluated.

property - -- the property of each child that will be evaluated. The property is expected to be one that can successfully return a value cast as type String.

bench - -- the benchmark value for the property to be used in comparisons.

exactMatch - -- if true, an exact case-sensitive match of the bench value provided is required to signal a match.
if false, a case-insensitive partial substring match with the bench value is performed.

Returns:

Object, the first child pseudo-object whose property value matches accordingly.

Throws:

SAFSObjectNotFoundException - if no matching child object is found.

See Also:

StringUtils.isCaseContainsMatch(String,String,boolean)