com.rational.test.ft.domain.html

Class CheckboxProxy

java.lang.Object

RegisteredObject

com.rational.test.ft.domain.ProxyTestObject

com.rational.test.ft.domain.html.HtmlProxy

com.rational.test.ft.domain.html.HtmlGuiProxy

com.rational.test.ft.domain.html.ElementProxy

com.rational.test.ft.domain.html.ControlProxy

com.rational.test.ft.domain.html.InputProxy

com.rational.test.ft.domain.html.CheckboxProxy

All Implemented Interfaces:

IDataDriven, IGetInterestingRecogProsForDynFind, IHtmlCustomDomainEnablement, IInternalObjectStatus, IProxyBase, IQuickFind, IRadioButtonProxy, IXPathFind

public class CheckboxProxy
extends InputProxy
implements IRadioButtonProxy

Implements the Proxy for HTML INPUT type=checkbox, and type=radio elements

• TestObject Interface: ToggleGuiTestObject
  
  
• Supported Test Data Types:
  

  Type	Desciption
  state	Button State	ITestData
  submit	Submit Value	ITestDataText

  
  
• Default Recognition Properties:
  • .class
  • .classIndex
  • .id
  • .name
  • .title
  • .type
  • .value
  
  
• Supported Canonical Properties:
  

  Property	Usage
  .alt	The value of the alt attribute an element. This is the "alternate" text for the element, frequently displayed by the browser when the mouse hovers over the element.
  .bounds	A rectangle representing the bounding rectangle of the object in screen coordinates.
  .checked	This is a boolean value indicating whether a checkboxed is currently checked (true) or not (false).
  .class	This is the test object class name, for example "HtmlTable" for a <Table> element.
  .className	This the value of the class attribute of an element
  .defaultChecked	This is a boolean value for the defaultchecked attribute of the element.
  .defaultValue	This is the value of the defaultValue attribute of the element.
  .disabled	The value of the disabled attribute of an element, returned as a boolean. If true then user input is currently disabled for this item.
  .hasScript	This value is returned as a boolean. If true then script as been associated with actions on this element.
  .id	This is the value of the id attribute of an element.
  .indeterminate	This value is returned as a boolean. If true then the status of the checkbox has been changesd.
  .maxLength	For an edit control (Input type=Text or TextArea) this indicates the maximum number of characters a user may enter.
  .name	This is the value of the name attribute (Form elements and Frames only)
  .offsetHeight	The height of the element.
  .offsetLeft	The offset of the element from its offset parent in the DOM.
  .offsetTop	The offset of the element from its offset parent in the DOM.
  .offsetWidth	The width of the element.
  .readOnly	The value of the readonly attribute of an element. A boolean value that when true indicates the form element is read only.
  .screenLeft	Upper left corner of bounding rectangle in screen coordinates, x component.
  .screenTop	Upper left corner of bounding rectangle in screen coordinates, y component.
  .size	The value of the size attribute of an element. For a Select element this indicates the number of items displayed at once in the list. If size > 1 then the list appears as listbox, otherwise the list appears as a Combodropdown.
  .src	This is the value of the src attribute for the element. For images and image buttons this is a URL specifying the desired image file.
  .tag	This is the Html tag for the element
  .text	This is the text inside of the HTML tags for bounding the element. For example, <A>This is an Anchor<IMG src=map.gif></a> the text property will return "This is an Anchor. All white space are combined and reduced to a single a blank character if consecutive white space characters are found.
  .title	This is the value of the title attribute of an element. This is frequently the text displayed when hovering over the element with the mouse.
  .type	This is the value of the Type attribute of an element. For example, for an Input element this will be text, password, checkbox, radio, submit, image, reset, button, hidden,orfile.
  .value	This is the value of the value attribute of an element. In Form elements this represents the value which will be sent when the form is posted.

  
  

Since:

RFT1.0

Nested Class Summary

Nested classes/interfaces inherited from class com.rational.test.ft.domain.html.HtmlGuiProxy

HtmlGuiProxy.Clicker, HtmlGuiProxy.DoubleClicker, HtmlGuiProxy.Dragger, HtmlGuiProxy.Hoverer, HtmlGuiProxy.nClickDragger, HtmlGuiProxy.nClicker, HtmlGuiProxy.PointIterator

Nested classes/interfaces inherited from class com.rational.test.ft.domain.html.HtmlProxy

HtmlProxy.GetObjectRunnable, HtmlProxy.HtmlElementEnumeration, HtmlProxy.IntegerByReference, HtmlProxy.InvalidNativeHandleException, HtmlProxy.JSObjectHtmlElementEnumeration, HtmlProxy.NativeProxyReleasedException

