com.rational.test.ft.domain.html

Class OptionProxy

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

com.rational.test.ft.domain.html.OptionProxy

All Implemented Interfaces:

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

public class OptionProxy
extends SubobjectProxy

Implements the proxy for HTML Option elements. This object does not represent a full fledged object, but a subobject of selected elements.

• TestObject Interface: GuiTestObject
  
  
• Supported Canonical Properties:
  

  Property	Usage
  .bounds	A rectangle representing the bounding rectangle of the object in screen coordinates.
  .class	This is the test object class name, for example "HtmlTable" for a <Table> element.
  .defaultSelected	This is a boolean value that when true indicates that the Option element in a Select element (listbox or dropdown) is selected by default when the page is displayed.
  .id	This is the value of the id attribute of an element.
  .index	This is the index of the OPTION element within a listbox or combodropdown list.
  .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.
  .selected	This is a boolean value that indicates whether the Option element in a Select (Listbox or dropdown) is selected.
  .screenLeft	Upper left corner of bounding rectangle in screen coordinates, x component.
  .screenTop	Upper left corner of bounding rectangle in screen coordinates, y component.
  .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.
  .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.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, DISABLEDPROPERTY, DOCCLASSINDEX, dojoProps, domain, HTMLPROXYCHANNELRUNNABLE_TIMEOUTVALUE, IDPROPERTY, isSiebelActive, jswarapper, NAMEPROPERTY, parentsTextDescendantsMayBeInteresting, READONLYPROPERTY, TAGPROPERTY, TESTDATA_TEXT, TEXTPROPERTY, TITLEPROPERTY, 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
OptionProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) compare the option element to the subitem, return true if it matches the value expressed by the subitem.
boolean	equals(Subitem subitem, java.lang.String label) This method is used to compare the subitem along with the option group.
IGraphical	getClippingParent() Get the clipping parent for this object.
java.lang.String	getLabel()
int	getMyIndex()
java.lang.String	getOptionValue()
java.awt.Rectangle	getScreenRectangle()
Subitem	getSubitem() Return a subitem object that identifies the subobject
int	index() Retrieve the index attribute from the Option element.
boolean	isInView() Is the object in view (not clipped)?
boolean	isPointInObject(java.awt.Point point)
boolean	isSelected() Is this option element currently selected?
static boolean	isSupported(Subitem subitem)
void	select(boolean select) select or deselect the Optin element.
void	setMyIndex(int index)
java.lang.String	value() Retrieve the value attribute from the Option element.

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

shouldBeMapped

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

activateTopWindow, click, click, click, clickAtScreenPoint, clickWithMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouse, clickWithOutMouseN, convertFromScreenToOffset, doScroll, doubleClick, doubleClick, doubleClick, doubleClickAtScreenPoint, drag, drag, drag, drag, dragAtScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, ensureObjectIsVisible, getActionArgs, getChildAtPoint, getChildAtPoint, getChildAtPointN, getChildrenHandlesMatchingProperty, getClippedScreenRectangle, getClippingParentRectangle, getCurrentMethod, getDefaultActionArgs, getDefaultPointToClick, getDefaultPointToClick, getMethodName, getMethodSpecForPoint, getPointFromAction, getPointOnObject, getPointToClick, getScreenCenter, getScreenPoint, getScreenPoint, getTargetChildHandles, getTargetChildItem, getTargetChildItem, getTargetChildItems, getTestObjectClassName, getVisualClippableParent, hasFocus, hover, hover, hover, hover, hoverAtScreenPoint, isEnabled, isInView, isOpaque, 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, 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, getDataDrivableCommand, getDescriptiveName, 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, 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, getRole, getSavedDescriptiveName, getScriptCommandFlags, getStandardProperties, getStandardProperties, getTestData, getTestDataTypes, 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, setProperty, setSavedDescriptiveName, shouldDocumentBeAdded, split, updateTestData

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

baseClassMatch, canTakeVP, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getDataDrivableCommands, 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

OptionProxy

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

Method Detail

getScreenRectangle

public java.awt.Rectangle getScreenRectangle()

Overrides:

getScreenRectangle in class HtmlGuiProxy

getClippingParent

public IGraphical getClippingParent()

Description copied from class: HtmlGuiProxy

Get the clipping parent for this object. The clipping parent is the object whose rectangle will clip all of its children, usually the browser or a frame. Unfortunately, it can also be a div tag in the object hierarchy, so going directly to the document does not worl

Overrides:

getClippingParent in class HtmlGuiProxy

isInView

public boolean isInView()

Description copied from class: HtmlGuiProxy

Is the object in view (not clipped)?

Overrides:

isInView in class HtmlGuiProxy

select

public void select(boolean select)

select or deselect the Optin element.

Parameters:

select - - true then select the Option, false then deselect the option.

value

public java.lang.String value()

Retrieve the value attribute from the Option element.

Returns:

String - value of value attribute.

index

public int index()

Retrieve the index attribute from the Option element.

Returns:

int - index of this Option element

getLabel

public java.lang.String getLabel()

getOptionValue

public java.lang.String getOptionValue()

isSelected

public boolean isSelected()

Is this option element currently selected?

Returns:

true - selected

getSubitem

public Subitem getSubitem()

Description copied from class: SubobjectProxy

Return a subitem object that identifies the subobject

Specified by:

getSubitem in class SubobjectProxy

equals

public boolean equals(java.lang.Object other)

compare the option element to the subitem, return true if it matches the value expressed by the subitem.

Overrides:

equals in class HtmlProxy

Parameters:

subitem - - subclass of subitem, currently supports Index, Text, and Value.

Returns:

true - matches subitem.

isSupported

public static boolean isSupported(Subitem subitem)

isPointInObject

public boolean isPointInObject(java.awt.Point point)

Overrides:

isPointInObject in class HtmlGuiProxy

equals

public boolean equals(Subitem subitem,
             java.lang.String label)

This method is used to compare the subitem along with the option group.

Parameters:

subitem -

label -

Returns:

getMyIndex

public int getMyIndex()

setMyIndex

public void setMyIndex(int index)