|
IBM Rational Functional Tester Version 8.2.1 IBM Rational Functional Tester Proxy SDK Reference Project Version 2.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.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.CheckboxProxy
public class CheckboxProxy
Proxy for AWT Checkbox objects. This handles simple checkboxes and radio buttons, which are implemented as Checkbox objects that are part of a CheckboxGroup.
ToggleGUITestObject
| Type | Desciption | Data Class |
|---|---|---|
| text | CheckBox Visible Text | ITestDataText |
| state | CheckBox Button State | ITestData |
| 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 checkbox. 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.sys.RegisteredObject |
|---|
theTestObject |
| Fields inherited from interface com.rational.test.ft.domain.IDataDriven |
|---|
INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS |
| Constructor Summary | |
|---|---|
CheckboxProxy(java.lang.Object theObjectInTheSUT)
Sets the SUT object as a member variable for the proxy. |
|
| Method Summary | |
|---|---|
void |
clickToState(com.rational.test.ft.script.MouseModifiers modifiers,
com.rational.test.ft.script.State state)
Performs the necessary mouse actions to attain the desired state for the associated component. |
void |
clickToState(com.rational.test.ft.script.State state)
Performs the necessary mouse actions to attain the desired state for the associated component. |
void |
deselect()
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)
Performs the necessary mouse actions to attain the desired state for the associated component. |
void |
dragToState(com.rational.test.ft.script.State state)
Performs the necessary mouse actions to attain the desired state for the associated component. |
com.rational.test.ft.sys.MethodSpecification |
getDataDrivableCommand()
This method must be implemented by any proxy that wishes to support data driving. |
com.rational.test.ft.sys.MethodSpecification[] |
getDataDrivableCommands(int includeChildren)
Walks the proxy parent-child hierarchy and returns a command for each control that is data drivable. |
com.rational.test.ft.script.Property[] |
getDataDrivenRecognitionProperties(java.util.Hashtable radiobuttonGroups)
Return a limited set of properties that can be used to identify all radiobuttons in the group. |
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 Checkbox object. |
java.lang.Object |
getProperty(java.lang.String propertyName)
Gets the value for a specific property. |
java.lang.Object |
getRadioButtonGroup()
Return access to the radio button group object. |
java.lang.String |
getRole()
Returns TestObjectRole.ROLE_CHECK_BOX. |
com.rational.test.ft.script.State |
getState()
Returns the state of the associated object. |
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. |
java.lang.String |
getTestObjectClassName()
Returns the top level GUI test object classname that implements ITopWindow. |
java.lang.String |
getVariableDataDrivenRecognitionProperty(com.rational.test.ft.script.Property[] properties)
Only one recognition property will be data driven by default, this method specifies that property. |
void |
indeterminate()
Sets the state of the associated object to INDETERMINATE. |
boolean |
isRadioSelected()
Specifies if the radiobutton is currently selected. |
void |
processSingleMouseEvent(IMouseActionInfo action)
Returns a method specification for the specified mouse event. |
void |
select()
Sets the state of the associated object to SELECTED. |
void |
setState(com.rational.test.ft.script.State state)
Sets the state of the associated object to the specified state. |
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.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.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 |
|---|
public CheckboxProxy(java.lang.Object theObjectInTheSUT)
| Method Detail |
|---|
public java.lang.String getTestObjectClassName()
getTestObjectClassName in interface IProxyBasegetTestObjectClassName in class JavaGuiProxypublic java.lang.String getLabel()
public java.lang.String getDescriptiveName()
getDescriptiveName in class ComponentProxypublic java.lang.String getRole()
TestObjectRole.ROLE_CHECK_BOX.
getRole in class ComponentProxypublic java.lang.Object getProperty(java.lang.String propertyName)
getProperty in class ComponentProxypropertyName - The name of the property to fetch.
ProxyTestObject.getProperties(),
ProxyTestObject.setProperty(String,Object),
ProxyTestObject.getRecognitionProperties(),
ProxyTestObject.addRecognitionProperty(String,Object,int)public com.rational.test.ft.sys.MethodSpecification[] getDataDrivableCommands(int includeChildren)
ProxyTestObjectnull.
The reason that the proxies are left with doing the walk instead of it happening at a higher level is because they have a better understanding of the hierarchy they expose. Domains like HTML can take advantage of internal knowledge to allow them better control the traversal of interesting child proxies relative to data driving. By default this method will perform a standard traversal of the proxy hierarchy and does not need to be overridden unless necessary.
getDataDrivableCommands in interface IDataDrivengetDataDrivableCommands in class ProxyTestObjectincludeChildren - Flag to control which child objects are considered
for data driving. Must be IDataDriven.INCLUDE_JUSTOBJECT,
IDataDriven.INCLUDE_SIBLINGS or IDataDriven.INCLUDE_ALL.
ProxyTestObject.getDataDrivableCommand()public com.rational.test.ft.sys.MethodSpecification getDataDrivableCommand()
null value is returned.
getDataDrivableCommand in interface IDataDrivengetDataDrivableCommand in class ProxyTestObjectgetDataDrivableCommands(int)public void processSingleMouseEvent(IMouseActionInfo action)
processSingleMouseEvent method is implemented in order to
record clickToState against checkboxes. But for checkboxes that are
really radiobuttons (part of a CheckBoxGroup), ordinary clicks are recorded.
processSingleMouseEvent in class JavaGuiProxyaction - The event cache and other mouse state information
for this mouse action.MethodSpecificationpublic void clickToState(com.rational.test.ft.script.State state)
clickToState in interface com.rational.test.ft.object.interfaces.IToggleGUIstate - The desired target state for the associated
component.
public void clickToState(com.rational.test.ft.script.MouseModifiers modifiers,
com.rational.test.ft.script.State state)
clickToState in interface com.rational.test.ft.object.interfaces.IToggleGUImodifiers - The mouse modifiers to be used to attain the
desired state.state - The desired target state for the associated
component.public void dragToState(com.rational.test.ft.script.State state)
dragToState in interface com.rational.test.ft.object.interfaces.IToggleGUIstate - The desired target state for the associated
component.
public void dragToState(com.rational.test.ft.script.MouseModifiers modifiers,
com.rational.test.ft.script.State state)
dragToState in interface com.rational.test.ft.object.interfaces.IToggleGUImodifiers - The mouse modifiers to be used to attain the
desired state.state - The desired target state for the associated
component.public void setState(com.rational.test.ft.script.State state)
setState in interface com.rational.test.ft.object.interfaces.IToggleStatepublic com.rational.test.ft.script.State getState()
getState in interface com.rational.test.ft.object.interfaces.IToggleState literals.Statepublic void select()
UnsupportedActionException exception will be thrown if
this action can not be performed.
select in interface com.rational.test.ft.object.interfaces.ITogglepublic void deselect()
UnsupportedActionException exception is thrown if
this action cannot be performed.
deselect in interface com.rational.test.ft.object.interfaces.ITogglepublic void indeterminate()
UnsupportedActionException exception is thrown if
this action cannot be performed.
indeterminate in interface com.rational.test.ft.object.interfaces.ITogglepublic java.util.Hashtable getTestDataTypes()
JavaProxy
getTestDataTypes in class JavaProxyProxyTestObject.getTestData(String),
ITestDatapublic com.rational.test.ft.vp.ITestData getTestData(java.lang.String testDataType)
ProxyTestObjecttestDataType parameter is a hashtable key
returned by getTestDataTypes().
getTestData in class ProxyTestObjecttestDataType - A test data type supplied by
getTestDataTypes().
ProxyTestObject.getTestDataTypes(),
ITestData
public com.rational.test.ft.vp.ITestData updateTestData(java.lang.String testDataType,
com.rational.test.ft.vp.ITestData testData)
ProxyTestObjecttestDataType parameter is a hashtable key
returned by ProxyTestObject.getTestDataTypes().
The testData is a previously supplied ITestData
object that needs to be updated to reflect the current state
of the associated test object.
updateTestData in class ProxyTestObjecttestDataType - A test data type supplied by
getTestDataTypes().testData - The test database object that requires
updating.
testData passed in with appropriate updates.ProxyTestObject.getTestDataTypes(),
ITestDatapublic java.lang.Object getRadioButtonGroup()
IRadioButtonProxynull should be returned and all radiobuttons
in the parent will be treated as if they come from the same group.
getRadioButtonGroup in interface IRadioButtonProxypublic com.rational.test.ft.script.Property[] getDataDrivenRecognitionProperties(java.util.Hashtable radiobuttonGroups)
IRadioButtonProxy
getDataDrivenRecognitionProperties in interface IRadioButtonProxyradiobuttonGroups - The set of radiobutton groups available from
the same parent. The key to the map is the
group object and
the value is a java.util.Vector of
the radiobuttons in the group.public java.lang.String getVariableDataDrivenRecognitionProperty(com.rational.test.ft.script.Property[] properties)
IRadioButtonProxy#getDataDrivenRecognitionProperties().
Nothing will be data driven if this property name is not in that set.
getVariableDataDrivenRecognitionProperty in interface IRadioButtonProxyproperties - The properties returned by IRadioButtonProxy.getDataDrivenRecognitionProperties(Hashtable).public boolean isRadioSelected()
IRadioButtonProxy
isRadioSelected in interface IRadioButtonProxy
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||