Field Summary

Fields inherited from class com.rational.test.ft.domain.html.ElementProxy

TESTDATA_SUBMIT

Fields inherited from class com.rational.test.ft.domain.html.HtmlGuiProxy

currentMethod, LEFT, OFFSETHEIGHTPROPERTY, OFFSETLEFTPROPERTY, OFFSETRECTPROPERTY, OFFSETTOPPROPERTY, OFFSETWIDTHPROPERTY

Fields inherited from class com.rational.test.ft.domain.html.HtmlProxy

BOUNDSPROPERTY, channel, CLASSINDEX, CLASSPROPERTY, CLIENTRECTPROPERTY, debug, DOCCLASSINDEX, dojoProps, domain, HTMLPROXYCHANNELRUNNABLE_TIMEOUTVALUE, IDPROPERTY, isSiebelActive, jswarapper, NAMEPROPERTY, parentsTextDescendantsMayBeInteresting, READONLYPROPERTY, TAGPROPERTY, TESTDATA_TEXT, TEXTPROPERTY, UNIQUEIDPROPERTY

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

CUSTOM_DOMAIN_LIST, DOJO_CUSTOM_DOMAIN_NAME, SAPWEBPORTAL_CUSTOM_DOMAIN_NAME

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

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

Constructor and Description
CheckboxProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clickAtScreenPoint(MouseModifiers modifiers, java.awt.Point screenPoint) Generate a click at the screen point.
void	clickToState(MouseModifiers modifiers, State state)
void	clickToState(State state)
void	deselect()
void	dragToState(MouseModifiers modifiers, State state)
void	dragToState(State state)
protected java.util.Vector	getActionArgs(java.awt.Point point) Override of getActionArgs in base class to provide the subitem action data requested inside the base class implementation of processMouseEvent.
MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
MethodSpecification[]	getDataDrivableCommands(int includeChildren) Walks the proxy parent-child hierarchy and returns a command for each control that is data drivable.
Property[]	getDataDrivenRecognitionProperties(java.util.Hashtable radiobuttonGroups) Return a limited set of properties that can be used to identify all radiobuttons in the group.
ProxyTestObject[]	getMappableChildren() Uses getChildrenEnumeration to implement.
java.lang.Object	getRadioButtonGroup() Return access to the radio button group object.
java.lang.String	getRole() Returns TestObjectRole.ROLE_CHECK_BOX.
State	getState()
java.lang.String[]	getSubmitData() Return an array of String objects which contains Submit Data for the control.
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 marshaller is returned.
java.lang.String	getVariableDataDrivenRecognitionProperty(Property[] properties) Only one recognition property will be data driven by default, this method specifies that property.
void	indeterminate()
boolean	isRadioSelected() Specifies if the radiobutton is currently selected.
void	select()
void	setState(State state)
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.html.InputProxy

getDescriptiveName, isEnabled, isReadOnly, setProperty

Methods inherited from class com.rational.test.ft.domain.html.ElementProxy

shouldBeMapped

Methods inherited from class com.rational.test.ft.domain.html.HtmlGuiProxy

activateTopWindow, click, click, click, clickWithMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouseN, convertFromScreenToOffset, doScroll, doubleClick, doubleClick, doubleClick, doubleClickAtScreenPoint, drag, drag, drag, drag, dragAtScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, ensureObjectIsVisible, getChildAtPoint, getChildAtPoint, getChildAtPointN, getChildrenHandlesMatchingProperty, getClippedScreenRectangle, getClippingParent, getClippingParentRectangle, getCurrentMethod, getDefaultActionArgs, getDefaultPointToClick, getDefaultPointToClick, getMethodName, getMethodSpecForPoint, getPointFromAction, getPointOnObject, getPointToClick, getScreenCenter, getScreenPoint, getScreenPoint, getScreenRectangle, getTargetChildHandles, getTargetChildItem, getTargetChildItem, getTargetChildItems, getVisualClippableParent, hasFocus, hover, hover, hover, hover, hoverAtScreenPoint, isInView, isInView, isOpaque, isPointInObject, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClick, nClickAtScreenPoint, nClickDrag, nClickDragAtScreenPoint, nClickDragToScreenPoint, performAction, performClick, performClick, performDoubleClick, performSelect, performSetText, processHoverMouseEvent, processMouseEvent, processPreDownMouseEvent, processPreUpMouseEvent, proxyGetChildAtPoint, restoreTopLevelWindow, scrollIntoView, scrollIntoView, scrollIntoView, scrollIntoViewN, scrollIntoViewWithDirection, scrollIntoViewWithDirectionN, setClickArgs, setCurrentMethod, setDownPointArgs, setDrag, setMethodSpecification, setMethodSpecification, setMultiClickAction, snapToRectangle

