IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.object.interfaces.WPF
Interface IWpfGraphical

All Superinterfaces:
IGraphical
All Known Implementing Classes:
WpfFrameSubitemTestObject, WpfFrameTestObject, WpfGuiSubitemTestObject, WpfGuiTestObject, WpfSelectGuiSubitemTestObject, WpfStatelessGuiSubitemTestObject, WpfTextGuiSubitemTestObject, WpfTextSelectGuiSubitemTestObject, WpfToggleGUITestObject, WpfToggleTestObject, WpfTopLevelSubitemTestObject, WpfTopLevelTestObject, WpfTrackbarTestObject

public interface IWpfGraphical
extends IGraphical


Method Summary
 void click(DPoint pt)
          Clicks at a given DPoint
 void click(MouseModifiers modifiers, DPoint pt)
          Performs a click on the specified coordinates, relative to the associated TestObject.
 void doubleClick(DPoint pt)
          Performs a left-mouse double-click on the specified DPoint
 void doubleClick(MouseModifiers modifiers, DPoint pt)
          Performs a double-click on the specified coordinates, relative to the associated TestObject
 void drag(DPoint pt1, DPoint pt2)
          Performs a (left button) mouse drag action against the associated TestObject.
 void drag(MouseModifiers modifiers, DPoint pt1, DPoint pt2)
          Performs a mouse drag action against the associated TestObject
 void dragToScreenPoint(DPoint screenPt)
          Performs a drag to the specified DPoint on the screen
 void dragToScreenPoint(DPoint objectPt, DPoint screenPt)
          Performs a drag from an object point to a screen point
 void dragToScreenPoint(MouseModifiers modifiers, DPoint objectPt, DPoint screenPt)
          Performs a drag from an object point to a screen point
 java.lang.Object getChildAtPoint(DPoint pt)
          Finds the child object that is at the specified DPoint.
 java.awt.Point getScreenPoint(DPoint pt)
          Returns the screen-relative Point, given an object relative DPoint.
 void hover(double secondDelay, DPoint pt)
          Hovers the mouse over the specified coordinates of the associated TestObject
 void hover(DPoint pt)
          Hovers the mouse over the specified coordinates of the associated TestObject
 boolean isPointInObject(DPoint pt)
          Determines whether the specified screen-relative DPoint is contained in the component under evaluation.
 void mouseMove(DPoint pt)
          Performs a MOUSE_LEFT move action against the associated TestObject
 void mouseMove(MouseModifiers modifiers, DPoint pt)
          Performs a MOUSE_LEFT move action against the associated TestObject
 void nClick(int clickCount, MouseModifiers modifiers, DPoint pt)
          Performs a mouse n-click action on the specified coordinates, relative to the associated TestObject.
 void nClickDrag(int clickCount, MouseModifiers modifiers, DPoint pt1, DPoint pt2)
          Performs a mouse n-click drag action from and to the specified coordinates, relative to the associated TestObject
 void nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, DPoint objectPt, DPoint screenPt)
          Performs a n-click drag from an object point to a screen point
 
Methods inherited from interface com.rational.test.ft.object.interfaces.IGraphical
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getChildAtPoint, getClippedScreenRectangle, getScreenPoint, getScreenPoint, getScreenRectangle, hasFocus, hover, hover, hover, hover, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint
 

Method Detail

isPointInObject

boolean isPointInObject(DPoint pt)
Determines whether the specified screen-relative DPoint is contained in the component under evaluation.

Parameters:
pt - - the screen relative DPoint which needs to checked
Returns:
boolean - true if the Dpoint is within the Object else false
Detail description:
The DPoint is relative to the top-left corner of the screen and not to the component itself, or its parent. This functionality is performed by the proxy. While typically the IGraphical.getScreenRectangle() method is used to resolve this query, this is not accurate in certain situations. For example, if the clickable region on a button is not rectangular, just checking whether the point is in the rectangle would not yield a valid result.
Since:
RFT8.0

getChildAtPoint

java.lang.Object getChildAtPoint(DPoint pt)
Finds the child object that is at the specified DPoint.

Parameters:
pt - - the DPoint where the child object is required
Returns:
java.lang.Object - The object at the point, or null if no child object is found.
Detail description:
The DPoint is relative to the top-left corner of the screen and not to the component itself, or its parent.
Since:
RFT8.0
See Also:
getScreenRectangle()}, com.rational.test.ft.value.DPoint}

getScreenPoint

java.awt.Point getScreenPoint(DPoint pt)
Returns the screen-relative Point, given an object relative DPoint.

Parameters:
pt - - The object-relative DPoint
Returns:
java.awt.Point - The screen relative DPoint
Detail description:
The input parameter is with respect to the object. This will convert it into a point with respect to the screen.

Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

click

void click(DPoint pt)
Clicks at a given DPoint

Parameters:
pt - - The DPoint where a click needs to be done.
Detail description:
This will do a left-mouse click at the specified Dpoint, relative to the TestObject. This method is a shortcut to the Click method with a modifier parameter and coordinates.(The modifieris set to MOUSE_LEFT)
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

click

void click(MouseModifiers modifiers,
           DPoint pt)
Performs a click on the specified coordinates, relative to the associated TestObject.

Parameters:
pt: - The DPoint where a click needs to be done
modifiers: - MouseModifiers object.
Detail description:
The type of click can be governed by appropriately setting the MouseModifiers
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}

doubleClick

void doubleClick(DPoint pt)
Performs a left-mouse double-click on the specified DPoint

Parameters:
pt: - The DPoint where a click needs to be done
Detail description:
This locates the Dpoint which is relative to the associated TestObject and performs a left - mouse double click at that location.

Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

