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

java.lang.Object   com.rational.test.ft.sys.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
                      com.rational.test.ft.domain.java.swt.ScrollableProxy
                          com.rational.test.ft.domain.java.swt.ScrollableSwtGraphicalSubitemProxy
                              com.rational.test.ft.domain.java.swt.ToolBarProxy

All Implemented Interfaces:

IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.IGraphicalSubitem, com.rational.test.ft.object.interfaces.IScrollable

public class ToolBarProxy
extends ScrollableSwtGraphicalSubitemProxy

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

• TestObject interface:
  GuiSubitemTestObject
  
  

• Supported Test Data Types:
  

  Type	Desciption	Data Class
  items	ToolItems Text	ITestDataList
  extendedItems	ToolItems with Properties	ITestDataList

  
  
  

• 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.
  .itemText	The text for the up to ten items of the toolbar.
  .itemToolTipText	The tooltiptext for the up to ten items of the toolbar.
  .itemCount	The number of toolitems within the toolbar.

  
  
  

• Supported Subitems:
  

  Subitem	Usage
  Text	Defines the ToolItem with the specified visible text.
  ToolTipText	Defines the ToolItem with the specified ToolTipText.
  Separator	Defines the specific separator located on the toolbar.
  Index	Defines the ToolItem at the specified zero-based index.

  
  

  Nested Class Summary

  Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.swt.ControlProxy

  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

  ToolBarProxy(java.lang.Object theObjectInTheSUT)
  This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.

  Method Summary

  protected java.util.Vector	getActionArgs(java.awt.Point point) Set the desired action arguments for the event during recording.
  java.util.Enumeration	getImmediateChildren() Return an enumeration of proxies for the children of this object.
  ProxyTestObject[]	getMappableChildren() Uses getChildren to implement.
  java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
  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.
  protected void	getStyleForItems()
  java.lang.Object	getSubitem(com.rational.test.ft.script.Subitem subitem) Returns an object that represents the specified subitem in the associated test object.
  com.rational.test.ft.vp.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() Return the GuiSubitemTestObject classname.
  void	processMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.

  Methods inherited from class com.rational.test.ft.domain.java.swt.ScrollableSwtGraphicalSubitemProxy

  click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getScreenPoint, getScreenPoint, hover, hover, hover, hover, hScrollTo, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint, scrollLineDown, scrollLineLeft, scrollLineRight, scrollLineUp, scrollPageDown, scrollPageLeft, scrollPageRight, scrollPageUp, setState, vScrollTo

  Methods inherited from class com.rational.test.ft.domain.java.swt.ScrollableProxy

  canBeScrolled, getClientArea, getHorizontalBar, getVerticalBar, hScroll, isHorizontalScrollable, isPointInClientArea, isScrollable, isVerticalScrollable, processSingleMouseEvent, scrollRectToVisible, vScroll

  Methods inherited from class com.rational.test.ft.domain.java.swt.ControlProxy

  childConstructed, getChannel, getChildProxy, getChildrenEnumeration, getClippedScreenRectangle, getDefaultActionArgs, getDescriptiveName, getHandle, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParentObject, getReorderedChildren, getScreenRectangle, getStyle, getToolTipText, getTopMappableParent, getTopParent, getVisualClippedRectangle, hasFocus, isEnabled, isGTK, isLabelled, isObjectMoved, isShell, isShowing, processHoverMouseEvent, processPreDownMouseEvent, processPreUpMouseEvent, 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, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getMethodSpecForPoint, 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, getMethods, getNonValueProperties, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getStandardProperties, 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, 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

  ToolBarProxy

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

  getTestObjectClassName

  public java.lang.String getTestObjectClassName()

  Return the GuiSubitemTestObject classname.

  Specified by:

  getTestObjectClassName in interface IProxyBase

  Overrides:

  getTestObjectClassName in class ScrollableSwtGraphicalSubitemProxy

  Returns:

  The default IGraphicalSubitem test object class full name.

  getRole

  public java.lang.String getRole()

  Returns TestObjectRole.ROLE_TOOL_BAR.

  Overrides:

  getRole in class ControlProxy

  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 ControlProxy

  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)

  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.

  getMappableChildren

  public ProxyTestObject[] getMappableChildren()

  Description copied from class: JavaProxy

  Uses getChildren to implement.

  Overrides:

  getMappableChildren in class JavaProxy

  Returns:

  null, if no known children.

  getScreenRectangle

  public java.awt.Rectangle getScreenRectangle(com.rational.test.ft.script.Subitem subitem)

  Description copied from class: ScrollableSwtGraphicalSubitemProxy

  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 ScrollableSwtGraphicalSubitemProxy

  Returns:

  The adjusted rectangle surrounding subitem relative to the screen. null is returned if the subitem is not showing.

  getSubitem

  public java.lang.Object getSubitem(com.rational.test.ft.script.Subitem subitem)

  Description copied from class: ScrollableSwtGraphicalSubitemProxy

  Returns an object that represents the specified subitem in the associated test object. SubitemNotFoundException will be thrown if the specified subitem is invalid relative to the associated test object. null may be returned if the subitem does not have an object association that can be returned.

  Specified by:

  getSubitem in interface com.rational.test.ft.object.interfaces.IGraphicalSubitem

  Specified by:

  getSubitem in class ScrollableSwtGraphicalSubitemProxy

  Parameters:

  subitem - The subitem to fetch an object for.

  Returns:

  An object representation of the subitem.

  getStyleForItems

  protected void getStyleForItems()

  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

  getActionArgs

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

  Set the desired action arguments for the event during recording. Derived classes should override this method to set the desired action, the default is to generate an atPoint() action.

  Overrides:

  getActionArgs in class ControlProxy

  Parameters:

  point - Screen point where action ocurred

  Returns:

  Vector of action arguments

  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 com.rational.test.ft.vp.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