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

Class TextAreaProxy

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.awt.ComponentProxy

com.rational.test.ft.domain.java.awt.TextAreaProxy

All Implemented Interfaces:

IDataDriven, IProxyBase, IPropertyFilter, ISetParent

public class TextAreaProxy
extends ComponentProxy

Proxy for the AWT TextArea objects.

• Test Object interface:
  TextGuiTestObject
  
• Supported Test Data Types:
  

  Type	Desciption	Data Class
  text	Text	ITestDataText
  selectedText	Selected 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.
  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, 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
TextAreaProxy(java.lang.Object theObjectInTheSUT) Sets the SUT object as a member variable for the proxy.

Method Summary

Methods

Modifier and Type	Method and Description
MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
java.lang.String	getRole() Returns TestObjectRole.ROLE_TEXT.
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() The default GUI test object classname is returned.
java.lang.String	getText() Allow direct acess to the text property on the control.
boolean	isEditable() Check if the text component is editable.
void	setText(java.lang.String text) Directly modify the text on the control.
ITestData	updateTestData(java.lang.String testDataType, ITestData testData) This method updates the supplied test data object and returns it.

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

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getChildrenEnumeration, getClippedRect, getComponentChildren, getDescriptiveName, getElementWithFocus, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getProperty, 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, 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, invokeMethodOnEDT, isDrag, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, processSingleMouseEvent, 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 java.lang.Object

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

Constructor Detail

TextAreaProxy

public TextAreaProxy(java.lang.Object theObjectInTheSUT)

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

Overrides:

getRole in class ComponentProxy

Returns:

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

Since:

RFT1.0

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.

isEditable

public boolean isEditable()

Check if the text component is editable.

Returns:

true is returned if the text component is editable.

Since:

RFT2.0

getText

public java.lang.String getText()

Allow direct acess to the text property on the control.

Returns:

The active text in the control.

Since:

RFT2.0

setText

public void setText(java.lang.String text)

Directly modify the text on the control. Any existing text in the control is replaced with the specified text value. This command will attempt to playback this action from the glass when possible.

Parameters:

text - The text to update the control with.

Since:

RFT2.0

getDataDrivableCommand

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

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 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 ITestData updateTestData(java.lang.String testDataType,
                       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