com.rational.test.ft.object.interfaces

Class StatelessGuiSubitemTestObject

java.lang.Object

com.rational.test.ft.object.interfaces.TestObject

com.rational.test.ft.object.interfaces.ClientTestObject

com.rational.test.ft.object.interfaces.GuiTestObject

com.rational.test.ft.object.interfaces.StatelessGuiSubitemTestObject

All Implemented Interfaces:

IGraphical, IGraphicalSubitem

Direct Known Subclasses:

DojoGridTestObject, DojoMenuTestObject, GuiSubitemTestObject, SapGridTestObject

public class StatelessGuiSubitemTestObject
extends GuiTestObject
implements IGraphicalSubitem

Provides access to actions replayed by the mouse or keyboard.

Since:

RFT1.0

Field Summary

Fields inherited from class com.rational.test.ft.object.interfaces.TestObject

ignoreTheObjectState, ref

Constructor Summary

Constructors

Constructor and Description
StatelessGuiSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject) For internal use.
StatelessGuiSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor) For internal use.
StatelessGuiSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags) For internal use.
StatelessGuiSubitemTestObject(TestObject obj) Constructs one StatelessGuiSubitemTestObject from another TestObject.
StatelessGuiSubitemTestObject(com.rational.test.ft.object.TestObjectReference ref) For internal use.

Method Summary

Modifier and Type	Method and Description
void	click(MouseModifiers modifiers, Subitem subitem) Performs a left-mouse click on the specified object-relative coordinates within the associated TestObject.
void	click(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Performs a left-mouse click on the specified coordinates, relative to the associated TestObject.
void	click(Subitem subitem) Performs a left-mouse click on the center point of the associated subitem.
void	click(Subitem subitem, java.awt.Point pt) Performs a left-mouse click on the specified coordinates, relative to the associated TestObject.
void	doubleClick(MouseModifiers modifiers, Subitem subitem) Performs a left-mouse double-click on the specified object, relative to coordinates within the associated TestObject.
void	doubleClick(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Performs a left-mouse double-click action on the specified coordinates, relative to the associated TestObject.
void	doubleClick(Subitem subitem) Performs a left-mouse double-click on the center point of the associated TestObject.
void	doubleClick(Subitem subitem, java.awt.Point pt) Performs a left-mouse double-click on the specified coordinates, relative to the associated TestObject.
void	drag(MouseModifiers modifiers, Subitem subitem) Performs 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) Performs a drag action against the associated TestObject.
void	drag(MouseModifiers modifiers, Subitem subitem1, Subitem subitem2) Performs a drag action against the associated TestObject.
void	drag(Subitem subitem) Performs a MOUSE-LEFT drag action against the associated TestObject.
void	drag(Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2) Performs a MOUSE-LEFT drag action against the associated TestObject.
void	drag(Subitem subitem1, Subitem subitem2) Performs a MOUSE-LEFT drag action against the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point screenPt) Performs a drag action against the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Performs a drag action against the associated TestObject.
void	dragToScreenPoint(Subitem subitem, java.awt.Point screenPt) Performs a MOUSE-LEFT drag action against the associated TestObject.
void	dragToScreenPoint(Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Performs 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.
java.awt.Rectangle	getScreenRectangle(Subitem subitem) Returns the rectangle containing the component that is 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 TestObject.
void	hover(double secondDelay, Subitem subitem) Hovers the mouse over the center of the specified subitem.
void	hover(double secondDelay, Subitem subitem, java.awt.Point pt) Hovers the mouse over the specified coordinates, relative to the specified subitem.
void	hover(Subitem subitem) Hovers the mouse over the center of the specified subitem.
void	hover(Subitem subitem, java.awt.Point pt) Hovers the mouse over the specified coordinates that are relative to the specified subitem.
void	mouseMove(MouseModifiers modifiers, Subitem subitem) Performs a move action against the associated TestObject.
void	mouseMove(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Performs a move action against the associated TestObject.
void	mouseMove(Subitem subitem) Performs a MOUSE-LEFT move action against the associated TestObject.
void	mouseMove(Subitem subitem, java.awt.Point subitemPt) Performs a MOUSE-LEFT move action against the associated TestObject.
void	nClick(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Performs 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) Performs 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) Performs 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) Performs a mouse n-click drag action on the specified coordinates, relative to the screen-relative screenPt coordinates.
void	nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Performs a mouse n-click drag action on the specified coordinates, relative to the screen-relative screenPt coordinates.

Methods inherited from class com.rational.test.ft.object.interfaces.GuiTestObject

