com.rational.test.ft.object.interfaces
Interface IFrame

All Superinterfaces:

IGraphical

All Known Subinterfaces:

IFileDialog, IInternalFrame, ITopWindow, IWindow

All Known Implementing Classes:

BrowserTestObject, ColorDialogTestObject, DialogTestObject, EclipseTestObject, FileDialogTestObject, FrameSubitemTestObject, FrameTestObject, FTETopLevelTestObject, InternalFrameTestObject, MessageBoxTestObject, SAPTopLevelTestObject, ShellTestObject, TopLevelSubitemTestObject, TopLevelTestObject, WpfFrameSubitemTestObject, WpfFrameTestObject, WpfTopLevelSubitemTestObject, WpfTopLevelTestObject

public interface IFrame
extends IGraphical

Defines the interface for frame GUI objects. The methods in the class assist in performing Window based actions. The window based actions are performed in the most resilient manner.

Since:

RFT6.1.1.1

See Also:

ITopWindow, FrameTestObject, FrameSubitemTestObject

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 pt) 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 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

Method Detail

close

void close()

Closes the associated frame.

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

void maximize()

Maximizes the associated frame.

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

void minimize()

Iconifies the associated frame.

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

void restore()

Restores the associated frame.

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

boolean isIconified()

Provides access to the iconified state of the frame

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

void resize(int width,             int height)

Resizes the frame to the specified width and height.

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

void move(java.awt.Point pt)

Moves the frame to the specified location within parent.

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

void contextHelp()

Activate the context-sensitive Help

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