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

java.lang.Object   com.rational.test.ft.sys.RegisteredObject       com.rational.test.ft.domain.ProxyTestObject
          com.rational.test.ft.domain.java.JavaProxy
              com.rational.test.ft.domain.java.JavaGuiProxy
                  com.rational.test.ft.domain.java.swt.ControlProxy
                      com.rational.test.ft.domain.java.swt.LabelProxy

All Implemented Interfaces:

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

public class LabelProxy
extends ControlProxy

This is the proxy class for org.eclipse.swt.widgets.Control.Label.

• TestObject interface:
  GuiTestObject
  
  

• Supported Test Data Types:
  

  Type	Desciption	Data Class
  text	Label Visible Text	ITestDataText

  
  
  

• Default Recognition Properties:
  

  Property	Usage
  .class	The Java full class name of the test object.
  .classIndex	The zero-based index of the class relative to the immediate parent in the object map.
  .priorLabel	The text of a preceding label. Suppressed if there is no preceding label.
  .groupText	The text of a group parent. Only available if parent is a group. Omitted if the group parent has no visible text.
  .toolTipText	The text from the associated tool tip, omitted if there is no associated tool tip.
  text	The visible text of the label. If there is no visible text this property is omitted.

  
  

Nested Class Summary

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

ControlProxy.ChildEnumerator, ControlProxy.ImmediateChildEnumerator

Field Summary

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

childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, clickArgs, currentMethod, GROUPTEXT, GROUPTEXTWEIGHT, HANDLE, MAPPABLECLASSINDEX, MAPPABLECLASSINDEXWEIGHT, MAX_NAME, predownScreenRect, PRIORLABEL, PRIORLABELWEIGHT, TOOLTIPTEXT, TOOLTIPTEXTWEIGHT

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

LEFT, preDownState, processMouseEventHandler, ROLEINDEX, ROLEINDEXWEIGHT, TESTDATA_SPECIALFRAMESTATE, TESTDATA_SPECIALFRAMESTATE_DESCRIPTION, topLevelWindow

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

debug, uniqueId

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

BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle

Fields inherited from class com.rational.test.ft.sys.RegisteredObject

theTestObject

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

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

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

Method Summary

java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
protected java.lang.String	getLabelText() This method returns the label text associated with an isLabelled proxy.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_LABEL.
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	getText() Returns the Text for the Label object.
protected boolean	isLabelled() This method should return true if the particular proxy has a label that can be used as a recognition property for a another test object.
void	processSingleMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
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.

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

childConstructed, getActionArgs, getChannel, getChildProxy, getChildrenEnumeration, getClippedScreenRectangle, getDefaultActionArgs, getHandle, getImmediateChildren, getLeadingLabel, getLocationOnScreen, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParentObject, getReorderedChildren, getScreenRectangle, getStyle, getToolTipText, getTopMappableParent, getTopParent, getVisualClippedRectangle, hasFocus, isEnabled, isGTK, 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, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTestObjectClassName, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, 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, getTestDomain, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, isRecognitionProperty, setIndexer, setProperty

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

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChildren, getDataDrivableCommand, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction

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

LabelProxy

public LabelProxy(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_LABEL.

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)

getText

public java.lang.String getText()

Returns the Text for the Label object.

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 ControlProxy

Returns:

A descriptive object name.

isLabelled

protected boolean isLabelled()

This method should return true if the particular proxy has a label that can be used as a recognition property for a another test object.

Overrides:

isLabelled in class ControlProxy

Returns:

true if the particular proxy has a label that can be used as a recognition property for a another test object.

See Also:

ControlProxy.getChildrenEnumeration(), getLabelText()

getLabelText

protected java.lang.String getLabelText()

This method returns the label text associated with an isLabelled proxy. This text is used in recognition of siblings in the test object finds. This method is only called if the proxy has reported itself as isLabelled().

Overrides:

getLabelText in class ControlProxy

Returns:

The label text associated with an isLabelled proxy.

See Also:

ControlProxy.getChildrenEnumeration(), isLabelled()

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.

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