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 FrameSubitemTestObject

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.StatelessGuiSubitemTestObject
                  extended by com.rational.test.ft.object.interfaces.GuiSubitemTestObject
                      extended by com.rational.test.ft.object.interfaces.FrameSubitemTestObject
All Implemented Interfaces:
IFrame, IGraphical, IGraphicalSubitem, ISubitem
Direct Known Subclasses:
TopLevelSubitemTestObject

public class FrameSubitemTestObject
extends GuiSubitemTestObject
implements IFrame

Provides subitem methods for frame controls.

Since:
RFT2.0

Field Summary
 
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject
ref
 
Constructor Summary
FrameSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
FrameSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
FrameSubitemTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
FrameSubitemTestObject(TestObject obj)
          Construct one FrameTestObject from another TestObject.
FrameSubitemTestObject(com.rational.test.ft.object.TestObjectReference reference)
          For internal use.
 
Method Summary
 void close()
          Closes the associated frame.
 void contextHelp()
          Activate the context-sensitive Help
 boolean isIconified()
          Provides access to the iconified state of the frame
 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.GuiSubitemTestObject
describe, setState, setState, setState
 
Methods inherited from class com.rational.test.ft.object.interfaces.StatelessGuiSubitemTestObject
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getScreenPoint, getScreenPoint, getScreenRectangle, getSubitem, hover, hover, hover, hover, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint
 
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
 
Methods inherited from interface com.rational.test.ft.object.interfaces.IGraphicalSubitem
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getScreenPoint, getScreenPoint, getScreenRectangle, getSubitem, hover, hover, hover, hover, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint
 

Constructor Detail

FrameSubitemTestObject

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

Since:
RFT6.1.1.1

FrameSubitemTestObject

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

Since:
RFT6.1.1.1

FrameSubitemTestObject

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

Since:
RFT6.1.1.1

FrameSubitemTestObject

public FrameSubitemTestObject(com.rational.test.ft.object.TestObjectReference reference)
For internal use.

Since:
RFT6.1.1.1

FrameSubitemTestObject

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

Since:
RFT6.1.1.1
Method Detail

close

public void close()
Closes the associated frame.

Specified by:
close in interface IFrame
Detail description:
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:
To close the Classics Java Application

classicsJava().close()

Since:
RFT6.1.1.1

maximize

public void maximize()
Maximizes the associated frame.

Specified by:
maximize in interface IFrame
Detail description:
The means by which the frame is maximized depends on the platform. The most resilient means of maximizing the frame should be used. If the frame is already maximized, this method has no effect.
Example:
To maximize the Classics Java Application

classicsJava().maximize()

Since:
RFT6.1.1.1

minimize

public void minimize()
Iconifies the associated frame.

Specified by:
minimize in interface IFrame
Detail description:
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:
To minimize the Classics Java Application

classicsJava().minimize()

Since:
RFT6.1.1.1

restore

public void restore()
Restores the associated frame.

Specified by:
restore in interface IFrame
Detail description:
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:
To restore the Classics Java Application

classicsJava().restore()

Since:
RFT6.1.1.1

isIconified

public boolean isIconified()
Provides access to the iconified state of the frame

Specified by:
isIconified in interface IFrame
Returns:
boolean - true, if the frame can be iconified, false otherwise
Detail description:
Returns true if the frame is iconified. Return false if the frame cannot be iconified.
Example:
To get the iconified state of the frame

boolean isIconified = classicsJava().isIconified()

Since:
RFT6.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 new width in pixels size
height - The new height in pixel size
Detail description:
Resize the frame to the given 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:
To resize the Classics Java Application to 500 pixels width and 600 pixels height.

classicsJava().resize(500,600)

Since:
RFT6.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:
pt - The point specified in java.awt.Point to move the application
Detail description:
The top-left corner of the frame is moved to the specified location relative to the top-left corner of the parent.
Example:
To move the application to top of the screen

classicsJava().move(new java.awt.Point(0,0))

Since:
RFT6.1.1.1

contextHelp

public void contextHelp()
Activate the context-sensitive Help

Specified by:
contextHelp in interface IFrame
Detail description:
Activates 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:
To activate the context help

classicsJava().contextHelp()

Since:
RFT6.1.1.1