com.rational.test.ft.object.interfaces

Interface IGraphicalSubitem

All Known Implementing Classes:

DojoComboboxTestObject, DojoGridTestObject, DojoMenuTestObject, FrameSubitemTestObject, GenericCalenderTestObject, GenericDropdownMenuTestObject, GenericTabStripTestObject, GenericTreeTestObject, GuiSubitemTestObject, PaletteGuiSubitemTestObject, SapGridTestObject, SapPaginatorTestObject, ScrollGuiSubitemTestObject, SelectGuiSubitemTestObject, SelectScrollGuiSubitemTestObject, StatelessGuiSubitemTestObject, TextGuiSubitemTestObject, TextSelectGuiSubitemTestObject, TopLevelSubitemTestObject, TrackbarTestObject

public interface IGraphicalSubitem

Defines methods that enable access to actions replayed by the mouse or keyboard.

Since:

RFT1.0

Method Summary

Methods

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 coordinates within the associated TestObject.
void	doubleClick(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Performs a left-mouse double-click 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 on 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 on the associated TestObject.
void	drag(MouseModifiers modifiers, Subitem subitem1, Subitem subitem2) Performs a drag action on the associated TestObject.
void	drag(Subitem subitem) Performs a MOUSE_LEFT drag action on the associated TestObject.
void	drag(Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2) Performs a MOUSE_LEFT drag action on the associated TestObject.
void	drag(Subitem subitem1, Subitem subitem2) Performs a MOUSE_LEFT drag action on the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point screenPt) Performs a drag action on the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Perform a drag action on the associated TestObject.
void	dragToScreenPoint(Subitem subitem, java.awt.Point screenPt) Performs a MOUSE_LEFT drag action on the associated TestObject.
void	dragToScreenPoint(Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Performs a MOUSE_LEFT drag action on 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 that contains the component under evaluation 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 specified subitem.
void	hover(Subitem subitem, java.awt.Point pt) Hovers the mouse over the specified coordinates, 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 on the associated TestObject.
void	mouseMove(Subitem subitem, java.awt.Point subitemPt) Performs a MOUSE_LEFT move action on the associated TestObject.
void	nClick(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point pt) Performs a mouse n-click 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.

Method Detail

getScreenRectangle

java.awt.Rectangle getScreenRectangle(Subitem subitem)

Returns the rectangle that contains the component under evaluation relative to the top left corner of the screen. This commonly consists of these two operations combined into one operation: (1)getScreenRectangle for the parent object, and (2) adjusting for the specified subitem. The rectangle is exposed so that actions can be directly scripted against a visible subitem. null is returned if the subitem is not showing.

Since:

RFT1.0

getScreenPoint

java.awt.Point getScreenPoint(Subitem subitem)

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

Parameters:

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

Since:

RFT1.0

getScreenPoint

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 that the resultant screen point is relative to

pt - The subitem-relative point

Since:

RFT1.0

getSubitem

java.lang.Object getSubitem(Subitem subitem)

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

If the resulting type is not a value class, a TestObject for the object is supplied. For example, 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)) commonly returns only the text for the item in the fifth position (as a string).

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

Parameters:

subitem - the subitem to fetch an object for

Returns:

An object representation of the subitem

click

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

Since:

RFT1.0

click

void click(MouseModifiers modifiers,
         Subitem subitem)

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

Since:

RFT1.0

click

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 (modifier set to MOUSE_LEFT).

Since:

RFT1.0

click

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

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

Since:

RFT1.0

doubleClick

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

Since:

RFT1.0

doubleClick

void doubleClick(MouseModifiers modifiers,
               Subitem subitem)

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

doubleClick

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

Since:

RFT1.0

doubleClick

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

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

Since:

RFT1.0

nClick

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

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

Since:

RFT1.0

drag

void drag(Subitem subitem)

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

Since:

RFT1.0

drag

void drag(MouseModifiers modifiers,
        Subitem subitem)

Performs a drag action on 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.

Since:

RFT1.0

drag

void drag(Subitem subitem1,
        Subitem subitem2)

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

Since:

RFT1.0

drag

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

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

Since:

RFT1.0

drag

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

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

Since:

RFT1.0

drag

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

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

Since:

RFT1.0

nClickDrag

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.

Since:

RFT1.0

nClickDrag

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.

Since:

RFT1.0

dragToScreenPoint

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

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

Since:

RFT1.0

dragToScreenPoint

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

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

Since:

RFT1.0

dragToScreenPoint

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

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

Since:

RFT1.0

dragToScreenPoint

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

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

Since:

RFT1.0

nClickDragToScreenPoint

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.

Since:

RFT1.0

nClickDragToScreenPoint

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.

Since:

RFT1.0

mouseMove

void mouseMove(Subitem subitem)

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

Since:

RFT1.0

mouseMove

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

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

Since:

RFT1.0

mouseMove

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.

Since:

RFT1.0

mouseMove

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.

Since:

RFT1.0

hover

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.

Since:

RFT1.0

hover

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.

Since:

RFT1.0

hover

void hover(Subitem subitem)

Hovers the mouse over the specified subitem. The mouse is moved to the subitem and stays there for a default length of time.

Since:

RFT1.0

hover

void hover(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 a default length of time.

Since:

RFT1.0