org.safs.rational.win

Class CFWinMenuBar

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.rational.CFComponent

org.safs.rational.CFMenuBar

org.safs.rational.win.CFWinMenuBar

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

CFWinPopupMenu

public class CFWinMenuBar
extends CFMenuBar

Purpose: Process CFWinMenuBar component.

Since:

JUL 24, 2008
JUL 24, 2008 (LeiWang) Original Release
JUN 12, 2009 (LeiWang) Add method: getPropertyText(), getSubMenuItemCount(), getNewTreeNode() extractMenuItems(), staticExtractMenuItems()

Author:

Lei Wang

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.ComponentFunction

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_MENUBAR_NAME
static java.lang.String	CLASS_MENUITEM_NAME
static java.lang.String	CLASS_POPUPMENU_NAME
static java.lang.String	CLASS_SEPARATOR_NAME
static java.lang.String	PROPERTY_NAME
static java.lang.String	PROPERTY_NUM_CHILDREN
static java.lang.String	PROPERTY_NUM_SUBMENUITEM
static java.lang.String	PROPERTY_TEXT

Fields inherited from class org.safs.rational.CFMenuBar

ITEMCOUNT_PROPERTY, MENUCOUNT_PROPERTY, PATH_PREFIX, SELECTMENUITEM, SELECTMENUITEMCONTAINS, SELECTPOPUPMENUITEM, SELECTUNVERIFIEDMENUITEM, SELECTUNVERIFIEDPOPUPMENUITEM, TEXT_PROPERTY, UITYPE_MENUBAR, UITYPE_POPUPMENU, UITYPE_PROPERTY, VERIFYMENUITEM, VERIFYMENUITEMCONTAINS, VERIFYPOPUPMENU, VERIFYPOPUPMENUCONTAINS, VERIFYPOPUPMENUITEM, VERIFYPOPUPMENUPARTIALMATCH

Fields inherited from class org.safs.rational.CFComponent

keepEncodingConsistent, obj1, script, winObject

Fields inherited from class org.safs.ComponentFunction

action, ALTCLICK, ALTLEFTDRAG, altText, ASSIGNPROPERTYVARIABLE, CAPTUREOBJECTDATATOFILE, CAPTUREPROPERTIESTOFILE, CAPTUREPROPERTYTOFILE, CLEARAPPMAPCACHE, CLICK, CLOSEWINDOW, compName, COMPONENTCLICK, CTRLALTLEFTDRAG, CTRLCLICK, CTRLLEFTDRAG, CTRLRIGHTCLICK, CTRLSHIFTLEFTDRAG, DOUBLECLICK, GETGUIIMAGE, GETTEXTFROMGUI, GUIDOESEXIST, GUIDOESNOTEXIST, HOVERMOUSE, HSCROLLTO, INPUTCHARACTERS, INPUTKEYS, ISPROPERTYEXIST, iterator, LEFTDRAG, LOCATESCREENIMAGE, mapname, MAXIMIZE, MINIMIZE, MOUSECLICK, OBJECT_DATA, PARAM_FILTER, PARAM_UUID, PROPERTY_DOT_itemText, PROPERTY_innerHTML, PROPERTY_innerText, PROPERTY_Items, PROPERTY_text, PROPERTY_textContent, RELATIVE_TO_PARENT, RELATIVE_TO_SCREEN, RESTORE, RIGHTCLICK, RIGHTDRAG, SAVETEXTFROMGUI, SENDEVENT, SETPOSITION, SETPROPERTYVALUE, SHIFTCLICK, SHIFTLEFTDRAG, TEST_DATA_SUFFIX, utils, VERIFYARRAYPROPERTYTOFILE, VERIFYBINARYFILETOFILE, VERIFYCLIPBOARDTOFILE, VERIFYFILETOFILE, VERIFYGUIIMAGETOFILE, VERIFYOBJECTDATATOFILE, VERIFYPROPERTY, VERIFYPROPERTYCONTAINS, VERIFYPROPERTYTOFILE, VERIFYTEXTFILETOFILE, VERIFYVALUECONTAINS, VERIFYVALUEEQUALS, VERIFYVALUES, VERIFYVALUESIGNORECASE, VSCROLLTO, WAITFORGUI, windowName

Fields inherited from class org.safs.Processor

breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors

Constructor and Description
CFWinMenuBar()

Method Summary

