IBM Rational Functional Tester
Version 6.1
IBM Rational Functional Tester API Reference

Project Version 2.0

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

All Superinterfaces:
IFrame, IGraphical
All Known Subinterfaces:
IFileDialog, IWindow
All Known Implementing Classes:
FileDialogTestObject, TopLevelSubitemTestObject, TopLevelTestObject

public interface ITopWindow
extends IFrame

Defines the interface for top-level GUI objects. This is needed when keys played back to top-level windows. We always know how to activate top-level windows, but not always know how to activate (set focus) to nested GUI components.

Since:
RFT1.0

Field Summary
static java.lang.String INPUTCHARS_METHOD
          The name of the inputChars method.
static java.lang.String INPUTKEYS_METHOD
          The name of the inputKeys method.
 
Method Summary
 void activate()
          Causes the associated window control to become the active window if possible.
 void clickDisabled()
          Clicks in a benign location on the top-level object to get other action-sensitive windows to change their state.
 void inputChars(java.lang.String characters)
          Sends the supplied characters to the associated window.
 void inputKeys(java.lang.String keys)
          Sends the supplied characters to the associated window.
 
Methods inherited from interface com.rational.test.ft.object.interfaces.IFrame
close, contextHelp, isIconified, maximize, minimize, move, resize, restore
 
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
 

Field Detail

INPUTCHARS_METHOD

public static final java.lang.String INPUTCHARS_METHOD
The name of the inputChars method.

Since:
RFT1.1
See Also:
Constant Field Values

INPUTKEYS_METHOD

public static final java.lang.String INPUTKEYS_METHOD
The name of the inputKeys method.

Since:
RFT1.0
See Also:
Constant Field Values
Method Detail

inputKeys

public void inputKeys(java.lang.String keys)
Sends the supplied characters to the associated window. The window is responsible for sending the characters on to the appropriate controls nested in that window. Note that passing in a null string will result in a BadArgumentException being thrown.

Strings that do not contain any characters with special meaning are played back as is. For example, if you put "abcd" in a keystring, it plays back as "abcd." The characters with special meanings are:
+^%~(){}

The meanings of these special characters are described as follows:

Since:
RFT1.0

inputChars

public void inputChars(java.lang.String characters)
Sends the supplied characters to the associated window. The window is responsible for sending the characters on to the appropriate controls nested in that window. The characters are uninterpreted. For example, inputChars("+a+b") emits "+a+b", in contrast to inputKeys("+a+b"), which interprets the "+" as shift and emit "AB".

Note that passing in a null string will result in a BadArgumentException being thrown.

Parameters:
characters - the characters to be processed by this window
Since:
RFT1.0

activate

public void activate()
Causes the associated window control to become the active window if possible. If this action is not possible, an appropriate exception is thrown. Common reasons that the window does not become active are that another window is modal or that the window cannot be displayed.

Since:
RFT1.0

clickDisabled

public void clickDisabled()
Clicks in a benign location on the top-level object to get other action-sensitive windows to change their state. All actions performed against an inactive window are recorded as a call to this method. Top objects become inactive when a modal dialog box prevents them from becoming active. Actions against an inactive window cause the topmost modal dialog box to be activated, rather than the test object.

Since:
RFT1.0