|
IBM Rational Functional Tester Version 8.1.1000 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.rational.test.ft.object.interfaces.TestObject com.rational.test.ft.object.interfaces.ClientTestObject com.rational.test.ft.object.interfaces.GuiTestObject
public class GuiTestObject
The core class for modeling GUI components. All GUI objects
must extend this class.
Serves as the base TestObject
implementation of the IGraphical
interface.
Field Summary |
---|
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject |
---|
ref |
Constructor Summary | |
---|---|
GuiTestObject()
|
|
GuiTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
For internal use. |
|
GuiTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
For internal use. |
|
GuiTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
For internal use. |
|
GuiTestObject(TestObject obj)
Constructs one GuiTestObject from another TestObject . |
|
GuiTestObject(com.rational.test.ft.object.TestObjectReference ref)
For internal use. |
Method Summary | |
---|---|
boolean |
canTakeVP()
|
void |
click()
Performs a left-mouse click on the center point of the associated TestObject . |
void |
click(MouseModifiers modifiers)
Performs a left-mouse click on the specified object, relative to the coordinates within the associated TestObject . |
void |
click(MouseModifiers modifiers, java.awt.Point pt)
Performs a left-mouse click on the specified coordinates, relative to the associated TestObject . |
void |
click(java.awt.Point pt)
Performs a left-mouse click on the specified coordinates, relative to the associated TestObject . |
void |
clickRadio(Subitem childProperties)
Locate a radiobutton
child with the supplied properties and click on it. |
void |
doubleClick()
Performs a left-mouse double-click on the center point of the associated TestOject . |
void |
doubleClick(MouseModifiers modifiers)
Performs a left-mouse double-click at the specified object, relative to the coordinates within the associated TestObject . |
void |
doubleClick(MouseModifiers modifiers, java.awt.Point pt)
Performs a mouse double-click on the specified coordinates, relative to the associated TestObject . |
void |
doubleClick(java.awt.Point pt)
Performs a left-mouse double-click on the specified coordinates, relative to the associated TestObject . |
void |
drag()
Performs a MOUSE_LEFT drag action on the associated TestObject . |
void |
drag(MouseModifiers modifiers)
Performs a drag action on the associated TestObject with the supplied set of mouse modifiers. |
void |
drag(MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
Performs a drag action on the associated TestObject . |
void |
drag(java.awt.Point pt1, java.awt.Point pt2)
Performs a MOUSE_LEFT drag action on the associated TestObject . |
void |
dragToScreenPoint(MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
Performs a drag action against the associated TestObject . |
void |
dragToScreenPoint(java.awt.Point screenPt)
Performs a MOUSE_LEFT drag action on the associated TestObject . |
void |
dragToScreenPoint(java.awt.Point objectPt, java.awt.Point screenPt)
Performs a MOUSE_LEFT drag action against the associated TestObject . |
boolean |
ensureObjectIsVisible()
Ensures that the object is visible on the screen, provided that the object exists |
java.lang.Object |
getChildAtPoint(java.awt.Point pt)
Finds the child object that is at the specified point. |
java.awt.Rectangle |
getClippedScreenRectangle()
Returns the clipped-screen rectangle for the associated TestObject |
java.awt.image.BufferedImage |
getImage(java.awt.Rectangle rect, java.lang.String fname)
Returns the image contained with in the rectangle as specified by rect as java.awt.image.BufferedImage Also, writes the image into a file named by the argument |
java.awt.image.BufferedImage |
getImage(java.lang.String fname)
Returns the image of the GUI object as java.awt.image.BufferedImage Also, writes the image into a file named by the argument |
java.awt.Point |
getScreenPoint()
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. |
java.awt.Rectangle |
getScreenRectangle()
Returns the rectangle that contains the component being evaluated, relative to the top-left corner of the screen. |
java.awt.image.BufferedImage |
getScreenSnapshot()
Takes a snapshot (screen capture) of the visible GuiTestObject |
java.awt.Rectangle |
getVisibleArea()
|
boolean |
hasFocus()
Determines whether a component has keyboard focus. |
void |
hover()
Hovers the mouse over the center of the associated TestObject . |
void |
hover(double secondDelay)
Hovers the mouse over the center of the associated TestObject . |
void |
hover(double secondDelay, java.awt.Point pt)
Hovers the mouse over the specified coordinates of the associated TestObject . |
void |
hover(java.awt.Point pt)
Hovers the mouse over the specified coordinates of the associated TestObject . |
protected java.lang.Object |
invokeProxyWithGuiDelay(java.lang.String method)
Invokes a method on the proxy for an object in the software under test. |
protected java.lang.Object |
invokeProxyWithGuiDelay(java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args)
Invokes a method on the proxy for an object in the software under test. |
boolean |
isEnabled()
Determines whether a component is enabled. |
boolean |
isOpaque()
Determines whether a component is opaque. |
boolean |
isPointInObject(java.awt.Point pt)
Determines whether the specified screen-relative point is contained in the component under evaluation. |
boolean |
isShowing()
Determines whether a component is showing. |
void |
mouseMove(MouseModifiers modifiers, java.awt.Point pt)
Performs a move action against the associated TestObject . |
void |
mouseMove(java.awt.Point pt)
Performs a MOUSE_LEFT move action on the associated TestObject . |
void |
nClick(int clickCount, MouseModifiers modifiers, 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, java.awt.Point pt1, java.awt.Point pt2)
Performs a mouse n-click drag action on the specified coordinates, relative to the associated TestObject . |
void |
nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
Performs a mouse n-click drag action on the specified coordinates, relative to the associated TestObject . |
Methods inherited from class com.rational.test.ft.object.interfaces.ClientTestObject |
---|
exists, find, find, findAndInvoke, findAndInvokeProxy, invoke, invokeProxy, unregister, waitForExistence |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public GuiTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
public GuiTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
public GuiTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
public GuiTestObject(com.rational.test.ft.object.TestObjectReference ref)
public GuiTestObject(TestObject obj)
GuiTestObject
from another TestObject
.
Both are references to the same object.
public GuiTestObject()
Method Detail |
---|
public boolean isShowing()
isShowing
in interface IGraphical
true
if the component is showing; false
otherwise.placeOrder().isShowing();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public boolean isEnabled()
isEnabled
in interface IGraphical
true
if the component is enabled; false
otherwise.placeOrder().isEnabled();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public boolean isOpaque()
isOpaque
in interface IGraphical
true
if the component is opaque; false
otherwise.placeOrder().isOpaque();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public java.lang.Object getChildAtPoint(java.awt.Point pt)
getChildAtPoint
in interface IGraphical
pt
- the x,y coordinates of the specified point null
if no child object is found.classicsJava().getChildAtPoint(new Point(400,325));
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.getScreenRectangle()
public boolean hasFocus()
hasFocus
in interface IGraphical
true
if component has keyboard focus; false
otherwise.placeOrder().hasFocus();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public boolean isPointInObject(java.awt.Point pt)
This functionality is performed by the proxy because of the potentially
unusual aspects associated with this functionality. Although
getScreenRectangle
is typically used to resolve this query, there are situations for which this
is not accurate. For example, if the clickable region on a
button is not rectangular, checking only whether the point is in
the rectangle would yield an invalid result.
isPointInObject
in interface IGraphical
pt
- the x,y coordinates of the specified point true
if the component contains the point; false
otherwise.placeOrder().isPointInObject(new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.getScreenRectangle()
public java.awt.image.BufferedImage getImage(java.lang.String fname)
null
placeOrder().getImage("Test.png");
Here placeOrder is of type GuiTestObject from the ClassicjavaA as Application under test.public java.awt.image.BufferedImage getImage(java.awt.Rectangle rect, java.lang.String fname)
null
placeOrder().getImage(new Rectangle(0,0,10,10),"Test.png");
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public java.awt.Rectangle getVisibleArea()
public java.awt.Rectangle getScreenRectangle()
getLocationOnScreen
getSize
getScreenRectangle
in interface IGraphical
null
if the GUI object does not appear.placeOrder().getScreenRectangle();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.isPointInObject(java.awt.Point)
public java.awt.Rectangle getClippedScreenRectangle()
TestObject
getClippedScreenRectangle
in interface IGraphical
null
if the object cannot be seen
in any window on the screen.TestObject
, relative to the top-left corner of the screen. While getScreenRectangle()
returns the true rectangle of the TestObject
, this method clips the true screen rectangle to the bounds
of any clipping parent TestObject
. Clipping parents, such as scroll panes or a browser window, may hide part or all of the true screen rectangle. Only the screen-level
viewable rectangle is returned, or null
if the object is not showing, or is completely clipped by a clipping parent.placeOrder().getClippedScreenRectangle();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.getScreenRectangle()
public java.awt.Point getScreenPoint()
getScreenPoint
in interface IGraphical
null
if the object cannot be seen
in any window on the screen.classicsJava().getScreenPoint();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.public java.awt.Point getScreenPoint(java.awt.Point pt)
getScreenPoint
in interface IGraphical
pt
- the x,y coordinates of the object-relative point classicsJava().getScreenPoint(new Point(25,25));
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.protected java.lang.Object invokeProxyWithGuiDelay(java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args)
delayBeforeGuiAction
.
Note that invokeProxyWithGuiDelay
can directly modify the object in the software under test. Whenever possible, avoid using this method, because it enables you to modify the software under test in ways that a typical user cannot. If you use it,
be sure to discuss its use with the developers of the software that you are testing.
If the returned object is not a value class, invoke
registers the object and returns a reference to the object in the software under test.
Registered object references are released by calling one of the unregister methods.
method
- the name of the method to be calledmethodSignature
- the signature of the method to be called (using standard JNI syntax)args
- the arguments to be passed to the method ClientTestObject.unregister()
,
RationalTestScript.unregisterAll()
,
RationalTestScript.unregister(Object[])
,
RationalTestScript.getRegisteredTestObjects()
protected java.lang.Object invokeProxyWithGuiDelay(java.lang.String method)
delayBeforeGuiAction
.
Note that invokeProxyWithGuiDelay
can directly modify the object in the software under test. Whenever possible, avoid using this method, because it enables you to modify the software under test in ways that a typical user cannot. If you use it,
be sure to discuss its use with the developers of the software that you are testing.
If the returned object is not a value class, invoke
registers the object and returns a reference to the object in the software under test.
Registered object references are released by calling one of the unregister methods.
method
- the name of the method to be called ClientTestObject.unregister()
,
RationalTestScript.unregisterAll()
,
RationalTestScript.unregister(Object[])
,
RationalTestScript.getRegisteredTestObjects()
public boolean ensureObjectIsVisible()
placeOrder().ensureObjectIsVisible();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void click()
TestObject
.
This method is a shortcut to the click method with a modifier parameter. (The modifier is set to MOUSE_LEFT
.)
click
in interface IGraphical
placeOrder().click();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void click(MouseModifiers modifiers)
TestObject
.
click
in interface IGraphical
placeOrder().lick(new MouseModifiers(MOUSE_LEFT));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void click(java.awt.Point pt)
TestObject
. This method is a shortcut to the
click method with a modifier parameter and coordinates. (The modifier
is set to MOUSE_LEFT
.)
click
in interface IGraphical
pt
- the x,y coordinates where the left-mouse click is performedplaceOrder().click(new MouseModifiers(MOUSE_LEFT));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void click(MouseModifiers modifiers, java.awt.Point pt)
TestObject
.
click
in interface IGraphical
modifiers
- pt
- the x,y coordinates where the left-mouse click is performedplaceOrder().click(new MouseModifiers(MOUSE_LEFT),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void doubleClick()
TestOject
.
This method is a shortcut to the double-click method with a modifier parameter. (The modifier is set to MOUSE_LEFT
.)
doubleClick
in interface IGraphical
placeOrder().doubleClick();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void doubleClick(MouseModifiers modifiers)
TestObject
.
doubleClick
in interface IGraphical
placeOrder().doubleClick(new MouseModifiers(MOUSE_LEFT));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void doubleClick(java.awt.Point pt)
TestObject
. This method is a shortcut to the
double-click method with a modifier parameter and coordinates. (The modifier
is set to MOUSE_LEFT
.)
doubleClick
in interface IGraphical
pt
- the x,y coordinates where the left-mouse double-click is performedplaceOrder().doubleClick(new Point(25,25);
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void doubleClick(MouseModifiers modifiers, java.awt.Point pt)
TestObject
.
doubleClick
in interface IGraphical
placeOrder().doubleClick(new MouseModifiers(MOUSE_LEFT),new Point(25,25);
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void nClick(int clickCount, MouseModifiers modifiers, java.awt.Point pt)
TestObject
.
nClick
in interface IGraphical
placeOrder().nClick(1,new MouseModifiers(MOUSE_LEFT),new Point(25,25);
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void drag()
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.
drag
in interface IGraphical
placeOrder().drag();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void drag(MouseModifiers modifiers)
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.
drag
in interface IGraphical
placeOrder().drag(new MouseModifiers(MOUSE_LEFT));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void drag(java.awt.Point pt1, java.awt.Point pt2)
MOUSE_LEFT
drag action on the associated TestObject
.
The action is performed from (x1, y1) to (x2, y2) coordinates,
relative to this TestObject
.
drag
in interface IGraphical
pt1
- the point where the drag action beginspt2
- the point where the drag action endsplaceOrder().drag(new Point(400,325),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void drag(MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
TestObject
.
The action is performed from (x1, y1) to (x2, y2) coordinates,
relative to this TestObject
.
example placeOrder().drag(new MouseModifiers(MOUSE_LEFT),new Point(400,325),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.
drag
in interface IGraphical
public void nClickDrag(int clickCount, MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
TestObject
.
nClickDrag
in interface IGraphical
placeOrder().nClickDrag( 2,new MouseModifiers(MOUSE_LEFT),new Point(400,325),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void dragToScreenPoint(java.awt.Point screenPt)
MOUSE_LEFT
drag action on the associated TestObject
.
The action is performed from a valid point within this TestObject
to
the screen-relative screenPt
coordinates.
dragToScreenPoint
in interface IGraphical
placeOrder().dragToScreenPoint(new Point(400,325));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void dragToScreenPoint(java.awt.Point objectPt, java.awt.Point screenPt)
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.
dragToScreenPoint
in interface IGraphical
placeOrder().dragToScreenPoint(new Point(400,325),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void dragToScreenPoint(MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
TestObject
.
The action is performed from (x, y), relative to this TestObject
, to
the screen-relative screenPt
coordinates.
dragToScreenPoint
in interface IGraphical
placeOrder().dragToScreenPoint(new MouseModifiers(MOUSE_LEFT),new Point(400,325),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
TestObject
.
nClickDragToScreenPoint
in interface IGraphical
placeOrder().nClickDragToScreenPoint(2,new MouseModifiers(MOUSE_LEFT),new Point(400,325),new Point(25,25));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void mouseMove(java.awt.Point pt)
MOUSE_LEFT
move action on the associated TestObject
.
The action is performed from (x1, y1) to (x2, y2) coordinates,
relative to this TestObject
.
mouseMove
in interface IGraphical
placeOrder().mouseMove(new Point(400,325));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void mouseMove(MouseModifiers modifiers, java.awt.Point pt)
TestObject
.
The action is performed from (x1, y1) to (x2, y2) coordinates,
relative to this TestObject
.
mouseMove
in interface IGraphical
placeOrder().mouseMove(new MouseModifiers(MOUSE_LEFT),new Point(400,325));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void hover(double secondDelay)
TestObject
.
The mouse is moved to the center of the TestObject
and stays there for at least the specified number of seconds.
You can record a hover action by moving the mouse over an object and hitting the shift key.
hover
in interface IGraphical
placeOrder().hover(10);
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void hover(double secondDelay, java.awt.Point pt)
TestObject
. The mouse is moved to the object-relative coordinates of the TestObject
and stays there for at least the specified number
of seconds.
You can record a hover action by moving the mouse over an object and hitting the shift key.
hover
in interface IGraphical
placeOrder().hover(10,new Point(400,325));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void hover()
TestObject
.
The mouse is moved to the center of the TestObject
and stays
there for the default length of time.
You can record a hover action by moving the mouse over an object and hitting the shift key.
hover
in interface IGraphical
placeOrder().hover();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void hover(java.awt.Point pt)
TestObject
. The mouse is moved to the object-relative coordinates of the TestObject
and stays there for the default length of time.
You can record a hover action by moving the mouse over an object and hitting the shift key.
hover
in interface IGraphical
placeOrder().hover(new Point(400,325);
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public void clickRadio(Subitem childProperties)
radiobutton
child with the supplied properties and click on it.
newCustomer().clickRadio(atPoint(1,2));
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public java.awt.image.BufferedImage getScreenSnapshot()
placeOrder().getScreenSnapshot();
Here placeOrder is of type GuiTestObject and i have used the ClassicjavaA as Application under test.public boolean canTakeVP()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |