com.rational.test.ft.domain.html

Class HtmlHTMLDialogProxy

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

com.rational.test.ft.domain.html.HtmlBrowserProxy

com.rational.test.ft.domain.html.HtmlHTMLDialogProxy

All Implemented Interfaces:

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

public class HtmlHTMLDialogProxy
extends HtmlBrowserProxy

Provides the proxy for HTML browser objects in the HtmlTestDomainImplementation.

• TesObject Interface: BrowserTestObject
  
  
• Supported Test Data Types:
  

  Type	Desciption
  text	Visible Text	ITestDataText

  
  
• Default Recognition Properties:
  • .class
  • .classIndex
  • .text
  
  
• Supported Canonical Properties:
  

  Property	Usage
  .align	This is the value of the align attribute of the element. Valid values are bottom, middle, and top.
  .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.
  .border	This is the value of the border attribute of the element. Returns the number of pixels.
  .bounds	A rectangle representing the bounding rectangle of the object in screen coordinates.
  .caption	For TABLE elements is the the value of the caption attribute. For an Html dialog this is the text of the dialog's caption.
  .cellIndex	The cell index of an element with respect to its row (0>=)
  .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 (used for stylesheets in HTML).
  .clientRect	The bounding rectangle of the element in client coordinates.
  .colSpan	The value of the colspan attribute of an element.
  .code	The value of the code attribute of an APPLET element.
  .codeBase	The value of codebase attribute of an APPLET element.
  .cookie	This is the current value of the cookie for the document.
  .coords	The value of the coords attribute of an element. This is string containing the coordinates used to define the AREA of client side image map. In the form x1, y1, x2,y2, etc.
  .defaultChecked	This is a boolean value for the defaultchecked attribute of the 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.
  .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.
  .height	The value of the height attribute of an element. For an Image element this is the display height in pixels for the image.
  .href	The value of the href attribute of an element. This is a URL used by ANCHOR and AREA elements to indicate the result of clicking on the corresponding element.
  .hspace	The value of the hspace attribute of an element, the amount of whitespace inserted to the left or right of an IMG, OBJECT, or APPLET.
  .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.
  .isMap	The value of the isMap attribute of an element returned as a boolean. For Image elements (IMG) if this is TRUE then this indicates a server side image map.
  .length	The value of the length attribute of an element. For a Select element this indicates the number of items in the list.
  .maxLength	For an edit control (Input type=Text or TextArea) this indicates the maximum number of characters a user may enter.
  .multiple	The value of the multiple attribute of an element. For a Select element (Listbox or combo dropdown) this indicates that the list supports multiple selection, returned as a boolean.
  .name	This is the value of the name attribute (Form elements and Frames only)
  .noHref	The value of the nohref attribute of an element. When set on an AREA element indicates that the corresponding area has no associated action.
  .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.
  .readyState	This is the current status of a browser, indicating whether it is currently loading a document or is ready for user input. This is an integer value: 0 - Uninitialized 1 - Loading 2 - Loaded 3- Interactive 4 - Complete (ready)
  .rowIndex	The row index of an element in a table (0>= ).
  .rows	The value of the rows attribute of a TEXTAREA element, indicating the size of the edit control in number of rows of text.
  .rowSpan	The value of the rowspan attribute of an element.
  .select	This is boolean value that Indicates whether the form element is highlighted to receive user input.
  .selected	This is a boolean value that indicates whether the Option element in a Select (Listbox or dropdown) is selected.
  .selectedIndex	The value of the selectedIndex attribute of an element. For a single selection Select element, this indicates which option element is selected. Integer in the range of >=0.
  .screenLeft	Upper left corner of bounding rectangle in screen coordinates, x component.
  .screenTop	Upper left corner of bounding rectangle in screen coordinates, y component.
  .shape	The value of the shapeattribute of an element. Used for AREA elements in client side image maps. Valid values are default, rect, circle, and poly.
  .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
  .target	The value of the target attribute of an element. For anchors this indicates the name of the target frame, that is, the frame where the document should be opened.
  .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.
  .url	This is the url of the document.
  .useMap	The value of the usemap attribute of an element. The value is a string specifying a URL and is used for Image elements (IMG) to indicate a client side image map. The URL points to the map associated MAP. Frequently, this is a document relative reference.
  .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.
  .vspace	The value of the vspace attribute of an element, the amount of whitespace inserted to the above or below of an IMG, OBJECT, or APPLET.
  .width	The value of the width attribute of an element. For an Image element this is the display width in pixels for the image.
  .window	This is the heavyweight window for the element returned as a long. For the Browser, this is the top level window.

  
  

Since:

RFT1.0

Nested Class Summary

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

HtmlBrowserProxy.GetDocClippedScreenRectangleRunnable, HtmlBrowserProxy.GetHandleAtPointRunnable, HtmlBrowserProxy.GetPropertyInternalRunnable

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

TopLevelWindowProxy.CharEmiter, TopLevelWindowProxy.KeyEmiter

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

Modifier and Type	Field and Description
protected static FtDebug	debug

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, 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
HtmlHTMLDialogProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
ScriptCommandFlags	getReadyState()
ScriptCommandFlags	getScriptCommandFlags() This method returns an active state value that reflects the state of the test object at the time of the call.
void	processBrowserPostUpMouseEvent(IMouseActionInfo action)
void	processBrowserPreDownMouseEvent(IMouseActionInfo action)

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

