IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester Proxy SDK Reference

Project Version 2.3

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

java.lang.Object   extended by com.rational.test.ft.sys.RegisteredObject       extended by com.rational.test.ft.domain.ProxyTestObject
          extended by com.rational.test.ft.domain.java.JavaProxy
              extended by com.rational.test.ft.domain.java.JavaGuiProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, com.rational.test.ft.object.interfaces.IGraphical
Direct Known Subclasses:
ComboListBoxProxy, ComponentProxy, ControlProxy, MenuComponentProxy, MenuItemProxy, PopupMenuProxy, PseudoTopLevelProxy, TopLevelWindowProxy, WidgetProxy

public abstract class JavaGuiProxy
extends JavaProxy
implements com.rational.test.ft.object.interfaces.IGraphical

This is the Java GUI object proxies base class. All Java GUI proxies must extend this class. The abstract ProxyTestObject base class defines the non-GUI object properties required to implement a proxy object. This abstract class extends that definition with the additional properties needed for a GUI object.

This class further contains the default implementation of various base class methods that proxy implementations may need to extend or override.

Since:
1.0

Field Summary
protected static com.rational.test.ft.script.MouseModifiers LEFT
           
protected  com.rational.test.ft.script.ScriptCommandFlags preDownState
           
protected  JavaGuiProxy processMouseEventHandler
           
protected static java.lang.String ROLEINDEX
           
protected static int ROLEINDEXWEIGHT
           
protected static java.lang.String TESTDATA_SPECIALFRAMESTATE
           
protected static java.lang.String TESTDATA_SPECIALFRAMESTATE_DESCRIPTION
           
protected  com.rational.test.ft.sys.graphical.TopLevelWindow 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, 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
JavaGuiProxy(java.lang.Object theObjectInTheSUT)
          This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.
 
Method Summary
protected  void activateTopWindow()
           
 void click()
          Left mouse click on the center point of the associated TestObject; is a simple shortcut to the click method with a modifier parameter (modifier set to MOUSE_LEFT).
 void click(com.rational.test.ft.script.MouseModifiers modifiers)
          Perform a mouse click action with the specified modifiers at the center of the associated TestObject.
 void click(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt)
          Perform a mouse click action on the specified coordinates relative to the associated TestObject.
 void click(java.awt.Point pt)
          Left mouse click the specified coordinates relative to the associated TestObject.
 void doubleClick()
          Left mouse dbl-click on the center point of the associated TestObject.
 void doubleClick(com.rational.test.ft.script.MouseModifiers modifiers)
          Perform a mouse dbl-click action with the specified modifiers in the center of the associated TestObject.
 void doubleClick(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt)
          Perform a mouse dbl-click action on the specified coordinates relative to the associated TestObject.
 void doubleClick(java.awt.Point pt)
          Left mouse dbl-click on the specified coordinates relative to the associated TestObject.
 void drag()
          Perform a MOUSE_LEFT drag action against the associated TestObject.
 void drag(com.rational.test.ft.script.MouseModifiers modifiers)
          Perform a drag action against the associated TestObject with the supplied set of mouse modifiers.
 void drag(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
          Perform a drag action against the associated TestObject.
 void drag(java.awt.Point pt1, java.awt.Point pt2)
          Perform a MOUSE_LEFT drag action against the associated TestObject.
 void dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
          Perform a drag action against the associated TestObject.
 void dragToScreenPoint(java.awt.Point screenPt)
          Performs a MOUSE_LEFT drag action against the associated TestObject.
 void dragToScreenPoint(java.awt.Point objectPt, java.awt.Point screenPt)
          Perform a MOUSE_LEFT drag action against the associated TestObject.
protected  void dumpAction(java.lang.String header, IMouseActionInfo action)
           
 boolean ensureObjectIsVisible()
           
protected  java.awt.Rectangle getActionRect()
          Gets the screen relative rectangle and throws an invalid action exception if the rectangle is not valid.
 int getCachedRectX(IMouseActionInfo action)
           
 int getCachedRectY(IMouseActionInfo action)
           
 java.lang.Object getChildAtPoint(java.awt.Point pt)
          Finds the child object that is at the specified point.
abstract  java.util.Enumeration getChildrenEnumeration()
          Return an enumeration of mappable proxies for the children of this object.
 java.awt.Rectangle getClippedRect(java.awt.Rectangle childRect)
           
 java.awt.Rectangle getClippedScreenRectangle()
          Returns the clipped-screen rectangle for the associated TestObject
abstract  java.lang.String getDescriptiveName()
          Returns a name that can be used to describe the associated UI object in a script.
abstract  java.util.Enumeration getImmediateChildren()
          Return an enumeration of proxies for the immediate children of this object.
abstract  ProxyTestObject getMappableParent()
          Returns a proxy object for the mappable parent of this object.
 com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)
          Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
