IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester Proxy SDK Reference

Project Version 2.3

com.rational.test.ft.domain.java.swt
Class DialogProxy

java.lang.Object
  extended by com.rational.test.ft.sys.RegisteredObject
      extended by com.rational.test.ft.domain.ProxyTestObject
          extended by com.rational.test.ft.domain.java.JavaProxy
              extended by com.rational.test.ft.domain.java.JavaGuiProxy
                  extended by com.rational.test.ft.domain.java.swt.TopLevelWindowProxy
                      extended by com.rational.test.ft.domain.java.swt.DialogProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, com.rational.test.ft.object.interfaces.IGraphical
Direct Known Subclasses:
ColorDialogProxy, DirectoryDialogProxy, FileDialogProxy, MessageBoxProxy

public abstract class DialogProxy
extends TopLevelWindowProxy


Field Summary
protected static java.lang.String ACCEPT_METHOD
           
protected static java.lang.String CANCEL_METHOD
           
protected static java.lang.String CLOSE_METHOD
           
protected static com.rational.test.ft.util.FtDebug debug
           
protected  boolean isClickOnClose
           
 
Fields inherited from class com.rational.test.ft.domain.java.JavaGuiProxy
LEFT, preDownState, processMouseEventHandler, ROLEINDEX, ROLEINDEXWEIGHT, TESTDATA_SPECIALFRAMESTATE, TESTDATA_SPECIALFRAMESTATE_DESCRIPTION, topLevelWindow
 
Fields inherited from class com.rational.test.ft.domain.java.JavaProxy
uniqueId
 
Fields inherited from class com.rational.test.ft.domain.ProxyTestObject
BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle
 
Fields inherited from class com.rational.test.ft.sys.RegisteredObject
theTestObject
 
Fields inherited from interface com.rational.test.ft.domain.IDataDriven
INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS
 
Constructor Summary
DialogProxy(java.lang.Object theObjectInTheSUT)
           
 
Method Summary
protected  void activateTopWindow()
           
protected  void clearText()
           
 void close()
           
protected  java.lang.String getCachedMethodName()
           
 java.util.Enumeration getChildrenEnumeration()
          Return an enumeration of mappable proxies for the children of this object.
protected  com.rational.test.ft.sys.MethodSpecification getComments()
           
 java.lang.String getDescriptiveName()
          Returns a name that can be used to describe the associated UI object in a script.
protected  com.rational.test.ft.sys.graphical.TopLevelWindow getDialogWindow()
           
 ProxyTestObject getMappableParent()
          Returns a proxy object for the mappable parent of this object.
 ProxyTestObject getOwner()
          Always returns null because object relationships are not understood at this level of abstaction.
 ProxyTestObject getParent()
          Returns a proxy object for the parent of this object.
 java.lang.Object getParentObject()
          Returns an object for the parent of this object.
 java.lang.Object getProperty(java.lang.String propertyName)
          Gets the value for a specific property.
 java.awt.Rectangle getScreenRectangle()
          Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
 int getStyle()
           
 java.lang.String getText()
           
 boolean hasFocus()
          Check the component under evaluation to determine if it has keyboard focus.
 void inputChars(java.lang.String characters)
           
 void inputKeys(java.lang.String characters)
           
 boolean isEnabled()
          Check the component under evaluation to determine if it is enabled or disabled.
 boolean isShowing()
          Check the component under evaluation to determine if it is showing (as opposed to hidden).
 void processSingleMouseEvent(IMouseActionInfo action)
          The method is used to add comments to the MethodSpecification
protected  void setCachedMethodName(java.lang.String methodName)
           
 void setText(java.lang.String text)
           
 
Methods inherited from class com.rational.test.ft.domain.java.JavaGuiProxy
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getClippedScreenRectangle, getImmediateChildren, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTestObjectClassName, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, scrollRectToVisible, setProcessMouseEventHandler, setTopLevelWindow, shouldBeMapped
 
Methods inherited from class com.rational.test.ft.domain.java.JavaProxy
addMappableChildrenToVector, addRecognitionProperty, allowProperty, childConstructed, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMappableChildren, getMethods, getNonValueProperties, getOwnedObjects, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getRole, getStandardProperties, getTestDataTypes, getTestDomain, getTopMappableParent, getTopParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, isRecognitionProperty, setIndexer, setProperty
 
Methods inherited from class com.rational.test.ft.domain.ProxyTestObject
addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommand, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getTestData, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData
 
Methods inherited from class com.rational.test.ft.sys.RegisteredObject
addProxyReference, dereference, getObject, getRegisteredId, getTransactionId, isReferenced, isReleaseRequired, register, registerTransiently, release, toString, unregister
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

debug

protected static com.rational.test.ft.util.FtDebug debug

isClickOnClose

protected boolean isClickOnClose

CLOSE_METHOD

protected static final java.lang.String CLOSE_METHOD
See Also:
Constant Field Values

ACCEPT_METHOD

