com.rational.test.ft.domain.html

Class HtmlGuiProxy

java.lang.Object

RegisteredObject

com.rational.test.ft.domain.ProxyTestObject

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ElementProxy, EmbeddedBrowserProxy, GenericHtmlGuiProxy, HtmlDocumentProxy, MapProxy, SubobjectProxy, TableDataCellProxy, TableRowProxy, TextNodeProxy, TopLevelWindowProxy

public class HtmlGuiProxy
extends HtmlProxy

This is the HTML GUI object proxies base class, all HTML GUI proxies must extend this class. The abstract ProxyTestObject base class defines the non-GUI object properties required to implement a proxy object. This abstract class extends that definition with the additional properties needed for a GUI object.

This class further contains the default implementation of various base class methods that proxy implementations may need to extend or override.

• TestObject Interface: GuiTestObject
  
  
• Supported Test Data Types:
  

  Type	Desciption
  text	Visible Text	ITestDataText

  
  
• Default Recognition Properties:
  • .class
  • .classIndex
  • .id
  • .title
  
  
• 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.
  .id	This is the value of the id attribute of an element.
  .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.
  .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.

  
  

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HtmlGuiProxy.Clicker
protected class	HtmlGuiProxy.DoubleClicker
protected class	HtmlGuiProxy.Dragger
protected class	HtmlGuiProxy.Hoverer
protected class	HtmlGuiProxy.nClickDragger
protected class	HtmlGuiProxy.nClicker
protected class	HtmlGuiProxy.PointIterator PointIterator class is an internal class used to iterate over the points in a rectangle which may be tried for clicking.

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 java.lang.String	currentMethod
protected static MouseModifiers	LEFT
static java.lang.String	OFFSETHEIGHTPROPERTY
static java.lang.String	OFFSETLEFTPROPERTY
static java.lang.String	OFFSETRECTPROPERTY
static java.lang.String	OFFSETTOPPROPERTY
static java.lang.String	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
HtmlGuiProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle)
HtmlGuiProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle, IBrowserCommunicator jswrap)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateTopWindow()
void	click()
void	click(MouseModifiers modifiers)
void	click(MouseModifiers modifiers, java.awt.Point pt)
protected void	clickAtScreenPoint(MouseModifiers modifiers, java.awt.Point screenPoint) Generate a click at the screen point.
void	clickWithMouse(MouseModifiers modifiers)
boolean	clickWithOutMouse()
boolean	clickWithOutMouse(long handle)
boolean	clickWithOutMouse(MouseModifiers modifiers)
boolean	clickWithOutMouse(MouseModifiers modifiers, long handle)
boolean	clickWithOutMouse(MouseModifiers modifiers, java.awt.Point pt)
boolean	clickWithOutMouse(MouseModifiers modifiers, java.awt.Point pt, long handle)
boolean	clickWithOutMouseN(long handle)
java.awt.Point	convertFromScreenToOffset(java.awt.Point pt)
void	doScroll(HtmlGuiProxy subObject)
void	doubleClick()
void	doubleClick(MouseModifiers modifiers)
void	doubleClick(MouseModifiers modifiers, java.awt.Point pt)
protected void	doubleClickAtScreenPoint(MouseModifiers modifiers, java.awt.Point screenPoint)
void	drag()
void	drag(MouseModifiers modifiers)
void	drag(MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
void	drag(java.awt.Point pt1, java.awt.Point pt2)
protected void	dragAtScreenPoint(MouseModifiers modifiers, java.awt.Point screenPoint1, java.awt.Point screenPoint2) Generate a drag using the screen points.
void	dragToScreenPoint(MouseModifiers modifiers, java.awt.Point objectPoint, java.awt.Point screenPoint)
void	dragToScreenPoint(java.awt.Point screenPt)
void	dragToScreenPoint(java.awt.Point objectPoint, java.awt.Point screenPoint)
boolean	ensureObjectIsVisible()
protected java.util.Vector	getActionArgs(java.awt.Point point) Generate the action argument for the screen point.
long	getChildAtPoint(long handle, int x, int y)
java.lang.Object	getChildAtPoint(java.awt.Point pt) Finds the most interesting child object at the specified point.
long	getChildAtPointN(long handle, int x, int y)
java.util.ArrayList	getChildrenHandlesMatchingProperty(java.lang.String propertyName, java.util.ArrayList propertyValues)
java.awt.Rectangle	getClippedScreenRectangle()
IGraphical	getClippingParent() Get the clipping parent for this object.
java.awt.Rectangle	getClippingParentRectangle() Return the screen rectangle of this objects clipping parent.
java.lang.String	getCurrentMethod()
protected java.util.Vector	getDefaultActionArgs(java.awt.Point point)
protected java.awt.Point	getDefaultPointToClick() Determines the default click point by performing hit tests on candidates.
protected java.awt.Point	getDefaultPointToClick(java.awt.Rectangle screenRect) Determines the default click point by performing hit tests on candidates.
protected java.lang.String	getMethodName(IMouseActionInfo action)
MethodSpecification	getMethodSpecForPoint(java.awt.Point pt) Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
java.awt.Point	getPointFromAction(IMouseActionInfo action, int index)
java.awt.Point	getPointOnObject()
protected java.awt.Point	getPointToClick(java.awt.Rectangle screenRect) Find a clickable point for this object within the given screen rectangle.
protected java.awt.Point	getScreenCenter() Get screen rectangle for object and caluclate the center point of the rectangle.
java.awt.Point	getScreenPoint()
java.awt.Point	getScreenPoint(java.awt.Point objectPoint)
java.awt.Rectangle	getScreenRectangle()
java.util.ArrayList	getTargetChildHandles(java.lang.String childTagName, java.lang.String property, java.util.ArrayList propertyValues)
HtmlGuiProxy	getTargetChildItem(HtmlProxy proxy, java.lang.String childTagName, java.lang.String property, java.util.ArrayList propertyValues)
HtmlGuiProxy	getTargetChildItem(java.lang.String childTagName, java.lang.String property, java.util.ArrayList propertyValues)
java.util.ArrayList	getTargetChildItems(java.lang.String childTagName, java.lang.String property, java.util.ArrayList propertyValues)
java.lang.String	getTestObjectClassName() The default GUI marshaller is returned.
protected ProxyTestObject	getVisualClippableParent() Return the clippable parent for the control
boolean	hasFocus()
void	hover()
void	hover(double delay)
void	hover(double delay, java.awt.Point pt)
void	hover(java.awt.Point pt)
protected void	hoverAtScreenPoint(double delay, java.awt.Point screenPoint)
boolean	isEnabled()
boolean	isInView() Is the object in view (not clipped)?
boolean	isInView(java.awt.Point pt)
boolean	isOpaque()
boolean	isPointInObject(long handle, int x, int y)
boolean	isPointInObject(java.awt.Point point)
boolean	isShowing()
void	mouseMove(MouseModifiers modifiers, java.awt.Point pt)
void	mouseMove(java.awt.Point pt)
void	nClick(int clickCount, MouseModifiers modifiers)
void	nClick(int clickCount, MouseModifiers modifiers, java.awt.Point pt)
protected void	nClickAtScreenPoint(int clickCount, MouseModifiers modifiers, java.awt.Point screenPoint) Generate a nClick at the screen point.
void	nClickDrag(int clickCount, MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2)
protected void	nClickDragAtScreenPoint(int clickCount, MouseModifiers modifiers, java.awt.Point screenPoint1, java.awt.Point screenPoint2)
void	nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt)
boolean	performAction(long handle, java.lang.String action, java.lang.String text)
boolean	performClick(MouseModifiers modifiers)
boolean	performClick(MouseModifiers modifiers, java.awt.Point pt)
boolean	performDoubleClick(MouseModifiers modifiers)
boolean	performSelect(java.lang.String item)
boolean	performSetText(java.lang.String text)
protected void	processHoverMouseEvent(IMouseActionInfo action)
void	processMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
protected void	processPreDownMouseEvent(IMouseActionInfo action)
protected void	processPreUpMouseEvent(IMouseActionInfo action, int clicks, boolean isDrag) This method is called to process a mouse event, IMouseActionInfo.PRE_UP event state On PRE_UP build a new method specification will override the one recorded on the PRE_DOWN.
java.lang.Object	proxyGetChildAtPoint(java.awt.Point pt)
protected void	restoreTopLevelWindow()
boolean	scrollIntoView()
boolean	scrollIntoView(boolean scrollDirection)
protected boolean	scrollIntoView(long nativeHandle)
protected boolean	scrollIntoViewN(long handle)
protected boolean	scrollIntoViewWithDirection(long nativeHandle, boolean scrollDirection)
protected boolean	scrollIntoViewWithDirectionN(long handle, boolean scrollDirection)
protected java.util.Vector	setClickArgs(int modifiers) Set args for click (depends on clickArgs member variable set by getActionArgs in PRE_DOWN)
void	setCurrentMethod(java.lang.String currentMethod)
protected java.util.Vector	setDownPointArgs(int modifiers) Set args for down point (depends on clickArgs member variable set by getActionArgs in PRE_DOWN)
protected java.util.Vector	setDrag(IMouseActionInfo action, int modifiers, java.awt.Point firstPoint, java.awt.Point nthPoint) Set args and method for single click drag member variable screenRect must be set before calling this method.
protected void	setMethodSpecification(IMouseActionInfo action, java.lang.String method, java.util.Vector args)
protected void	setMethodSpecification(IMouseActionInfo action, java.lang.String method, java.util.Vector args, ScriptCommandFlags flags)
protected java.util.Vector	setMultiClickAction(int clicks, int modifiers, boolean isDrag, java.awt.Point firstPoint, java.awt.Point nthPoint) Set args for multi-click action (more than two clicks in one place, or more than one click drag) member variable screenRect must be set before calling this method.
static java.awt.Point	snapToRectangle(java.awt.Rectangle rect, java.awt.Point originalPoint)

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, 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, shouldBeMapped, 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