Modifier and Type	Method and Description
protected Tree	extractMenuItems(java.lang.Object obj, int level) Purpose: Extract a menu hierarchy from a TestObject; The item is for .Menubar, .Menuitem, .Menupopup.
protected MenuTreeNode	getNewTreeNode(java.lang.Object userObject, int siblingCounter, int childrenCounter) Note: Needed to be overrided for other application than Swing.
protected java.lang.String	getPropertyText(com.rational.test.ft.object.interfaces.TestObject testObject) Note: Override that of its superclass.
protected java.lang.Integer	getSubMenuItemCount(com.rational.test.ft.object.interfaces.TestObject aMenuObj) Return the number of immediate child (.Menuitem or .Menupopup) from the provided .Menubar or .Menupopup.
protected boolean	isMenuBar(com.rational.test.ft.object.interfaces.TestObject menuObject) Note: Needed to be override in subclass.
protected boolean	isMenuItem(com.rational.test.ft.object.interfaces.TestObject menuObject) Note: Needed to be override in subclass.
protected boolean	isPopupMenu(com.rational.test.ft.object.interfaces.TestObject menuObject)
static Tree	staticExtractMenuItems(java.lang.Object obj, int level) Note: This method is used by the RDDGUIUtilities.java

Methods inherited from class org.safs.rational.CFMenuBar

captureObjectData, convertToMap, getAbsoluteFileName, getPath, getPropertyTextName, getStatus, getSubMenuItemFullPath, localProcess, selectMenuBar, selectMenuItem, selectMenuItemContains, selectMenuItemWithoutVerification, selectMenuItemWithVerification, selectUnverifiedMenuItem, selectUnverifiedPopupMenuItem, verifyMenuBar, verifyMenuItem, verifyMenuItemContains, verifyPopupMenu

Methods inherited from class org.safs.rational.CFComponent

_maximize, _minimize, _restore, _setPosition, _setSize, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, clearAppMapCache, closeWindow, componentClick, convertObjectValueToString, exist, extractTreeItemsSub, findMenuBars, formatObjectData, getAppletsBrowser, getComponentRectangle, getComponentRectangleOnScreen, getHelpers, getKeepEncodingConsistent, getObjectProperty, getObjectPropertyFromProperties, getProperties, getPropertyObject, getUserObject, getWindowRectangleOnScreen, inputKeystrokes, isDotnetDomain, isFlexDomain, isHtmlDomain, isJavaDomain, isSwtDomain, isSWTWidget, isWinDomain, listAllProperties, listAllProperties, listMethods, listNonValueProperties, listProperties, matchedPathOfMenuItem, mouseClick, parseWhereInfo, performClick, performDrag, performHoverMouse, performScorll, process, selectMenuItem, sendEvent, sendFlexEvent, setKeepEncodingConsistent, setPropertyValue, tobj, verifyClipboardToFile, verifyFileToFile, verifyMenuItem, verifyObjectDataToFile, verifyPropertyContains, verifyPropertyToFile, verifyValueContains, verifyValues

Methods inherited from class org.safs.ComponentFunction

_close, action_ComputedStyle, action_getGuiImage, action_GetSaveTextFromGUI, action_showOnPage, action_verifyGuiImageToFile, assignPropertyVariable, captureObjectData, checkForCoord, checkForCoord, clearCache, close, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertCoords, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, dragTo, executeScript, getAlternateParams, getHelpersWorker, getPossibleMapItem, getProperty, getPropertyCollection, getPropertyCollection, getRectangleImage, getStringValue, getUUIDBoolean, guiDoesExist, hoverMouse, hoverScreenLocation, isPropertyExist, issueFileErrorFailure, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issuePassedSuccessUsing, issueUnknownErrorFailure, isSupportedRecordType, locateScreenImage, lookupAppMapCoordReference, lookupAppMapLineReference, lookupAppMapNumReference, lookupAppMapReference, maximize, minimize, normalizeFileEncoding, normalizePropertyCollection, restore, setIterator, setPosition, setRectVars, showComponentAsMuchPossible, updateFromTestRecordData, verifyPropertiesToFile, verifyProperty, waitForGUI, waitForObject

Methods inherited from class org.safs.Processor

activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setTestRecordData, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_POPUPMENU_NAME

public static final java.lang.String CLASS_POPUPMENU_NAME

See Also:

Constant Field Values

CLASS_MENUBAR_NAME

public static final java.lang.String CLASS_MENUBAR_NAME

See Also:

Constant Field Values

CLASS_MENUITEM_NAME

public static final java.lang.String CLASS_MENUITEM_NAME

See Also:

Constant Field Values

CLASS_SEPARATOR_NAME

public static final java.lang.String CLASS_SEPARATOR_NAME

See Also:

Constant Field Values

PROPERTY_NUM_CHILDREN

public static final java.lang.String PROPERTY_NUM_CHILDREN

See Also:

Constant Field Values