abstract  ProxyTestObject getParent()
          Returns a proxy object for the parent of this object.
abstract  java.lang.Object getParentObject()
          Returns an object for the parent of this object.
 JavaGuiProxy getProcessMouseEventHandler()
           
 com.rational.test.ft.sys.graphical.TopLevelWindow getRegisteredTopLevelWindow()
          Get the topLevelWindow for this proxy.
 java.awt.Point getScreenPoint()
          Returns the screen relative point to a valid point within the object.
 java.awt.Point getScreenPoint(java.awt.Point pt)
          Returns the screen relative point given an object relative point.
abstract  java.awt.Rectangle getScreenRectangle()
          Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
 com.rational.test.ft.script.ScriptCommandFlags getScriptCommandFlags()
          This method returns an active state value that reflects the state of the test object at the time of the call.
 java.lang.String getTestObjectClassName()
          The default GUI test object classname is returned.
 com.rational.test.ft.object.interfaces.ITopWindow getTopMappableWindow()
          All Gui Components must be inside a top-level object.
 com.rational.test.ft.object.interfaces.ITopWindow getTopWindow()
          All Gui Components must be inside a top-level object.
abstract  boolean hasFocus()
          Check the component under evaluation to determine if it has keyboard focus.
 void hover()
          Hover the mouse over the center of the associated TestObject.
 void hover(double secondDelay)
          Hover the mouse over the center of the associated TestObject.
 void hover(double secondDelay, java.awt.Point pt)
          Hover the mouse over the specified coordinates of the associated TestObject.
 void hover(java.awt.Point pt)
          Hover the mouse over the specified coordinates of the associated TestObject.
protected  boolean isDrag(IMouseActionInfo action)
          Java-specific test to determine if the action is a drag action.
abstract  boolean isEnabled()
          Check the component under evaluation to determine if it is enabled or disabled.
 boolean isOpaque()
          Check the component under evaluation to determine if it is opaque or transparent.
 boolean isPointInObject(java.awt.Point pt)
          Determines if the specified screen relative point is contained in the component under evaluation.
protected  boolean isPointInObject(java.awt.Point pt, java.awt.Rectangle screenRect)
           
abstract  boolean isShowing()
          Check the component under evaluation to determine if it is showing (as opposed to hidden).