Field Detail

LEFT

protected static final MouseModifiers LEFT

currentMethod

protected java.lang.String currentMethod

OFFSETWIDTHPROPERTY

public static final java.lang.String OFFSETWIDTHPROPERTY

See Also:

Constant Field Values

OFFSETHEIGHTPROPERTY

public static final java.lang.String OFFSETHEIGHTPROPERTY

See Also:

Constant Field Values

OFFSETLEFTPROPERTY

public static final java.lang.String OFFSETLEFTPROPERTY

See Also:

Constant Field Values

OFFSETTOPPROPERTY

public static final java.lang.String OFFSETTOPPROPERTY

See Also:

Constant Field Values

OFFSETRECTPROPERTY

public static final java.lang.String OFFSETRECTPROPERTY

See Also:

Constant Field Values

Constructor Detail

HtmlGuiProxy

public HtmlGuiProxy(HtmlTestDomainImplementation domain,
            IChannel channel,
            long handle,
            IBrowserCommunicator jswrap)

HtmlGuiProxy

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

Method Detail

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 HtmlProxy

Returns:

The default mashaller class full name.

click

public void click()

click

public void click(MouseModifiers modifiers)

clickWithMouse

public void clickWithMouse(MouseModifiers modifiers)

click

public void click(MouseModifiers modifiers,
         java.awt.Point pt)

