com.rational.test.ft.domain.java.awt
Class ChoiceProxy

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.awt.ComponentProxy
                      com.rational.test.ft.domain.java.awt.ChoiceProxy

All Implemented Interfaces:

IChannelObject, IDataDriven, IProxyBase, IComboBox, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.IGraphicalSubitem, com.rational.test.ft.object.interfaces.ISelect

public class ChoiceProxy
extends ComponentProxy
implements com.rational.test.ft.object.interfaces.IGraphicalSubitem, com.rational.test.ft.object.interfaces.ISelect, IComboBox

Proxy for the AWT Choice (ComboListBox) objects.

• Test Object interface:
  SelectGuiSubitemTestObject
  

• Supported Test Data Types:
  

  Type	Desciption	Data Class
  list	Combo List Elements	ITestDataList
  selected	Selected List Element	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.
  .itemText	The text for the up to ten items from the list.
  .priorLabel	The text of a preceding label. Suppressed if there is no preceding label.
  itemCount	The number of items in the list.
  name	The name property, suppressed if default formatted (default form = className+count).

  
  

• Supported Subitems:
  

  Subitem	Usage
  Text	Defines the element with the specified visible text.
  Index	Defines the element at the specified zero-based index.

  
  

Nested Class Summary

Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

ComponentProxy.ChildEnumerator, ComponentProxy.ImmediateChildEnumerator

Field Summary

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