protected  boolean modifiersChanged(IMouseActionInfo action)
           
 void mouseMove(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt)
          Perform a move action against the associated TestObject.
 void mouseMove(java.awt.Point pt)
          Perform a mouse move action.
 void nClick(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt)
          Perform a mouse n-click action on the specified coordinates relative to the associated TestObject.
 void nClickDrag(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
          Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
 void nClickDragToScreenPoint(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
          Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
protected  void processHoverMouseEvent(IMouseActionInfo action)
           
 void processMouseEvent(IMouseActionInfo action)
          Return a MethodSpecification for the specified mouse event.
 void processSingleMouseEvent(IMouseActionInfo action)
           
 void scrollRectToVisible(java.awt.Rectangle rect)
          Scrolls the viewport(if it exists) so that the rectangle within the viewport becomes visible.
 void setProcessMouseEventHandler(JavaGuiProxy proxy)
           
 void setTopLevelWindow(com.rational.test.ft.sys.graphical.TopLevelWindow tlw)
          Set the topLevelWindow for this proxy.
 boolean shouldBeMapped()
          Returns true; by default all test objects are mapped.
 
Methods inherited from class com.rational.test.ft.domain.java.JavaProxy
addMappableChildrenToVector, addRecognitionProperty, allowProperty, childConstructed, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMappableChildren, getMethods, getNonValueProperties, getOwnedObjects, getOwner, getProperties, getProperty, getRecognitionProperties, getRecognitionPropertyWeight, getRole, getStandardProperties, getTestDataTypes, getTestDomain, getTopMappableParent, getTopParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, isRecognitionProperty, 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, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData
 
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
 

Field Detail

LEFT

protected static final com.rational.test.ft.script.MouseModifiers LEFT

preDownState

protected com.rational.test.ft.script.ScriptCommandFlags preDownState

topLevelWindow

protected com.rational.test.ft.sys.graphical.TopLevelWindow topLevelWindow

TESTDATA_SPECIALFRAMESTATE

protected static final java.lang.String TESTDATA_SPECIALFRAMESTATE
See Also:
Constant Field Values

TESTDATA_SPECIALFRAMESTATE_DESCRIPTION

protected static final java.lang.String TESTDATA_SPECIALFRAMESTATE_DESCRIPTION
See Also:
Constant Field Values

processMouseEventHandler

protected JavaGuiProxy processMouseEventHandler

ROLEINDEX

protected static final java.lang.String ROLEINDEX
See Also:
Constant Field Values

ROLEINDEXWEIGHT

protected static final int ROLEINDEXWEIGHT
See Also:
Constant Field Values
Constructor Detail

JavaGuiProxy

public JavaGuiProxy(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()
The default GUI test object classname is returned. More specific test objects are returned by more constrained proxy classes. This level of support is always required.

Specified by:
getTestObjectClassName in interface IProxyBase
Overrides:
getTestObjectClassName in class JavaProxy
Returns:
The default test object class full name.

getDescriptiveName

public abstract 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 become unique to the script, but it acts 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 cause script compilation failures. An example of what to return is "OKButton" for a java.awt.Button with the text "OK" on it.

Overrides:
getDescriptiveName in class JavaProxy
Returns:
A descriptive object name.

shouldBeMapped

public boolean shouldBeMapped()
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 JavaProxy
Returns:
true, unless overriden in a super class.

getParent

public abstract ProxyTestObject getParent()
Returns a proxy object for the parent of this object. Returns null if this object has no parent.

Overrides:
getParent in class JavaProxy
Returns:
The proxy for the parent test object or null for a top-level window.

getParentObject

public abstract 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 JavaProxy
Returns:
The parent test object or null for a top-level window.

getMappableParent

public abstract ProxyTestObject getMappableParent()
Returns a proxy object for the mappable parent of this object. Returns null if this object has no parent.

Overrides:
getMappableParent in class JavaProxy
Returns:
The proxy for the parent test object or null for a top-level window.

getTopWindow

public com.rational.test.ft.object.interfaces.ITopWindow getTopWindow()
All Gui Components must be inside a top-level object. This method returns the TopWindow. Note that if this object is a top-level object, it returns an interface to itself.


getTopMappableWindow

public com.rational.test.ft.object.interfaces.ITopWindow getTopMappableWindow()
All Gui Components must be inside a top-level object. This method returns the TopWindow. Note that if this object is a top-level object, it returns an interface to itself.


getChildrenEnumeration

public abstract java.util.Enumeration getChildrenEnumeration()
Return an enumeration of mappable proxies for the children of this object.

Overrides:
getChildrenEnumeration in class JavaProxy
Returns:
The child proxies relative to this proxy.

getImmediateChildren

public abstract java.util.Enumeration getImmediateChildren()
Return an enumeration of proxies for the immediate children of this object.

Overrides:
getImmediateChildren in class JavaProxy
Returns:
The child proxies relative to this proxy.

setTopLevelWindow

public void setTopLevelWindow(com.rational.test.ft.sys.graphical.TopLevelWindow tlw)
Set the topLevelWindow for this proxy.

Parameters:
the - TopLevelWindow.

getRegisteredTopLevelWindow

public com.rational.test.ft.sys.graphical.TopLevelWindow getRegisteredTopLevelWindow()
Get the topLevelWindow for this proxy.

Returns:
the TopLevelWindow.

setProcessMouseEventHandler

public void setProcessMouseEventHandler(JavaGuiProxy proxy)

getProcessMouseEventHandler

public JavaGuiProxy getProcessMouseEventHandler()

processMouseEvent

public void processMouseEvent(IMouseActionInfo action)
Return a MethodSpecification for the specified mouse event. This is the primary record interface for mouse events against a particular control.

Overrides:
processMouseEvent in class JavaProxy
Parameters:
action - The event cache and other mouse state information for this mouse action.
See Also:
MethodSpecification

processHoverMouseEvent

protected void processHoverMouseEvent(IMouseActionInfo action)

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)

modifiersChanged

protected boolean modifiersChanged(IMouseActionInfo action)

dumpAction

protected void dumpAction(java.lang.String header,                           IMouseActionInfo action)

getCachedRectX

public int getCachedRectX(IMouseActionInfo action)

getCachedRectY

public int getCachedRectY(IMouseActionInfo action)

getMethodSpecForPoint

public com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)
Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default, a method specification for IGraphical.getScreenPoint is returned. However, if a proxy can find

Overrides:
getMethodSpecForPoint in class JavaProxy
Parameters:
x - The screen relative x coordinate.
y - The screen relative y coordinate.
See Also:
MethodSpecification

isShowing

public abstract boolean isShowing()
Check the component under evaluation to determine if it is showing (as opposed to hidden).

Specified by:
isShowing in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
true if component is showing, else false.

isEnabled

public abstract boolean isEnabled()
Check the component under evaluation to determine if it is enabled or disabled.

Specified by:
isEnabled in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
true if component is enabled, else false.

getScriptCommandFlags

public com.rational.test.ft.script.ScriptCommandFlags getScriptCommandFlags()
This method returns an active state value that reflects the state of the test object at the time of the call. The state includes values such as enabled and showing< and allows the find algorithm to wait until a required state is achieved.

Overrides:
getScriptCommandFlags in class ProxyTestObject
Returns:
An object that reflects the active state of the represented test object.

isOpaque

public boolean isOpaque()
Check the component under evaluation to determine if it is opaque or transparent.

Specified by:
isOpaque in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
true if component is opaque, else false.

hasFocus

public abstract boolean hasFocus()
Check the component under evaluation to determine if it has keyboard focus.

Specified by:
hasFocus in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
true if component has keyboard focus, else false.

isPointInObject

public boolean isPointInObject(java.awt.Point pt)
Determines if the specified screen relative point is contained in the component under evaluation. Note that the point is relative to the top left corner of the screen, and not the component itself or its parent.

This functionality is performed by the proxy due to potentially unusual aspects associated with functionality. While typically the getScreenRectangle is used to resolve this query, there are situations for which this is not accurate. For instance if the clickable region on a button is not rectangular, just checking if the point is in the rectangle is not be valid.

Specified by:
isPointInObject in interface com.rational.test.ft.object.interfaces.IGraphical
Parameters:
pt - Screen relative point to check.
Returns:
true if component contains thePoint, else false.
See Also:
getScreenRectangle()

isPointInObject

protected boolean isPointInObject(java.awt.Point pt,                                   java.awt.Rectangle screenRect)

getChildAtPoint

public java.lang.Object getChildAtPoint(java.awt.Point pt)
Finds the child object that is at the specified point. Note that the point is relative to the top left corner of the screen, and not the component itself or its parent.

If this object has no children, it should return null.

Specified by:
getChildAtPoint in interface com.rational.test.ft.object.interfaces.IGraphical
Parameters:
pt - Screen relative point to check.
Returns:
The object at the point or null if no child object is found.
See Also:
getScreenRectangle()

getScreenRectangle

public abstract java.awt.Rectangle getScreenRectangle()
Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen. This commonly consists of two operations: (getLocationOnScreen and getSize) combined into a single operation.

Specified by:
getScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
The adjusted rectangle surrounding component relative to the screen.
See Also:
IGraphical.isPointInObject(java.awt.Point), IGraphical.getClippedScreenRectangle()

getClippedScreenRectangle

public java.awt.Rectangle getClippedScreenRectangle()
Description copied from interface: com.rational.test.ft.object.interfaces.IGraphical
Returns the clipped-screen rectangle for the associated TestObject

Specified by:
getClippedScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
java.awt.Rectangle - The clipped screen rectangle, or null if the object cannot be seen in any window on the screen.
See Also:
IGraphical.getScreenRectangle()

getClippedRect

public java.awt.Rectangle getClippedRect(java.awt.Rectangle childRect)

getScreenPoint

public java.awt.Point getScreenPoint()
Returns the screen relative point to a valid point within the object.

Specified by:
getScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical
Returns:
The Object relative point.
Since:
RFT1.0

getScreenPoint

public java.awt.Point getScreenPoint(java.awt.Point pt)
Returns the screen relative point given an object relative point.

Specified by:
getScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical
Parameters:
pt - The Object relative point.
Returns:
A screen relative point.

getActionRect

protected java.awt.Rectangle getActionRect()
Gets the screen relative rectangle and throws an invalid action exception if the rectangle is not valid.

Returns:
The adjusted rectangle surrounding component relative to the screen.

ensureObjectIsVisible

public boolean ensureObjectIsVisible()

scrollRectToVisible

public void scrollRectToVisible(java.awt.Rectangle rect)
Scrolls the viewport(if it exists) so that the rectangle within the viewport becomes visible. By default, it does nothing.


activateTopWindow

protected void activateTopWindow()

click

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

Specified by:
click in interface com.rational.test.ft.object.interfaces.IGraphical

click

public void click(com.rational.test.ft.script.MouseModifiers modifiers)
Perform a mouse click action with the specified modifiers at the center of the associated TestObject.

Specified by:
click in interface com.rational.test.ft.object.interfaces.IGraphical

click

public void click(java.awt.Point pt)
Left mouse click 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).

