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

Project Version 2.3

com.rational.test.ft.object.interfaces
Class FrameTestObject

java.lang.Object   extended by com.rational.test.ft.object.interfaces.TestObject
      extended by com.rational.test.ft.object.interfaces.ClientTestObject
          extended by com.rational.test.ft.object.interfaces.GuiTestObject
              extended by com.rational.test.ft.object.interfaces.FrameTestObject
All Implemented Interfaces:
IFrame, IGraphical
Direct Known Subclasses:
InternalFrameTestObject, TopLevelTestObject

public class FrameTestObject
extends GuiTestObject
implements IFrame

Represents frame objects in the system under test. These controls must be acted upon in a consistent and resilient fashion across the various supported platforms.

Since:
RFT 6.1.1.1

Field Summary
 
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject
ref
 
Constructor Summary
FrameTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
FrameTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
FrameTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
FrameTestObject(TestObject obj)
          Construct one FrameTestObject from a TestObject.
FrameTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 void close()
          Closes the associated frame.
 void contextHelp()
          Activates the window's context-sensitive Help mode.
 boolean isIconified()
          This will check whether the frame is iconfied or not
 void maximize()
          Maximizes the associated frame.
 void minimize()
          Iconifies the associated frame..
 void move(java.awt.Point screenPt)
          Moves the frame to the specified location within parent.
 void resize(int width, int height)
          Resizes the frame to the specified width and height.
 void restore()
          Restores the associated frame.
 
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, ensureObjectIsVisible, getChildAtPoint, getClippedScreenRectangle, getImage, getImage, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, getVisibleArea, 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, invoke, invokeProxy, unregister, waitForExistence
 
Methods inherited from class com.rational.test.ft.object.interfaces.TestObject
compare, compare, compareAndLog, compareAndLog, equals, find, findAndInvoke, getActualData, getChildren, getDescribedObject, getDescribedObjects, getDescriptiveName, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMapProperties, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectCustomClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getProperty, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTestDataTypes, getTopMappableParent, getTopParent, hashCode, invoke, invokeProxy, isMappedObject, isSameObject, isScreenTestObject, isTopLevelTestObject, performTest, performTest, performTest, performTest, setIndexer, setIndexer, setMapProperties, setProperty, toString, updateTestData, waitForExistence
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 

Constructor Detail

FrameTestObject

public FrameTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
For internal use.

Since:
RFT 6.1.1.1

FrameTestObject

public FrameTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,                        TestObject anchor)
For internal use.

Since:
RFT 6.1.1.1

FrameTestObject

public FrameTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,                        TestObject anchor,                        long scriptCommandFlags)
For internal use.

Since:
RFT 6.1.1.1

FrameTestObject

public FrameTestObject(com.rational.test.ft.object.TestObjectReference ref)
For internal use.

Since:
RFT 6.1.1.1

FrameTestObject

public FrameTestObject(TestObject obj)
Construct one FrameTestObject from a TestObject. Both are references to the same object.

Since:
RFT 6.1.1.1
Method Detail

close

public void close()
Closes the associated frame.

Specified by:
close in interface IFrame
Detail description:
This will close the associated frame. The means by which the frame is closed depends on the platform. The most resilient means of closing the frame should be used, for example, clicking on the close-window icon/button. If the frame is already closed, this method has no effect.
Example:
This is an example
classicsJava().close();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

maximize

public void maximize()
Maximizes the associated frame.

Specified by:
maximize in interface IFrame
Detail description:
This will Maximizes the frame. The means by which the frame is closed depends on the platform. The most resilient means of closing the frame should be used, for example, clicking on the close-window icon/button. If the frame is already closed, this method has no effect.
Example:
This is an example
classicsJava().maximize();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

minimize

public void minimize()
Iconifies the associated frame..

Specified by:
minimize in interface IFrame
Detail description:
This will Iconifies the associated frame. The means by which the frame is iconified depends on the platform. The most resilient means of iconifying the window should be used. If the frame is already minimized, this method has no effect.
Example:
This is an example
classicsJava().minimize();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

restore

public void restore()
Restores the associated frame.

Specified by:
restore in interface IFrame
Detail description:
This will Restores the associated frame. The means by which the frame is restored depends on the platform. The most resilient means of restoring the frame should be used. How a frame is restored depends on its state. If the frame is iconified, it is returned to its previous state. If the frame is maximized, it is returned to its normal size. If the window is already at the normal size, this method has no effect.
Example:
This is an example
classicsJava().restore();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

isIconified

public boolean isIconified()
This will check whether the frame is iconfied or not

Specified by:
isIconified in interface IFrame
Returns:
boolean - true if the frame is iconified. A frame cannot be iconified return false.
Example:
This is an example
classicsJava().isIconified();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

resize

public void resize(int width,                    int height)
Resizes the frame to the specified width and height.

Specified by:
resize in interface IFrame
Parameters:
width - - The width to set for the frame
height - - The height to set for the frame
Detail description:
This will resize the frame to the specified width and height. The width and height dimensions are in pixel sizes. The most resilient method of resizing the frame is used. This action depends on the current state of the frame and desktop when the action is performed. If the resize target size is larger than the current parent size, the maximum size is the parent size.
Example:
This is an example
classicsJava().resize(500,600);
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

move

public void move(java.awt.Point screenPt)
Moves the frame to the specified location within parent.

Specified by:
move in interface IFrame
Parameters:
screenPt - - The point where you want to move the frame
Detail description:
This will Moves the frame to the specified location within parent. The top-left corner of the frame is moved to the specified location relative to the top-left corner of the parent.
Example:
This is an example
classicsJava().move(new Point(100,100));
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1

contextHelp

public void contextHelp()
Activates the window's context-sensitive Help mode.

Specified by:
contextHelp in interface IFrame
Detail description:
This will Activate the window's context-sensitive Help mode, which is activated through the Help button on the title bar. This mode is indicated by the mouse icon changing to a question mark. Note that this window feature is available on some Internet Explorer dialogs
Example:
This is an example
classicsJava().contextHelp();
Here classicsJava is of type TopLevelTestObject and i have used the ClassicjavaA as Application under test.
Since:
RFT 6.1.1.1