protected static final java.lang.String ACCEPT_METHOD
See Also:
Constant Field Values

CANCEL_METHOD

protected static final java.lang.String CANCEL_METHOD
See Also:
Constant Field Values
Constructor Detail

DialogProxy

public DialogProxy(java.lang.Object theObjectInTheSUT)
Parameters:
theObjectInTheSUT -
Method Detail

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()
Description copied from class: JavaGuiProxy
Return an enumeration of mappable proxies for the children of this object.

Specified by:
getChildrenEnumeration in class JavaGuiProxy
Returns:
The child proxies relative to this proxy.

hasFocus

public boolean hasFocus()
Description copied from class: JavaGuiProxy
Check the component under evaluation to determine if it has keyboard focus.

Specified by:
hasFocus in interface com.rational.test.ft.object.interfaces.IGraphical
Specified by:
hasFocus in class JavaGuiProxy
Returns:
true if component has keyboard focus, else false.

isEnabled

public boolean isEnabled()
Description copied from class: JavaGuiProxy
Check the component under evaluation to determine if it is enabled or disabled.

Specified by:
isEnabled in interface com.rational.test.ft.object.interfaces.IGraphical
Specified by:
isEnabled in class JavaGuiProxy
Returns:
true if component is enabled, else false.

isShowing

public boolean isShowing()
Description copied from class: JavaGuiProxy
Check the component under evaluation to determine if it is showing (as opposed to hidden).

Specified by:
isShowing in interface com.rational.test.ft.object.interfaces.IGraphical
Specified by:
isShowing in class JavaGuiProxy
Returns:
true if component is showing, else false.

getText

public java.lang.String getText()
Returns:

setText

public void setText(java.lang.String text)
Parameters:
text -

getMappableParent

public ProxyTestObject getMappableParent()
Description copied from class: JavaGuiProxy
Returns a proxy object for the mappable parent of this object. Returns null if this object has no parent.

Specified by:
getMappableParent in class JavaGuiProxy
Returns:
The proxy for the parent test object or null for a top-level window.

getParent

public ProxyTestObject getParent()
Description copied from class: JavaGuiProxy
Returns a proxy object for the parent of this object. Returns null if this object has no parent.

Specified by:
getParent in class JavaGuiProxy
Returns:
The proxy for the parent test object or null for a top-level window.

getParentObject

public java.lang.Object getParentObject()
Description copied from class: JavaGuiProxy
Returns an object for the parent of this object. Returns null if this object has no parent.

Specified by:
getParentObject in class JavaGuiProxy
Returns:
The parent test object or null for a top-level window.

getOwner

public ProxyTestObject getOwner()
Description copied from class: JavaProxy
Always returns null because object relationships are not understood at this level of abstaction.

Overrides:
getOwner in class JavaProxy
Returns:
null, no known parent.

getDialogWindow

protected com.rational.test.ft.sys.graphical.TopLevelWindow getDialogWindow()
Returns:

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)
Description copied from class: JavaProxy
Gets the value for a specific property.

Overrides:
getProperty in class JavaProxy
Parameters:
propertyName - The name of the property to fetch.
Returns:
The active value of the specified property for the associated test object.
See Also:
ProxyTestObject.getProperties(), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getRecognitionProperties(), ProxyTestObject.addRecognitionProperty(String,Object,int)

getScreenRectangle

public java.awt.Rectangle getScreenRectangle()
Description copied from class: JavaGuiProxy
Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen. This commonly consists of two operations: (getLocationOnScreen and getSize) combined into a single operation.

Specified by:
getScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphical
Specified by:
getScreenRectangle in class JavaGuiProxy
Returns:
The adjusted rectangle surrounding component relative to the screen.
See Also:
IGraphical.isPointInObject(java.awt.Point), IGraphical.getClippedScreenRectangle()

getDescriptiveName

public java.lang.String getDescriptiveName()
Description copied from class: JavaGuiProxy
Returns a name that can be used to describe the associated UI object in a script. This name may be further adjusted to become unique to the script, but it acts as the base for the name used in the script. Only characters used in Java identifiers should be returned (alphabetic, numeric, or underscore characters). Non-identifier characters cause script compilation failures. An example of what to return is "OKButton" for a java.awt.Button with the text "OK" on it.

Specified by:
getDescriptiveName in class JavaGuiProxy
Returns:
A descriptive object name.

getStyle

public int getStyle()

activateTopWindow

protected void activateTopWindow()
Overrides:
activateTopWindow in class JavaGuiProxy

close

public void close()

inputChars

public void inputChars(java.lang.String characters)

inputKeys

public void inputKeys(java.lang.String characters)

clearText

protected void clearText()

getCachedMethodName

protected java.lang.String getCachedMethodName()

setCachedMethodName

protected void setCachedMethodName(java.lang.String methodName)

getComments

protected com.rational.test.ft.sys.MethodSpecification getComments()

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)
The method is used to add comments to the MethodSpecification

Overrides:
processSingleMouseEvent in class JavaGuiProxy