IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester Proxy SDK Reference

Project Version 2.3

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

java.lang.Object   extended by com.rational.test.ft.sys.RegisteredObject       extended by com.rational.test.ft.domain.ProxyTestObject
          extended by com.rational.test.ft.domain.java.JavaProxy
              extended by com.rational.test.ft.domain.java.JavaGuiProxy
                  extended by com.rational.test.ft.domain.java.swt.WidgetProxy
                      extended by com.rational.test.ft.domain.java.swt.ItemProxy
                          extended by com.rational.test.ft.domain.java.swt.CTabItemProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, com.rational.test.ft.object.interfaces.IGraphical

public class CTabItemProxy
extends ItemProxy


Nested Class Summary
 
Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.swt.WidgetProxy
WidgetProxy.ChildEnumerator, WidgetProxy.ImmediateChildEnumerator
 
Field Summary
static java.lang.String TOOLTIPTEXT
           
 
Fields inherited from class com.rational.test.ft.domain.java.swt.WidgetProxy
CLASSINDEX, CLASSINDEXWEIGHT, MAPPABLECLASSINDEX, MAPPABLECLASSINDEXWEIGHT, MAX_NAME
 
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
CTabItemProxy(java.lang.Object theObjectInTheSUT)
           
 
Method Summary
 void click(com.rational.test.ft.script.Subitem item)
          Click on the close button, if CLOSE_BUTTON is passed as a parameter
 java.awt.Point getControlLocationOnScreen(org.eclipse.swt.widgets.Control control)
           
 java.lang.Object getParentObject()
          Returns an object for the parent of this object.
 java.lang.Object getProperty(java.lang.String propertyName)
          Get the value for a specific property.
 java.lang.String getRole()
          Returns TestObjectRole#ROLE_Item.
 java.awt.Rectangle getScreenRectangle()
          Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
 java.awt.Rectangle getScreenRectangle(org.eclipse.swt.widgets.Control theTabFolder)
           
 java.lang.String getTestObjectClassName()
          The default GUI test object classname is returned.
 void hover(com.rational.test.ft.script.Subitem item)
          Hover on the close button, if CLOSE_BUTTON is passed as a parameter.
 boolean isEnabled()
          Check the component under evaluation to determine if it is enabled or disabled.
 boolean isShowing()
          Check the component under evaluation to determine if it is showing (as opposed to hidden).
 void processSingleMouseEvent(IMouseActionInfo action)
           
 boolean shouldBeMapped()
          Returns true; by default all test objects are mapped.
 
Methods inherited from class com.rational.test.ft.domain.java.swt.ItemProxy
getDescriptiveName, getLabel, getStyle
 
Methods inherited from class com.rational.test.ft.domain.java.swt.WidgetProxy
getChannel, getChildProxy, getChildrenEnumeration, getImmediateChildren, getLeadingLabel, getLocationOnScreen, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getTopMappableParent, getTopParent, hasFocus
 
Methods inherited from class com.rational.test.ft.domain.java.JavaGuiProxy
activateTopWindow, click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getClippedScreenRectangle, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, scrollRectToVisible, setProcessMouseEventHandler, setTopLevelWindow
 
Methods inherited from class com.rational.test.ft.domain.java.JavaProxy
addMappableChildrenToVector, addRecognitionProperty, allowProperty, childConstructed, 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, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData
 
Methods inherited from class com.rational.test.ft.sys.RegisteredObject
addProxyReference, dereference, getObject, getRegisteredId, getTransactionId, isReferenced, isReleaseRequired, register, registerTransiently, release, toString, unregister
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TOOLTIPTEXT

public static final java.lang.String TOOLTIPTEXT
See Also:
Constant Field Values
Constructor Detail

CTabItemProxy

public CTabItemProxy(java.lang.Object theObjectInTheSUT)
Method Detail

shouldBeMapped

public boolean shouldBeMapped()
Description copied from class: JavaGuiProxy
Returns true; by default all test objects are mapped. This method should be overriden by proxies that do not contain interesting persistent information. Objects that the script may want to interact with should always return true.

Overrides:
shouldBeMapped in class JavaGuiProxy
Returns:
true, unless overriden in a super class.

isEnabled

public boolean isEnabled()
Description copied from class: JavaGuiProxy
Check the component under evaluation to determine if it is enabled or disabled.

Specified by:
isEnabled in interface com.rational.test.ft.object.interfaces.IGraphical
Specified by:
isEnabled in class JavaGuiProxy
Returns:
true if component is enabled, else false.

getRole

public java.lang.String getRole()
Description copied from class: ItemProxy
Returns TestObjectRole#ROLE_Item.

Overrides:
getRole in class ItemProxy
Returns:
A brief type name that describes the role this object plays in the UI.

getControlLocationOnScreen

public java.awt.Point getControlLocationOnScreen(org.eclipse.swt.widgets.Control control)

getScreenRectangle

public java.awt.Rectangle getScreenRectangle(org.eclipse.swt.widgets.Control theTabFolder)

getScreenRectangle

public java.awt.Rectangle getScreenRectangle()
Description copied from class: WidgetProxy
Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen. This will commonly be two operations (getLocationOnScreen and getSize) combined into a single operation.

Specified by:
getScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphical
Overrides:
getScreenRectangle in class WidgetProxy
Returns:
The adjusted rectangle surrounding component relative to the screen.
See Also:
IGraphical.isPointInObject(java.awt.Point), IGraphical.getClippedScreenRectangle()

isShowing

public boolean isShowing()
Description copied from class: JavaGuiProxy
Check the component under evaluation to determine if it is showing (as opposed to hidden).

Specified by:
isShowing in interface com.rational.test.ft.object.interfaces.IGraphical
Specified by:
isShowing in class JavaGuiProxy
Returns:
true if component is showing, else false.

getParentObject

public java.lang.Object getParentObject()
Description copied from class: WidgetProxy
Returns an object for the parent of this object. Returns null if this object has no parent.

Overrides:
getParentObject in class WidgetProxy
Returns:
The parent test object or null for a top level window.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)
Description copied from class: ItemProxy
Get the value for a specific property.

Overrides:
getProperty in class ItemProxy
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)

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)
Overrides:
processSingleMouseEvent in class JavaGuiProxy

getTestObjectClassName

public java.lang.String getTestObjectClassName()
The default GUI test object classname is returned. More specific test objects are returned by more constrained proxy classes. This level of support is always required.

Specified by:
getTestObjectClassName in interface IProxyBase
Overrides:
getTestObjectClassName in class JavaGuiProxy
Returns:
The default test object class full name.

click

public void click(com.rational.test.ft.script.Subitem item)
Click on the close button, if CLOSE_BUTTON is passed as a parameter

Parameters:
item -

hover

public void hover(com.rational.test.ft.script.Subitem item)
Hover on the close button, if CLOSE_BUTTON is passed as a parameter.

Parameters:
item -