com.rational.test.ft.domain.java.jfc

Class AbstractButtonProxy

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.jfc.JComponentProxy

com.rational.test.ft.domain.java.jfc.AbstractButtonProxy

All Implemented Interfaces:

com.rational.test.ft.domain.IChannelObject, com.rational.test.ft.domain.IDataDriven, com.rational.test.ft.domain.IProxyBase, com.rational.test.ft.domain.IRadioButtonProxy, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.IToggle, com.rational.test.ft.object.interfaces.IToggleGUI

Direct Known Subclasses:

JCheckBoxProxy, JMenuItemProxy

public class AbstractButtonProxy
extends JComponentProxy
implements com.rational.test.ft.object.interfaces.IToggleGUI, com.rational.test.ft.domain.IRadioButtonProxy

Proxy class for javax.swing.AbstractButton.

• TestObject interface:
  ToggleGUITestObject
  
• Supported Test Data Types:
  

  Type	Desciption	Data Class
  text	Button Visible Text	ITestDataText
  state	Toggle Button State	ITestData

  
  
  
• 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.
  accessibleContext.accessibleName	A programmatically defined name for the component.
  name	The name property, suppressed if default formatted (default form = className+count).
  text	The visible text of the button. If there is no visible text this property is omitted.
  toolTipText	The text from the associated tool tip, omitted if there is no associated tool tip.

  
  

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.jfc.JComponentProxy

TAB_INDEX, TAB_TEXT

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

Constructors

