com.rational.test.ft.domain.java.jfc

Class JPopupMenuProxy

java.lang.Object

com.rational.test.ft.sys.RegisteredObject

com.rational.test.ft.domain.ProxyTestObject

com.rational.test.ft.domain.java.JavaProxy

com.rational.test.ft.domain.java.JavaGuiProxy

com.rational.test.ft.domain.java.awt.ComponentProxy

com.rational.test.ft.domain.java.jfc.JComponentProxy

com.rational.test.ft.domain.java.jfc.JfcGraphicalSubitemProxy

com.rational.test.ft.domain.java.jfc.JPopupMenuProxy

All Implemented Interfaces:

com.rational.test.ft.domain.IChannelObject, com.rational.test.ft.domain.IDataDriven, com.rational.test.ft.domain.IProxyBase, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.IGraphicalSubitem

public class JPopupMenuProxy
extends JfcGraphicalSubitemProxy

Proxy for the javax.swing.JPopupMenu class.

• TestObject interface:
  GuiSubitemTestObject
  
• Supported Test Data Types:
  

  Type	Desciption	Data Class
  menu	Menu Hierarchy	ITestDataTree
  extendedMenu	Menu Hierarchy with Properties	ITestDataTree

  
  
  
• Default Recognition Properties:
  

  Property	Usage
  .class	The Java full class name of the test object.
  .classIndex	The zero-based index of the class relative to the immediate parent in the object map.
  accessibleContext.accessibleName	A programmatically defined name for the component.
  name	The name property, suppressed if default formatted (default form = className+count).

  
  
• Supported Subitems:
  

  Subitem	Usage
  List	The ordered set of Text and Index subitems that define a path to a child menu item. Most commonly appears in scripts as atPath specifications.
  Text	Defines the menu with the specified visible text.
  Index	Defines the menu at the specified zero-based index.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JPopupMenuProxy.ChildEnumerator

Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

ComponentProxy.ImmediateChildEnumerator

Field Summary

Fields inherited from class com.rational.test.ft.domain.java.jfc.JComponentProxy

TAB_INDEX, TAB_TEXT

Fields inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, MAX_NAME, NAMEPROPERTY, NAMEPROPERTYWEIGHT, PRIORLABEL, PRIORLABELWEIGHT

Fields inherited from class com.rational.test.ft.domain.java.JavaGuiProxy

LEFT, preDownState, processMouseEventHandler, ROLEINDEX, ROLEINDEXWEIGHT, TESTDATA_SPECIALFRAMESTATE, TESTDATA_SPECIALFRAMESTATE_DESCRIPTION, topLevelWindow

Fields inherited from class com.rational.test.ft.domain.java.JavaProxy

debug, uniqueId

Fields inherited from class com.rational.test.ft.domain.ProxyTestObject

BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TIMEOUTTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle

Fields inherited from class com.rational.test.ft.sys.RegisteredObject

theTestObject

Fields inherited from interface com.rational.test.ft.domain.IDataDriven

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

Constructor and Description
JPopupMenuProxy(java.lang.Object theObjectInTheSUT) This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateTopWindow()
void	childConstructed(com.rational.test.ft.domain.ProxyTestObject child) Inform the parent when child proxies are constructed so additional recognition properties can be added when needed.
java.util.Enumeration	getChildrenEnumeration() Return an enumeration of proxies for the children of this object.
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
java.awt.Component	getInvoker() Returns the component which is the 'invoker' of this popup menu.
com.rational.test.ft.domain.ProxyTestObject[]	getMappableChildren() Uses getChildren to implement.
com.rational.test.ft.domain.ProxyTestObject	getMappableParent() Returns a proxy object for the parent of this object.
protected com.rational.test.ft.domain.ProxyTestObject[]	getMenuChildrenArray()
JMenuItemProxy	getMenuItemProxy(com.rational.test.ft.script.Subitem item) This method gets the proxy related to the Subitem.
com.rational.test.ft.domain.ProxyTestObject	getOwner() Returns a proxy object for the owner of this object.
com.rational.test.ft.domain.ProxyTestObject	getParent() Returns a proxy object for the parent of this object.
java.lang.Object	getParentObject() Returns an object for the parent of this object.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_POPUP_MENU.
java.awt.Rectangle	getScreenRectangle(com.rational.test.ft.script.Subitem subitem) Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
com.rational.test.ft.script.Subitem	getSubitem() Return the Subitem describes this JPopupMenu.
java.lang.Object	getSubitem(com.rational.test.ft.script.Subitem subitem) Returns an object that represents the specified subitem in the associated test object.
com.rational.test.ft.vp.ITestData	getTestData(java.lang.String testDataType) This method constructs the specified verification data object.
java.util.Hashtable	getTestDataTypes() Returns a hashtable of data type descriptions of the verification point data available with the associated object in the SUT.
boolean	shouldBeMapped() Returns true; by default all test objects are mapped.
com.rational.test.ft.vp.ITestData	updateTestData(java.lang.String testDataType, com.rational.test.ft.vp.ITestData testData) This method updates the supplied test data object and returns it.