clickAtScreenPoint

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

Generate a click at the screen point.

Parameters:

modifiers - -

screenPoint - - point in screen coordinates

restoreTopLevelWindow

protected void restoreTopLevelWindow()

activateTopWindow

protected void activateTopWindow()

doubleClickAtScreenPoint

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

doubleClick

public void doubleClick()

doubleClick

public void doubleClick(MouseModifiers modifiers)

doubleClick

public void doubleClick(MouseModifiers modifiers,
               java.awt.Point pt)

drag

public void drag()

drag

public void drag(MouseModifiers modifiers)

drag

public void drag(MouseModifiers modifiers,
        java.awt.Point pt1,
        java.awt.Point pt2)

snapToRectangle

public static java.awt.Point snapToRectangle(java.awt.Rectangle rect,
                             java.awt.Point originalPoint)

drag

public void drag(java.awt.Point pt1,
        java.awt.Point pt2)

dragToScreenPoint

public void dragToScreenPoint(MouseModifiers modifiers,
                     java.awt.Point objectPoint,
                     java.awt.Point screenPoint)

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point screenPt)

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point objectPoint,
                     java.awt.Point screenPoint)

dragAtScreenPoint

protected void dragAtScreenPoint(MouseModifiers modifiers,
                     java.awt.Point screenPoint1,
                     java.awt.Point screenPoint2)