Specified by:
click in interface com.rational.test.ft.object.interfaces.IGraphical

click

public void click(com.rational.test.ft.script.MouseModifiers modifiers,                   java.awt.Point pt)
Perform a mouse click action on the specified coordinates relative to the associated TestObject.

Specified by:
click in interface com.rational.test.ft.object.interfaces.IGraphical

doubleClick

public void doubleClick()
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).

Specified by:
doubleClick in interface com.rational.test.ft.object.interfaces.IGraphical

doubleClick

public void doubleClick(com.rational.test.ft.script.MouseModifiers modifiers)
Perform a mouse dbl-click action with the specified modifiers in the center of the associated TestObject.

Specified by:
doubleClick in interface com.rational.test.ft.object.interfaces.IGraphical

doubleClick

public void doubleClick(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).

Specified by:
doubleClick in interface com.rational.test.ft.object.interfaces.IGraphical

doubleClick

public void doubleClick(com.rational.test.ft.script.MouseModifiers modifiers,                         java.awt.Point pt)
Perform a mouse dbl-click action on the specified coordinates relative to the associated TestObject.

Specified by:
doubleClick in interface com.rational.test.ft.object.interfaces.IGraphical

nClick

public void nClick(int clickCount,                    com.rational.test.ft.script.MouseModifiers modifiers,                    java.awt.Point pt)
Perform a mouse n-click action on the specified coordinates relative to the associated TestObject.

