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

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

All Implemented Interfaces:

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

public class ButtonProxy
extends ComponentProxy

The proxy class for the java.awt.Button class.

• Test Object interface:
  GuiTestObject
  

• Supported Test Data Types:
  

  Type	Desciption	Data Class
  text	Button 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.
  label	The visible text of the button. If there is no visible text this property is omitted.
  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

ButtonProxy(java.lang.Object theObjectInTheSUT)
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.
java.lang.String	getLabel() Returns the label for the Button object.
com.rational.test.ft.sys.MethodSpecification	getMethodSpecForPoint(java.awt.Point pt) Returns a method specification for a method that returns a java.awt.Point for the specified coordinates.
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_BUTTON.
com.rational.test.ft.vp.ITestData	getTestData(java.lang.String testDataType) 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.
void	processSingleMouseEvent(IMouseActionInfo action) Returns a method specification for the specified mouse event.
com.rational.test.ft.vp.ITestData	updateTestData(java.lang.String testDataType, com.rational.test.ft.vp.ITestData testData) 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, 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, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTestObjectClassName, 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, getDataDrivableCommand, 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

ButtonProxy

public ButtonProxy(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

getLabel

public java.lang.String getLabel()

Returns the label for the Button object.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

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

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 become unique to the script, but it acts 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 cause script compilation failures. An example of what to return is "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_BUTTON.

Overrides:

getRole in class ComponentProxy

Returns:

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

Since:

RFT1.0

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)

Returns a method specification 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

getMethodSpecForPoint

public com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

Returns a method specification for a method that returns a java.awt.Point for the specified coordinates. By default a method specification for IGraphical.getScreenPoint is 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

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 different from other type values associated with this object under test. The type keys map to a verbose description of the test data. This is 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)

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)

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