com.rational.test.ft.domain.java.eclipse.gef

Class FigureProxy

java.lang.Object

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.eclipse.gef.FigureProxy

All Implemented Interfaces:

IDataDriven, IProxyBase, IPropertyFilter

public class FigureProxy
extends JavaGuiProxy

Field Summary

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, TIMEOUTTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle

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

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

Constructor and Description
FigureProxy(java.lang.Object theObjectInTheSUT)
FigureProxy(java.lang.Object theObjectInTheSUT, java.lang.Object[] proxyArgs)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateTopWindow() Request for focus on the figure
IChannel	getChannel() return the channel for the object.
java.lang.Object	getChildAtPoint(java.awt.Point pt) Finds the child object that is at the specified point.
java.util.Enumeration	getChildrenEnumeration() Return an enumeration of mappable proxies for the children of this object.
java.awt.Rectangle	getClippedScreenRectangle() We clip with respect to Mappable parent
MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
java.util.Enumeration	getImmediateChildren() Return an enumeration of proxies for the immediate children of this object.
ProxyTestObject	getMappableParent() Returns a proxy object for the mappable parent of this object.
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.
ITestData	getTestData(java.lang.String testDataType) This method constructs the specified verification data object.
java.util.Hashtable	getTestDataTypes() Returns a hashtable of data type descriptions of the verification point data available with the associated object in the SUT.
java.lang.String	getTestObjectClassName() The default GUI test object classname is returned.
java.awt.Rectangle	getVisualClippedRectangle() The optimized way to obtain the ClippedRectangle.
boolean	hasFocus() Check the component under evaluation to determine if it has keyboard focus.
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	scrollRectToVisible(java.awt.Rectangle rect) Scrolls the viewport(if it exists) so that the rectangle within the viewport becomes visible.
void	setText(java.lang.String text) Set the text for the labelled edit part
boolean	shouldBeMapped() Returns true; by default all test objects are mapped.

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

click, click, click, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getClippedRect, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, invokeMethodOnEDT, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, processSingleMouseEvent, setProcessMouseEventHandler, setTopLevelWindow

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

addMappableChildrenToVector, addRecognitionProperty, allowProperty, childConstructed, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMappableChildren, getMethods, getNonValueProperties, getOwnedObjects, getOwner, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getRole, getStandardProperties, 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, getChildren, getDataDrivableCommands, getElementWithFocus, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FigureProxy

public FigureProxy(java.lang.Object theObjectInTheSUT)

FigureProxy

public FigureProxy(java.lang.Object theObjectInTheSUT,
           java.lang.Object[] proxyArgs)

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.

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.

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.

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.

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 class JavaGuiProxy

Returns:

The adjusted rectangle surrounding component relative to the screen.

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 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 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 class JavaGuiProxy

Returns:

true if component is showing, else false.

getTestDataTypes

public java.util.Hashtable getTestDataTypes()

Returns a hashtable of data type descriptions of the verification point data available with the associated object in the SUT. The hashtable keys are String objects that are used as the VP type in the associated test data. The type is a simple value that is defferent then other type values associated with this object under test. The type keys map to a verbose description of the test data, reasonable for presentation to a user.

Overrides:

getTestDataTypes in class JavaProxy

Returns:

An hashtable of type/description pairs used to describe the verification data available from this proxy.

See Also:

getTestData(String), ITestData

getTestData

public ITestData getTestData(java.lang.String testDataType)

This method constructs the specified verification data object. The testDataType parameter is one of the hashtable keys returned by getTestDataTypes.

Overrides:

getTestData in class ProxyTestObject

Parameters:

testDataType - A test data type supplied by getTestDataTypes.

Returns:

The verification data for the supplied type.

See Also:

getTestDataTypes(), ITestData

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)

getChannel

public IChannel getChannel()

return the channel for the object.

Overrides:

getChannel in class ProxyTestObject

getChildAtPoint

public java.lang.Object getChildAtPoint(java.awt.Point pt)

Finds the child object that is at the specified point. Note that the point is relative to the top left corner of the screen, and not the component itself or its parent.

If this object has no children, it should return null.

Overrides:

getChildAtPoint in class JavaGuiProxy

Parameters:

pt - Screen relative point to check.

Returns:

The object at the point or null if no child object is found.

See Also:

getScreenRectangle()

setText

public void setText(java.lang.String text)

Set the text for the labelled edit part

Parameters:

text -

getDataDrivableCommand

public MethodSpecification getDataDrivableCommand()

This method must be implemented by any proxy that wishes to support data driving. By default a null value is returned.

Specified by:

getDataDrivableCommand in interface IDataDriven

Overrides:

getDataDrivableCommand in class ProxyTestObject

Since:

RFT8.0

See Also:

ProxyTestObject.getDataDrivableCommands(int)

getTestObjectClassName

public java.lang.String getTestObjectClassName()

The default GUI test object classname is returned. More specific test objects are returned by more constrained proxy classes. This level of support is always required.

Specified by:

getTestObjectClassName in interface IProxyBase

Overrides:

getTestObjectClassName in class JavaGuiProxy

Returns:

The default test object class full name.

activateTopWindow

protected void activateTopWindow()

Request for focus on the figure

Overrides:

activateTopWindow in class JavaGuiProxy

shouldBeMapped

public boolean shouldBeMapped()

Returns true; by default all test objects are mapped. This method should be overriden by proxies that do not contain interesting persistent information. Objects that the script may want to interact with should always return true.

Overrides:

shouldBeMapped in class JavaGuiProxy

Returns:

true, unless overriden in a super class.

scrollRectToVisible

public void scrollRectToVisible(java.awt.Rectangle rect)

Scrolls the viewport(if it exists) so that the rectangle within the viewport becomes visible. By default, it does nothing.

Overrides:

scrollRectToVisible in class JavaGuiProxy

getClippedScreenRectangle

public java.awt.Rectangle getClippedScreenRectangle()

We clip with respect to Mappable parent

Overrides:

getClippedScreenRectangle in class JavaGuiProxy

getVisualClippedRectangle

public java.awt.Rectangle getVisualClippedRectangle()

Description copied from class: ProxyTestObject

The optimized way to obtain the ClippedRectangle.

Overrides:

getVisualClippedRectangle in class ProxyTestObject

Returns:

The ClippedScreen Rectangle of the control