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 FileDialogProxy

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
                          extended by com.rational.test.ft.domain.java.swt.FileDialogProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, com.rational.test.ft.object.interfaces.IGraphical

public class FileDialogProxy
extends DialogProxy


Field Summary
 
Fields inherited from class com.rational.test.ft.domain.java.swt.DialogProxy
ACCEPT_METHOD, CANCEL_METHOD, CLOSE_METHOD, debug, 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
FileDialogProxy(java.lang.Object theObjectInTheSUT)
           
 
Method Summary
 void clickAccept()
           
 void clickCancel()
          Clicks on the cancel button on the file dialog.
 com.rational.test.ft.sys.graphical.FileDialog getFileDialogWindow()
           
 java.util.Enumeration getImmediateChildren()
          Return an enumeration of proxies for the immediate children of this object.
 java.lang.String getRole()
          Returns a brief type name that describes the role this object plays in the UI.
 com.rational.test.ft.script.ScriptCommandFlags getScriptCommandFlags()
          This method returns an active state value that reflects the state of the test object at the time of the call.
 java.lang.String getTestObjectClassName()
          Returns the top level GUI test object that implements IFileDialog and ITopLevel.
 void processSingleMouseEvent(IMouseActionInfo action)
          Returns a method specification for the specified mouse event.
 void setFile(java.lang.String file)
           
 
Methods inherited from class com.rational.test.ft.domain.java.swt.DialogProxy
activateTopWindow, clearText, close, getCachedMethodName, getChildrenEnumeration, getComments, getDescriptiveName, getDialogWindow, getMappableParent, getOwner, getParent, getParentObject, getProperty, getScreenRectangle, getStyle, getText, hasFocus, inputChars, inputKeys, isEnabled, isShowing, setCachedMethodName, setText
 
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, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, 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, 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
 

Constructor Detail

FileDialogProxy

public FileDialogProxy(java.lang.Object theObjectInTheSUT)
Method Detail

getImmediateChildren

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

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

getRole

public java.lang.String getRole()
Description copied from class: ProxyTestObject
Returns a brief type name that describes the role this object plays in the UI. For instance a java.awt.Button might return button. There are suggested role constants in the TestObjectRole class. However, proxies are not limited to these constants.

The role is used for several purposes by the test infrastructure. First, the role can be used in the construction of object names in scripts, augmenting the name returned by getDescriptiveName(). The role is also used in the UI to decorate nodes in the map with icons that help users quickly associate the nodes with the roles they play in the system under test.

Overrides:
getRole in class JavaProxy
Returns:
A brief type name that describes the role this object plays in the UI.

getTestObjectClassName

public java.lang.String getTestObjectClassName()
Returns the top level GUI test object that implements IFileDialog and ITopLevel.

Specified by:
getTestObjectClassName in interface IProxyBase
Overrides:
getTestObjectClassName in class JavaGuiProxy
Returns:
The default test object class full name.

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)
Returns a method specification for the specified mouse event. This is the primary record interface for mouse events against a particular control. This method is supplied for a Frame (rather than inheriting from JavaGuiProxy) so that the icons in the title bar can be special cased.

Overrides:
processSingleMouseEvent in class DialogProxy
Parameters:
action - The event cache and other mouse state information for this mouse action.
See Also:
MethodSpecification

setFile

public void setFile(java.lang.String file)

clickAccept

public void clickAccept()

getFileDialogWindow

public com.rational.test.ft.sys.graphical.FileDialog getFileDialogWindow()

clickCancel

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


getScriptCommandFlags

public com.rational.test.ft.script.ScriptCommandFlags getScriptCommandFlags()
This method returns an active state value that reflects the state of the test object at the time of the call. The state includes values such as enabled and showing< and allows the find algorithm to wait until a required state is achieved.

Overrides:
getScriptCommandFlags in class JavaGuiProxy
Returns:
An object that reflects the active state of the represented test object.