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

Class ControlProxy

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.swt.ControlProxy

All Implemented Interfaces:

IDataDriven, IProxyBase, IPropertyFilter

Direct Known Subclasses:

ButtonProxy, CLabelProxy, EmbeddedShellProxy, GroupProxy, LabelProxy, SashFormProxy, SashProxy, ScaleProxy, ScrollableProxy, ScrollBarProxy, ShellProxy, SliderProxy, SwtGraphicalSubitemProxy, ViewFormProxy

public class ControlProxy
extends JavaGuiProxy

This is the proxy class for org.eclipse.swt.widgets.Control.

• TestObject interface:
  GuiTestObject
  
  
• Default Recognition Properties:
  

  Property	Usage
  .class	The Java full class name of the test object.
  .classIndex	The zero-based index of the class relative to the immediate parent in the object map.
  .priorLabel	The text of a preceding label. Suppressed if there is no preceding label.
  .groupText	The text of a group parent. Only available if parent is a group. Omitted if the group parent has no visible text.
  .toolTipText	The text from the associated tool tip, omitted if there is no associated tool tip.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ControlProxy.ChildEnumerator
protected class	ControlProxy.ImmediateChildEnumerator

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	childrenEnumerated
protected static java.lang.String	CLASSINDEX
protected static int	CLASSINDEXWEIGHT
protected java.util.Vector	clickArgs
protected java.lang.String	currentMethod
protected static java.lang.String	GROUPTEXT
protected static int	GROUPTEXTWEIGHT
protected static java.lang.String	HANDLE
protected static java.lang.String	MAPPABLECLASSINDEX
protected static int	MAPPABLECLASSINDEXWEIGHT
protected static int	MAX_NAME
protected java.awt.Rectangle	predownScreenRect
protected static java.lang.String	PRIORLABEL
protected static int	PRIORLABELWEIGHT
protected static java.lang.String	TOOLTIPTEXT
protected static int	TOOLTIPTEXTWEIGHT

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
ControlProxy(java.lang.Object theObjectInTheSUT) This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.

Method Summary

Methods

Modifier and Type	Method and Description
void	childConstructed(ProxyTestObject child) Inform the parent when child proxies are constructed so additional recognition properties can be added when needed.
protected java.util.Vector	getActionArgs(java.awt.Point point)
IChannel	getChannel() return the channel for the object.
protected ProxyTestObject	getChildProxy(java.lang.Object childObject)
java.util.Enumeration	getChildrenEnumeration() Return an enumeration of proxies for the children of this object.
java.awt.Rectangle	getClippedScreenRectangle()
protected java.util.Vector	getDefaultActionArgs(java.awt.Point point)
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
ProxyTestObject	getElementWithFocus() Return the element with focus
long	getHandle() Get the value for the handle field.
java.util.Enumeration	getImmediateChildren() Return an enumeration of proxies for the children of this object.
protected java.lang.String	getLabelText() Returns the label text associated with an isLabelled proxy.
protected java.lang.String	getLeadingLabel() This method is used to generate an interesting descriptive name for controls without persistent text.
java.awt.Point	getLocationOnScreen() Return the location on the screen for an swt control
ProxyTestObject	getMappableParent() Returns a proxy object for the parent of this object.
java.lang.String	getName() get the name of the object
ProxyTestObject[]	getOwnedObjects() Return an array of proxies for the objects owned by this object.
ProxyTestObject	getOwner() Returns a proxy object for the owner 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) Get the value for a specific property.
protected org.eclipse.swt.widgets.Widget[]	getReorderedChildren(org.eclipse.swt.widgets.Widget[] children)
java.lang.String	getRole() Returns TestObjectRole.ROLE_SWT.
java.awt.Rectangle	getScreenRectangle() Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
protected int	getStyle()
java.lang.String	getToolTipText() Returns the control's tool tip text, or null if it has not been set.
ProxyTestObject	getTopMappableParent() Returns a proxy object for the top parent of this object.
ProxyTestObject	getTopParent() Returns a proxy object for the top parent of this object.
java.awt.Rectangle	getVisualClippedRectangle() The optimized way to obtain the ClippedRectangle.
boolean	hasFocus() The hasFocus method is private in the SWT world, so this method always returns false.
boolean	isEnabled() Check the component under evaluation to determine if it is enabled or disabled.
protected boolean	isGTK() This method returns true if the application is an SWT/GTK+ application.
protected boolean	isLabelled() Returns true if the particular proxy has a label that can be used as a recognition property for another test object.
protected boolean	isObjectMoved(java.awt.Point endPoint)
protected boolean	isShell(java.lang.Object theTestObject)
boolean	isShowing() Check the component under evaluation to determine if it is showing (as apposed to hidden).
protected void	processHoverMouseEvent(IMouseActionInfo action)
protected void	processPreDownMouseEvent(IMouseActionInfo action) Process the Pre-down mouse event and determine what action might be recorded for this object (if any).
protected void	processPreUpMouseEvent(IMouseActionInfo action) Process the preup event and determine what action should be recorded for this object (if any).
void	scrollRectToVisible(java.awt.Rectangle rect) Scrolls the viewport(if there's any) so that Rectangle within the viewport becomes visible.
protected java.util.Vector	setClickArgs(int modifiers)
protected java.util.Vector	setDownPointArgs()
protected java.util.Vector	setDrag(IMouseActionInfo action, int modifiers, java.awt.Point firstPoint, java.awt.Point nthPoint)
protected void	setMethodSpecification(IMouseActionInfo action, java.lang.String method, java.util.Vector args, ScriptCommandFlags flags) Set the method specification for the action that should be recorded for the current set of events.
protected java.util.Vector	setMultiClickAction(IMouseActionInfo action, int clicks, int modifiers, boolean isDrag, java.awt.Point firstPoint, java.awt.Point lastPoint)
protected void	setRecordCache()

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

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

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

addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMappableChildren, getMethods, getNonValueProperties, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getStandardProperties, getTestDataTypes, getTestDomain, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, isRecognitionProperty, setIndexer, setProperty

Methods inherited from class com.rational.test.ft.domain.ProxyTestObject

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, 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 java.lang.Object

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

Field Detail

MAX_NAME

protected static final int MAX_NAME

See Also:

Constant Field Values

CLASSINDEX

protected static final java.lang.String CLASSINDEX

See Also:

Constant Field Values

MAPPABLECLASSINDEX

protected static final java.lang.String MAPPABLECLASSINDEX

See Also:

Constant Field Values

MAPPABLECLASSINDEXWEIGHT

protected static final int MAPPABLECLASSINDEXWEIGHT

See Also:

Constant Field Values

HANDLE

protected static final java.lang.String HANDLE

See Also:

Constant Field Values

CLASSINDEXWEIGHT

protected static final int CLASSINDEXWEIGHT

See Also:

Constant Field Values

PRIORLABEL

protected static final java.lang.String PRIORLABEL

See Also:

Constant Field Values

PRIORLABELWEIGHT

protected static final int PRIORLABELWEIGHT

See Also:

Constant Field Values

GROUPTEXT

protected static final java.lang.String GROUPTEXT

See Also:

Constant Field Values

GROUPTEXTWEIGHT

protected static final int GROUPTEXTWEIGHT

See Also:

Constant Field Values

TOOLTIPTEXT

protected static final java.lang.String TOOLTIPTEXT

See Also:

Constant Field Values

TOOLTIPTEXTWEIGHT

protected static final int TOOLTIPTEXTWEIGHT

See Also:

Constant Field Values

childrenEnumerated

protected boolean childrenEnumerated

predownScreenRect

protected java.awt.Rectangle predownScreenRect

clickArgs

protected java.util.Vector clickArgs

currentMethod

protected java.lang.String currentMethod

Constructor Detail

ControlProxy

public ControlProxy(java.lang.Object theObjectInTheSUT)

This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.

Method Detail

getName

public java.lang.String getName()

get the name of the object

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 be made unique to the script, but will act 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 will cause script compilation failures. An example of what to return may be "OKButton" for a swt.Button with the text "OK" on it.

Specified by:

getDescriptiveName in class JavaGuiProxy

Returns:

A descriptive object name.

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_SWT.

Overrides:

getRole in class JavaProxy

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)

Get 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)

getHandle

public long getHandle()

Get the value for the handle field. * 2007/12/20 by sky Create AXUIElement object.

getToolTipText

public java.lang.String getToolTipText()

Returns the control's tool tip text, or null if it has not been set.

Returns:

the receiver's tool tip text

isShowing

public boolean isShowing()

Check the component under evaluation to determine if it is showing (as apposed to hidden).

Specified by:

isShowing in class JavaGuiProxy

Returns:

true if component is showing, else false.

isEnabled

public boolean isEnabled()

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.

hasFocus

public boolean hasFocus()

The hasFocus method is private in the SWT world, so this method always returns false. Not a significant loss in functionality for SWT because the associated HWND can be queried to determine who has focus. Could monitor focus events, but just not that significant an issue for such drastic (and error prone) solution.

Specified by:

hasFocus in class JavaGuiProxy

Returns:

Always false for AWT.

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 will commonly be 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.

getClippedScreenRectangle

public java.awt.Rectangle getClippedScreenRectangle()

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

getLocationOnScreen

public java.awt.Point getLocationOnScreen()

Return the location on the screen for an swt control

getParent

public ProxyTestObject getParent()

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()

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.

isShell

protected boolean isShell(java.lang.Object theTestObject)

getMappableParent

public ProxyTestObject getMappableParent()

Returns a proxy object for the 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.

getTopParent

public ProxyTestObject getTopParent()

Returns a proxy object for the top parent of this object. Returns itself if this object has no parent.

Overrides:

getTopParent in class JavaProxy

Returns:

The proxy for the top parent test object or itself for a top level window.

getTopMappableParent

public ProxyTestObject getTopMappableParent()

