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.awt
Class AppletProxy

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.awt.ComponentProxy
                      extended by com.rational.test.ft.domain.java.awt.AppletProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IFrame, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.ITopWindow

public class AppletProxy
extends ComponentProxy
implements com.rational.test.ft.object.interfaces.ITopWindow

This is the base class for all Java applet test objects.

Since:
RFT1.0

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.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
AppletProxy(java.lang.Object theObjectInTheSUT)
          Sets the SUT object as a member variable for the proxy.
 
Method Summary
 void activate()
          Brings the window to top
 void clickDisabled()
          Click on a window that is disabled or waiting on the modal dialog.
 void close()
          Closes the associated frame.
 void contextHelp()
          Activate the context-sensitive Help
 java.lang.String getDescriptiveName()
          Returns a name that can be used to describe the associated UI object in a script.
 ProxyTestObject getMappableParent()
          Returns a proxy object for the mappable parent of this object; returns null if this object has no mappable parent.
 ProxyTestObject getParent()
          Returns a proxy object for the parent of this object; returns null if this object has no parent.
 java.lang.Object getProperty(java.lang.String propertyName)
          Gets the value for a specific property.
 java.lang.String getRole()
          Returns TestObjectRole.ROLE_BUTTON.
 void inputChars(java.lang.String characters)
          Sends the supplied characters to the associated window.
 void inputKeys(java.lang.String keys)
          Sends the supplied characters to the associated window.
 boolean isIconified()
          Provides access to the iconified state of the frame
 void maximize()
          Maximizes the associated frame.
 void minimize()
          Iconifies the associated frame.
 void move(java.awt.Point screenPt)
          Moves the frame to the specified location within parent.
 void resize(int width, int height)
          Resizes the frame to the specified width and height.
 void restore()
          Restores the associated frame.
 
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, getName, getOwnedObjects, getOwner, getParent2, getParentObject, getScreenRectangle, 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, getClippedScreenRectangle, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTestObjectClassName, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, processSingleMouseEvent, 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, 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
 
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

AppletProxy

public AppletProxy(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

getDescriptiveName

public java.lang.String getDescriptiveName()
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.

Overrides:
getDescriptiveName in class ComponentProxy
Returns:
A descriptive object name.

getRole

public java.lang.String getRole()
Returns TestObjectRole.ROLE_BUTTON.

Overrides:
getRole in class ComponentProxy
Returns:
A brief type name that describes the role this object plays in the UI.
Since:
RFT1.0

getParent

public ProxyTestObject getParent()
Returns a proxy object for the parent of this object; returns null if this object has no parent.

Overrides:
getParent in class ComponentProxy
Returns:
The proxy for the parent test object or null for a top-level object.
Since:
RFT1.0

getMappableParent

public ProxyTestObject getMappableParent()
Returns a proxy object for the mappable parent of this object; returns null if this object has no mappable parent. Note that only a proxy that shouldBeMapped should be returned from this method.

Overrides:
getMappableParent in class ComponentProxy
Returns:
The proxy for the first mappable parent test object or null for a top-level mapped object.
Since:
RFT1.0

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)
Gets the value for a specific property.

Overrides:
getProperty in class ComponentProxy
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)

inputKeys

public void inputKeys(java.lang.String keys)
Description copied from interface: com.rational.test.ft.object.interfaces.ITopWindow
Sends the supplied characters to the associated window.

Specified by:
inputKeys in interface com.rational.test.ft.object.interfaces.ITopWindow
Parameters:
keys - java.lang.String The keys to be sent to the current active window

inputChars

public void inputChars(java.lang.String characters)
Description copied from interface: com.rational.test.ft.object.interfaces.ITopWindow
Sends the supplied characters to the associated window. The window is responsible for sending the characters on to the appropriate controls nested in that window. The characters are uninterpreted. For example, inputChars("+a+b") emits "+a+b", in contrast to inputKeys("+a+b"), which interprets the "+" as shift and emit "AB".

Note that passing in a null string will result in a BadArgumentException being thrown.

Specified by:
inputChars in interface com.rational.test.ft.object.interfaces.ITopWindow
Parameters:
characters - the characters to be processed by this window

activate

public void activate()
Description copied from interface: com.rational.test.ft.object.interfaces.ITopWindow
Brings the window to top

Specified by:
activate in interface com.rational.test.ft.object.interfaces.ITopWindow

close

public void close()
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Closes the associated frame.

Specified by:
close in interface com.rational.test.ft.object.interfaces.IFrame

maximize

public void maximize()
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Maximizes the associated frame.

Specified by:
maximize in interface com.rational.test.ft.object.interfaces.IFrame

minimize

public void minimize()
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Iconifies the associated frame.

Specified by:
minimize in interface com.rational.test.ft.object.interfaces.IFrame

restore

public void restore()
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Restores the associated frame.

Specified by:
restore in interface com.rational.test.ft.object.interfaces.IFrame

isIconified

public boolean isIconified()
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Provides access to the iconified state of the frame

Specified by:
isIconified in interface com.rational.test.ft.object.interfaces.IFrame
Returns:
boolean - true, if the frame can be iconified, false otherwise

resize

public void resize(int width,                    int height)
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Resizes the frame to the specified width and height.

Specified by:
resize in interface com.rational.test.ft.object.interfaces.IFrame
Parameters:
width - The new width in pixels size
height - The new height in pixel size

move

public void move(java.awt.Point screenPt)
Description copied from interface: com.rational.test.ft.object.interfaces.IFrame
Moves the frame to the specified location within parent.

Specified by:
move in interface com.rational.test.ft.object.interfaces.IFrame
Parameters:
screenPt - The point specified in java.awt.Point to move the application

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

clickDisabled

public void clickDisabled()
Description copied from interface: com.rational.test.ft.object.interfaces.ITopWindow
Click on a window that is disabled or waiting on the modal dialog.

Specified by:
clickDisabled in interface com.rational.test.ft.object.interfaces.ITopWindow