Generate a drag using the screen points.

Parameters:

modifiers - -

screenPoint1 - - point in screen coordinates

screenPoint1 - - point in screen coordinates

getScreenPoint

public java.awt.Point getScreenPoint()

getScreenPoint

public java.awt.Point getScreenPoint(java.awt.Point objectPoint)

getScreenRectangle

public java.awt.Rectangle getScreenRectangle()

getClippedScreenRectangle

public java.awt.Rectangle getClippedScreenRectangle()

hasFocus

public boolean hasFocus()

hover

public void hover(double delay)

hover

public void hover(double delay,
         java.awt.Point pt)

hover

public void hover()

hover

public void hover(java.awt.Point pt)

hoverAtScreenPoint

protected void hoverAtScreenPoint(double delay,
                      java.awt.Point screenPoint)

getScreenCenter

protected java.awt.Point getScreenCenter()

Get screen rectangle for object and caluclate the center point of the rectangle.

Returns:

center point of object in screen coordinates.

isEnabled

public boolean isEnabled()

isOpaque

public boolean isOpaque()

getClippingParent

public IGraphical getClippingParent()

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

getClippingParentRectangle

public java.awt.Rectangle getClippingParentRectangle()

Return the screen rectangle of this objects clipping parent.

isPointInObject

public boolean isPointInObject(java.awt.Point point)

isPointInObject

public boolean isPointInObject(long handle,
                      int x,
                      int y)

ensureObjectIsVisible

public boolean ensureObjectIsVisible()

doScroll

public void doScroll(HtmlGuiProxy subObject)

scrollIntoView

public boolean scrollIntoView()

scrollIntoView

public boolean scrollIntoView(boolean scrollDirection)

scrollIntoView

protected boolean scrollIntoView(long nativeHandle)

scrollIntoViewN

protected boolean scrollIntoViewN(long handle)

scrollIntoViewWithDirection

protected boolean scrollIntoViewWithDirection(long nativeHandle,
                                  boolean scrollDirection)

scrollIntoViewWithDirectionN

protected boolean scrollIntoViewWithDirectionN(long handle,
                                   boolean scrollDirection)

getChildAtPoint

public java.lang.Object getChildAtPoint(java.awt.Point pt)

Finds the most interesting child object at the specified point. Note that the point is relative to the top left corner of the screen, and not the component itself or its parent.

If this object has no children, it should return null.

Parameters:

pt - Screen relative point to check.

Returns:

The object at the point or null if no child object is found.

See Also:

getScreenRectangle()

proxyGetChildAtPoint

public java.lang.Object proxyGetChildAtPoint(java.awt.Point pt)

convertFromScreenToOffset

public java.awt.Point convertFromScreenToOffset(java.awt.Point pt)

getChildAtPoint

public long getChildAtPoint(long handle,
                   int x,
                   int y)

getChildAtPointN