doubleClick

void doubleClick(MouseModifiers modifiers,
                 DPoint pt)
Performs a double-click on the specified coordinates, relative to the associated TestObject

Parameters:
pt: - The DPoint where a double click needs to be done,
modifiers: - MouseModifiers object.
Detail description:
Performs a double click at the point. The type of mouse click can be govered using the MouseModifiers.
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}

nClick

void nClick(int clickCount,
            MouseModifiers modifiers,
            DPoint pt)
Performs a mouse n-click action on the specified coordinates, relative to the associated TestObject.

Parameters:
clickCount - - Number of clicks to be performed.
modifiers - - MouseModifiers object to set the type of click.
pt - - The DPoint where a click needs to be done.
Detail description:
Performs a n-click at the given DPoint. The type of mouse click can be governed using the MouseModifiers
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}

drag

void drag(DPoint pt1,
          DPoint pt2)
Performs a (left button) mouse drag action against the associated TestObject.

Parameters:
pt1 - - The initial DPoint
pt2 - - The final DPoint
Detail description:
The drag action is performed from one DPoint to the other DPoint.
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

drag

void drag(MouseModifiers modifiers,
          DPoint pt1,
          DPoint pt2)
Performs a mouse drag action against the associated TestObject

Parameters:
modifiers - - MouseModifiers object to set the type of drag
pt1 - - The initial DPoint
pt2 - - The final DPoint
Detail description:
The drag action is performed from one DPoint to the other DPoint. The drag specifications can be modified in the MouseModifiers
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}

nClickDrag

void nClickDrag(int clickCount,
                MouseModifiers modifiers,
                DPoint pt1,
                DPoint pt2)
Performs a mouse n-click drag action from and to the specified coordinates, relative to the associated TestObject

Parameters:
clickCount - - number of clicks to be done
modifiers - - MouseModifiers object to set the type of drag
pt1 - - The initial DPoint
pt2 - - The final DPoint
Detail description:
The drag action is performed from one DPoint to the other DPoint.The drag specifications can be modified in the MouseModifiers
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}

dragToScreenPoint

void dragToScreenPoint(DPoint screenPt)
Performs a drag to the specified DPoint on the screen

Parameters:
screenPt - - The screen relative final DPoint
Detail description:
Performs a MOUSE_LEFT drag action on the associated TestObject. The action is performed from a valid point within this TestObject to the screen-relative DPoint.
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

dragToScreenPoint

void dragToScreenPoint(DPoint objectPt,
                       DPoint screenPt)
Performs a drag from an object point to a screen point

Parameters:
objectPt - - The initial DPoint on the Object, relative to the object
screenPt - - The final DPoint relative to the screen.
Detail description:
Performs a MOUSE_LEFT drag action against the associated TestObject. The action is performed from a DPoint relative to this TestObject, to a DPoint relative to the screen
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

dragToScreenPoint

void dragToScreenPoint(MouseModifiers modifiers,
                       DPoint objectPt,
                       DPoint screenPt)
Performs a drag from an object point to a screen point

Parameters:
modifiers - - MouseModifiers object to set the type of drag
objectPt - - The initial DPoint on the Object, relative to the object
screenPt - - The final DPoint relative to the screen.
Detail description:
Performs a drag action against the associated TestObject. The action is performed from a DPoint relative to this TestObject, to a DPoint relative to the screen
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}, com.rational.test.ft.object.interfaces.GuiTestObject#dragToScreenPoint(MouseModifiers, java.awt.Point, java.awt.Point)

nClickDragToScreenPoint

void nClickDragToScreenPoint(int clickCount,
                             MouseModifiers modifiers,
                             DPoint objectPt,
                             DPoint screenPt)
Performs a n-click drag from an object point to a screen point

Parameters:
clickCount - - Number of clicks to be performed.
modifiers - - MouseModifiers object to set the type of drag
objectPt - - The initial DPoint on the Object, relative to the object
screenPt - - The final DPoint relative to the screen.
Detail description:
Performs a n- click drag action against the associated TestObject. The action is performed from a DPoint relative to this TestObject, to a DPoint relative to the screen
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}, com.rational.test.ft.object.interfaces.WPF.WpfGuiTestObject#dragToScreenPoint(MouseModifiers, DPoint, DPoint)

mouseMove

void mouseMove(DPoint pt)
Performs a MOUSE_LEFT move action against the associated TestObject

Detail description:
The action is performed from current mouse coordinates to the specified DPoint relative to this TestObject
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

mouseMove

void mouseMove(MouseModifiers modifiers,
               DPoint pt)
Performs a MOUSE_LEFT move action against the associated TestObject

Parameters:
modifiers - - MouseModifiers object
pt - - The final DPoint relative to the TestObject
Detail description:
The action is performed from current mouse coordinates to the specified DPoint relative to this TestObject
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}, com.rational.test.ft.script.MouseModifiers}

hover

void hover(DPoint pt)
Hovers the mouse over the specified coordinates of the associated TestObject

Parameters:
pt - - The Dpoint relative to the object
Detail description:
The mouse is moved to the object, relative to the coordinates of the TestObject. It stays there for the default length of time.
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}

hover

void hover(double secondDelay,
           DPoint pt)
Hovers the mouse over the specified coordinates of the associated TestObject

Parameters:
secondDelay - - int - The time period for Hover in seconds.
pt - - The Dpoint where Hover needs to done, relative to the object.
Detail description:
The mouse is moved to the DPoint, relative to TestObject. It stays there for at least the specified number of seconds.
Since:
RFT8.0
See Also:
com.rational.test.ft.value.DPoint}