Constructor and Description
AbstractButtonProxy(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	clickToState(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.State state) This method performs the necessary mouse actions to attain the desired state for the associated component.
void	clickToState(com.rational.test.ft.script.State state) This method performs the necessary mouse actions to attain the desired state for the associated component.
void	deselect() This method sets the state of the associated object to NOT_SELECTED.
void	dragToState(com.rational.test.ft.script.MouseModifiers modifiers, com.rational.test.ft.script.State state) This method performs the necessary mouse actions to attain the desired state for the associated component.
void	dragToState(com.rational.test.ft.script.State state) This method performs the necessary mouse actions to attain the desired state for the associated component.
com.rational.test.ft.sys.MethodSpecification[]	getDataDrivableCommands(int includeChildren)
com.rational.test.ft.script.Property[]	getDataDrivenRecognitionProperties(java.util.Hashtable radiobuttonGroups)
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
protected java.lang.String	getIconDescription() Returns the Text for the icon on the label object.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.Object	getRadioButtonGroup()
java.lang.String	getRole() Returns TestObjectRole.ROLE_BUTTON.
com.rational.test.ft.script.State	getState() This method returns the state of the associated object.
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	getTestObjectClassName() Return the test object.
java.lang.String	getText() Returns the Text on the object.
java.lang.String	getVariableDataDrivenRecognitionProperty(com.rational.test.ft.script.Property[] properties)
boolean	hasSpecialFrameState()
void	indeterminate() This method sets the state of the associated object to INDETERMINATE.
boolean	isRadioSelected()
void	processSingleMouseEvent(com.rational.test.ft.domain.IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
void	select() This method sets the state of the associated object to SELECTED.
void	setState(com.rational.test.ft.script.State state) Set the state of the associated object to the specified state.
boolean	shouldBeMapped() Returns false when it is the scroll button in JScrollBar.
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.jfc.JComponentProxy

getBorderTitle, getClippedRect, getClippedScreenRectangle, getProperties, getStandardProperties, getText, getVisibleRectangle, getVisualClippedRectangle, hasFocus, isOpaque, isPointInObject, isType, scrollRectToVisible

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

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getChildrenEnumeration, getComponentChildren, getElementWithFocus, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getScreenRectangle, getTopParent, getWindow, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, 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, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, invokeMethodOnEDT, isDrag, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, setProcessMouseEventHandler, setTopLevelWindow

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

addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMethods, getNonValueProperties, getRecognitionProperties, getRecognitionPropertyWeight, 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, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, 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

AbstractButtonProxy

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

getTestObjectClassName

public java.lang.String getTestObjectClassName()

Return the test object. If the test object is a JRadioButton, return the test object implement IToggleGUI.

Specified by:

getTestObjectClassName in interface com.rational.test.ft.domain.IProxyBase

Overrides:

getTestObjectClassName in class JavaGuiProxy

Returns:

The stateful test object class full name.

shouldBeMapped

public boolean shouldBeMapped()

Returns false when it is the scroll button in JScrollBar. Returns true for other cases.

Overrides:

shouldBeMapped in class JavaGuiProxy

Returns:

false when it is the scroll button in JScrollBar true otherwise

getProperty

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

Get the value for a specific property.

Overrides:

getProperty in class JComponentProxy

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 JComponentProxy

Returns:

A descriptive object name.

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_BUTTON.

Overrides:

getRole in class JComponentProxy

Returns:

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

Since:

RFT1.0

getText

public java.lang.String getText()

Returns the Text on the object.

getIconDescription

protected java.lang.String getIconDescription()

Returns the Text for the icon on the label object.

processSingleMouseEvent

public void processSingleMouseEvent(com.rational.test.ft.domain.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.

clickToState

public void clickToState(com.rational.test.ft.script.State state)

This method performs the necessary mouse actions to attain the desired state for the associated component. If the state of the component is already in the desired state, multiple actions may be performed to reset the state appropriately.

Specified by:

clickToState in interface com.rational.test.ft.object.interfaces.IToggleGUI

Parameters:

state - The desired target state for the associated component.

clickToState

public void clickToState(com.rational.test.ft.script.MouseModifiers modifiers,
                com.rational.test.ft.script.State state)

This method performs the necessary mouse actions to attain the desired state for the associated component. If the state of the component is already in the desired state, multiple actions may be performed to reset the state appropriately.

Specified by:

clickToState in interface com.rational.test.ft.object.interfaces.IToggleGUI

Parameters:

modifiers - The mouse modifiers to be used to attain the desired state.

state - The desired target state for the associated component.

dragToState

public void dragToState(com.rational.test.ft.script.State state)

This method performs the necessary mouse actions to attain the desired state for the associated component. If the state of the component is already in the desired state, multiple actions may be performed to reset the state appropriately.

Specified by:

dragToState in interface com.rational.test.ft.object.interfaces.IToggleGUI

Parameters:

state - The desired target state for the associated component.

dragToState

public void dragToState(com.rational.test.ft.script.MouseModifiers modifiers,
               com.rational.test.ft.script.State state)

This method performs the necessary mouse actions to attain the desired state for the associated component. If the state of the component is already in the desired state, multiple actions may be performed to reset the state appropriately.

Specified by:

dragToState in interface com.rational.test.ft.object.interfaces.IToggleGUI

Parameters:

modifiers - The mouse modifiers to be used to attain the desired state.

state - The desired target state for the associated component.

setState

public void setState(com.rational.test.ft.script.State state)

Set the state of the associated object to the specified state.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.IToggle

getState

public com.rational.test.ft.script.State getState()

This method returns the state of the associated object.

Specified by:

getState in interface com.rational.test.ft.object.interfaces.IToggle

Returns:

One of the State literals.

See Also:

State

select

public void select()

This method sets the state of the associated object to SELECTED. The UnableToPerformActionException exception will be thrown if this action can not be performed.

Specified by:

select in interface com.rational.test.ft.object.interfaces.IToggle

deselect

public void deselect()

This method sets the state of the associated object to NOT_SELECTED. The UnableToPerformActionException exception will be thrown if this action can not be performed.

Specified by:

deselect in interface com.rational.test.ft.object.interfaces.IToggle

indeterminate

public void indeterminate()

This method sets the state of the associated object to INDETERMINATE. The UnableToPerformActionException exception will be thrown if this action can not be performed.

Specified by:

indeterminate in interface com.rational.test.ft.object.interfaces.IToggle

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 com.rational.test.ft.domain.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 com.rational.test.ft.domain.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

hasSpecialFrameState

public boolean hasSpecialFrameState()

Overrides:

hasSpecialFrameState in class com.rational.test.ft.domain.ProxyTestObject

getDataDrivableCommands

public com.rational.test.ft.sys.MethodSpecification[] getDataDrivableCommands(int includeChildren)

Specified by:

getDataDrivableCommands in interface com.rational.test.ft.domain.IDataDriven

Overrides:

getDataDrivableCommands in class com.rational.test.ft.domain.ProxyTestObject

getDataDrivenRecognitionProperties

public com.rational.test.ft.script.Property[] getDataDrivenRecognitionProperties(java.util.Hashtable radiobuttonGroups)

Specified by:

getDataDrivenRecognitionProperties in interface com.rational.test.ft.domain.IRadioButtonProxy

getRadioButtonGroup

public java.lang.Object getRadioButtonGroup()

Specified by:

getRadioButtonGroup in interface com.rational.test.ft.domain.IRadioButtonProxy

getVariableDataDrivenRecognitionProperty

public java.lang.String getVariableDataDrivenRecognitionProperty(com.rational.test.ft.script.Property[] properties)

Specified by:

getVariableDataDrivenRecognitionProperty in interface com.rational.test.ft.domain.IRadioButtonProxy

isRadioSelected

public boolean isRadioSelected()

Specified by:

isRadioSelected in interface com.rational.test.ft.domain.IRadioButtonProxy