public long getChildAtPointN(long handle,
                    int x,
                    int y)

isShowing

public boolean isShowing()

isInView

public boolean isInView()

Is the object in view (not clipped)?

isInView

public boolean isInView(java.awt.Point pt)

mouseMove

public void mouseMove(MouseModifiers modifiers,
             java.awt.Point pt)

mouseMove

public void mouseMove(java.awt.Point pt)

nClick

public void nClick(int clickCount,
          MouseModifiers modifiers)

nClick

public void nClick(int clickCount,
          MouseModifiers modifiers,
          java.awt.Point pt)

nClickAtScreenPoint

protected void nClickAtScreenPoint(int clickCount,
                       MouseModifiers modifiers,
                       java.awt.Point screenPoint)

Generate a nClick at the screen point.

Parameters:

modifiers - -

screenPoint - - point in screen coordinates

nClickDrag

public void nClickDrag(int clickCount,
              MouseModifiers modifiers,
              java.awt.Point pt1,
              java.awt.Point pt2)

nClickDragToScreenPoint

public void nClickDragToScreenPoint(int clickCount,
                           MouseModifiers modifiers,
                           java.awt.Point objectPt,
                           java.awt.Point screenPt)

nClickDragAtScreenPoint

protected void nClickDragAtScreenPoint(int clickCount,
                           MouseModifiers modifiers,
                           java.awt.Point screenPoint1,
                           java.awt.Point screenPoint2)

processMouseEvent

public void processMouseEvent(IMouseActionInfo action)

Return a MethodSpecification for the specified mouse event. This is the primary record interface for mouse events against a particular control. This implementation calls getActionArgs to generate the appropriate subitem specification. Subclasses which generate subitem specifications should override getActionArgs.

Overrides:

processMouseEvent in class HtmlProxy

Parameters:

action - The event cache and other mouse state information for this mouse action.

See Also:

MethodSpecification, getActionArgs(java.awt.Point)

processHoverMouseEvent

protected void processHoverMouseEvent(IMouseActionInfo action)

processPreDownMouseEvent

protected void processPreDownMouseEvent(IMouseActionInfo action)

getMethodName

protected java.lang.String getMethodName(IMouseActionInfo action)

getPointFromAction

public java.awt.Point getPointFromAction(IMouseActionInfo action,
                                int index)

processPreUpMouseEvent

protected void processPreUpMouseEvent(IMouseActionInfo action,
                          int clicks,
                          boolean isDrag)

This method is called to process a mouse event, IMouseActionInfo.PRE_UP event state On PRE_UP build a new method specification will override the one recorded on the PRE_DOWN. Note: For efficiency, the Subitems may have already been constructed while handling previous PRE_DOWN or PRE_UP event states.

getCurrentMethod

public java.lang.String getCurrentMethod()

setCurrentMethod

public void setCurrentMethod(java.lang.String currentMethod)

setMethodSpecification

protected void setMethodSpecification(IMouseActionInfo action,
                          java.lang.String method,
                          java.util.Vector args)

setMethodSpecification

protected void setMethodSpecification(IMouseActionInfo action,
                          java.lang.String method,
                          java.util.Vector args,
                          ScriptCommandFlags flags)

setClickArgs

protected java.util.Vector setClickArgs(int modifiers)

Set args for click (depends on clickArgs member variable set by getActionArgs in PRE_DOWN)

setDownPointArgs

protected java.util.Vector setDownPointArgs(int modifiers)

Set args for down point (depends on clickArgs member variable set by getActionArgs in PRE_DOWN)

setDrag

protected java.util.Vector setDrag(IMouseActionInfo action,
                       int modifiers,
                       java.awt.Point firstPoint,
                       java.awt.Point nthPoint)

Set args and method for single click drag member variable screenRect must be set before calling this method.

setMultiClickAction

protected java.util.Vector setMultiClickAction(int clicks,
                                   int modifiers,
                                   boolean isDrag,
                                   java.awt.Point firstPoint,
                                   java.awt.Point nthPoint)