back, back, close, deleteAllCookies, deleteCookies, deleteCookies, deleteCookies, forward, forward, getBrowserDocument, getChildAtPoint, getChildDocumentProxy, getChildren, getChildren, getClippingParent, getDocument, getElementWithFocus, getFlexObjectHandle, getMappableChildren, getMappableChildren, getMethodSpecForPoint, getProperty, getPropertyInternal, getRole, getScriptCommandAnchor, getTestObjectClassName, getTopParent, getUniqueId, getWindow, home, home, isPropertyOptimizable, loadUrl, loadUrl, loadUrl, processMouseEvent, setChildDocumentProxy, setClassIndex, setMethodSpecification, setMethodSpecification, shouldBeMapped, suppressKeyAction

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

activate, clickDisabled, contextHelp, getOwner, inputChars, inputKeys, isIconified, isShowing, maximize, minimize, move, resize, restore

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, getChildAtPointN, getChildrenHandlesMatchingProperty, getClippedScreenRectangle, getClippingParentRectangle, getCurrentMethod, getDefaultActionArgs, getDefaultPointToClick, getDefaultPointToClick, getMethodName, getPointFromAction, getPointOnObject, getPointToClick, getScreenCenter, getScreenPoint, getScreenPoint, getScreenRectangle, getTargetChildHandles, getTargetChildItem, getTargetChildItem, getTargetChildItems, getVisualClippableParent, hasFocus, hover, hover, hover, hover, hoverAtScreenPoint, isEnabled, isInView, isInView, isOpaque, isPointInObject, isPointInObject, mouseMove, mouseMove, nClick, nClick, nClickAtScreenPoint, nClickDrag, nClickDragAtScreenPoint, nClickDragToScreenPoint, performAction, performClick, performClick, performDoubleClick, performSelect, performSetText, processHoverMouseEvent, processPreDownMouseEvent, processPreUpMouseEvent, proxyGetChildAtPoint, restoreTopLevelWindow, scrollIntoView, scrollIntoView, scrollIntoView, scrollIntoViewN, scrollIntoViewWithDirection, scrollIntoViewWithDirectionN, setClickArgs, setCurrentMethod, setDownPointArgs, setDrag, 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, getChildrenEnumeration, getChildrenEnumeration, getChildrenHandleEnumeration, getChildrenHandles, getChildrenN, getChildrenWithTagType, getClassIndex, getCustomClassProperty, getCustomClassPropertyValue, getCustomDomainName, getCustomDomainName, getCustomDomainName, getCustomDomainNameForChildren, getCustomDomainNameForParent, getCustomObject, getDataDrivableCommand, getDisabledProperty, getDocClassIndex, 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, getMappableElementsByNameInProxyTestObjects, getMappableElementsByTagInProxyTestObjects, getMappableParent, getMappableParent, getMethods, getNonValueProperties, getObject, getObjectClassName, getOwnedObjects, getOwnedObjects, getParent, getParent, getParentN, getProperties, getProperties, getProperty, getPropertyInternalRunnable, getPropertyN, getProxyTestObjectsFromEnumeration, getReadOnlyProperty, getRecognitionProperties, getRecognitionPropertyWeight, getSavedDescriptiveName, getStandardProperties, getStandardProperties, getTestData, getTestDataTypes, getTestDomain, getText, getTopMappableParent, getTopParent, getTopParentInternal, getTopParentN, getValueProperty, getVisualTopParent, hasAddedRecognitionProperties, isClassIndexConsidered, isClassIndexPropertyAndValueDefined, isClassIndexSet, isContextObjectSet, isContextObjectSet, isDocClassIndexSet, isEqual, isFindOptimized, isObjectDead, isReleaseRequired, isSameObject, isScoreForFindBYIdorName, isValidRecognitionProperty, isXpathSupported, matches, release, release, release, release, release, release, releaseElementHandle, releaseN, replaceAll, restoreAllCustomSubDomains, restoreCustomSubDomains, setCachedData, setClass, 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, getField, getObjectCustomClassName, getProxy, getVisualClippedRectangle, getVisualMappableChildren, getVOMSpecificProperty, hasSpecialFrameState, isValidObject, ping

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static FtDebug debug

Constructor Detail

HtmlHTMLDialogProxy

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

Method Detail

getDescriptiveName

public java.lang.String getDescriptiveName()

Description copied from class: HtmlProxy

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 Html 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 Html.BUTTON with the text "OK" on it.

Overrides:

getDescriptiveName in class HtmlBrowserProxy

Returns:

A descriptive object name.

getScriptCommandFlags

public ScriptCommandFlags getScriptCommandFlags()

Description copied from class: ProxyTestObject

This method returns an active state value that reflects the state of the test object at the time of the call. The state includes values such as enabled and showing< and allows the find algorithm to wait until a required state has been achieved.

Overrides:

getScriptCommandFlags in class HtmlBrowserProxy

Returns:

An object that reflects the active state of the represented test object.

getReadyState

public ScriptCommandFlags getReadyState()

Overrides:

getReadyState in class HtmlBrowserProxy

processBrowserPreDownMouseEvent

public void processBrowserPreDownMouseEvent(IMouseActionInfo action)

Overrides:

processBrowserPreDownMouseEvent in class TopLevelWindowProxy

processBrowserPostUpMouseEvent

public void processBrowserPostUpMouseEvent(IMouseActionInfo action)

Overrides:

processBrowserPostUpMouseEvent in class TopLevelWindowProxy