canTakeVP, click, click, click, click, clickRadio, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, ensureObjectIsVisible, getChildAtPoint, getClippedScreenRectangle, getImage, getImage, getIWindow, getRole, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, getVisibleArea, hasFocus, hover, hover, hover, hover, invokeProxyWithGuiDelay, invokeProxyWithGuiDelay, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, switchTo

Methods inherited from class com.rational.test.ft.object.interfaces.ClientTestObject

exists, exists, exists, find, find, findAndInvoke, findAndInvokeProxy, getProperty, getTestDataTypes, invoke, invokeProxy, unregister, waitForExistence

Methods inherited from class com.rational.test.ft.object.interfaces.TestObject

compare, compare, compareAndLog, compareAndLog, equals, find, findAndInvoke, getActualData, getChildren, getDescribedObject, getDescribedObjects, getDescriptiveName, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMapProperties, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectCustomClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTopMappableParent, getTopParent, hashCode, invoke, invoke, invoke, invokeProxy, invokeProxy, isHtmlWebui, isLoggedDuringUnregister, isMappedObject, isSameObject, isScreenTestObject, isTopLevelTestObject, performTest, performTest, performTest, performTest, setIndexer, setIndexer, setLoggedDuringUnregister, setMapProperties, setProperty, toString, updateTestData, waitForExistence

Methods inherited from class java.lang.Object

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

Constructor Detail

StatelessGuiSubitemTestObject

public StatelessGuiSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)

For internal use.

Since:

RFT1.0

StatelessGuiSubitemTestObject

public StatelessGuiSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,
                                     TestObject anchor)

For internal use.

Since:

RFT1.0

StatelessGuiSubitemTestObject

public StatelessGuiSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,
                                     TestObject anchor,
                                     long scriptCommandFlags)

For internal use.

Since:

RFT1.0

StatelessGuiSubitemTestObject

public StatelessGuiSubitemTestObject(com.rational.test.ft.object.TestObjectReference ref)

For internal use.

Since:

RFT1.0

StatelessGuiSubitemTestObject

public StatelessGuiSubitemTestObject(TestObject obj)

Constructs one StatelessGuiSubitemTestObject from another TestObject. Both are references to the same object.

Since:

RFT1.0

Method Detail

getScreenRectangle

public java.awt.Rectangle getScreenRectangle(Subitem subitem)

