|
IBM Rational Functional Tester Version 8.2.1 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 com.rational.test.ft.object.interfaces.ScreenTestObject
public class ScreenTestObject
Field Summary |
---|
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject |
---|
ignoreTheObjectState, ref |
Constructor Summary | |
---|---|
ScreenTestObject()
|
Method Summary | |
---|---|
boolean |
ensureObjectIsVisible()
Ensures that the object is visible on the screen, provided that the object exists |
java.lang.String |
getObjectClassName()
Returns the complete class name for the object in the software under test. |
java.util.Hashtable |
getProperties()
Returns a Hashtable containing properties. |
java.util.Hashtable |
getRecognitionProperties()
Returns the properties that are useful for recognition. |
java.awt.Rectangle |
getScreenRectangle()
Returns the rectangle for this window relative to the top left corner of the screen. |
java.awt.Rectangle[] |
getScreenRectangleForText(java.lang.String input,
java.awt.Rectangle rectangle)
Returns an array of rectangles of the given text found in the given rectangle. |
ScriptCommandFlags |
getScriptCommandFlags()
Returns an active state value that reflects the state of the TestObejct at the time of the call. |
java.util.Hashtable |
getTestDataTypes()
Returns a Hashtable of data type descriptions of the verification
point data available with the associated object in the software under test. |
java.awt.Rectangle |
getVisibleArea()
|
int |
hashCode()
Returns |
boolean |
isMappedObject()
Returns true if the object contains a mapped reference. |
protected boolean |
isScreenTestObject()
Check to see if this TestObject is indeed the Screen. |
boolean |
performTest(IFtVerificationPoint baseline)
Captures, compares and logs active data available relative to this object instance against the supplied baseline data. |
boolean |
performTest(IFtVerificationPoint baseline,
boolean compareTrueEqualsPass)
Captures, compares and logs active data available relative to this object instance against the supplied baseline data. |
boolean |
performTest(IFtVerificationPoint baseline,
double delayBetweenRetries,
double maximumTestTime)
Captures, compares and logs active data available relative to this object instance against the supplied baseline data. |
boolean |
performTest(IFtVerificationPoint baseline,
double delayBetweenRetries,
double maximumTestTime,
boolean compareTrueEqualsPass)
Captures, compares and logs active data available relative to this object instance against the supplied baseline data. |
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, getChildAtPoint, getClippedScreenRectangle, getImage, getImage, getIWindow, getRole, getScreenPoint, getScreenPoint, getScreenSnapshot, hasFocus, hover, hover, hover, hover, invokeProxyWithGuiDelay, invokeProxyWithGuiDelay, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint |
Methods inherited from class com.rational.test.ft.object.interfaces.ClientTestObject |
---|
exists, find, find, findAndInvoke, findAndInvokeProxy, getProperty, invoke, invokeProxy, unregister, waitForExistence |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ScreenTestObject()
Method Detail |
---|
public java.awt.Rectangle getScreenRectangle()
getScreenRectangle
in interface IGraphical
getScreenRectangle
in class GuiTestObject
GuiTestObject.isPointInObject(java.awt.Point)
public boolean ensureObjectIsVisible()
GuiTestObject
ensureObjectIsVisible
in class GuiTestObject
public java.lang.String getObjectClassName()
TestObject
getObjectClassName
in class TestObject
public ScriptCommandFlags getScriptCommandFlags()
TestObject
TestObejct
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.
getScriptCommandFlags
in class TestObject
TestObject
public boolean isMappedObject()
TestObject
true
if the object contains a mapped reference.
Returns false
for a TestObject
that is returned by
reference from the software under test.
isMappedObject
in class TestObject
public java.util.Hashtable getTestDataTypes()
ClientTestObject
Hashtable
of data type descriptions of the verification
point data available with the associated object in the software under test. The
Hashtable
keys are String
objects that are used as the verification point
type
in the associated test data. The type
is a
simple value that is different from other type values associated
with this object under test. The type
keys map to a verbose
description of the test data. This is reasonable for presentation to a
user.
getTestDataTypes
in class ClientTestObject
Hashtable
of type
/description
pairs
used to describe the verification data available from this
proxy.TestObject.getTestData(String)
,
ITestData
public java.util.Hashtable getProperties()
TestObject
Hashtable
containing properties.
Note that this is an extended Hashtable
and can have null
values. The keys are strings that represent property names; they
are never null
. This method does not return
registered object references to objects in the software under test; it only returns
properties that are value classes.
getProperties
in class TestObject
public java.util.Hashtable getRecognitionProperties()
TestObject
Hashtable
and has null
values. The keys, which are strings that represent property names,
are never null
. This method does not return
references to objects in the software under test; it only returns
properties that are value classes.
getRecognitionProperties
in class TestObject
public java.awt.Rectangle getVisibleArea()
getVisibleArea
in class GuiTestObject
public boolean performTest(IFtVerificationPoint baseline)
performTest
in class TestObject
true
value is returned if the passing result is
logged, otherwise false
is returned.performTest(IFtVerificationPoint,boolean)
,
performTest(IFtVerificationPoint,double,double)
,
performTest(IFtVerificationPoint,double,double,boolean)
public boolean performTest(IFtVerificationPoint baseline, boolean compareTrueEqualsPass)
performTest
in class TestObject
compareTrueEqualsPass
- If true
the expected
and actual data must match to get a passing result. If
false
the expected and actual data must
NOT match to get a passing result.
true
value is returned if the passing result is
logged, false
is returned for a failing result.performTest(IFtVerificationPoint)
,
performTest(IFtVerificationPoint,double,double)
,
performTest(IFtVerificationPoint,double,double,boolean)
public boolean performTest(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime)
performTest
in class TestObject
delayBetweenRetries
- the delay in seconds after a failed result
is recaptured and retested.maximumTestTime
- the maximum time in seconds spent attempting
to receive a passing result. Note that at least
one attempt will be made to return a failed
result, even if this value is a zero or negative
value.
true
value is returned if the passing result is
logged, false
is returned for a failing result.performTest(IFtVerificationPoint)
,
performTest(IFtVerificationPoint,boolean)
,
performTest(IFtVerificationPoint,double,double,boolean)
public boolean performTest(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime, boolean compareTrueEqualsPass)
performTest
in class TestObject
delayBetweenRetries
- the delay in seconds after a failed result
is recaptured and retested.maximumTestTime
- the maximum time in seconds spent attempting
to receive a passing result. Note that at least
one attempt will be made to return a failed
result, even if this value is a zero or negative
value.compareTrueEqualsPass
- If true
the expected
and actual data must match to get a passing result. If
false
the expected and actual data must
NOT match to get a passing result.
true
value is returned if the passing result is
logged, false
is returned for a failing result.performTest(IFtVerificationPoint)
,
performTest(IFtVerificationPoint,boolean)
,
performTest(IFtVerificationPoint,double,double)
public java.awt.Rectangle[] getScreenRectangleForText(java.lang.String input, java.awt.Rectangle rectangle)
public int hashCode()
TestObject
equals
method on the TestObject calls the
remote process to find out if the objects are really
equal. This function doesn't make a remote call but ensures the java rule
which says hashCode should return the same value for those objects if equals return true.
Performance of hash functions on this object will not be good if used
hashCode
in class TestObject
protected boolean isScreenTestObject()
TestObject
TestObject
is indeed the Screen. By default this
returns false
. This is here for compatibility. Please refer to ScreenTestObject
for the actual implementation for a Screen Test Object.
isScreenTestObject
in class TestObject
ScreenTestObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |