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 CoolItemProxy

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

public class CoolItemProxy
extends ButtonProxy

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


Nested Class Summary
 
Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.swt.ControlProxy
ControlProxy.ChildEnumerator, ControlProxy.ImmediateChildEnumerator
 
Field Summary
 
Fields inherited from class com.rational.test.ft.domain.java.swt.ControlProxy
childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, clickArgs, currentMethod, GROUPTEXT, GROUPTEXTWEIGHT, HANDLE, MAPPABLECLASSINDEX, MAPPABLECLASSINDEXWEIGHT, MAX_NAME, predownScreenRect, PRIORLABEL, PRIORLABELWEIGHT, TOOLTIPTEXT, 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, 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
CoolItemProxy(java.lang.Object theObjectInTheSUT)
          This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.
 
Method Summary
 void drag(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
          Perform a drag action against the associated TestObject.
 IChannel getChannel()
          return a channel for the object.
 java.util.Enumeration getChildrenEnumeration()
          Return an enumeration of proxies for the children of this object.
 java.util.Enumeration getImmediateChildren()
          Return an enumeration of proxies for the children of this object.
protected  java.lang.String getLeadingLabel()
          This method is used to generate an interesting descriptive name for controls without persistent text.
 ProxyTestObject getMappableParent()
          Returns a proxy object for the parent of this 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.
 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()
           
 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.
 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 apposed to hidden).
 void processMouseEvent(IMouseActionInfo action)
          Return a MethodSpecification for the specified mouse event.
 
Methods inherited from class com.rational.test.ft.domain.java.swt.ButtonProxy
clickToState, clickToState, deselect, dragToState, dragToState, getDescriptiveName, getLabel, getMethodSpecForPoint, getRole, getState, getTestData, getTestDataTypes, getTestObjectClassName, getUniqueId, indeterminate, processSingleMouseEvent, select, setState, updateTestData
 
Methods inherited from class com.rational.test.ft.domain.java.swt.ControlProxy
childConstructed, getActionArgs, getChildProxy, getClippedScreenRectangle, getDefaultActionArgs, getHandle, getLabelText, getLocationOnScreen, getName, getReorderedChildren, getToolTipText, getVisualClippedRectangle, hasFocus, isGTK, isLabelled, isObjectMoved, isShell, processHoverMouseEvent, processPreDownMouseEvent, processPreUpMouseEvent, scrollRectToVisible, setClickArgs, setDownPointArgs, setDrag, setMethodSpecification, setMultiClickAction, setRecordCache
 
Methods inherited from class com.rational.test.ft.domain.java.JavaGuiProxy
activateTopWindow, click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, 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, getTestDomain, 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, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction
 
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

CoolItemProxy

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

isShowing

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

Specified by:
isShowing in interface com.rational.test.ft.object.interfaces.IGraphical
Overrides:
isShowing in class ControlProxy
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 interface com.rational.test.ft.object.interfaces.IGraphical
Overrides:
isEnabled in class ControlProxy
Returns:
true if component is enabled, else false.

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 interface com.rational.test.ft.object.interfaces.IGraphical
Overrides:
getScreenRectangle in class ControlProxy
Returns:
The adjusted rectangle surrounding component relative to the screen.
See Also:
IGraphical.isPointInObject(java.awt.Point), IGraphical.getClippedScreenRectangle()

getStyle

protected int getStyle()
Overrides:
getStyle in class ControlProxy

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 ControlProxy
Returns:
The proxy for the parent test object or null for a top level window.

getMappableParent

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

Overrides:
getMappableParent in class ControlProxy
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 ControlProxy
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 ControlProxy
Returns:
The proxy for the top parent test object or itself 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.

Overrides:
getParentObject in class ControlProxy
Returns:
The parent test object or null for a top level window.

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()
Return an enumeration of proxies for the children of this object.

Overrides:
getChildrenEnumeration in class ControlProxy
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.

Overrides:
getImmediateChildren in class ControlProxy
Returns:
The child proxies relative to this proxy.

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

Overrides:
getLeadingLabel in class ControlProxy
Returns:
A leading label components text.

getProperty

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

Overrides:
getProperty in class ButtonProxy
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 a channel for the object.

Specified by:
getChannel in interface IChannelObject
Overrides:
getChannel in class ControlProxy
Returns:
the channel used by this object.

processMouseEvent

public void processMouseEvent(IMouseActionInfo action)
Description copied from class: JavaGuiProxy
Return a MethodSpecification for the specified mouse event. This is the primary record interface for mouse events against a particular control.

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

drag

public void drag(com.rational.test.ft.script.MouseModifiers modifiers,                  java.awt.Point pt1,                  java.awt.Point pt2)
Perform a drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates relative to this TestObject.

Specified by:
drag in interface com.rational.test.ft.object.interfaces.IGraphical
Overrides:
drag in class JavaGuiProxy