Returns the rectangle containing the component that is evaluated, relative to the top-left corner of the screen. This typically consists of two operations: (getScreenRectangle for the parent object, and (2) adjusting for the specified subitem combined into a single operation. The rectangle is exposed so that actions can be directly scripted against a visible subitem. If the subitem does not show, null is returned.

Specified by:

getScreenRectangle in interface IGraphicalSubitem

Since:

RFT1.0

getScreenPoint

public java.awt.Point getScreenPoint(Subitem subitem)

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

Specified by:

getScreenPoint in interface IGraphicalSubitem

Parameters:

subitem - the subitem that the resulting screen point is relative to

Since:

RFT1.0

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.

Specified by:

getScreenPoint in interface IGraphicalSubitem

Parameters:

subitem - the subitem that the resulting screen point is relative to

pt - the subitem-relative point

Since:

RFT1.0

getSubitem

public java.lang.Object getSubitem(Subitem subitem)

Returns an object that represents the specified subitem in the associated TestObject. The SubitemNotFoundException is thrown if the specified subitem is invalid, relative to the associated TestObject. If the subitem does not have an object association that can be returned, null is returned .

Note that if the resulting type is not a value class, a TestObject for the object is supplied. For instance, MyMenuBar().getSubitem(atPath("File->New")) returns the TestObject for the New menu item (with all the associated methods available). A simpler example is that myList().getSubitem(atIndex(4)) typically only returns the text for the item in the fifth position (as a string).

WARNING: If the result of this call is a TestObject, you must explicitly unregister the resulting TestObject. Failure to do so causes objects to be pinned in the memory of the system under test.

Specified by:

getSubitem in interface IGraphicalSubitem

Parameters:

subitem - the subitem to fetch an object for

Returns:

An object representation of the subitem

click

public void click(Subitem subitem)

Performs a left-mouse click on the center point of the associated subitem. This method is a shortcut to the Click method with a modifier parameter. (The modifier is set to MOUSE-LEFT).

Specified by:

click in interface IGraphicalSubitem

Since:

RFT1.0

click

public void click(MouseModifiers modifiers,
                  Subitem subitem)

Performs a left-mouse click on the specified object-relative coordinates within the associated TestObject.

Specified by:

click in interface IGraphicalSubitem

Since:

RFT1.0

click

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

Performs a left-mouse click on the specified coordinates, relative to the associated TestObject. This method is a shortcut to the click method, with a modifier parameter and coordinates. (The modifier is set to MOUSE-LEFT).

Specified by:

click in interface IGraphicalSubitem

Since:

RFT1.0

click

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

Performs a left-mouse click on the specified coordinates, relative to the associated TestObject.

Specified by:

click in interface IGraphicalSubitem

Since:

RFT1.0

doubleClick

public void doubleClick(Subitem subitem)

Performs a left-mouse double-click on the center point of the associated TestObject. This method is a shortcut to the double-click method with a modifier parameter. (The modifier is set to MOUSE-LEFT).

Specified by:

doubleClick in interface IGraphicalSubitem

Since:

RFT1.0

doubleClick

public void doubleClick(MouseModifiers modifiers,
                        Subitem subitem)

Performs a left-mouse double-click on the specified object, relative to coordinates within the associated TestObject.

Specified by:

doubleClick in interface IGraphicalSubitem

Since:

RFT1.0

doubleClick

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

Performs a left-mouse double-click on the specified coordinates, relative to the associated TestObject. This method is a shortcut to the double-click method with a modifier parameter and coordinates. (The modifier is set to MOUSE-LEFT).

Specified by:

doubleClick in interface IGraphicalSubitem

Since:

RFT1.0

doubleClick

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

Performs a left-mouse double-click action on the specified coordinates, relative to the associated TestObject.

Specified by:

doubleClick in interface IGraphicalSubitem

Since:

RFT1.0

nClick

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

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

Specified by:

nClick in interface IGraphicalSubitem

Since:

RFT1.0

drag

public void drag(Subitem subitem)

Performs 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.

Specified by:

drag in interface IGraphicalSubitem

Since:

RFT1.0

drag

public void drag(MouseModifiers modifiers,
                 Subitem subitem)

Performs 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.

Specified by:

drag in interface IGraphicalSubitem

Since:

RFT1.0

drag

public void drag(Subitem subitem1,
                 Subitem subitem2)

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

Specified by:

drag in interface IGraphicalSubitem

Since:

RFT1.0

drag

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

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

Specified by:

drag in interface IGraphicalSubitem

Since:

RFT1.0

drag

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

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

Specified by:

drag in interface IGraphicalSubitem

Since:

RFT1.0

drag

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

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

Specified by:

drag in interface IGraphicalSubitem

Since:

RFT1.0

nClickDrag

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

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

Specified by:

nClickDrag in interface IGraphicalSubitem

Since:

RFT1.0

nClickDrag

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

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

Specified by:

nClickDrag in interface IGraphicalSubitem

Since:

RFT1.0

dragToScreenPoint

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

Performs 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.

Specified by:

dragToScreenPoint in interface IGraphicalSubitem

Since:

RFT1.0

dragToScreenPoint

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

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

Specified by:

dragToScreenPoint in interface IGraphicalSubitem

Since:

RFT1.0

dragToScreenPoint

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

Performs 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.

Specified by:

dragToScreenPoint in interface IGraphicalSubitem

Since:

RFT1.0

dragToScreenPoint

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

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

Specified by:

dragToScreenPoint in interface IGraphicalSubitem

Since:

RFT1.0

nClickDragToScreenPoint

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

Performs a mouse n-click drag action on the specified coordinates, relative to the screen-relative screenPt coordinates.

Specified by:

nClickDragToScreenPoint in interface IGraphicalSubitem

Since:

RFT1.0

nClickDragToScreenPoint

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

Performs a mouse n-click drag action on the specified coordinates, relative to the screen-relative screenPt coordinates.

Specified by:

nClickDragToScreenPoint in interface IGraphicalSubitem

Since:

RFT1.0

mouseMove

public void mouseMove(Subitem subitem)

Performs 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.

Specified by:

mouseMove in interface IGraphicalSubitem

Since:

RFT1.0

mouseMove

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

Performs 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.

Specified by:

mouseMove in interface IGraphicalSubitem

Since:

RFT1.0

mouseMove

public void mouseMove(MouseModifiers modifiers,
                      Subitem subitem)

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

Specified by:

mouseMove in interface IGraphicalSubitem

Since:

RFT1.0

mouseMove

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

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

Specified by:

mouseMove in interface IGraphicalSubitem

Since:

RFT1.0

hover

public void hover(double secondDelay,
                  Subitem subitem)

Hovers 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.

Specified by:

hover in interface IGraphicalSubitem

Since:

RFT1.0

hover

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

Hovers 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.

Specified by:

hover in interface IGraphicalSubitem

Since:

RFT1.0

hover

public void hover(Subitem subitem)

Hovers 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.

Specified by:

hover in interface IGraphicalSubitem

Since:

RFT1.0

hover

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

Hovers the mouse over the specified coordinates that are 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.

Specified by:

hover in interface IGraphicalSubitem

Since:

RFT1.0