PROPERTY_NUM_SUBMENUITEM

public static final java.lang.String PROPERTY_NUM_SUBMENUITEM

See Also:

Constant Field Values

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME

See Also:

Constant Field Values

PROPERTY_TEXT

public static final java.lang.String PROPERTY_TEXT

See Also:

Constant Field Values

Constructor Detail

CFWinMenuBar

public CFWinMenuBar()

Method Detail

isMenuBar

protected boolean isMenuBar(com.rational.test.ft.object.interfaces.TestObject menuObject)
                     throws SAFSException

Description copied from class: CFMenuBar

Note: Needed to be override in subclass. "uIClassID" is a property specific for java swing object, we use this property to test what UI Component it is. This can only work for swing.

Overrides:

isMenuBar in class CFMenuBar

Parameters:

menuObject - A TestObject represents a MenuBar or PopupMenu or Menu or MenuItem

Returns:

True if the TestObject is MenuBar or PopupMenu. False otherwise.

Throws:

SAFSException

isMenuItem

protected boolean isMenuItem(com.rational.test.ft.object.interfaces.TestObject menuObject)
                      throws SAFSException

Description copied from class: CFMenuBar

Note: Needed to be override in subclass. We just call isMenuBar() to make the test.

Overrides:

isMenuItem in class CFMenuBar

Parameters:

menuObject - A TestObject represents a MenuBar or PopupMenu or Menu or MenuItem

Returns:

True if the TestObject is Menu or MenuItem. False otherwise.

Throws:

SAFSException

isPopupMenu

protected boolean isPopupMenu(com.rational.test.ft.object.interfaces.TestObject menuObject)
                       throws SAFSException

Overrides:

isPopupMenu in class CFMenuBar

Returns:

True if the menuObject is a popupMenu; False otherwise.

Throws:

SAFSException

getPropertyText

protected java.lang.String getPropertyText(com.rational.test.ft.object.interfaces.TestObject testObject)

Note: Override that of its superclass. In Win domain, the text property of menuitem is represented by string ".text" or ".name".

Overrides:

getPropertyText in class CFMenuBar

Returns:

The value of "text" property of a menuitem.

getSubMenuItemCount

protected java.lang.Integer getSubMenuItemCount(com.rational.test.ft.object.interfaces.TestObject aMenuObj)

Return the number of immediate child (.Menuitem or .Menupopup) from the provided .Menubar or .Menupopup. or .Menuitem Note: If a .Menuitem has submenu, then it has only one child of type .Menupopup the child of type .Menupopup will has .Menuitem as its children, which are the items that we see from the submenu. The following tree show the structure of .Menubar .Menubar |____________________________________ | | | .Menuitem .Menuitem .Menuitem | | | .Menupopup .Menupopup .Menupopup ____|____ | | .Menuitem .Menuitem

Overrides:

getSubMenuItemCount in class CFMenuBar

Parameters:

aMenuObj - -- Typically a .Menubar or .Menupopup or .Menuitem proxy. Will be cast to TestObject.

Returns:

Integer -- the number of child (.Menuitem)

getNewTreeNode

protected MenuTreeNode getNewTreeNode(java.lang.Object userObject,
                                      int siblingCounter,
                                      int childrenCounter)

Description copied from class: CFMenuBar

Note: Needed to be overrided for other application than Swing.

Overrides:

getNewTreeNode in class CFMenuBar

Returns:

An apporiate MenuTreeNode. For Example, a JavaMenuTreeNode for java application; a DotNetMenuTreeNode for .NET application.

extractMenuItems

protected Tree extractMenuItems(java.lang.Object obj,
                                int level)
                         throws SAFSException

Purpose: Extract a menu hierarchy from a TestObject; The item is for .Menubar, .Menuitem, .Menupopup. This routine is reentrant until there are no more submenus to process.
Assumptions: obj is a .Menubar, .Menuitem, .Menupopup TestObject proxy.
Note: Override the method of its superclass CFMenuBar The following tree show the structure of .Menubar .Menubar |____________________________________ | | | .Menuitem .Menuitem .Menuitem | | | .Menupopup .Menupopup .Menupopup ____|____ | | .Menuitem .Menuitem

Overrides:

extractMenuItems in class CFMenuBar

Parameters:

obj, - Object (TestObject)

level, - what level in the tree are we processing

Returns:

org.safs.Tree, the real instance is org.safs.rational.MenuTree

Throws:

SAFSException

staticExtractMenuItems

public static Tree staticExtractMenuItems(java.lang.Object obj,
                                          int level)
                                   throws SAFSException

Note: This method is used by the RDDGUIUtilities.java

Throws:

SAFSException