Set args for multi-click action (more than two clicks in one place, or more than one click drag) member variable screenRect must be set before calling this method.

getDefaultPointToClick

protected java.awt.Point getDefaultPointToClick()

Determines the default click point by performing hit tests on candidates. This is required since a the point to click should always click on the object 1) Try the center. 2) try points along a diagonal from top left to bottom right.

getDefaultPointToClick

protected java.awt.Point getDefaultPointToClick(java.awt.Rectangle screenRect)

Determines the default click point by performing hit tests on candidates. This is required since a the point to click should always click on the object 1) Try the center. 2) try points along a diagonal from top left to bottom right.

getPointOnObject

public java.awt.Point getPointOnObject()

getPointToClick

protected java.awt.Point getPointToClick(java.awt.Rectangle screenRect)

Find a clickable point for this object within the given screen rectangle.

getMethodSpecForPoint

public MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

Description copied from class: HtmlProxy

Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default a method specification for IGraphical.getScreenPoint will be returned. However, if a proxy can fin

Overrides:

getMethodSpecForPoint in class HtmlProxy

See Also:

MethodSpecification

getActionArgs

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

Generate the action argument for the screen point. This method is called by the processMouseEvent implementation in this class. Subclasses should override this and substitute the corresponding ISubItem object(s). The default implementation generates a java.awt.Point which is relative to the upper left of the object as the single argument.

Parameters:

point - point in screen coordinates

Returns:

a vector containing the appropriate subitem arguments.

getDefaultActionArgs

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

clickWithOutMouse

public boolean clickWithOutMouse()

clickWithOutMouse

public boolean clickWithOutMouse(long handle)

clickWithOutMouse

public boolean clickWithOutMouse(MouseModifiers modifiers)

clickWithOutMouse

public boolean clickWithOutMouse(MouseModifiers modifiers,
                        java.awt.Point pt)

clickWithOutMouse

public boolean clickWithOutMouse(MouseModifiers modifiers,
                        long handle)

clickWithOutMouse

public boolean clickWithOutMouse(MouseModifiers modifiers,
                        java.awt.Point pt,
                        long handle)

clickWithOutMouseN

public boolean clickWithOutMouseN(long handle)

getTargetChildItem

public HtmlGuiProxy getTargetChildItem(java.lang.String childTagName,
                              java.lang.String property,
                              java.util.ArrayList propertyValues)

getTargetChildItem

public HtmlGuiProxy getTargetChildItem(HtmlProxy proxy,
                              java.lang.String childTagName,
                              java.lang.String property,
                              java.util.ArrayList propertyValues)

getTargetChildItems

public java.util.ArrayList getTargetChildItems(java.lang.String childTagName,
                                      java.lang.String property,
                                      java.util.ArrayList propertyValues)

getTargetChildHandles

public java.util.ArrayList getTargetChildHandles(java.lang.String childTagName,
                                        java.lang.String property,
                                        java.util.ArrayList propertyValues)

getChildrenHandlesMatchingProperty

public java.util.ArrayList getChildrenHandlesMatchingProperty(java.lang.String propertyName,
                                                     java.util.ArrayList propertyValues)

getVisualClippableParent

protected ProxyTestObject getVisualClippableParent()

Description copied from class: ProxyTestObject

Return the clippable parent for the control

Overrides:

getVisualClippableParent in class ProxyTestObject

Returns:

ProxyTestObject of the control

performAction

public boolean performAction(long handle,
                    java.lang.String action,
                    java.lang.String text)

performClick

public boolean performClick(MouseModifiers modifiers)

performClick

public boolean performClick(MouseModifiers modifiers,
                   java.awt.Point pt)

performDoubleClick

public boolean performDoubleClick(MouseModifiers modifiers)

performSetText

public boolean performSetText(java.lang.String text)

performSelect

public boolean performSelect(java.lang.String item)