com.rational.test.ft.domain.java.awt
Class FileDialogProxy

java.lang.Object   com.rational.test.ft.sys.RegisteredObject       com.rational.test.ft.domain.ProxyTestObject
          com.rational.test.ft.domain.java.JavaProxy
              com.rational.test.ft.domain.java.JavaGuiProxy
                  com.rational.test.ft.domain.java.awt.ComponentProxy
                      com.rational.test.ft.domain.java.awt.TopLevelWindowProxy
                          com.rational.test.ft.domain.java.awt.WindowProxy
                              com.rational.test.ft.domain.java.awt.FileDialogProxy

All Implemented Interfaces:

IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IFileDialog, com.rational.test.ft.object.interfaces.IFrame, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.ITopWindow

public class FileDialogProxy
extends WindowProxy
implements com.rational.test.ft.object.interfaces.IFileDialog, com.rational.test.ft.object.interfaces.ITopWindow

Proxy for AWT FileDialog objects.

• Test Object interface:
  FileDialogTestObject
  
  

• Default Recognition Properties:
  

  Property	Usage
  .captionText	The visible text on the window titlebar.
  .class	The Java full class name of the test object.
  .mode	Either Load or Save depending on the mode of the dialog.
  name	The name property, suppressed if default formatted (default form = className+count).

  
  

Nested Class Summary

Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

ComponentProxy.ChildEnumerator, ComponentProxy.ImmediateChildEnumerator

Field Summary

Fields inherited from class com.rational.test.ft.domain.java.awt.TopLevelWindowProxy

CAPTION

Fields inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, MAX_NAME, NAMEPROPERTY, NAMEPROPERTYWEIGHT, PRIORLABEL, PRIORLABELWEIGHT

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

debug, 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.object.interfaces.ITopWindow

INPUTCHARS_METHOD, INPUTKEYS_METHOD

Fields inherited from interface com.rational.test.ft.domain.IDataDriven

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

FileDialogProxy(java.lang.Object theObjectInTheSUT)
Sets the SUT object as a member variable for the proxy.

Method Summary

void	activate() Causes the associated window control to become the active window if possible.
void	clickAccept() Clicks on the button on the file dialog that does the accepting.
void	clickCancel() Clicks on the cancel button on the file dialog.
void	contextHelp() Activate the context-sensitive Help
java.awt.Rectangle	getClippedScreenRectangle() Returns the clipped-screen rectangle for the associated TestObject
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_FILE_CHOOSER.
java.awt.Rectangle	getScreenRectangle() Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
java.lang.String	getTestObjectClassName() Returns the top level GUI test object that implements IFileDialog and ITopLevel.
protected com.rational.test.ft.sys.graphical.TopLevelWindow	getTopLevelWindow() Get the top-level window associated with this Frame.
java.awt.Rectangle	getVisualClippedRectangle() The optimized way to obtain the ClippedRectangle.
void	processSingleMouseEvent(IMouseActionInfo action) Returns a method specification for the specified mouse event.
void	setFile(java.lang.String file) Sets the full path name specified in the associated file dialog window.

Methods inherited from class com.rational.test.ft.domain.java.awt.WindowProxy

getCaption, getCaptionProperty

Methods inherited from class com.rational.test.ft.domain.java.awt.TopLevelWindowProxy

clickDisabled, close, getDescriptiveName, getHandle, getScriptCommandFlags, inputChars, inputKeys, isIconified, isTopLevel, maximize, minimize, move, resize, restore

Methods inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getChildrenEnumeration, getClippedRect, getComponentChildren, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getTopParent, getWindow, hasFocus, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, isOpaque, isRecognitionProperty, isShowing, isVScroll, setParent

Methods inherited from class com.rational.test.ft.domain.java.JavaGuiProxy

activateTopWindow, click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, 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, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMethods, getNonValueProperties, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getStandardProperties, getTestDataTypes, getTestDomain, getTopMappableParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, 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, 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

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