Specified by:
nClick in interface com.rational.test.ft.object.interfaces.IGraphical

drag

public void drag()
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.

Specified by:
drag in interface com.rational.test.ft.object.interfaces.IGraphical

drag

public void drag(com.rational.test.ft.script.MouseModifiers modifiers)
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.

Specified by:
drag in interface com.rational.test.ft.object.interfaces.IGraphical

drag

public void drag(java.awt.Point pt1,                  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.

Specified by:
drag in interface com.rational.test.ft.object.interfaces.IGraphical

drag

public void drag(com.rational.test.ft.script.MouseModifiers modifiers,                  java.awt.Point pt1,                  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.

Specified by:
drag in interface com.rational.test.ft.object.interfaces.IGraphical

nClickDrag

public void nClickDrag(int clickCount,                        com.rational.test.ft.script.MouseModifiers modifiers,                        java.awt.Point pt1,                        java.awt.Point pt2)
Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.

Specified by:
nClickDrag in interface com.rational.test.ft.object.interfaces.IGraphical

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point screenPt)
Performs a MOUSE_LEFT drag action against the associated TestObject. The action is performed from a valid point within this TestObject to the screen relative screenPt coordinates.

Specified by:
dragToScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical
Since:
RFT1.0

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point objectPt,                               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 target(x2, y2) coordinates.

Specified by:
dragToScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical

dragToScreenPoint

public void dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers,                               java.awt.Point objectPt,                               java.awt.Point screenPt)
Perform a drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to target(x2, y2) coordinates.

