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.jfc
Class JToolBarProxy

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.jfc.JComponentProxy
                          extended by com.rational.test.ft.domain.java.jfc.JfcGraphicalSubitemProxy
                              extended by com.rational.test.ft.domain.java.jfc.JToolBarProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.IGraphicalSubitem

public class JToolBarProxy
extends JfcGraphicalSubitemProxy

Proxy class for javax.swing.JToolBar.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy
ComponentProxy.ImmediateChildEnumerator
 
Field Summary
 
Fields inherited from class com.rational.test.ft.domain.java.jfc.JComponentProxy
TAB_INDEX, TAB_TEXT
 
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.domain.IDataDriven
INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS
 
Constructor Summary
JToolBarProxy(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 childConstructed(ProxyTestObject child)
          Inform the parent when child proxies are constructed so additional recognition properties can be added when needed.
 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.
 void dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
          Perform a drag action against the associated TestObject.
 void dragToScreenPoint(java.awt.Point screenPt)
          Performs a MOUSE_LEFT drag action against the associated TestObject.
 void dragToScreenPoint(java.awt.Point objectPt, java.awt.Point screenPt)
          Perform a MOUSE_LEFT drag action against the associated TestObject.
 java.util.Enumeration getChildrenEnumeration()
          Return an enumeration of proxies for the children of this object.
 com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)
          Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
 java.lang.String getRole()
          Returns TestObjectRole.ROLE_TOOL_BAR.
 java.awt.Rectangle getScreenRectangle(com.rational.test.ft.script.Subitem subitem)
          Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
 JSeparatorProxy getSeparatorProxy(com.rational.test.ft.script.Subitem item)
          This method gets the proxy related to the Subitem.
protected  ProxyTestObject[] getSeparatorsArray()
           
 void nClickDrag(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
          Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
 void nClickDragToScreenPoint(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
          Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
 void processSingleMouseEvent(IMouseActionInfo action)
          Return a MethodSpecification for the specified mouse event.
 
Methods inherited from class com.rational.test.ft.domain.java.jfc.JfcGraphicalSubitemProxy
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getScreenPoint, getScreenPoint, getSubitem, getTestObjectClassName, hover, hover, hover, hover, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint
 
Methods inherited from class com.rational.test.ft.domain.java.jfc.JComponentProxy
getBorderTitle, getClippedRect, getClippedScreenRectangle, getDescriptiveName, getProperties, getProperty, getStandardProperties, getText, getVisibleRectangle, getVisualClippedRectangle, hasFocus, isOpaque, isPointInObject, isType, scrollRectToVisible
 
Methods inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy
canBeScrolled, getChildAtPoint, getChildProxy, getComponentChildren, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getScreenRectangle, getTopParent, getWindow, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, 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, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, processHoverMouseEvent, processMouseEvent, setProcessMouseEventHandler, setTopLevelWindow, shouldBeMapped
 
Methods inherited from class com.rational.test.ft.domain.java.JavaProxy
addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMethods, getNonValueProperties, getRecognitionProperties, getRecognitionPropertyWeight, 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
 

Constructor Detail

JToolBarProxy

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

getRole

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

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

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 ComponentProxy
Parameters:
child - The child proxy that was just constructed.

getChildrenEnumeration

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

Overrides:
getChildrenEnumeration in class ComponentProxy
Returns:
The child proxies relative to this proxy.

getSeparatorsArray

protected ProxyTestObject[] getSeparatorsArray()

getSeparatorProxy

public JSeparatorProxy getSeparatorProxy(com.rational.test.ft.script.Subitem item)
This method gets the proxy related to the Subitem.

Parameters:
item - Subitem of the JToolBarProxy
Returns:
The JSeparatorProxy related to the item.

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)
Return a MethodSpecification for the specified mouse event. This is the primary record interface for mouse events against a particular control.

Overrides:
processSingleMouseEvent in class JavaGuiProxy
Parameters:
action - The event cache and other mouse state information for this mouse action.

getMethodSpecForPoint

public com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)
Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default a method specification for IGraphical.getScreenPoint will be returned. However, if a proxy can find

Overrides:
getMethodSpecForPoint in class JavaGuiProxy
Parameters:
x - The screen relative x coordinate.
y - The screen relative y coordinate.
See Also:
MethodSpecification

getScreenRectangle

public java.awt.Rectangle getScreenRectangle(com.rational.test.ft.script.Subitem subitem)
Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen. This will commonly be two operations (getScreenRectangle for the parent object and then adjusting for the specified subitem) combined into a single operation. The rectangle is exposed so that actions may be directly scripted against a visible subitem. null is returned if the subitem is not showing.

Specified by:
getScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphicalSubitem
Specified by:
getScreenRectangle in class JfcGraphicalSubitemProxy
Returns:
The adjusted rectangle surrounding subitem relative to the screen. null is returned if the subitem is not showing.

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

nClickDrag

public void nClickDrag(int clickCount,                        com.rational.test.ft.script.MouseModifiers modifiers,                        java.awt.Point pt1,                        java.awt.Point pt2)
Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.

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

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point screenPt)
Performs a MOUSE_LEFT drag action against the associated TestObject. The action is performed from a valid point within this TestObject to the screen relative screenPt coordinates.

Specified by:
dragToScreenPoint in interface com.rational.test.ft.object.interfaces.IGraphical
Overrides:
dragToScreenPoint in class JavaGuiProxy
Since:
RFT1.0

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point objectPt,                               java.awt.Point screenPt)
Perform a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to target(x2, y2) coordinates.

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

dragToScreenPoint

public void dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers,                               java.awt.Point objectPt,                               java.awt.Point screenPt)
Perform a drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to target(x2, y2) coordinates.

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

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,                                     com.rational.test.ft.script.MouseModifiers modifiers,                                     java.awt.Point objectPt,                                     java.awt.Point screenPt)
Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.

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