clickDisabled, inputChars, inputKeys

Methods inherited from interface com.rational.test.ft.object.interfaces.IFrame

close, isIconified, maximize, minimize, move, resize, restore

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, getScreenPoint, getScreenPoint, hasFocus, hover, hover, hover, hover, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint

Constructor Detail

FileDialogProxy

public FileDialogProxy(java.lang.Object theObjectInTheSUT)

Sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.

Method Detail

getTopLevelWindow

protected com.rational.test.ft.sys.graphical.TopLevelWindow getTopLevelWindow()

Description copied from class: TopLevelWindowProxy

Get the top-level window associated with this Frame.

Overrides:

getTopLevelWindow in class TopLevelWindowProxy

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 WindowProxy

Returns:

The default test object class full name.

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_FILE_CHOOSER.

Overrides:

getRole in class WindowProxy

Returns:

A brief type name that describes the role this object plays in the UI.

Since:

RFT1.0

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Gets the value for a specific property.

Overrides:

getProperty in class WindowProxy

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)

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 TopLevelWindowProxy

Parameters:

action - The event cache and other mouse state information for this mouse action.

See Also:

MethodSpecification

getScreenRectangle

public java.awt.Rectangle getScreenRectangle()

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

Overrides:

getScreenRectangle in class TopLevelWindowProxy

Returns:

The adjusted rectangle surrounding component relative to the screen.

See Also:

IGraphical.isPointInObject(java.awt.Point), IGraphical.getClippedScreenRectangle()

getClippedScreenRectangle

public java.awt.Rectangle getClippedScreenRectangle()

Description copied from interface: com.rational.test.ft.object.interfaces.IGraphical

Returns the clipped-screen rectangle for the associated TestObject

Specified by:

getClippedScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphical

Overrides:

getClippedScreenRectangle in class TopLevelWindowProxy

Returns:

java.awt.Rectangle - The clipped screen rectangle, or null if the object cannot be seen in any window on the screen.

See Also:

IGraphical.getScreenRectangle()

getVisualClippedRectangle

public java.awt.Rectangle getVisualClippedRectangle()

Description copied from class: ProxyTestObject

The optimized way to obtain the ClippedRectangle.

Overrides:

getVisualClippedRectangle in class TopLevelWindowProxy

Returns:

The ClippedScreen Rectangle of the control

activate

public void activate()

Causes the associated window control to become the active window if possible. The window is first de-iconified if necessary and then activated. (On Windows, this means calling SetForegroundWindow). If it is not possible to activate the window, an appropriate exception is thrown. Common causes for the window to not become active are that another window is modal or that the window is not displayable. Frame.activate is generally called before any UI action that occurs on a component in the frame. For instance, JavaGuiProxy.click() calls activateTopWindow(), which in most cases makes its way to Frame.activate. (This assumes that the top window to be activated is a frame.)

Specified by:

activate in interface com.rational.test.ft.object.interfaces.ITopWindow

Overrides:

activate in class TopLevelWindowProxy

setFile

public void setFile(java.lang.String file)

Sets the full path name specified in the associated file dialog window. Both directory name and file name are specified in the appropriate file path format for the target test context.

Specified by:

setFile in interface com.rational.test.ft.object.interfaces.IFileDialog

Parameters:

file - The full file path name for the desired file.

clickAccept

public void clickAccept()

Clicks on the button on the file dialog that does the accepting. The recognition information associated with this button varies from host to host, so a more generic method is supplied to perform this functionality.

Specified by:

clickAccept in interface com.rational.test.ft.object.interfaces.IFileDialog

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.

Specified by:

clickCancel in interface com.rational.test.ft.object.interfaces.IFileDialog

contextHelp

public void contextHelp()

Description copied from interface: com.rational.test.ft.object.interfaces.IFrame

Activate the context-sensitive Help

Specified by:

contextHelp in interface com.rational.test.ft.object.interfaces.IFrame

Overrides:

contextHelp in class TopLevelWindowProxy