Methods inherited from class com.rational.test.ft.domain.java.jfc.JfcGraphicalSubitemProxy

click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getScreenPoint, getScreenPoint, getTestObjectClassName, hover, hover, hover, hover, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint

Methods inherited from class com.rational.test.ft.domain.java.jfc.JComponentProxy

getBorderTitle, getClippedRect, getClippedScreenRectangle, getProperties, getStandardProperties, getText, getVisibleRectangle, getVisualClippedRectangle, hasFocus, isOpaque, isPointInObject, isType, scrollRectToVisible

Methods inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

canBeScrolled, getChildAtPoint, getChildProxy, getComponentChildren, getElementWithFocus, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getName, getOwnedObjects, getParent2, getScreenRectangle, getTopParent, getWindow, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, isRecognitionProperty, isShowing, isVScroll, setParent

Methods inherited from class com.rational.test.ft.domain.java.JavaGuiProxy

click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, invokeMethodOnEDT, isDrag, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, processSingleMouseEvent, setProcessMouseEventHandler, setTopLevelWindow

Methods inherited from class com.rational.test.ft.domain.java.JavaProxy

addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMethods, getNonValueProperties, getRecognitionProperties, getRecognitionPropertyWeight, getTestDomain, getTopMappableParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, setIndexer, setProperty

Methods inherited from class com.rational.test.ft.domain.ProxyTestObject

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommand, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction

Methods inherited from class com.rational.test.ft.sys.RegisteredObject

addProxyReference, dereference, getObject, getRegisteredId, getTransactionId, isReferenced, isReleaseRequired, register, registerTransiently, release, toString, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

JPopupMenuProxy

public JPopupMenuProxy(java.lang.Object theObjectInTheSUT)

This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.

Method Detail

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_POPUP_MENU.

Overrides:

getRole in class JComponentProxy

Returns:

A brief type name that describes the role this object plays in the UI.

Since:

RFT1.0

getInvoker

public java.awt.Component getInvoker()

Returns the component which is the 'invoker' of this popup menu.

Returns:

the Component in which the popup menu is displayed

getParentObject

public java.lang.Object getParentObject()

Returns an object for the parent of this object. Returns null if this object has no parent.

Overrides:

getParentObject in class ComponentProxy

Returns:

The parent test object or null for a top level window.

getParent

public com.rational.test.ft.domain.ProxyTestObject getParent()

Returns a proxy object for the parent of this object. Returns null if this object has no parent.

Overrides:

getParent in class ComponentProxy

Returns:

The proxy for the parent test object or null for a top level window.

getOwner

public com.rational.test.ft.domain.ProxyTestObject getOwner()

Returns a proxy object for the owner of this object. Returns null if this object has no owner.

Overrides:

getOwner in class ComponentProxy

Returns:

The proxy for the owning object or null for a top object without an owner.

childConstructed

public void childConstructed(com.rational.test.ft.domain.ProxyTestObject child)

Inform the parent when child proxies are constructed so additional recognition properties can be added when needed. By default nothing happens in this method.

Overrides:

childConstructed in class ComponentProxy

Parameters:

child - The child proxy that was just constructed.

getMappableChildren

public com.rational.test.ft.domain.ProxyTestObject[] getMappableChildren()

Uses getChildren to implement.

Overrides:

getMappableChildren in class ComponentProxy

Returns:

null, if no known children.

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()

Return an enumeration of proxies for the children of this object. Return JMenuProxy and JMenuItemProxy for JMenuBarProxy.

Overrides:

getChildrenEnumeration in class ComponentProxy

Returns:

The child proxies relative to this proxy.

getMappableParent

public com.rational.test.ft.domain.ProxyTestObject getMappableParent()

Returns a proxy object for the parent of this object. Returns null if this object has no parent.

Overrides:

getMappableParent in class ComponentProxy

Returns:

