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

Project Version 2.3

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

All Superinterfaces:
IFrame, IGraphical, ITopWindow

public interface IWindow
extends IGraphical, ITopWindow

Provides access to the native window management system; any use of this interface is likely to be platform specific.

Since:
RFT 6.1.1.1

Field Summary
 
Fields inherited from interface com.rational.test.ft.object.interfaces.ITopWindow
INPUTCHARS_METHOD, INPUTKEYS_METHOD
 
Method Summary
 IWindow[] getChildren()
          Returns an array of the children of this window.
 long getHandle()
          Returns the native window handle for the object.
 int getId()
          Returns the control ID (on Microsoft Windows) for the window.
 IWindow[] getOwned()
          Returns an array of the windows owned by this window.
 IWindow getOwner()
          Returns the owner of this window.
 IWindow getParent()
          Returns the parent of this window.
 int getPid()
          Returns the process ID for the window.
 java.lang.String getText()
          Returns the text for the window.
 IWindow getTopParent()
          Returns the topmost parent of this window.
 java.lang.String getWindowClassName()
          Returns the window class name for the window.
 boolean isTopLevel()
          Returns a flag to check whether the window is toplevel or not.
 
Methods inherited from interface com.rational.test.ft.object.interfaces.ITopWindow
activate, clickDisabled, inputChars, inputKeys
 
Methods inherited from interface com.rational.test.ft.object.interfaces.IFrame
close, contextHelp, isIconified, maximize, minimize, move, resize, restore
 

Method Detail

getChildren

IWindow[] getChildren()
Returns an array of the children of this window.

Detail description:
This will Return an array of the children of this window. If this window has no children, a 0-length array is returned.
Since:
RFT 6.1.1.1

getParent

IWindow getParent()
Returns the parent of this window.

Returns:
IWindow - The parent of the window , or null if no child object is found
Detail description:
This will Return the parent of the Window if exist
Since:
RFT 6.1.1.1

getTopParent

IWindow getTopParent()
Returns the topmost parent of this window.

Returns:
IWindow - The topmost parent of the window , or If this window is a topmost window, this window is returned.
Detail description:
This will Return the topmost parent of the Window.
Since:
RFT 6.1.1.1

getOwner

IWindow getOwner()
Returns the owner of this window.

Returns:
IWindow - The owner of the window , or If this window has no owner, null is returned.
Detail description:
This will Return the owner of the Window.
Since:
RFT 6.1.1.1

getOwned

IWindow[] getOwned()
Returns an array of the windows owned by this window.

Returns:
IWindow - The array of the windows Owned by this window , or If this window does not own any other windows, a 0-length array is returned.
Detail description:
This will Returns an array of the windows owned by this window.
Since:
RFT 6.1.1.1

isTopLevel

boolean isTopLevel()
Returns a flag to check whether the window is toplevel or not.

Returns:
boolean - true if this window is a top window (that is, not a child of any window). Returns false if this window has a parent.
Detail description:
This will Returns a boolean flag indication whether the window in question is toplevel or not.
Since:
RFT 6.1.1.1

getHandle

long getHandle()
Returns the native window handle for the object.

Returns:
long - handle of the window
Detail description:
This will Returns a window handle for the object
Since:
RFT 6.1.1.1

getText

java.lang.String getText()
Returns the text for the window.

Returns:
java.lang.String - text of the window
Detail description:
This will Returns the text asscociated with the window
Since:
RFT 6.1.1.1

getWindowClassName

java.lang.String getWindowClassName()
Returns the window class name for the window.

Returns:
java.lang.String - Window class name
Detail description:
This will Returns the classname of the Windows
Since:
RFT 6.1.1.1

getPid

int getPid()
           throws NotSupportedOnUnixException
Returns the process ID for the window.

Throws:
NotSupportedOnUnixException
Returns:
int - The process id of the window (on windows machines)
Detail description:
This will Returns the process ID for the Windows.This is not supported on UNIX platforms.
Since:
RFT 6.1.1.1

getId

int getId()
Returns the control ID (on Microsoft Windows) for the window.

Returns:
int - The control id of the window.
Detail description:
This will Returns the control ID for the Window. This returns 0 on UNIX platforms.
Since:
RFT 6.1.1.1