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

Class TabFolderProxy

java.lang.Object

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

com.rational.test.ft.domain.java.swt.TabFolderProxy

All Implemented Interfaces:

IDataDriven, IProxyBase, IPropertyFilter

public class TabFolderProxy
extends SwtGraphicalSubitemProxy

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

• TestObject interface:
  GuiSubitemTestObject
  
  

  Type	Desciption	Data Class
  list	List Elements	ITestDataList
  selected	Selected Tab Element	ITestDataList

  
  
  
• Default Recognition Properties:
  

  Property	Usage
  .class	The Java full class name of the TestObject.
  .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.
  .tabs	The text for the up to ten items from the tabs list.
  tabCount	The number of tabs registered with the tab control.

  
  
  
• Supported Subitems:
  

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

  
  

Nested Class Summary

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

ControlProxy.ChildEnumerator, ControlProxy.ImmediateChildEnumerator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAB_INDEX
static java.lang.String	TAB_TEXT

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, TIMEOUTTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle

Fields inherited from interface com.rational.test.ft.domain.IDataDriven

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	childConstructed(ProxyTestObject child) Inform the parent when child proxies are constructed so additional recognition properties can be added when needed.
protected int	getItemIndex(com.rational.test.ft.script.Text item)
protected int	getItemIndex(Subitem item)
MethodSpecification	getMethodSpecForPoint(java.awt.Point pt) Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_PAGE_TAB_LIST.
java.awt.Point	getScreenPoint(Subitem subitem) Returns the screen relative point to the center of the supplied subitem.
java.awt.Point	getScreenPoint(Subitem subitem, java.awt.Point pt) Returns the screen relative point given a subitem and a subitem relative point.
java.awt.Rectangle	getScreenRectangle(Subitem subitem) Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
int	getSelectionIndex() Gets the index of the selected item.
int[]	getSelectionIndices()
java.lang.Object	getSubitem(Subitem subitem) Returns an object that represents the specified subitem in the associated test object.
protected int	getTabCount()
protected java.lang.String	getTabText(int index)
void	processSingleMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
void	setSelection(int index) Sets the selection.
void	setState(com.rational.test.ft.script.Action action) This method performs a specific action against the JTabbedPane.
void	setState(com.rational.test.ft.script.Action action, Subitem item) This method performs a specific action against the subitem.
void	setState(com.rational.test.ft.script.Action action, Subitem start, Subitem end) This method performs a specific action against the subitem range defined by the specified indices.

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

click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getTestObjectClassName, hover, hover, hover, hover, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint

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

getActionArgs, getChannel, getChildProxy, getChildrenEnumeration, getClippedScreenRectangle, getDefaultActionArgs, getDescriptiveName, getElementWithFocus, getHandle, getImmediateChildren, 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, scrollRectToVisible, setClickArgs, setDownPointArgs, setDrag, setMethodSpecification, setMultiClickAction, setRecordCache

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

activateTopWindow, click, doubleClick, drag, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, invokeMethodOnEDT, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, nClick, processMouseEvent, setProcessMouseEventHandler, setTopLevelWindow, shouldBeMapped

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

addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMappableChildren, getMethods, getNonValueProperties, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getStandardProperties, getTestDataTypes, 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, getTestData, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAB_TEXT

public static final java.lang.String TAB_TEXT

See Also:

Constant Field Values

TAB_INDEX

public static final java.lang.String TAB_INDEX

See Also:

Constant Field Values

Constructor Detail

TabFolderProxy

public TabFolderProxy(java.lang.Object theObjectInTheSUT)

This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.

Method Detail

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_PAGE_TAB_LIST.

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)

childConstructed

public void childConstructed(ProxyTestObject child)

Inform the parent when child proxies are constructed so additional recognition properties can be added when needed. By default nothing happens in this method.

Overrides:

childConstructed in class ControlProxy

Parameters:

child - The child proxy that was just constructed.

getSubitem

public java.lang.Object getSubitem(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.

Overrides:

getSubitem in class SwtGraphicalSubitemProxy

Parameters:

subitem - The subitem to fetch an object for.

Returns:

An object representation of the subitem.

getItemIndex

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

getItemIndex

protected int getItemIndex(Subitem item)

getTabCount

protected int getTabCount()

getTabText

protected java.lang.String getTabText(int index)

getSelectionIndex

public int getSelectionIndex()

Gets the index of the selected item. Indexing is zero based. If no item is selected -1 is returned.

Returns:

the index of the selected item.

getSelectionIndices

public int[] getSelectionIndices()

setSelection

public void setSelection(int index)

Sets the selection.

Parameters:

index - the index of the item

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)

Return a MethodSpecification for the specified mouse event. This is the primary record interface for mouse events against a particular control.

Overrides:

processSingleMouseEvent in class JavaGuiProxy

Parameters:

action - The event cache and other mouse state information for this mouse action.

See Also:

MethodSpecification

setState

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

This method performs a specific action against the JTabbedPane.

Parameters:

action - The action that should be performed.

setState

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

This method performs a specific action against the subitem.

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,
            Subitem start,
            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.

getMethodSpecForPoint

public MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default a method specification for IGraphical.getScreenPoint will be returned. However, if a proxy can find

Overrides:

getMethodSpecForPoint in class JavaGuiProxy

Parameters:

x - The screen relative x coordinate.

y - The screen relative y coordinate.

See Also:

MethodSpecification

getScreenRectangle

public java.awt.Rectangle getScreenRectangle(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 class SwtGraphicalSubitemProxy

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(Subitem subitem)

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

Overrides:

getScreenPoint in class SwtGraphicalSubitemProxy

Parameters:

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

Returns:

A screen relative point.

getScreenPoint

public java.awt.Point getScreenPoint(Subitem subitem,
                            java.awt.Point pt)

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

Overrides:

getScreenPoint in class SwtGraphicalSubitemProxy

Parameters:

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

pt - The subitem relative point.

Returns:

A screen relative point.