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

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

All Implemented Interfaces:

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

public class ListProxy
extends ComponentProxy
implements com.rational.test.ft.object.interfaces.IGraphicalSubitem, com.rational.test.ft.object.interfaces.IScrollable, com.rational.test.ft.object.interfaces.ISubitem

Proxy for te java.awt.List class.

• Test Object interface:
  GuiSubitemTestObject
  

• Supported Test Data Types:
  

  Type	Desciption	Data Class
  list	List Elements	ITestDataList
  selected	Selected List Elements	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).

  
  

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

ListProxy(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(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	deselect(int item) This method deselects a subitem at a specified index.
protected void	deselectAll()
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(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.
protected void	ensureIndexIsVisible(int index)
void	extendSelect(int item) This method extends the current selection to include a subitem at a specified index.
protected java.awt.Rectangle	getCellBounds(int index) Returns the bounds of the item in List coordinates.
com.rational.test.ft.sys.MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
protected int	getFirstVisibleIndex() Returns the index of the cell in the upper left corner of the JList or -1 if nothing is visible or the list is empty.
protected java.lang.String	getItem(int index)
protected int	getItemCount() This method returns the number of items available in the associated List control.
protected int	getItemIndex(java.lang.String item)
protected int	getItemIndex(com.rational.test.ft.script.Subitem item)
protected java.lang.String[]	getItems(int limit)
protected int	getLastVisibleIndex() Returns the index of the cell in the lower left corner of the JList or -1 if nothing is visible or the list is empty.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_LIST.
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.
java.lang.String	getSelectedText()
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 ListTestObject classname, the default list test object.
java.lang.String	getText()
protected boolean	hasItem(java.lang.String item)
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.
void	hScrollTo(int position) This action moves a horizontal scrollbar to a specified position.
protected int	locationToIndex(java.awt.Point pt)
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) Performs 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.
void	processSingleMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
void	scrollLineDown() This action moves a vertical scrollbar one line (also called a unit) down in position.
void	scrollLineLeft() This action moves a horizontal scrollbar one line (also called a unit) left in position.
void	scrollLineRight() This action moves a horizontal scrollbar one line (also called a unit) right in position.
void	scrollLineUp() This action moves a vertical scrollbar one line (also called a unit) up in position.
void	scrollPageDown() This action moves a vertical scrollbar one page (also called a block) down in position.
void	scrollPageLeft() This action moves a horizontal scrollbar one page (also called a block) left in position.
void	scrollPageRight() This action moves a horizontal scrollbar one page (also called a block) right in position.
void	scrollPageUp() This action moves a vertical scrollbar one page (also called a block) up in position.
void	select(int item) This method selects a subitem at a specified index.
void	select(java.lang.String item)
void	setState(com.rational.test.ft.script.Action action) This method performs a specific action.
protected void	setState(com.rational.test.ft.script.Action action, int 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 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.
void	vScrollTo(int position) This action moves a vertical scrollbar to a specified position.

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

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getChildrenEnumeration, getClippedRect, getComponentChildren, 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, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, 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

ListProxy

public ListProxy(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 ListTestObject classname, the default list test object.

Specified by:

getTestObjectClassName in interface IProxyBase

Overrides:

getTestObjectClassName in class JavaGuiProxy

Returns:

The default list test object class full name.

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 java.awt.Button with the text "OK" on it.

Overrides:

getDescriptiveName in class ComponentProxy

Returns:

A descriptive object name.

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_LIST.

Overrides:

getRole in class ComponentProxy

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

ensureIndexIsVisible

protected void ensureIndexIsVisible(int index)

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.

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.

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)

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

Performs 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

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

locationToIndex

protected int locationToIndex(java.awt.Point pt)

getFirstVisibleIndex

protected int getFirstVisibleIndex()

Returns the index of the cell in the upper left corner of the JList or -1 if nothing is visible or the list is empty. Note that this cell may only be partially visible.

Returns:

the index of the first visible cell

getLastVisibleIndex

protected int getLastVisibleIndex()

Returns the index of the cell in the lower left corner of the JList or -1 if nothing is visible or the list is empty. Note that this cell may only be partially visible.

Returns:

the index of the last visible cell

getCellBounds

protected java.awt.Rectangle getCellBounds(int index)

Returns the bounds of the item in List coordinates. Returns null if index isn't valid. index1 the index of the last List cell in the range

Returns:

the bounds of the indexed cells in pixels

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.

See Also:

MethodSpecification

getItem

protected java.lang.String getItem(int index)

getItems

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

getItemCount

protected int getItemCount()

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

Returns:

The number of items available in the associated List control.

getItemIndex

protected int getItemIndex(java.lang.String item)

getItemIndex

protected int getItemIndex(com.rational.test.ft.script.Subitem item)

hasItem

protected boolean hasItem(java.lang.String item)

getSelectedText

public java.lang.String getSelectedText()

getText

public java.lang.String getText()

deselectAll

protected void deselectAll()

select

public void select(java.lang.String item)

select

public void select(int item)

This method selects a subitem at a specified index.

Parameters:

item - The index of the item to select.

deselect

public void deselect(int item)

This method deselects a subitem at a specified index.

Parameters:

item - The index of the item to deselect.

extendSelect

public void extendSelect(int item)

This method extends the current selection to include a subitem at a specified index.

Parameters:

item - The index of the item to select.

setState

protected void setState(com.rational.test.ft.script.Action action,                         int item)

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

Parameters:

item - The index of the item to act upon.

action - The action that should be performed.

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.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.ISubitem

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.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.ISubitem

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.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.ISubitem

Parameters:

start - The first item to act upon.

end - The last item to act upon.

action - The action that should be performed.

hScrollTo

public void hScrollTo(int position)

This action moves a horizontal scrollbar to a specified position.

Specified by:

hScrollTo in interface com.rational.test.ft.object.interfaces.IScrollable

Parameters:

position - The poition of the horizontal scrollbar after this action is completed.

See Also:

vScrollTo(int)

vScrollTo

public void vScrollTo(int position)

This action moves a vertical scrollbar to a specified position.

Specified by:

vScrollTo in interface com.rational.test.ft.object.interfaces.IScrollable

Parameters:

position - The poition of the vertical scrollbar after this action is completed.

See Also:

hScrollTo(int)

scrollPageUp

public void scrollPageUp()

This action moves a vertical scrollbar one page (also called a block) up in position.

Specified by:

scrollPageUp in interface com.rational.test.ft.object.interfaces.IScrollable

scrollPageDown

public void scrollPageDown()

This action moves a vertical scrollbar one page (also called a block) down in position.

Specified by:

scrollPageDown in interface com.rational.test.ft.object.interfaces.IScrollable

scrollPageLeft

public void scrollPageLeft()

This action moves a horizontal scrollbar one page (also called a block) left in position.

Specified by:

scrollPageLeft in interface com.rational.test.ft.object.interfaces.IScrollable

scrollPageRight

public void scrollPageRight()

This action moves a horizontal scrollbar one page (also called a block) right in position.

Specified by:

scrollPageRight in interface com.rational.test.ft.object.interfaces.IScrollable

scrollLineUp

public void scrollLineUp()

This action moves a vertical scrollbar one line (also called a unit) up in position.

Specified by:

scrollLineUp in interface com.rational.test.ft.object.interfaces.IScrollable

scrollLineDown

public void scrollLineDown()

This action moves a vertical scrollbar one line (also called a unit) down in position.

Specified by:

scrollLineDown in interface com.rational.test.ft.object.interfaces.IScrollable

scrollLineLeft

public void scrollLineLeft()

This action moves a horizontal scrollbar one line (also called a unit) left in position.

Specified by:

scrollLineLeft in interface com.rational.test.ft.object.interfaces.IScrollable

scrollLineRight

public void scrollLineRight()

This action moves a horizontal scrollbar one line (also called a unit) right in position.

Specified by:

scrollLineRight in interface com.rational.test.ft.object.interfaces.IScrollable