ChoiceProxy(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	click() Left mouse click on the center point of the associated TestObject; is a simple shortcut to the click method with a modifier parameter (modifier set to MOUSE_LEFT).
void	click(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem) Perform a mouse click action at the specified object relative coordinates within the associated TestObject.
void	click(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Perform a mouse click action on the specified coordinates relative to the associated TestObject.
void	click(com.rational.test.ft.script.Subitem subitem) Left mouse click on the center point of the associated subitem.
void	click(com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Left mouse click on the specified coordinates relative to the associated TestObject.
void	doubleClick(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem) Perform a mouse dbl-click action at the specified object relative coordinates within the associated TestObject.
void	doubleClick(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Perform a mouse dbl-click action on the specified coordinates relative to the associated TestObject.
void	doubleClick(com.rational.test.ft.script.Subitem subitem) Left mouse dbl-click on the center point of the associated TestObject.
void	doubleClick(com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Left mouse dbl-click on the specified coordinates relative to the associated TestObject.
void	drag() Perform a MOUSE_LEFT drag action against the associated TestObject.
void	drag(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem) Perform a drag action against the associated TestObject with the supplied set of mouse modifiers.
void	drag(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem1, java.awt.Point pt1, com.rational.test.ft.script.Subitem subitem2, java.awt.Point pt2) Perform a drag action against the associated TestObject.
void	drag(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem1, com.rational.test.ft.script.Subitem subitem2) Perform a drag action against the associated TestObject.
void	drag(com.rational.test.ft.script.Subitem subitem) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	drag(com.rational.test.ft.script.Subitem subitem1, java.awt.Point pt1, com.rational.test.ft.script.Subitem subitem2, java.awt.Point pt2) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	drag(com.rational.test.ft.script.Subitem subitem1, com.rational.test.ft.script.Subitem subitem2) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point screenPt) Perform a drag action against the associated TestObject.
void	dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Perform a drag action against the associated TestObject.
void	dragToScreenPoint(com.rational.test.ft.script.Subitem subitem, java.awt.Point screenPt) Perform a MOUSE_LEFT drag action against the associated TestObject.
void	dragToScreenPoint(com.rational.test.ft.script.Subitem subitem, java.awt.Point subitemPt, 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.
protected java.awt.Rectangle	getClickActionRect() Gets the screen relative rectangle and throws an invalid action exception if the rectangle is not valid.
com.rational.test.ft.sys.MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
int	getItemCount() This method returns the number of items available in the associated ComboBox control.
protected java.lang.String[]	getItems(int limit)
java.lang.String	getItemText(int itemIndex) This method returns the text of the item at the specified index.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_COMBO_BOX.
java.awt.Point	getScreenPoint(com.rational.test.ft.script.Subitem subitem) Returns the screen relative point to the center of the supplied subitem.
java.awt.Point	getScreenPoint(com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Returns the screen relative point given a subitem and a subitem relative point.
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.
int	getSelectedIndex() This method returns the index of the selected item in the associated ComboBox control.
java.lang.String	getSelectedText() Allows direct access to the selected text property on the control.
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 test object that implements IGraphicalSubitem.
java.lang.String	getText() Allows direct access to the text property on the control.
void	hover(double secondDelay, com.rational.test.ft.script.Subitem subitem) Hover the mouse over the center of the specified subitem.
void	hover(double secondDelay, com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Hover the mouse over the specified coordinates relative to the specified subitem.
void	hover(com.rational.test.ft.script.Subitem subitem) Hovers the mouse over the specified specified subitem.
void	hover(com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Hovers the mouse over the specified coordinates relative to the specified subitem.
protected boolean	isEditable() Returns true if this Choice is editable.
void	mouseMove(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem) Perform a move action against the associated TestObject.
void	mouseMove(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Perform a move action against the associated TestObject.
void	mouseMove(com.rational.test.ft.script.Subitem subitem) Perform a MOUSE_LEFT move action against the associated TestObject.
void	mouseMove(com.rational.test.ft.script.Subitem subitem, java.awt.Point subitemPt) Perform a MOUSE_LEFT move action against the associated TestObject.
void	nClick(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point pt) Perform a mouse n-click action on the specified coordinates relative to the associated TestObject.
void	nClickDrag(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem1, java.awt.Point pt1, com.rational.test.ft.script.Subitem subitem2, java.awt.Point pt2) Perform a mouse n-click drag action on the specified coordinates relative to the associated TestObject.
void	nClickDrag(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem1, com.rational.test.ft.script.Subitem subitem2) 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, com.rational.test.ft.script.Subitem subitem, java.awt.Point screenPt) Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.
void	nClickDragToScreenPoint(int clickCount, com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt) Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.
boolean	needMethodSpecForPoint() Returns true if getMethodSpecForPoint should return a coordinate based action for drags onto the popup.
void	processSingleMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
void	select(int index) Directly modifies subitem selected in the control.
void	select(java.lang.String item) Directly modifies subitem selected in the control.
void	setState(com.rational.test.ft.script.Action action) This method performs a specific action.
void	setState(com.rational.test.ft.script.Action action, com.rational.test.ft.script.Subitem item) This method performs a specific action against the subitem at a specified index.
void	setState(com.rational.test.ft.script.Action action, com.rational.test.ft.script.Subitem start, com.rational.test.ft.script.Subitem end) This method performs a specific action against the subitem range defined by the specified indices.
com.rational.test.ft.vp.ITestData	updateTestData(java.lang.String testDataType, com.rational.test.ft.vp.ITestData testData) This method updates the supplied test data object and returns it.
protected java.awt.Rectangle	waitForScreenRectangle(int subitemIndex)

Methods inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getClippedRect, getComponentChildren, getDescriptiveName, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getScreenRectangle, getTopParent, getWindow, hasFocus, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, isOpaque, isRecognitionProperty, isShowing, isVScroll, setParent

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

activateTopWindow, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getClippedScreenRectangle, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, scrollRectToVisible, 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, getTopMappableParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, setIndexer, setProperty

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

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualClippedRectangle, 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

ChoiceProxy

public ChoiceProxy(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 test object that implements IGraphicalSubitem.

Specified by:

getTestObjectClassName in interface IProxyBase

Overrides:

getTestObjectClassName in class JavaGuiProxy

Returns:

The stateful test object class full name.

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_COMBO_BOX.

Overrides:

getRole in class ComponentProxy

Returns:

A brief type name that describes the role this object plays in the UI.

Since:

RFT1.0

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()

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

Overrides:

getChildrenEnumeration in class ComponentProxy

Returns:

null

isEditable

protected boolean isEditable()

Returns true if this Choice is editable.

Returns:

true if it is editable

getSelectedIndex

public int getSelectedIndex()

This method returns the index of the selected item in the associated ComboBox control.

Specified by:

getSelectedIndex in interface IComboBox

Returns:

The index of the selected item in the associated ComboBox control.

getItemCount

public int getItemCount()

This method returns the number of items available in the associated ComboBox control.

Specified by:

getItemCount in interface IComboBox

Returns:

The number of items available in the associated ComboBox control.

getItemText

public java.lang.String getItemText(int itemIndex)

This method returns the text of the item at the specified index.

Specified by:

getItemText in interface IComboBox

Parameters:

itemIndex - The zero-based index of the desired item.

Returns:

The text of the item at the specified index.

getItems

protected java.lang.String[] getItems(int limit)

needMethodSpecForPoint

public boolean needMethodSpecForPoint()

Returns true if getMethodSpecForPoint should return a coordinate based action for drags onto the popup.

Specified by:

needMethodSpecForPoint in interface IComboBox

Returns:

If getMethodSpecForPoint should be supported for the popup window.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Get the value for a specific property.

Overrides:

getProperty in class ComponentProxy

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)

getDataDrivableCommand

public com.rational.test.ft.sys.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:

RFT2.0

See Also:

ProxyTestObject.getDataDrivableCommands(int)

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.

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

Returns:

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

waitForScreenRectangle

protected java.awt.Rectangle waitForScreenRectangle(int subitemIndex)

getScreenPoint

public java.awt.Point getScreenPoint(com.rational.test.ft.script.Subitem subitem)

Returns the screen relative point to the center of the supplied subitem.

Specified by:

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

Parameters:

subitem - The subitem the resultant screen point is relative to.

Returns:

A screen relative point.

getScreenPoint

public java.awt.Point getScreenPoint(com.rational.test.ft.script.Subitem subitem,                                      java.awt.Point pt)

Returns the screen relative point given a subitem and a subitem relative point.

Specified by:

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

Parameters:

subitem - The subitem the resultant screen point is relative to.

pt - The subitem relative point.

Returns:

A screen relative point.

getSubitem

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

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.

Note that if the resulting type is not a value class that a test object for the object will be supplied. For instance MyMenuBar().getSubitem(atPath("File->New")) would return the TestObject for the New menu item (with all the associated methods available). A simpler example may be that myList().getSubitem(atIndex(4)) will commonly just return the text for the item in the 5th position (as a string).

WARNING: if the result of this call is a TestObject then the user is required to explicitly unregister the resulting test object. Failure to do so will cause objects to be pinned in the memory of the system under test.

Specified by:

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

Parameters:

subitem - The subitem to fetch an object for.

Returns:

An object representation of the subitem.

getSelectedText

public java.lang.String getSelectedText()

Description copied from interface: com.rational.test.ft.object.interfaces.ISelect

Allows direct access to the selected text property on the control.

Specified by:

getSelectedText in interface com.rational.test.ft.object.interfaces.ISelect

Returns:

The selected text in the control

getText

public java.lang.String getText()

Description copied from interface: com.rational.test.ft.object.interfaces.ISelect

Allows direct access to the text property on the control.

Specified by:

getText in interface com.rational.test.ft.object.interfaces.ISelect

Returns:

The text of all elements in the control

select

public void select(java.lang.String item)

Description copied from interface: com.rational.test.ft.object.interfaces.ISelect

Directly modifies subitem selected in the control. If the specified text is not in the controls list of elements, a SubitemNotFoundException is thrown.

Specified by:

select in interface com.rational.test.ft.object.interfaces.ISelect

Parameters:

item - the item to update the control with

See Also:

ISelect.select(int)

select

public void select(int index)

Description copied from interface: com.rational.test.ft.object.interfaces.ISelect

Directly modifies subitem selected in the control. If the specified index is not valid for the active list of elements in the control, a SubitemNotFoundException is thrown.

Specified by:

select in interface com.rational.test.ft.object.interfaces.ISelect

Parameters:

index - the index of the item to update the control with

See Also:

ISelect.select(String)

getClickActionRect

protected java.awt.Rectangle getClickActionRect()

Gets the screen relative rectangle and throws an invalid action exception if the rectangle is not valid.

Returns:

The adjusted rectangle surrounding component relative to the screen.

click

public void click()

Description copied from class: JavaGuiProxy

Left mouse click on the center point of the associated TestObject; is a simple shortcut to the click method with a modifier parameter (modifier set to MOUSE_LEFT).

Specified by:

click in interface com.rational.test.ft.object.interfaces.IGraphical

Overrides:

click in class JavaGuiProxy

drag

public void drag()

Description copied from class: JavaGuiProxy

Perform a MOUSE_LEFT drag action against the associated TestObject. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Specified by:

drag in interface com.rational.test.ft.object.interfaces.IGraphical

Overrides:

drag in class JavaGuiProxy

click

public void click(com.rational.test.ft.script.Subitem subitem)

Left mouse click on the center point of the associated subitem. This method is a simple shortcut to the click method with a modifier parameter (modifier set to MOUSE_LEFT).

Specified by:

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

click

public void click(com.rational.test.ft.script.MouseModifiers modifiers,                   com.rational.test.ft.script.Subitem subitem)

Perform a mouse click action at the specified object relative coordinates within the associated TestObject.

Specified by:

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

click

public void click(com.rational.test.ft.script.Subitem subitem,                   java.awt.Point pt)

Left mouse click on the specified coordinates relative to the associated TestObject. This method is a simple shortcut to the click method with a modifier parameter and coordinates (modifier set to MOUSE_LEFT).

Specified by:

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

click

public void click(com.rational.test.ft.script.MouseModifiers modifiers,                   com.rational.test.ft.script.Subitem subitem,                   java.awt.Point pt)

Perform a mouse click action on the specified coordinates relative to the associated TestObject.

Specified by:

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

doubleClick

public void doubleClick(com.rational.test.ft.script.Subitem subitem)

Left mouse dbl-click on the center point of the associated TestObject. This method is a simple shortcut to the dbl-click method with a modifier parameter (modifier set to MOUSE_LEFT).

Specified by:

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

doubleClick

public void doubleClick(com.rational.test.ft.script.MouseModifiers modifiers,                         com.rational.test.ft.script.Subitem subitem)

Perform a mouse dbl-click action at the specified object relative coordinates within the associated TestObject.

Specified by:

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

doubleClick

public void doubleClick(com.rational.test.ft.script.Subitem subitem,                         java.awt.Point pt)

Left mouse dbl-click on the specified coordinates relative to the associated TestObject. This method is a simple shortcut to the dbl-click method with a modifier parameter and coordinates (modifier set to MOUSE_LEFT).

Specified by:

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

doubleClick

public void doubleClick(com.rational.test.ft.script.MouseModifiers modifiers,                         com.rational.test.ft.script.Subitem subitem,                         java.awt.Point pt)

Perform a mouse dbl-click action on the specified coordinates relative to the associated TestObject.

Specified by:

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

nClick

public void nClick(int clickCount,                    com.rational.test.ft.script.MouseModifiers modifiers,                    com.rational.test.ft.script.Subitem subitem,                    java.awt.Point pt)

Perform a mouse n-click action on the specified coordinates relative to the associated TestObject.

Specified by:

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

drag

public void drag(com.rational.test.ft.script.Subitem subitem)

Perform a MOUSE_LEFT drag action against the associated TestObject. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Specified by:

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

drag

public void drag(com.rational.test.ft.script.MouseModifiers modifiers,                  com.rational.test.ft.script.Subitem subitem)

Perform a drag action against the associated TestObject with the supplied set of mouse modifiers. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Specified by:

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

drag

public void drag(com.rational.test.ft.script.Subitem subitem1,                  com.rational.test.ft.script.Subitem subitem2)

Perform a MOUSE_LEFT 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.IGraphicalSubitem

drag

public void drag(com.rational.test.ft.script.MouseModifiers modifiers,                  com.rational.test.ft.script.Subitem subitem1,                  com.rational.test.ft.script.Subitem subitem2)

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

drag

public void drag(com.rational.test.ft.script.Subitem subitem1,                  java.awt.Point pt1,                  com.rational.test.ft.script.Subitem subitem2,                  java.awt.Point pt2)

Perform a MOUSE_LEFT 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.IGraphicalSubitem

drag

public void drag(com.rational.test.ft.script.MouseModifiers modifiers,                  com.rational.test.ft.script.Subitem subitem1,                  java.awt.Point pt1,                  com.rational.test.ft.script.Subitem subitem2,                  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.IGraphicalSubitem

nClickDrag

public void nClickDrag(int clickCount,                        com.rational.test.ft.script.MouseModifiers modifiers,                        com.rational.test.ft.script.Subitem subitem1,                        com.rational.test.ft.script.Subitem subitem2)

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

nClickDrag

public void nClickDrag(int clickCount,                        com.rational.test.ft.script.MouseModifiers modifiers,                        com.rational.test.ft.script.Subitem subitem1,                        java.awt.Point pt1,                        com.rational.test.ft.script.Subitem subitem2,                        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.IGraphicalSubitem

dragToScreenPoint

public void dragToScreenPoint(com.rational.test.ft.script.Subitem subitem,                               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 the screen relative screenPt coordinates.

Specified by:

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

dragToScreenPoint

public void dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers,                               com.rational.test.ft.script.Subitem subitem,                               java.awt.Point screenPt)

Perform a drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to the screen relative screenPt coordinates.

Specified by:

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

dragToScreenPoint

public void dragToScreenPoint(com.rational.test.ft.script.Subitem subitem,                               java.awt.Point subitemPt,                               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 the screen relative screenPt coordinates.

Specified by:

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

dragToScreenPoint

public void dragToScreenPoint(com.rational.test.ft.script.MouseModifiers modifiers,                               com.rational.test.ft.script.Subitem subitem,                               java.awt.Point subitemPt,                               java.awt.Point screenPt)

Perform a drag action against the associated TestObject. The action is performed from (x, y) relative to this TestObject to the screen relative screenPt coordinates.

Specified by:

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

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,                                     com.rational.test.ft.script.MouseModifiers modifiers,                                     com.rational.test.ft.script.Subitem subitem,                                     java.awt.Point screenPt)

Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.

Specified by:

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

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,                                     com.rational.test.ft.script.MouseModifiers modifiers,                                     com.rational.test.ft.script.Subitem subitem,                                     java.awt.Point subitemPt,                                     java.awt.Point screenPt)

Perform a mouse n-click drag action on the specified coordinates relative the screen relative screenPt coordinates.

Specified by:

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

mouseMove

public void mouseMove(com.rational.test.ft.script.Subitem subitem)

Perform a MOUSE_LEFT move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Specified by:

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

mouseMove

public void mouseMove(com.rational.test.ft.script.Subitem subitem,                       java.awt.Point subitemPt)

Perform a MOUSE_LEFT move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Specified by:

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

mouseMove

public void mouseMove(com.rational.test.ft.script.MouseModifiers modifiers,                       com.rational.test.ft.script.Subitem subitem)

Perform a move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Specified by:

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

mouseMove

public void mouseMove(com.rational.test.ft.script.MouseModifiers modifiers,                       com.rational.test.ft.script.Subitem subitem,                       java.awt.Point pt)

Perform a move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates relative to this TestObject.

Specified by:

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

hover

public void hover(double secondDelay,                   com.rational.test.ft.script.Subitem subitem)

Hover the mouse over the center of the specified subitem. The mouse is moved to the center of the subitem and stays there for at least the specified number of milliseconds.

Specified by:

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

hover

public void hover(double secondDelay,                   com.rational.test.ft.script.Subitem subitem,                   java.awt.Point pt)

Hover the mouse over the specified coordinates relative to the specified subitem. The mouse is moved to the subitem relative coordinates and stays there for at least the specified number of milliseconds.

Specified by:

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

hover

public void hover(com.rational.test.ft.script.Subitem subitem)

Hovers the mouse over the specified specified subitem. The mouse is moved to the subitem and stays there for a default length of time.

Specified by:

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

Since:

RFT1.0

hover

public void hover(com.rational.test.ft.script.Subitem subitem,                   java.awt.Point pt)

Hovers the mouse over the specified coordinates relative to the specified subitem. The mouse is moved to the subitem relative coordinates and stays there for a default length of time.

Specified by:

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

Since:

RFT1.0

setState

public void setState(com.rational.test.ft.script.Action action,                      com.rational.test.ft.script.Subitem item)

This method performs a specific action against the subitem at a specified index.

Parameters:

item - The item to act upon.

action - The action that should be performed.

setState

public void setState(com.rational.test.ft.script.Action action)

This method performs a specific action.

Parameters:

action - The action that should be performed.

setState

public void setState(com.rational.test.ft.script.Action action,                      com.rational.test.ft.script.Subitem start,                      com.rational.test.ft.script.Subitem end)

This method performs a specific action against the subitem range defined by the specified indices.

Parameters:

start - The first item to act upon.

end - The last item to act upon.

action - The action that should be performed.

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

updateTestData

public com.rational.test.ft.vp.ITestData updateTestData(java.lang.String testDataType,                                                         com.rational.test.ft.vp.ITestData testData)

This method updates the supplied test data object and returns it. The testDataType parameter is one of the hashtable keys returned by getTestDataTypes. The testData is a previously supplied ITestData object that needs to be updated to reflect the current state of the associated test object.

Overrides:

updateTestData in class ProxyTestObject

Parameters:

testDataType - A test data type supplied by getTestDataTypes.

testData - The test data base object that requires updating.

Returns:

The testData passed in with appropriate updates.

See Also:

getTestDataTypes(), ITestData