com.rational.test.ft.domain.html

Class EditboxProxy

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

All Implemented Interfaces:

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

public class EditboxProxy
extends InputProxy

Implements the proxy for HTML INPUT type=TEXT

• TestObject Interface: GuiTestObject
  
  
• Supported Test Data Types:
  

  Type	Desciption
  text	Visible Text	ITestDataText

  
  
• Default Recognition Properties:
  • .class
  • .classIndex
  • .id
  • .name
  • .title
  • .type
  
  
• 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.
  .id	This is the value of the id attribute of an element.
  .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, MAXIMIZE, OFFSETHEIGHTPROPERTY, OFFSETLEFTPROPERTY, OFFSETRECTPROPERTY, OFFSETTOPPROPERTY, OFFSETWIDTHPROPERTY, RESTORE

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	click(MouseModifiers modifiers)
protected void	clickAtScreenPoint(MouseModifiers modifiers, java.awt.Point screenPoint) Note**** The following method and the TextBoxClicker below has been overridden below to fix: WI 4812 After Just clicking the Textbox if we have to scroll then the Textbox seems to be snatching the focus back.
java.lang.String	getClearscriptSimpleName()
MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
java.lang.String	getRole() Returns TestObjectRole.ROLE_TEXT.
java.lang.String	getTestObjectClassName() The default GUI marshaller is returned.
java.lang.String	getText() Allow direct acess to the text property on the control.
boolean	isEditable() Check if the text component is editable.
boolean	isInView() Is the object in view (not clipped)?
boolean	isReadOnly()
void	setText(java.lang.String text) Directly modify the text on the control.
boolean	shouldBeMapped() Always returns true, because all HTML GUI objects are interesting.

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

getSubmitData, getTestData, getTestDataTypes, isEnabled, setProperty, updateTestData

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

activateTopWindow, 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, getActionArgs, getChildAtPoint, getChildAtPoint, getChildAtPointN, getChildrenHandlesMatchingProperty, getClippedScreenRectangle, getClippingParent, getClippingParentRectangle, getCurrentMethod, getDefaultActionArgs, getDefaultPointToClick, getDefaultPointToClick, getMappableDocument, getMethodName, getMethodSpecForPoint, getPointFromAction, getPointOnObject, getPointToClick, getScreenCenter, getScreenPoint, getScreenPoint, getScreenRectangle, getTargetChildHandles, getTargetChildItem, getTargetChildItem, getTargetChildItems, getVisualClippableParent, hasFocus, hover, hover, hover, hover, hoverAtScreenPoint, isInView, isOpaque, isPointInObject, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClick, nClickAtScreenPoint, nClickDrag, nClickDragAtScreenPoint, nClickDragToScreenPoint, performAction, performClick, performClick, performDoubleClick, performSelect, performSetText, performWindowAction, 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, 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, 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, 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

EditboxProxy

public EditboxProxy(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 InputProxy

Returns:

A descriptive object name.

shouldBeMapped

public boolean shouldBeMapped()

Description copied from class: ElementProxy

Always returns true, because all HTML GUI objects are interesting.

Overrides:

shouldBeMapped in class ElementProxy

Returns:

false

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_TEXT.

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.

isEditable

public boolean isEditable()

Check if the text component is editable.

Returns:

true is returned if the text component is editable.

Since:

RFT2.0

isReadOnly

public boolean isReadOnly()

Overrides:

isReadOnly in class InputProxy

getText

public java.lang.String getText()

Allow direct acess to the text property on the control.

Overrides:

getText in class HtmlProxy

Returns:

The active text in the control.

Since:

RFT2.0

setText

public void setText(java.lang.String text)

Directly modify the text on the control. Any existing text in the control is replaced with the specified text value. This command will attempt to playback this action from the glass when possible.

Parameters:

text - The text to update the control with.

Since:

RFT2.0

isInView

public boolean isInView()

Description copied from class: HtmlGuiProxy

Is the object in view (not clipped)?

Overrides:

isInView in class HtmlGuiProxy

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:

ProxyTestObject.getDataDrivableCommands(int)

clickAtScreenPoint

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

Note**** The following method and the TextBoxClicker below has been overridden below to fix: WI 4812 After Just clicking the Textbox if we have to scroll then the Textbox seems to be snatching the focus back. making the next control go out of view again. This does not happen if there is a sleep(1) ; or if debugging is enabled. Adding a delay of 500ms after invoking a click on Textbox fixes the problem.

Overrides:

clickAtScreenPoint in class HtmlGuiProxy

Parameters:

modifiers - -

screenPoint - - point in screen coordinates

getClearscriptSimpleName

public java.lang.String getClearscriptSimpleName()

click

public void click(MouseModifiers modifiers)

Overrides:

click in class HtmlGuiProxy