Methods inherited from class com.rational.test.ft.domain.html.HtmlProxy

addAdditionalRecognitionProperties, addChildrenHandlesToVector, addChildrenToVector, addChildrenToVector, addDataDrivableCommands, addDojoDomain, addRecognitionProperty, adjustCustomDomains, calculateParentsTextDescendantsMayBecomeInteresting, callJqueryFind, clearAllSubdomains, clearCustomSubdomains, detach, disableAllHtmlCustomDomains, disableHtmlCustomDomain, disableHtmlCustomDomains, enableAllHtmlCustomDomains, enableHtmlCustomDomain, enableHtmlCustomDomains, equals, fetchProperties, find, findElementsByXpath, findElementsDirectly, findElementsViaQuery, findElementWithDynamicFind, findElementWithName, getAddedRecognitionProperty, getAddedRecognitionPropertyValue, getAddedRecognitionPropertyWeight, getBrowserAppVersion, getCachedData, getChannel, getChildren, getChildren, getChildren, getChildrenEnumeration, getChildrenEnumeration, getChildrenHandleEnumeration, getChildrenHandles, getChildrenN, getChildrenWithTagType, getClassIndex, getCustomClassProperty, getCustomClassPropertyValue, getCustomDomainName, getCustomDomainName, getCustomDomainName, getCustomDomainNameForChildren, getCustomDomainNameForParent, getCustomObject, getDisabledProperty, getDocClassIndex, getDocument, getDocument, getDocumentHandle, getDocumentWindow, getDomain, getElementHandlesByTag, getElementObjectsByTag, getElementsByNameInProxyTestObjects, getElementsByTag, getElementsByTag, getElementsByTagEnumeration, getElementsByTagInProxyTestObjects, getElementsByTagN, getElementsByXpath, getElementsByXpath, getElementsByXpathEnumeration, getElementsDirectly, getHandle, getHtmlTag, getHtmlTagNameFromClassProperty, getIgnorableProperties, getIndexer, getIndexers, getInterestingRecogPropsForDynFind, getJsProps, getJswarapper, getMappableChildren, getMappableElementsByNameInProxyTestObjects, getMappableElementsByTagInProxyTestObjects, getMappableParent, getMappableParent, getMethods, getNonValueProperties, getObject, getObjectClassName, getOwnedObjects, getOwnedObjects, getOwner, getParent, getParent, getParentN, getProperties, getProperties, getProperty, getProperty, getPropertyInternal, getPropertyInternalRunnable, getPropertyN, getProxyTestObjectsFromEnumeration, getReadOnlyProperty, getRecognitionProperties, getRecognitionPropertyWeight, getSavedDescriptiveName, getScriptCommandFlags, getStandardProperties, getStandardProperties, getTestDomain, getText, getTopMappableParent, getTopParent, getTopParent, getTopParentInternal, getTopParentN, getUniqueId, getValueProperty, getVisualTopParent, hasAddedRecognitionProperties, isClassIndexConsidered, isClassIndexPropertyAndValueDefined, isClassIndexSet, isContextObjectSet, isContextObjectSet, isDocClassIndexSet, isEqual, isFindOptimized, isObjectDead, isPropertyOptimizable, isReleaseRequired, isSameObject, isScoreForFindBYIdorName, isValidRecognitionProperty, isXpathSupported, matches, release, release, release, release, release, release, releaseElementHandle, releaseN, replaceAll, restoreAllCustomSubDomains, restoreCustomSubDomains, setCachedData, setClass, setClassIndex, setClassIndex, setClassIndex, setClassIndex, setClassIndex, setClassIndexOfChild, setCustomClassProperty, setCustomClassPropertyValue, setCustomDomainInContext, setDocClassIndex, setDocClassIndex, setDocClassIndex, setDocClassIndex, setDomain, setIndexer, setJswarapper, setProperty, setSavedDescriptiveName, shouldDocumentBeAdded, split

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

baseClassMatch, canTakeVP, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getElementWithFocus, getField, getObjectCustomClassName, getProxy, getScriptCommandAnchor, getVisualClippedRectangle, getVisualMappableChildren, getVOMSpecificProperty, hasSpecialFrameState, isValidObject, ping, suppressKeyAction

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckboxProxy

public CheckboxProxy(HtmlTestDomainImplementation domain,
             IChannel channel,
             long handle)

Method Detail

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_CHECK_BOX.

Overrides:

getRole in class HtmlProxy

Returns:

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

Since:

RFT1.0

getTestObjectClassName