Specified by:
dragToScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,                                     com.rational.test.ft.script.MouseModifiers modifiers,                                     java.awt.Point objectPt,                                     java.awt.Point screenPt)
Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.

Specified by:
nClickDragToScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical

isDrag

protected boolean isDrag(IMouseActionInfo action)
Java-specific test to determine if the action is a drag action. Needed because Java is extremely sensitive to drag actions and does not pay attention to the system drag variables.


mouseMove

public void mouseMove(java.awt.Point pt)
Perform a mouse move action. The action is performed using coordinates relative to this TestObject.

Specified by:
mouseMove in interface com.rational.test.ft.object.interfaces.IGraphical

mouseMove

public void mouseMove(com.rational.test.ft.script.MouseModifiers modifiers,                       java.awt.Point pt)
Perform a move action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates relative to this TestObject.

Specified by:
mouseMove in interface com.rational.test.ft.object.interfaces.IGraphical

hover

public void hover(double secondDelay)
Hover the mouse over the center of the associated TestObject. The mouse is moved to the center of the TestObject and stays there for at least the specified number of seconds

Specified by:
hover in interface com.rational.test.ft.object.interfaces.IGraphical

hover

public void hover(double secondDelay,                   java.awt.Point pt)
Hover the mouse over the specified coordinates of the associated TestObject. The mouse is moved to the object relative coordinates of the TestObject and stays there for at least the specified number of seconds.

Specified by:
hover in interface com.rational.test.ft.object.interfaces.IGraphical

hover

public void hover()
Hover the mouse over the center of the associated TestObject. The mouse is moved to the center of the TestObject and stays there for at least the default amount of time.

Specified by:
hover in interface com.rational.test.ft.object.interfaces.IGraphical

hover

public void hover(java.awt.Point pt)
Hover the mouse over the specified coordinates of the associated TestObject. The mouse is moved to the object relative coordinates of the TestObject and stays there for at least the default amount of time.

Specified by:
hover in interface com.rational.test.ft.object.interfaces.IGraphical