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 DialogTestObject

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.FrameTestObject
                  extended by com.rational.test.ft.object.interfaces.TopLevelTestObject
                      extended by com.rational.test.ft.object.interfaces.DialogTestObject
All Implemented Interfaces:
IFrame, IGraphical, ITopWindow
Direct Known Subclasses:
ColorDialogTestObject, FileDialogTestObject, MessageBoxTestObject

public class DialogTestObject
extends TopLevelTestObject

Represents native-style Dialog controls. This interface can be used to make the native-control recording more resilient. Due to disconnects between the host domain and the native-level implementation, these controls typically do not expose all the visible child controls.

Since:
RFT8.0.1
See Also:
FileDialogTestObject, MessageBoxTestObject, ColorDialogTestObject

Field Summary
 
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject
ref
 
Fields inherited from interface com.rational.test.ft.object.interfaces.ITopWindow
INPUTCHARS_METHOD, INPUTKEYS_METHOD
 
Constructor Summary
DialogTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
DialogTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
DialogTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
DialogTestObject(TestObject obj)
          For internal use.
DialogTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 void clickAccept()
          Clicks on the dialog button that accepts the recognition information.
 void clickCancel()
          Clicks on the cancel button on the dialog.
 void close()
          Clicks on the close button on the top right corner of the Dialog
 int getStyle()
          Allows direct access to the style property on the control.
 java.lang.String getText()
          Allows direct access to the text property on the control.
 void setText(java.lang.String text)
          Directly modifies the text on the control.
 
Methods inherited from class com.rational.test.ft.object.interfaces.TopLevelTestObject
activate, clickDisabled, inputChars, inputKeys, isIconified, maximize, minimize, move, resize, restore
 
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, 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.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

DialogTestObject

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

Since:
RFT8.0.1

DialogTestObject

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

Since:
RFT8.0.1

DialogTestObject

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

Since:
RFT8.0.1

DialogTestObject

public DialogTestObject(com.rational.test.ft.object.TestObjectReference ref)
For internal use.

Since:
RFT8.0.1

DialogTestObject

public DialogTestObject(TestObject obj)
For internal use.

Since:
RFT8.0.1
Method Detail

getText

public java.lang.String getText()
Allows direct access to the text property on the control.

Returns:
the active text in the control.
Example:
Access the text property of the dialog String text = dialog().getText();
Since:
RFT8.0.1

setText

public void setText(java.lang.String text)
Directly modifies the text on the control. Any existing text in the control is replaced with the specified text value. The API dose not guarantee the immediate update on the dialog.

Parameters:
text - the text to update the control with.
Since:
RFT8.0.1

getStyle

public int getStyle()
Allows direct access to the style property on the control.

Returns:
the style for the control.
Example:
int style = dialog().getStyle();
Since:
RFT8.0.1

clickAccept

public void clickAccept()
Clicks on the dialog button that accepts the recognition information. This information varies from host to host. Therefore, a generic method is supplied to perform this functionality.

Since:
RFT6.1.1.1

clickCancel

public void clickCancel()
Clicks on the cancel button on the dialog. The recognition information that is associated with this button varies from host to host. Therefore, a generic method is supplied to perform this functionality.

Since:
RFT6.1.1.1

close

public void close()
Clicks on the close button on the top right corner of the Dialog

Specified by:
close in interface IFrame
Overrides:
close in class TopLevelTestObject
Detail description:
The click happens on the close button through the glass.
Example:
Close the Dialog dialog().close();
Since:
RFT8.0.1