Returns a proxy object for the top parent of this object. Returns itself if this object has no parent.

Overrides:

getTopMappableParent in class JavaProxy

Returns:

The proxy for the top parent test object or itself for a top level window.

getChildProxy

protected ProxyTestObject getChildProxy(java.lang.Object childObject)

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()

Return an enumeration of proxies for the children of this object.

Specified by:

getChildrenEnumeration in class JavaGuiProxy

Returns:

The child proxies relative to this proxy.

getImmediateChildren

public java.util.Enumeration getImmediateChildren()

Return an enumeration of proxies for the children of this object.

Specified by:

getImmediateChildren in class JavaGuiProxy

Returns:

The child proxies relative to this proxy.

getReorderedChildren

protected org.eclipse.swt.widgets.Widget[] getReorderedChildren(org.eclipse.swt.widgets.Widget[] children)

childConstructed

public void childConstructed(ProxyTestObject child)

Inform the parent when child proxies are constructed so additional recognition properties can be added when needed. By default nothing happens in this method.

Overrides:

childConstructed in class JavaProxy

Parameters:

child - The child proxy that was just constructed.

getStyle

protected int getStyle()

getOwner

public ProxyTestObject getOwner()

Returns a proxy object for the owner of this object. Returns null if this object has no owner.

Overrides:

getOwner in class JavaProxy

Returns:

The proxy for the owning object or null for a top object without an owner.

getOwnedObjects

public ProxyTestObject[] getOwnedObjects()

Return an array of proxies for the objects owned by this object.

Overrides:

getOwnedObjects in class JavaProxy

Returns:

An array of proxies of objects owned by this proxy.

getLeadingLabel

protected java.lang.String getLeadingLabel()

This method is used to generate an interesting descriptive name for controls without persistent text. This method returns the persistent text on a label that immediately precedes this control in the parents hierarchy.

Returns:

A leading label components text.

isLabelled

protected boolean isLabelled()

Returns true if the particular proxy has a label that can be used as a recognition property for another test object.

Returns:

true if the particular proxy has a label that can be used as a recognition property for another test object.

See Also:

getChildrenEnumeration(), getLabelText()

getLabelText

protected java.lang.String getLabelText()

Returns the label text associated with an isLabelled proxy. This text is used to recognize siblings in the test object finds. This method is only called if the proxy has reported itself as isLabelled().

Returns:

The label text associated with an isLabelled proxy.

See Also:

getChildrenEnumeration(), isLabelled()

getChannel

public IChannel getChannel()

return the channel for the object.

Overrides:

getChannel in class ProxyTestObject

isGTK

protected boolean isGTK()

This method returns true if the application is an SWT/GTK+ application.

Returns:

true if running under SWT/GTK+ false otherwise.

processPreDownMouseEvent

protected void processPreDownMouseEvent(IMouseActionInfo action)

Process the Pre-down mouse event and determine what action might be recorded for this object (if any). The action may be changed as subsequent events are processed.

Parameters:

action - recorder supplied ActionInfo

processPreUpMouseEvent

protected void processPreUpMouseEvent(IMouseActionInfo action)

Process the preup event and determine what action should be recorded for this object (if any).

Parameters:

action - recorder supplied ActionInfo

processHoverMouseEvent

protected void processHoverMouseEvent(IMouseActionInfo action)

Overrides:

processHoverMouseEvent in class JavaGuiProxy

setRecordCache

protected void setRecordCache()

setClickArgs

protected java.util.Vector setClickArgs(int modifiers)

setMethodSpecification

protected void setMethodSpecification(IMouseActionInfo action,
                          java.lang.String method,
                          java.util.Vector args,
                          ScriptCommandFlags flags)

Set the method specification for the action that should be recorded for the current set of events.

Parameters:

action -

method - name of method.

args - List of arguments to be recorded for the the method

flags - required script command flags to be recorded.

setDownPointArgs

protected java.util.Vector setDownPointArgs()

isObjectMoved

protected boolean isObjectMoved(java.awt.Point endPoint)

setDrag

protected java.util.Vector setDrag(IMouseActionInfo action,
                       int modifiers,
                       java.awt.Point firstPoint,
                       java.awt.Point nthPoint)

setMultiClickAction

protected java.util.Vector setMultiClickAction(IMouseActionInfo action,
                                   int clicks,
                                   int modifiers,
                                   boolean isDrag,
                                   java.awt.Point firstPoint,
                                   java.awt.Point lastPoint)

getDefaultActionArgs

protected java.util.Vector getDefaultActionArgs(java.awt.Point point)

getActionArgs

protected java.util.Vector getActionArgs(java.awt.Point point)

scrollRectToVisible

public void scrollRectToVisible(java.awt.Rectangle rect)

Scrolls the viewport(if there's any) so that Rectangle within the viewport becomes visible.

Overrides:

scrollRectToVisible in class JavaGuiProxy

getElementWithFocus

public ProxyTestObject getElementWithFocus()

Return the element with focus

Overrides:

getElementWithFocus in class ProxyTestObject