public java.lang.String getTestObjectClassName()

Description copied from class: HtmlProxy

The default GUI marshaller is returned. More specific marshallers are returned by more constrained proxy classes. This level of support is always required.

Specified by:

getTestObjectClassName in interface IProxyBase

Overrides:

getTestObjectClassName in class HtmlGuiProxy

Returns:

The default mashaller class full name.

clickToState

public void clickToState(State state)

clickToState

public void clickToState(MouseModifiers modifiers,
                State state)

dragToState

public void dragToState(State state)

dragToState

public void dragToState(MouseModifiers modifiers,
               State state)

setState

public void setState(State state)

getState

public State getState()

select

public void select()

deselect

public void deselect()

indeterminate

public void indeterminate()

getActionArgs

protected java.util.Vector getActionArgs(java.awt.Point point)

Override of getActionArgs in base class to provide the subitem action data requested inside the base class implementation of processMouseEvent.

Overrides:

getActionArgs in class HtmlGuiProxy

Parameters:

point - point in screen coordinates

Returns:

a vector containing the appropriate subitem arguments.

getSubmitData

public java.lang.String[] getSubmitData()

Description copied from class: ControlProxy

Return an array of String objects which contains Submit Data for the control. Submit Data consists of "name=value" pairs (CGI data).

Overrides:

getSubmitData in class InputProxy

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 InputProxy

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 InputProxy

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 InputProxy

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

getDataDrivableCommands

public MethodSpecification[] getDataDrivableCommands(int includeChildren)

Description copied from class: ProxyTestObject

Walks the proxy parent-child hierarchy and returns a command for each control that is data drivable. Controls that are not data drivable and do not have children that are data drivable should return null.

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.

Specified by:

getDataDrivableCommands in interface IDataDriven

Overrides:

getDataDrivableCommands in class ProxyTestObject

Parameters:

includeChildren - Flag to control which child objects are considered for data driving. Must be IDataDriven.INCLUDE_JUSTOBJECT, IDataDriven.INCLUDE_SIBLINGS or IDataDriven.INCLUDE_ALL.

Returns:

An array of commands that can be data driven.

See Also:

ProxyTestObject.getDataDrivableCommand()

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 InputProxy

Since:

RFT2.0

See Also:

getDataDrivableCommands(int)

getRadioButtonGroup

public java.lang.Object getRadioButtonGroup()

Return access to the radio button group object. The object returned is used to correlate the radio button to other radio buttons relative to the same parent in the same group. If access to the group is not available then null should be returned and all radiobuttons in the parent will be treated as if they come from the same group.

Specified by:

getRadioButtonGroup in interface IRadioButtonProxy

Since:

RFT2.0

getDataDrivenRecognitionProperties

public Property[] getDataDrivenRecognitionProperties(java.util.Hashtable radiobuttonGroups)

Return a limited set of properties that can be used to identify all radiobuttons in the group. The values are specific to the one proxy but will be applied to all proxies when attempting to find radiobuttons in this group during playback. For instance returning the "text" property is only interesting if all properties in the group have a non-null, unique text property. Otherwise, something more resilient to a parent relative find should be used.

Specified by:

getDataDrivenRecognitionProperties in interface IRadioButtonProxy

Parameters:

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

Since:

RFT2.0

getVariableDataDrivenRecognitionProperty

public java.lang.String getVariableDataDrivenRecognitionProperty(Property[] properties)

Only one recognition property will be data driven by default, this method specifies that property. The returned property must be in the set of properties returned by #getDataDrivenRecognitionProperties() and nothing will be data driven if this property name is not in that set.

Specified by:

getVariableDataDrivenRecognitionProperty in interface IRadioButtonProxy

Parameters:

properties - The properties returned by IRadioButtonProxy.getDataDrivenRecognitionProperties(Hashtable).

Since:

RFT2.0

isRadioSelected

public boolean isRadioSelected()

Specifies if the radiobutton is currently selected. The selected value is used to as the initial value in the datapool when data driving is complete.

Specified by:

isRadioSelected in interface IRadioButtonProxy

Since:

RFT2.0

clickAtScreenPoint

protected void clickAtScreenPoint(MouseModifiers modifiers,
                      java.awt.Point screenPoint)

Description copied from class: HtmlGuiProxy

Generate a click at the screen point.

Overrides:

clickAtScreenPoint in class HtmlGuiProxy

Parameters:

modifiers - -

screenPoint - - point in screen coordinates

getMappableChildren

public ProxyTestObject[] getMappableChildren()

Uses getChildrenEnumeration to implement.

Overrides:

getMappableChildren in class HtmlProxy

Returns:

null, if no known children.