The proxy for the parent test object or null for a top level window.

shouldBeMapped

public boolean shouldBeMapped()

Description copied from class: JavaGuiProxy

Returns true; by default all test objects are mapped. This method should be overriden by proxies that do not contain interesting persistent information. Objects that the script may want to interact with should always return true.

Overrides:

shouldBeMapped in class JavaGuiProxy

Returns:

true, unless overriden in a super class.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Get the value for a specific property.

Overrides:

getProperty in class JComponentProxy

getSubitem

public com.rational.test.ft.script.Subitem getSubitem()

Return the Subitem describes this JPopupMenu.

Returns:

Text

getSubitem

public java.lang.Object getSubitem(com.rational.test.ft.script.Subitem subitem)

Returns an object that represents the specified subitem in the associated test object. SubitemNotFoundException will be thrown if the specified subitem is invalid relative to the associated test object. null may be returned if the subitem does not have an object association that can be returned.

Specified by:

getSubitem in interface com.rational.test.ft.object.interfaces.IGraphicalSubitem

Overrides:

getSubitem in class JfcGraphicalSubitemProxy

Parameters:

subitem - The subitem to fetch an object for.

Returns:

An object representation of the subitem.

getDescriptiveName

public java.lang.String getDescriptiveName()

Returns a name that can be used to describe the associated UI object in a script. This name may be further adjusted to be made unique to the script, but will act as the base for the name used in the script. Only characters used in Java identifiers should be returned (alphabetic, numeric or underscore characters). Non-identifier characters will cause script compilation failures. An example of what to return may be "OKButton" for a java.awt.Button with the text "OK" on it.

Overrides:

getDescriptiveName in class JComponentProxy

Returns:

A descriptive object name.

getMenuItemProxy

public JMenuItemProxy getMenuItemProxy(com.rational.test.ft.script.Subitem item)

This method gets the proxy related to the Subitem.

Parameters:

item - Subitem of the JPopupMenuProxy

Returns:

The JMenuItemProxy related to the item.

getScreenRectangle

public java.awt.Rectangle getScreenRectangle(com.rational.test.ft.script.Subitem subitem)

Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen. This will commonly be two operations (getScreenRectangle for the parent object and then adjusting for the specified subitem) combined into a single operation. The rectangle is exposed so that actions may be directly scripted against a visible subitem. null is returned if the subitem is not showing.

Specified by:

getScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphicalSubitem

Specified by:

getScreenRectangle in class JfcGraphicalSubitemProxy

Returns:

The adjusted rectangle surrounding subitem relative to the screen. null is returned if the subitem is not showing.

activateTopWindow

protected void activateTopWindow()

Overrides:

activateTopWindow in class JavaGuiProxy

getTestDataTypes

public java.util.Hashtable getTestDataTypes()

Returns a hashtable of data type descriptions of the verification point data available with the associated object in the SUT. The hashtable keys are String objects that are used as the VP type in the associated test data. The type is a simple value that is defferent then other type values associated with this object under test. The type keys map to a verbose description of the test data, reasonable for presentation to a user.

Overrides:

getTestDataTypes in class JavaProxy

Returns:

An hashtable of type/description pairs used to describe the verification data available from this proxy.

See Also:

getTestData(String), ITestData

getTestData

public com.rational.test.ft.vp.ITestData getTestData(java.lang.String testDataType)

This method constructs the specified verification data object. The testDataType parameter is one of the hashtable keys returned by getTestDataTypes.

Overrides:

getTestData in class com.rational.test.ft.domain.ProxyTestObject

Parameters:

testDataType - A test data type supplied by getTestDataTypes.

Returns:

The verification data for the supplied type.

See Also:

getTestDataTypes(), ITestData

getMenuChildrenArray

protected com.rational.test.ft.domain.ProxyTestObject[] getMenuChildrenArray()

updateTestData

public com.rational.test.ft.vp.ITestData updateTestData(java.lang.String testDataType,
                                               com.rational.test.ft.vp.ITestData testData)

This method updates the supplied test data object and returns it. The testDataType parameter is one of the hashtable keys returned by getTestDataTypes. The testData is a previously supplied ITestData object that needs to be updated to reflect the current state of the associated test object.

Overrides:

updateTestData in class com.rational.test.ft.domain.ProxyTestObject

Parameters:

testDataType - A test data type supplied by getTestDataTypes.

testData - The test data base object that requires updating.

Returns:

The testData passed in with appropriate updates.

See Also:

getTestDataTypes(), ITestData