org.safs.abbot

Class AGuiObjectVector

java.lang.Object

org.safs.GuiObjectVector

org.safs.abbot.AGuiObjectVector

public class AGuiObjectVector
extends GuiObjectVector

Part of the required implementation to support SAFS "standard" recognition strings. External users would normally not use this class directly. Consequently, the API and associated data is subject to change without notice.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static AGuiClassData	classdata our static instance of AGuiClassData

Fields inherited from class org.safs.GuiObjectVector

ACTIVE_WINDOW_REFERENCE, cache, childName, childSeparator, DEFAULT_CHILD_SEPARATOR, DESKTOP_REFERENCE, DOTNET_POPUPMENU, FULLPATH_SEARCH_MODE_PREFIX, GENERIC_OBJECTTYPE_POPUPWINDOW, INITIAL_CACHE_SIZE, isFullPathSearchString, isMappedClassSearchString, isRftFindSearchString, MAPPEDCLASS_SEARCH_MODE_PREFIX, MODE_ENGINE_PROCESSING, MODE_EXTERNAL_PROCESSING, OBJECTTYPE_POPUPCONTAINER, OBJECTTYPE_POPUPMENU, OBJECTTYPE_POPUPWINDOW, path, pathVector, process_mode, recognitionStringPrefixes, RFT_FIND_SEARCH_MODE_PREFIX, SIMPLETYPE_POPUPMENU, WIN_POPUPMENU, windowName

Constructor Summary

Constructors

Constructor and Description
AGuiObjectVector(java.lang.String window, java.lang.String child, java.lang.String pathString) Default Constructor for our AGuiObjectVector.

Method Summary

Methods

Modifier and Type	Method and Description
GuiChildIterator	createGuiChildIterator(java.util.List gather) Provide a GuiChildIterator instance as required.
GuiChildIterator	createGuiChildIterator(java.lang.Object aparent, GuiObjectVector govVector, java.util.List gather) Provide our GuiChildIterator instance as required.
GuiObjectRecognition	createGuiObjectRecognition(java.lang.String subpath, int govLevel) Provide our AGuiObjectRecognition instance as required during initialization.
java.lang.Object[]	getChildObjects(java.lang.Object parent) Return an array representing all known child objects of the parent.
AGuiObjectRecognition	getChildRecognition(int index) Casts the GuiObjectRecognition from getChildGuiObjectRecognition to our subclass.
java.lang.Object[]	getDomainParentObjects(java.lang.String domainname) Return an array representing all known top level window objects.
GuiClassData	getGuiClassData() Return our AGuiClassData subclass as required.
java.lang.Object[]	getParentObjects() Return an array representing all known top level window objects.
boolean	isValidGuiContainer(java.lang.Object object) Return true if the object is a Container.
boolean	isValidGuiObject(java.lang.Object object) Return true if the object is a Component.
void	setActiveWindow(java.lang.Object _comp) Make the Window referenced by _comp the active window.

Methods inherited from class org.safs.GuiObjectVector

convertToKeys, getCachedItem, getChildGuiObjectRecognition, getChildMatchData, getChildName, getFinalChildGuiObjectRecognition, getGuiObjectType, getMatchingChildObject, getMatchingParentObject, getParentGuiObjectRecognition, getPathVector, getProcessMode, getRecognitionDepth, getVectorString, getWindowName, initGuiObjectRecognition, isFullPathSearchMode, isMappedClassSearchMode, isMatchingParent, isRftFindSearchMode, isSeekingPopupMenu, isTopLevelPopupContainer, isTopLevelPopupWindow, iterateChildMatchData, iterateChildren, makeUniqueCacheKey, putCachedItem, removeCachedItem, removeRStringPrefixes, resetExternalModeCache, setChildName, setFullPathSearchMode, setMappedClassSearchMode, setPathVector, setProcessMode, setRftFindSearchMode, setWindowName

Methods inherited from class java.lang.Object

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

Field Detail

classdata

static AGuiClassData classdata

our static instance of AGuiClassData

Constructor Detail

AGuiObjectVector

public AGuiObjectVector(java.lang.String window,
                java.lang.String child,
                java.lang.String pathString)

