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

Class JfcGraphicalSubitemProxy

java.lang.Object

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

All Implemented Interfaces:

IDataDriven, IProxyBase, IPropertyFilter, ISetParent

Direct Known Subclasses:

JComboBoxProxy, JMenuBarProxy, JPopupMenuProxy, JScrollBarProxy, JScrollPaneProxy, JSplitPaneProxy, JTabbedPaneProxy, JTableHeaderProxy, JToolBarProxy

public abstract class JfcGraphicalSubitemProxy
extends JComponentProxy

Abstract proxy class implements IGraphicalSubitem interface.

• TestObject interface:
  GuiSubitemTestObject
  This class acts as the base class for other subitem based proxies.
  
• 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.
  .priorLabel	The text of a preceding label. Suppressed if there is no preceding label.
  accessibleContext.accessibleName	A programmatically defined name for the component.
  name	The name property, suppressed if default formatted (default form = className+count).
  toolTipText	The text from the associated tool tip, omitted if there is no associated tool tip.

  
  

Nested Class Summary

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

ComponentProxy.ChildEnumerator, 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 interface com.rational.test.ft.domain.IDataDriven

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

Constructor and Description
JfcGraphicalSubitemProxy(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
void	click(MouseModifiers modifiers, Subitem subitem) Perform a mouse click action at the specified object relative coordinates within the associated TestObject.
void	click(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Perform a mouse click action on the specified coordinates relative to the associated TestObject.
void	click(Subitem subitem) Left mouse click on the center point of the associated subitem.
void	click(Subitem subitem, java.awt.Point pt) Left mouse click on the specified coordinates relative to the associated TestObject.
void	doubleClick(MouseModifiers modifiers, Subitem subitem) Perform a mouse dbl-click action at the specified object relative coordinates within the associated TestObject.
void	doubleClick(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Perform a mouse dbl-click action on the specified coordinates relative to the associated TestObject.
void	doubleClick(Subitem subitem) Left mouse dbl-click on the center point of the associated TestObject.
void	doubleClick(Subitem subitem, java.awt.Point pt) Left mouse dbl-click on the specified coordinates relative to the associated TestObject.
void	drag(MouseModifiers modifiers, Subitem subitem) Perform a drag action against the associated TestObject with the supplied set of mouse modifiers.
void	drag(MouseModifiers modifiers, Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2) Perform a drag action against the associated TestObject.
void	drag(MouseModifiers modifiers, Subitem subitem1, Subitem subitem2) Perform a drag action against the associated TestObject.
void	drag(Subitem subitem) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	drag(Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	drag(Subitem subitem1, Subitem subitem2) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point screenPt) Perform a drag action against the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Perform a drag action against the associated TestObject.
void	dragToScreenPoint(Subitem subitem, java.awt.Point screenPt) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	dragToScreenPoint(Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Perform a MOUSE_LEFT drag action against the associated TestObject.
java.awt.Point	getScreenPoint(Subitem subitem) Returns the screen relative point to the center of the supplied subitem.
java.awt.Point	getScreenPoint(Subitem subitem, java.awt.Point pt) Returns the screen relative point given a subitem and a subitem relative point.
abstract java.awt.Rectangle	getScreenRectangle(Subitem subitem) Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
java.lang.Object	getSubitem(Subitem subitem) Returns an object that represents the specified subitem in the associated test object.
java.lang.String	getTestObjectClassName() Return the GuiSubitemTestObject classname.
void	hover(double secondDelay, Subitem subitem) Hover the mouse over the center of the specified subitem.
void	hover(double secondDelay, Subitem subitem, java.awt.Point pt) Hover the mouse over the specified coordinates relative to the specified subitem.
void	hover(Subitem subitem) Hover the mouse over the center of the specified subitem.
void	hover(Subitem subitem, java.awt.Point pt) Hover the mouse over the specified coordinates relative to the specified subitem.
void	mouseMove(MouseModifiers modifiers, Subitem subitem) Perform a move action against the associated TestObject.
void	mouseMove(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Perform a move action against the associated TestObject.
void	mouseMove(Subitem subitem) Perform a MOUSE_LEFT move action against the associated TestObject.
void	mouseMove(Subitem subitem, java.awt.Point subitemPt) Perform a MOUSE_LEFT move action against the associated TestObject.
void	nClick(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Perform a mouse n-click action on the specified coordinates relative to the associated TestObject.
void	nClickDrag(int clickCount, MouseModifiers modifiers, Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2) Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
void	nClickDrag(int clickCount, MouseModifiers modifiers, Subitem subitem1, Subitem subitem2) Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
void	nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point screenPt) Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.
void	nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.

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

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

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

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getChildrenEnumeration, getComponentChildren, getElementWithFocus, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getScreenRectangle, getTopParent, getWindow, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, isRecognitionProperty, isShowing, isVScroll, setParent

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

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

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

addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMethods, getNonValueProperties, getRecognitionProperties, getRecognitionPropertyWeight, getTestDataTypes, 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, getTestData, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData

Methods inherited from class java.lang.Object

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

Constructor Detail

JfcGraphicalSubitemProxy

public JfcGraphicalSubitemProxy(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

getTestObjectClassName

public java.lang.String getTestObjectClassName()

Return the GuiSubitemTestObject classname.

Specified by:

getTestObjectClassName in interface IProxyBase

Overrides:

getTestObjectClassName in class JavaGuiProxy

Returns:

The default IGraphicalSubitem test object class full name.

getScreenRectangle

public abstract java.awt.Rectangle getScreenRectangle(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.

Returns:

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

getScreenPoint

public java.awt.Point getScreenPoint(Subitem subitem)

Returns the screen relative point to the center of the supplied subitem.

Overrides:

getScreenPoint in class JavaGuiProxy

Parameters:

subitem - The subitem the resultant screen point is relative to.

Returns:

A screen relative point.

getScreenPoint

public java.awt.Point getScreenPoint(Subitem subitem,
                            java.awt.Point pt)

Returns the screen relative point given a subitem and a subitem relative point.

Parameters:

subitem - The subitem the resultant screen point is relative to.

pt - The subitem relative point.

Returns:

A screen relative point.

getSubitem

public java.lang.Object getSubitem(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.

Parameters:

subitem - The subitem to fetch an object for.

Returns:

An object representation of the subitem.

click

public void click(Subitem subitem)

Left mouse click on the center point of the associated subitem. This method is a simple shortcut to the click method with a modifier parameter (modifier set to MOUSE_LEFT).

Overrides:

click in class JavaGuiProxy

click

public void click(MouseModifiers modifiers,
         Subitem subitem)

Perform a mouse click action at the specified object relative coordinates within the associated TestObject.

Overrides:

click in class JavaGuiProxy

click

public void click(Subitem subitem,
         java.awt.Point pt)

Left mouse click on the specified coordinates relative to the associated TestObject. This method is a simple shortcut to the click method with a modifier parameter and coordinates (modifier set to MOUSE_LEFT).

Overrides:

click in class JavaGuiProxy

click

public void click(MouseModifiers modifiers,
         Subitem subitem,
         java.awt.Point pt)

Perform a mouse click action on the specified coordinates relative to the associated TestObject.

doubleClick

public void doubleClick(Subitem subitem)

Left mouse dbl-click on the center point of the associated TestObject. This method is a simple shortcut to the dbl-click method with a modifier parameter (modifier set to MOUSE_LEFT).

Overrides:

doubleClick in class JavaGuiProxy

doubleClick

public void doubleClick(MouseModifiers modifiers,
               Subitem subitem)

Perform a mouse dbl-click action at the specified object relative coordinates within the associated TestObject.

Overrides:

doubleClick in class JavaGuiProxy

doubleClick

public void doubleClick(Subitem subitem,
               java.awt.Point pt)

Left mouse dbl-click on the specified coordinates relative to the associated TestObject. This method is a simple shortcut to the dbl-click method with a modifier parameter and coordinates (modifier set to MOUSE_LEFT).

Overrides:

doubleClick in class JavaGuiProxy

doubleClick

public void doubleClick(MouseModifiers modifiers,
               Subitem subitem,
               java.awt.Point pt)

Perform a mouse dbl-click action on the specified coordinates relative to the associated TestObject.

nClick

public void nClick(int clickCount,
          MouseModifiers modifiers,
          Subitem subitem,
          java.awt.Point pt)

Perform a mouse n-click action on the specified coordinates relative to the associated TestObject.

drag

public void drag(Subitem subitem)

Perform a MOUSE_LEFT drag action against the associated TestObject. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Overrides:

drag in class JavaGuiProxy

drag

public void drag(MouseModifiers modifiers,
        Subitem subitem)

Perform a drag action against the associated TestObject with the supplied set of mouse modifiers. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Overrides:

drag in class JavaGuiProxy

drag

public void drag(Subitem subitem1,
        Subitem subitem2)

Perform a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates relative to this TestObject.

Overrides:

drag in class JavaGuiProxy

drag

public void drag(MouseModifiers modifiers,
        Subitem subitem1,
        Subitem subitem2)

Perform a drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates relative to this TestObject.

Overrides:

drag in class JavaGuiProxy

drag

public void drag(Subitem subitem1,
        java.awt.Point pt1,
        Subitem subitem2,
        java.awt.Point pt2)

Perform a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates relative to this TestObject.

drag

public void drag(MouseModifiers modifiers,
        Subitem subitem1,
        java.awt.Point pt1,
        Subitem subitem2,
        java.awt.Point pt2)

Perform a drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates relative to this TestObject.

nClickDrag

public void nClickDrag(int clickCount,
              MouseModifiers modifiers,
              Subitem subitem1,
              Subitem subitem2)

Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.

Overrides:

nClickDrag in class JavaGuiProxy

nClickDrag

public void nClickDrag(int clickCount,
              MouseModifiers modifiers,
              Subitem subitem1,
              java.awt.Point pt1,
              Subitem subitem2,
              java.awt.Point pt2)

Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.

dragToScreenPoint

public void dragToScreenPoint(Subitem subitem,
                     java.awt.Point screenPt)

Perform a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to the screen relative screenPt coordinates.

Overrides:

dragToScreenPoint in class JavaGuiProxy

dragToScreenPoint

public void dragToScreenPoint(MouseModifiers modifiers,
                     Subitem subitem,
                     java.awt.Point screenPt)

Perform a drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to the screen relative screenPt coordinates.

Overrides:

dragToScreenPoint in class JavaGuiProxy

dragToScreenPoint

public void dragToScreenPoint(Subitem subitem,
                     java.awt.Point subitemPt,
                     java.awt.Point screenPt)

Perform a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to the screen relative screenPt coordinates.

Overrides:

dragToScreenPoint in class JavaGuiProxy

dragToScreenPoint

public void dragToScreenPoint(MouseModifiers modifiers,
                     Subitem subitem,
                     java.awt.Point subitemPt,
                     java.awt.Point screenPt)

Perform a drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to the screen relative screenPt coordinates.

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,
                           MouseModifiers modifiers,
                           Subitem subitem,
                           java.awt.Point screenPt)

Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.

Overrides:

nClickDragToScreenPoint in class JavaGuiProxy

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,
                           MouseModifiers modifiers,
                           Subitem subitem,
                           java.awt.Point subitemPt,
                           java.awt.Point screenPt)

Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.

mouseMove

public void mouseMove(Subitem subitem)

Perform a MOUSE_LEFT move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Overrides:

mouseMove in class JavaGuiProxy

mouseMove

public void mouseMove(Subitem subitem,
             java.awt.Point subitemPt)

Perform a MOUSE_LEFT move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Overrides:

mouseMove in class JavaGuiProxy

mouseMove

public void mouseMove(MouseModifiers modifiers,
             Subitem subitem)

Perform a move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Overrides:

mouseMove in class JavaGuiProxy

mouseMove

public void mouseMove(MouseModifiers modifiers,
             Subitem subitem,
             java.awt.Point pt)

Perform a move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

hover

public void hover(double secondDelay,
         Subitem subitem)

Hover the mouse over the center of the specified subitem. The mouse is moved to the center of the subitem and stays there for at least the specified number of seconds.

Overrides:

hover in class JavaGuiProxy

hover

public void hover(double secondDelay,
         Subitem subitem,
         java.awt.Point pt)

Hover the mouse over the specified coordinates relative to the specified subitem. The mouse is moved to the subitem relative coordinates and stays there for at least the specified number of seconds.

hover

public void hover(Subitem subitem)

Hover the mouse over the center of the specified subitem. The mouse is moved to the center of the subitem and stays there for at least the default amount of time.

Overrides:

hover in class JavaGuiProxy

hover

public void hover(Subitem subitem,
         java.awt.Point pt)

Hover the mouse over the specified coordinates relative to the specified subitem. The mouse is moved to the subitem relative coordinates and stays there for at least the default amount of time.

Overrides:

hover in class JavaGuiProxy