com.rational.test.ft.object.interfaces

Class TopLevelTestObject

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.FrameTestObject

com.rational.test.ft.object.interfaces.TopLevelTestObject

All Implemented Interfaces:

IFrame, IGraphical, ITopWindow

Direct Known Subclasses:

BrowserTestObject, DialogTestObject, DojoFloatingPaneTestObject, SAPTopLevelTestObject, ShellTestObject

public class TopLevelTestObject
extends FrameTestObject
implements ITopWindow

Represents top-level window objects in the system under test. These controls must be acted upon in a consistent and resilient fashion across the various supported platforms. These classes are typically frames or dialog objects.

Since:

RFT1.0

Field Summary

Fields inherited from class com.rational.test.ft.object.interfaces.TestObject

ignoreTheObjectState, ref

Fields inherited from interface com.rational.test.ft.object.interfaces.ITopWindow

INPUTCHARS_METHOD, INPUTKEYS_METHOD

Constructor Summary

Constructors

Constructor and Description
TopLevelTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject) For internal use.
TopLevelTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor) For internal use.
TopLevelTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags) For internal use.
TopLevelTestObject(TestObject obj) Construct a TopLevelTestObject from a TestObject.
TopLevelTestObject(com.rational.test.ft.object.TestObjectReference ref) For internal use.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Causes the associated window control to become the active window if possible.
void	clickDisabled() Records all actions performed against an inactive window.
void	close() Closes the associated window.
void	inputChars(java.lang.String keys) Sends the supplied characters to the associated window.
void	inputKeys(java.lang.String keys) Sends the supplied characters to the associated window.
boolean	isIconified() Returns true if the top-level window is iconified.
void	maximize() Maximizes the associated window.
void	minimize() Iconifies the associated window.
void	move(java.awt.Point screenPt) Moves the top-level window to the specified location on the desktop.
void	resize(int width, int height) Resizes the window to the specified width and height.
void	restore() Restores the associated window.

Methods inherited from class com.rational.test.ft.object.interfaces.FrameTestObject

contextHelp

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, getIWindow, getRole, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, getVisibleArea, hasFocus, hover, hover, hover, hover, invokeProxyWithGuiDelay, invokeProxyWithGuiDelay, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, switchTo

Methods inherited from class com.rational.test.ft.object.interfaces.ClientTestObject

exists, exists, exists, find, find, findAndInvoke, findAndInvokeProxy, getProperty, getTestDataTypes, 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, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTopMappableParent, getTopParent, hashCode, invoke, invoke, invoke, invokeProxy, invokeProxy, isHtmlWebui, isLoggedDuringUnregister, isMappedObject, isSameObject, isScreenTestObject, isTopLevelTestObject, performTest, performTest, performTest, performTest, setIndexer, setIndexer, setLoggedDuringUnregister, 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.IFrame

contextHelp

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

TopLevelTestObject

public TopLevelTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)

For internal use.

Since:

RFT1.0

TopLevelTestObject

public TopLevelTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,
                  TestObject anchor)

For internal use.

Since:

RFT1.0

TopLevelTestObject

public TopLevelTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,
                  TestObject anchor,
                  long scriptCommandFlags)

For internal use.

Since:

RFT1.0

TopLevelTestObject

public TopLevelTestObject(com.rational.test.ft.object.TestObjectReference ref)

For internal use.

Since:

RFT1.0

TopLevelTestObject

public TopLevelTestObject(TestObject obj)

Construct a TopLevelTestObject from a TestObject. Both are references to the same object.

Since:

RFT1.0

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. The characters in the given string are interpreted according to the rules documented under ITopWindow.inputKeys.

Specified by:

inputKeys in interface ITopWindow

Parameters:

keys - the characters to be processed by this window

Since:

RFT1.0

inputChars

public void inputChars(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. The characters are uninterpreted. For example, inputChars("+a+b") emits "+a+b", in contrast to inputKeys("+a+b"), which interprets the "+" as a shift and emits "AB".

Specified by:

inputChars in interface ITopWindow

Parameters:

keys - 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 is not possible, an appropriate exception is thrown. Common causes for the window to not become active are that another window is modal or that the window cannot be displayed.

Specified by:

activate in interface ITopWindow

Since:

RFT1.0

close

public void close()

Closes the associated window. The means by which the window is closed depends on the platform. The most resilient means of closing the window should be used, for example, clicking on the window close icon. If the window is already closed, this method has no effect.

Specified by:

close in interface IFrame

Overrides:

close in class FrameTestObject

Since:

RFT1.0

maximize

public void maximize()

Maximizes the associated window. The means by which the window is maximized depends on the platform. The most resilient means of maximizing the window should be used. If the window is already maximized, this method has no effect.

Specified by:

maximize in interface IFrame

Overrides:

maximize in class FrameTestObject

Since:

RFT1.0

minimize

public void minimize()

Iconifies the associated window. The means by which the window is iconified depends on the platform. The most resilient means of iconifying the window should be used. If the window is already minimized, this method has no effect.

Specified by:

minimize in interface IFrame

Overrides:

minimize in class FrameTestObject

Since:

RFT1.0

restore

public void restore()

Restores the associated window. The means by which the window is restored depends on the platform. The most resilient means of restoring the window should be used. Restoring a window depends on the state of the window. If it is iconified, it is returned to its previous state. If it is maximized, it is returned to its normal size. If the window is already the normal size, this method has no effect.

Specified by:

restore in interface IFrame

Overrides:

restore in class FrameTestObject

Since:

RFT1.0

isIconified

public boolean isIconified()

Returns true if the top-level window is iconified.

Specified by:

isIconified in interface IFrame

Overrides:

isIconified in class FrameTestObject

Returns:

boolean - true if the frame is iconified. A frame cannot be iconified return false.

Since:

RFT1.0

resize

public void resize(int width,
          int height)

Resizes the window to the specified width and height. The width and height dimensions are pixel sizes. The most resilient method of resizing the window is used. This action depends on the current state of the window and desktop when the action is performed. If the resize target size is larger than the current desktop size, it is limited to the desktop size as a maximum size.

Specified by:

resize in interface IFrame

Overrides:

resize in class FrameTestObject

Parameters:

width - - The width to set for the frame

height - - The height to set for the frame

Since:

RFT1.0

move

public void move(java.awt.Point screenPt)

Moves the top-level window to the specified location on the desktop. The top-left corner of the window is moved to the specified location, relative to the top-left corner of the desktop.

Specified by:

move in interface IFrame

Overrides:

move in class FrameTestObject

Parameters:

screenPt - - The point where you want to move the frame

Since:

RFT1.0

clickDisabled

public void clickDisabled()

Records all actions performed against an inactive window. 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 instead of the TestObject.

Specified by:

clickDisabled in interface ITopWindow

Since:

RFT1.0