Default Constructor for our AGuiObjectVector.

Method Detail

createGuiChildIterator

public GuiChildIterator createGuiChildIterator(java.lang.Object aparent,
                                      GuiObjectVector govVector,
                                      java.util.List gather)

Provide our GuiChildIterator instance as required. We currently use the default org.safs.GuiChildIterator

Specified by:

createGuiChildIterator in class GuiObjectVector

Parameters:

aparent - is NOT a cached key, but should be the actual engine-specific object that should have already been retrieved from internal cache if MODE_EXTERNAL_PROCESSING.

createGuiChildIterator

public GuiChildIterator createGuiChildIterator(java.util.List gather)

Provide a GuiChildIterator instance as required. We currently use the default org.safs.GuiChildIterator

Specified by:

createGuiChildIterator in class GuiObjectVector

createGuiObjectRecognition

public GuiObjectRecognition createGuiObjectRecognition(java.lang.String subpath,
                                              int govLevel)

Provide our AGuiObjectRecognition instance as required during initialization.

Specified by:

createGuiObjectRecognition in class GuiObjectVector

getGuiClassData

public GuiClassData getGuiClassData()

Return our AGuiClassData subclass as required.

Specified by:

getGuiClassData in class GuiObjectVector

getChildRecognition

public AGuiObjectRecognition getChildRecognition(int index)

Casts the GuiObjectRecognition from getChildGuiObjectRecognition to our subclass.

getParentObjects

public java.lang.Object[] getParentObjects()

Return an array representing all known top level window objects.

Specified by:

getParentObjects in class GuiObjectVector

See Also:

GuiObjectVector.convertToKeys(Object[]), GuiObjectVector.makeUniqueCacheKey(Object), GuiObjectVector.putCachedItem(Object, Object), GuiObjectVector.getCachedItem(Object)

getDomainParentObjects

public java.lang.Object[] getDomainParentObjects(java.lang.String domainname)

Return an array representing all known top level window objects. Abbot only supports the Java domain at this time. So we simply getTopLevelWindows().

Specified by:

getDomainParentObjects in class GuiObjectVector

Parameters:

domainname - should be one of the supported org.safs.Domains constants like "Java", "Html", "Win", etc..

See Also:

GuiObjectVector.convertToKeys(Object[]), GuiObjectVector.makeUniqueCacheKey(Object), GuiObjectVector.putCachedItem(Object, Object), GuiObjectVector.getCachedItem(Object)

getChildObjects

public java.lang.Object[] getChildObjects(java.lang.Object parent)

Return an array representing all known child objects of the parent.

Specified by:

getChildObjects in class GuiObjectVector

Returns:

array of objects or an empty array of new Object[0].

See Also:

GuiObjectVector.convertToKeys(Object[]), GuiObjectVector.makeUniqueCacheKey(Object), GuiObjectVector.putCachedItem(Object, Object), GuiObjectVector.getCachedItem(Object)

isValidGuiObject

public boolean isValidGuiObject(java.lang.Object object)

Return true if the object is a Component. Currently we check if the object is a java.awt.Component subclass.

Specified by:

isValidGuiObject in class GuiObjectVector

See Also:

GuiObjectVector.getCachedItem(Object)

isValidGuiContainer

public boolean isValidGuiContainer(java.lang.Object object)

Return true if the object is a Container. Currently we check if object is java.awt.Container subclass.

Specified by:

isValidGuiContainer in class GuiObjectVector

See Also:

GuiObjectVector.getCachedItem(Object)

setActiveWindow

public void setActiveWindow(java.lang.Object _comp)

Description copied from class: GuiObjectVector

Make the Window referenced by _comp the active window. If getProcessMode()==MODE_EXTERNAL_PROCESSING the implementor should assume the _comp is actually stored in the internal cache and the _comp in hand is actually a key to the cached object that must be retrieved using getCachedItem(object).

Specified by:

setActiveWindow in class GuiObjectVector

Parameters:

_comp - is a String key used to retrieve cached items or an engine-specific proxy implementation of the component itself. This is usually one the objects returned in the Object[] from getParentObjects();

See Also:

GuiObjectVector.setActiveWindow(java.lang.Object)