HtmlProxy (HCL OneTest UI)

java.lang.Object
- RegisteredObject
- - com.rational.test.ft.domain.ProxyTestObject
  - - com.rational.test.ft.domain.html.HtmlProxy

All Implemented Interfaces:: IDataDriven, IGetInterestingRecogProsForDynFind, IHtmlCustomDomainEnablement, IInternalObjectStatus, IProxyBase, IQuickFind, IXPathFind

Direct Known Subclasses:: HtmlGuiProxy

public class HtmlProxy
extends ProxyTestObject
implements IInternalObjectStatus, IHtmlCustomDomainEnablement, IGetInterestingRecogProsForDynFind, IQuickFind, IXPathFind

This is the HTML proxies base class, all HTML 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 HTML object.

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

TestObject Interface: TestObject
Default Recognition Properties:
- .classIndex
- .id
- .name
- .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)
.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
`class`	`HtmlProxy.GetObjectRunnable`
`class`	`HtmlProxy.HtmlElementEnumeration`
`class`	`HtmlProxy.IntegerByReference` Calculate, and set the class index for the mappable targetChild of "this" object (a parent object).
`class`	`HtmlProxy.InvalidNativeHandleException`
`class`	`HtmlProxy.JSObjectHtmlElementEnumeration`
`class`	`HtmlProxy.NativeProxyReleasedException`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BODYTAG`
`static java.lang.String`	`BOUNDSPROPERTY`
`protected IChannel`	`channel`
`protected static java.lang.String`	`CLASSINDEX`
`static java.lang.String`	`CLASSPROPERTY`
`static java.lang.String`	`CLIENTRECTPROPERTY`
`protected static FtDebug`	`debug`
`static java.lang.String`	`DISABLEDPROPERTY`
`protected static java.lang.String`	`DOCCLASSINDEX`
`java.util.HashMap`	`dojoProps`
`protected HtmlTestDomainImplementation`	`domain`
`static int`	`HTMLPROXYCHANNELRUNNABLE_TIMEOUTVALUE`
`static java.lang.String`	`IDPROPERTY`
`protected static boolean`	`isSiebelActive`
`IBrowserCommunicator`	`jswarapper`
`static java.lang.String`	`NAMEPROPERTY`
`protected java.lang.Boolean`	`parentsTextDescendantsMayBeInteresting`
`static java.lang.String`	`READONLYPROPERTY`
`static java.lang.String`	`TAGPROPERTY`
`protected static java.lang.String`	`TESTDATA_TEXT`
`static java.lang.String`	`TEXTPROPERTY`
`static java.lang.String`	`TITLEPROPERTY`
`static java.lang.String`	`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
`HtmlProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle)` This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.
`HtmlProxy(HtmlTestDomainImplementation domain, IChannel channel, long handle, IBrowserCommunicator jswrap)` This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addAdditionalRecognitionProperties(java.util.Hashtable result)`
`protected void`	`addChildrenHandlesToVector(HtmlProxy.HtmlElementEnumeration children, java.util.Vector v)`
`protected void`	`addChildrenToVector(java.util.Enumeration children, java.util.Vector v)`
`protected void`	`addChildrenToVector(java.util.Enumeration children, java.util.Vector v, ContextObject contextobject)`
`protected void`	`addDataDrivableCommands(ProxyTestObject proxy, java.util.Vector commands, int includeChildren)` Override this method from the ProxyTestObject.
`void`	`addDojoDomain()`
`void`	`addRecognitionProperty(java.lang.String property, java.lang.Object value, int weight)` This method defines an additional recognition property that this proxy should utilize.
`void`	`adjustCustomDomains(FindPropertySet fps)` Adjust customdomains based on fps
`protected java.lang.Boolean`	`calculateParentsTextDescendantsMayBecomeInteresting()`
`boolean`	`callJqueryFind()`
`void`	`clearAllSubdomains()`
`java.util.Vector`	`clearCustomSubdomains()`
`long`	`detach()` Detach the native proxy and return its handle.
`void`	`disableAllHtmlCustomDomains()` Disable all custom domains
`void`	`disableHtmlCustomDomain(java.lang.String domainName)` Disable a html custom domain
`void`	`disableHtmlCustomDomains(java.lang.String[] domainNames)` Disable array of custom domains
`void`	`enableAllHtmlCustomDomains()` Enable all html custom domain
`void`	`enableHtmlCustomDomain(java.lang.String domainName)` Enable a html custom subdomain
`void`	`enableHtmlCustomDomains(java.lang.String[] domainNames)` Enable array of custom domains
`boolean`	`equals(java.lang.Object obj)` Overrides the object-level `equals` with an equality against the handles of the underlying test objects.
`java.lang.Object[]`	`fetchProperties(java.lang.String[] props)`
`FindResult`	`find(IMappedTestObject[] pathToFind, int myLevel)`
`ProxyTestObject[]`	`findElementsByXpath(java.lang.String xpath)`
`ProxyTestObject[]`	`findElementsDirectly(boolean mappable)`
`ProxyTestObject[]`	`findElementsViaQuery(boolean mappable)`
`FindResult`	`findElementWithDynamicFind(IMappedTestObject[] pathToFind, int myLevel)`
`HtmlProxy`	`findElementWithName(java.lang.String name)` Find the element that is a child of this element which has the given name.
`protected com.rational.test.ft.domain.html.HtmlProxy.AdditionalRecognitionProperty`	`getAddedRecognitionProperty(java.lang.String propertyName)` This method returns the AdditionalRecognitionProperty object identified by propertyName
`protected java.lang.Object`	`getAddedRecognitionPropertyValue(java.lang.String propertyName)` This method returns the value associated with an `added` recognition property.
`protected int`	`getAddedRecognitionPropertyWeight(java.lang.String propertyName)`
`java.lang.String`	`getBrowserAppVersion()`
`CachedData`	`getCachedData()`
`IChannel`	`getChannel()` Return the channel associated with this object.
`ProxyTestObject[]`	`getChildren()` Uses getChildrenEnumeration to implement.
`ProxyTestObject[]`	`getChildren(ContextObject contextProxy)` Uses getChildrenEnumeration to implement.
`long`	`getChildren(long handle)`
`java.util.Enumeration`	`getChildrenEnumeration()` Enumerate child objects of the Html Element.
`java.util.Enumeration`	`getChildrenEnumeration(long handle)`
`HtmlProxy.HtmlElementEnumeration`	`getChildrenHandleEnumeration()`
`long[]`	`getChildrenHandles()`
`long`	`getChildrenN(long handle)`
`ProxyTestObject[]`	`getChildrenWithTagType(java.lang.String tagType)`
`protected RecognitionIndex`	`getClassIndex()`
`java.lang.String`	`getCustomClassProperty()`
`java.lang.String`	`getCustomClassPropertyValue()`
`java.lang.String`	`getCustomDomainName(boolean isForParent, boolean isForChildren)`
`java.lang.String`	`getCustomDomainName(ContextObject contextobject)`
`java.lang.String`	`getCustomDomainName(ProxyTestObject proxy)`
`java.lang.String`	`getCustomDomainNameForChildren()`
`java.lang.String`	`getCustomDomainNameForParent()`
`java.lang.Object`	`getCustomObject()`
`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.
`boolean`	`getDisabledProperty()` Check if the control is disabled.
`protected RecognitionIndex`	`getDocClassIndex()`
`HtmlDocumentProxy`	`getDocument()` Return a Proxy to the Html Document that contains this element.
`HtmlDocumentProxy`	`getDocument(long handle)`
`long`	`getDocumentHandle(long handle)`
`Window`	`getDocumentWindow()`
`HtmlTestDomainImplementation`	`getDomain()`
`HtmlProxy.HtmlElementEnumeration`	`getElementHandlesByTag(java.lang.String tag)`
`ProxyTestObject[]`	`getElementObjectsByTag(java.lang.String tag)`
`ProxyTestObject[]`	`getElementsByNameInProxyTestObjects(java.lang.String name)`
`long`	`getElementsByTag(long handle, java.lang.String tag)`
`java.util.Enumeration`	`getElementsByTag(java.lang.String tag)`
`java.util.Enumeration`	`getElementsByTagEnumeration(long handle, java.lang.String tag)`
`ProxyTestObject[]`	`getElementsByTagInProxyTestObjects(java.lang.String tag)`
`long`	`getElementsByTagN(long handle, java.lang.String tag)`
`java.util.Enumeration`	`getElementsByXpath(Property[] props)`
`java.util.Enumeration`	`getElementsByXpath(java.lang.String xpath)`
`java.util.Enumeration`	`getElementsByXpathEnumeration(long handle, java.lang.String xpath)`
`ProxyTestObject[]`	`getElementsDirectly(com.rational.test.ft.vp.impl.Property property, boolean mappable)`
`long`	`getHandle()`
`java.lang.String`	`getHtmlTag()` Return the HTML tag for this element.
`static java.lang.String`	`getHtmlTagNameFromClassProperty(java.lang.String classProperty)`
`java.lang.String[]`	`getIgnorableProperties()`
`java.lang.Object`	`getIndexer(java.lang.String name, java.lang.Object[] indexes)` Gets the value of an indexed property
`IndexerInfo[]`	`getIndexers()` Gets information about a `TestObject's` indexed properties
`java.util.Vector`	`getInterestingRecogPropsForDynFind(java.util.Vector properties)` Return .customclass or .dojoclass for html customdomins
`java.lang.Object`	`getJsProps(long handle, java.lang.String propName)`
`IBrowserCommunicator`	`getJswarapper()`
`ProxyTestObject[]`	`getMappableChildren()` Uses getChildrenEnumeration to implement.
`ProxyTestObject[]`	`getMappableChildren(ContextObject contextProxy)` Uses getChildrenEnumeration to implement.
`ProxyTestObject[]`	`getMappableElementsByNameInProxyTestObjects(java.lang.String name)`
`ProxyTestObject[]`	`getMappableElementsByTagInProxyTestObjects(java.lang.String tag)`
`ProxyTestObject`	`getMappableParent()` Walks the `getParent()` relationship until a mappable parent is encountered.
`ProxyTestObject`	`getMappableParent(ContextObject contextProxy)` Walks the `getParent()` relationship until a mappable parent is encountered.
`MethodInfo[]`	`getMethods()` Returns an array of MethodInfos
`MethodSpecification`	`getMethodSpecForPoint(java.awt.Point pt)` Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
`java.util.Hashtable`	`getNonValueProperties()` return the properties that are not supported because of the return value
`java.lang.Object`	`getObject()`
`java.lang.String`	`getObjectClassName()` Returns the class name of the associated object.
`ProxyTestObject[]`	`getOwnedObjects()` Returns an array of proxies for the objects owned by this object.
`ProxyTestObject[]`	`getOwnedObjects(java.lang.String domainName)` Returns null only for html because the abstraction is not understood in this way.
`ProxyTestObject`	`getOwner()` Returns null always because object relationships are not understood at this level of abstaction.
`ProxyTestObject`	`getParent()` Returns null always because object relationships are not understood at this level of abstaction.
`ProxyTestObject`	`getParent(ContextObject contextProxy)` Returns null always because object relationships are not understood at this level of abstaction.
`long`	`getParentN(long handle)`
`java.util.Hashtable`	`getProperties()` Returns a complete set of properties for the associated test object.
`java.lang.String[]`	`getProperties(long handle)`
`java.lang.Object`	`getProperty(long handle, java.lang.String propertyName)`
`java.lang.Object`	`getProperty(java.lang.String propertyName)` Get the value for a specific property.
`java.lang.Object`	`getPropertyInternal(java.lang.String propertyName)`
`java.lang.Object`	`getPropertyInternalRunnable(java.lang.String propertyName)`
`java.lang.Object`	`getPropertyN(long nativeHandle, java.lang.String propertyName)`
`ProxyTestObject[]`	`getProxyTestObjectsFromEnumeration(java.util.Enumeration children)`
`boolean`	`getReadOnlyProperty()`
`java.util.Hashtable`	`getRecognitionProperties()` Returns an enumeration of properties used to uniquely identify the associated test object in the SUT.
`int`	`getRecognitionPropertyWeight(java.lang.String propertyName)` Returns an indication of how useful this property is for recognition.
`java.lang.String`	`getRole()` Returns `TestObjectRole.ROLE_HTML`.
`protected java.lang.String`	`getSavedDescriptiveName()`
`ScriptCommandFlags`	`getScriptCommandFlags()` This method returns an active state value that reflects the state of the test object at the time of the call.
`java.util.Hashtable`	`getStandardProperties()` Returns a complete set of consistent properties for the associated test object.
`java.lang.String[]`	`getStandardProperties(long handle)`
`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.
`TestDomainImplementation`	`getTestDomain()` Return the `TestDomainImplementation` that this proxy object is associated with.
`java.lang.String`	`getTestObjectClassName()` The default GUI marshaller is returned.
`java.lang.String`	`getText()` Return the text associated with this element.
`ProxyTestObject`	`getTopMappableParent()` Returns `getTopParent()` which is the browser and is always mappable.
`ProxyTestObject`	`getTopParent()` Returns a proxy object for the top parent of this object.
`long`	`getTopParent(long handle)`
`protected ProxyTestObject`	`getTopParentInternal()` Returns a proxy object for the top most parent of this object, or null if this object has no parent.
`long`	`getTopParentN(long handle)`
`java.lang.String`	`getUniqueId()` Returns a string for the associated object.
`java.lang.String`	`getValueProperty()`
`ProxyTestObject`	`getVisualTopParent()` Return the top mappable parent that is sensible for the Visual Object Maps In case of HTML document is top visual parent In case of PDF, page is the top visual parent
`boolean`	`hasAddedRecognitionProperties()` This method returns true if recocnition properties have been added to this proxy from an external source through the `addRecognitionProperty` method.
`boolean`	`isClassIndexConsidered(java.util.Vector properties)` To include or ignore classindex property while scoring the underlying object represented by the `ProxyTestObject`.
`protected boolean`	`isClassIndexPropertyAndValueDefined()`
`protected boolean`	`isClassIndexSet()` Test if the class index has been set for this object
`boolean`	`isContextObjectSet()`
`boolean`	`isContextObjectSet(ProxyTestObject proxy)`
`protected boolean`	`isDocClassIndexSet()` Test if the document class index has been set for this object
`boolean`	`isEqual(HtmlProxy sourceElem, HtmlProxy targetElem)`
`boolean`	`isFindOptimized(FindPropertySet fps)`
`boolean`	`isObjectDead()` Is the object in the SUT dead?
`boolean`	`isPropertyOptimizable(com.rational.test.ft.vp.impl.Property property)`
`boolean`	`isReleaseRequired()`
`boolean`	`isSameObject(java.lang.Object obj)` Returns `true` if the supplied test object represents the same underlying object.
`boolean`	`isScoreForFindBYIdorName()`
`protected boolean`	`isValidRecognitionProperty(java.lang.String propertyName)` This method may be override by a derived class to keep a property from being added as a recognition property by a base class.
`boolean`	`isXpathSupported()`
`static boolean`	`matches(java.lang.String toBeCompared, java.lang.String pattern)` Utility method to match strings for java 1.3
`void`	`processMouseEvent(IMouseActionInfo action)` At this level of the Html proxy abstraction this method is null.
`void`	`release()`
`void`	`release(java.util.ArrayList handles)`
`void`	`release(java.util.ArrayList handles, long exceptionHandle)`
`void`	`release(long handle)`
`void`	`release(long[] handles)`
`void`	`release(long[] handles, long exceptionHandle)`
`void`	`releaseElementHandle(long handle)`
`void`	`releaseN(long nativeHandle)`
`static java.lang.String`	`replaceAll(java.lang.String originalString, java.lang.String searchString, java.lang.String toBeReplaced)` utility method for replacing all the patterns in a string equivalent to jdk 1.4 and above
`boolean`	`restoreAllCustomSubDomains()`
`boolean`	`restoreCustomSubDomains(java.util.Vector customDomains)`
`void`	`setCachedData(CachedData cachedData)`
`void`	`setClass(java.lang.String objectClass)`
`protected void`	`setClassIndex()` Calculate and set the classindex for this object.
`protected void`	`setClassIndex(int index)`
`protected void`	`setClassIndex(java.lang.Integer index)`
`protected void`	`setClassIndex(ProxyTestObject proxyTestObject, RecognitionIndex index)`
`protected void`	`setClassIndex(RecognitionIndex index)`
`protected boolean`	`setClassIndexOfChild(HtmlProxy.IntegerByReference startingIndex, ProxyTestObject targetChild, int level)`
`boolean`	`setCustomClassProperty(java.lang.String customClassProperty)`
`boolean`	`setCustomClassPropertyValue(java.lang.String customClassPropertyValue)`
`boolean`	`setCustomDomainInContext(java.lang.String custDomainName)`
`protected void`	`setDocClassIndex()`
`protected void`	`setDocClassIndex(int index)`
`protected void`	`setDocClassIndex(java.lang.Integer index)`
`protected void`	`setDocClassIndex(RecognitionIndex index)`
`void`	`setDomain(HtmlTestDomainImplementation domain)`
`void`	`setIndexer(java.lang.String name, java.lang.Object[] indexes, java.lang.Object val)` Sets the value of an indexed property
`void`	`setJswarapper(IBrowserCommunicator jswarapper)`
`boolean`	`setProperty(long handle, java.lang.String propertyName, java.lang.Object value)`
`void`	`setProperty(java.lang.String propertyName, java.lang.Object value)` Set the value for a specific property.
`protected void`	`setSavedDescriptiveName(java.lang.String descriptiveName)`
`boolean`	`shouldBeMapped()` Returns false, by default only GUI test objects are mapped.
`protected boolean`	`shouldDocumentBeAdded(java.util.ArrayList docProps, long handle)`
`static java.lang.String[]`	`split(java.lang.String value, java.lang.String delimiter)` Split the given string.
`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.ProxyTestObject
baseClassMatch, canTakeVP, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getDataDrivableCommands, getElementWithFocus, getField, getObjectCustomClassName, getProxy, getScriptCommandAnchor, getVisualClippableParent, 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
  - debug
```
protected static FtDebug debug
```
  - HTMLPROXYCHANNELRUNNABLE_TIMEOUTVALUE
```
public static final int HTMLPROXYCHANNELRUNNABLE_TIMEOUTVALUE
```
  - jswarapper
```
public IBrowserCommunicator jswarapper
```
  - channel
```
protected IChannel channel
```
  - dojoProps
```
public java.util.HashMap dojoProps
```
  - parentsTextDescendantsMayBeInteresting
```
protected java.lang.Boolean parentsTextDescendantsMayBeInteresting
```
  - isSiebelActive
```
protected static boolean isSiebelActive
```
  - TAGPROPERTY
```
public static final java.lang.String TAGPROPERTY
```
    See Also:
    Constant Field Values
  - CLASSPROPERTY
```
public static final java.lang.String CLASSPROPERTY
```
    See Also:
    Constant Field Values
  - IDPROPERTY
```
public static final java.lang.String IDPROPERTY
```
    See Also:
    Constant Field Values
  - UNIQUEIDPROPERTY
```
public static final java.lang.String UNIQUEIDPROPERTY
```
    See Also:
    Constant Field Values
  - NAMEPROPERTY
```
public static final java.lang.String NAMEPROPERTY
```
    See Also:
    Constant Field Values
  - BOUNDSPROPERTY
```
public static final java.lang.String BOUNDSPROPERTY
```
    See Also:
    Constant Field Values
  - TEXTPROPERTY
```
public static final java.lang.String TEXTPROPERTY
```
    See Also:
    Constant Field Values
  - TITLEPROPERTY
```
public static final java.lang.String TITLEPROPERTY
```
    See Also:
    Constant Field Values
  - DISABLEDPROPERTY
```
public static final java.lang.String DISABLEDPROPERTY
```
    See Also:
    Constant Field Values
  - CLIENTRECTPROPERTY
```
public static final java.lang.String CLIENTRECTPROPERTY
```
    See Also:
    Constant Field Values
  - BODYTAG
```
public static final java.lang.String BODYTAG
```
    See Also:
    Constant Field Values
  - CLASSINDEX
```
protected static final java.lang.String CLASSINDEX
```
    See Also:
    Constant Field Values
  - DOCCLASSINDEX
```
protected static final java.lang.String DOCCLASSINDEX
```
    See Also:
    Constant Field Values
  - READONLYPROPERTY
```
public static final java.lang.String READONLYPROPERTY
```
    See Also:
    Constant Field Values
  - domain
```
protected HtmlTestDomainImplementation domain
```
  - TESTDATA_TEXT
```
protected static final java.lang.String TESTDATA_TEXT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HtmlProxy
```
public HtmlProxy(HtmlTestDomainImplementation domain,
         IChannel channel,
         long handle,
         IBrowserCommunicator jswrap)
```
    This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.
    
    Parameters:
    domain - - domain implementation that created this proxy.
    channel - - channel on which that proxy should be accessed.
    handle - - handle to native object.
  - HtmlProxy
```
public HtmlProxy(HtmlTestDomainImplementation domain,
         IChannel channel,
         long handle)
```
    This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.
    
    Parameters:
    domain - - domain implementation that created this proxy.
    channel - - channel on which that proxy should be accessed.
    handle - - handle to native object.
- Method Detail
  - getBrowserAppVersion
```
public java.lang.String getBrowserAppVersion()
```
  - getValueProperty
```
public java.lang.String getValueProperty()
```
  - getCachedData
```
public CachedData getCachedData()
```
  - setCachedData
```
public void setCachedData(CachedData cachedData)
```
  - getDomain
```
public HtmlTestDomainImplementation getDomain()
```
  - setDomain
```
public void setDomain(HtmlTestDomainImplementation domain)
```
  - getCustomClassProperty
```
public java.lang.String getCustomClassProperty()
```
  - getJswarapper
```
public IBrowserCommunicator getJswarapper()
```
  - setJswarapper
```
public void setJswarapper(IBrowserCommunicator jswarapper)
```
  - setCustomClassProperty
```
public boolean setCustomClassProperty(java.lang.String customClassProperty)
```
  - getCustomClassPropertyValue
```
public java.lang.String getCustomClassPropertyValue()
```
  - setCustomClassPropertyValue
```
public boolean setCustomClassPropertyValue(java.lang.String customClassPropertyValue)
```
  - isObjectDead
```
public boolean isObjectDead()
```
    Description copied from interface: IInternalObjectStatus
    
    Is the object in the SUT dead?
    
    Specified by:
    
    isObjectDead in interface IInternalObjectStatus
    
    Returns:
    true if the object is dead.
  - getChannel
```
public IChannel getChannel()
```
    Return the channel associated with this object.
    
    Overrides:
    
    getChannel in class ProxyTestObject
  - getHandle
```
public long getHandle()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides the object-level equals with an equality against the handles of the underlying test objects.
    
    Overrides:
    
    equals in class ProxyTestObject
    
    Parameters:
    obj - The object to compare against. If obj is a ProxyTestObject, the comparison is made with the underlying object.
    
    Returns:
    true if the underlying test objects are equal.
    Since:
    
    RFT1.0
  - isSameObject
```
public boolean isSameObject(java.lang.Object obj)
```
    Description copied from class: ProxyTestObject
    
    Returns true if the supplied test object represents the same underlying object. This method is different from equals in that it represents an "==" of the object in the AUT rather than an "equals" of these objects.
    
    Overrides:
    
    isSameObject in class ProxyTestObject
    
    Parameters:
    obj - The object to compare against. If obj is a ProxyTestObject, the comparison is made with the underlying object.
    
    Returns:
    true if the underlying test objects are ==.
  - getTestObjectClassName
```
public java.lang.String getTestObjectClassName()
```
    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
    
    Specified by:
    
    getTestObjectClassName in class ProxyTestObject
    
    Returns:
    The default mashaller class full name.
  - getTestDomain
```
public final TestDomainImplementation getTestDomain()
```
    Return the TestDomainImplementation that this proxy object is associated with. This method should not be overriden.
    
    Specified by:
    
    getTestDomain in interface IProxyBase
    
    Specified by:
    
    getTestDomain in class ProxyTestObject
    
    Returns:
    The associated TestDomainImplementation.
  - setSavedDescriptiveName
```
protected void setSavedDescriptiveName(java.lang.String descriptiveName)
```
  - getSavedDescriptiveName
```
protected java.lang.String getSavedDescriptiveName()
```
  - getDescriptiveName
```
public java.lang.String getDescriptiveName()
```
    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.
    
    Specified by:
    
    getDescriptiveName in class ProxyTestObject
    
    Returns:
    A descriptive object name.
  - getRole
```
public java.lang.String getRole()
```
    Returns TestObjectRole.ROLE_HTML.
    
    Overrides:
    
    getRole in class ProxyTestObject
    
    Returns:
    A brief type name that describes the role this object plays in the UI.
    Since:
    
    RFT1.0
  - processMouseEvent
```
public void processMouseEvent(IMouseActionInfo action)
```
    At this level of the Html proxy abstraction this method is null. GUI objects that can interact with the mouse should be implemented with HtmlGuiProxy level support.
    
    Specified by:
    
    processMouseEvent in class ProxyTestObject
    
    Parameters:
    action - The event cache and other mouse state information for this mouse action.
    See Also:
    IMouseActionInfo, MethodSpecification
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Description copied from class: ProxyTestObject
    
    Returns a string for the associated object. This string must be unique and must be identical for each call to this method for the same instance of the UI object.
    
    Specified by:
    
    getUniqueId in class ProxyTestObject
    
    Returns:
    A unique and repeatable identifier for the object being evaluated.
  - shouldBeMapped
```
public boolean shouldBeMapped()
```
    Returns false, by default only GUI test objects are mapped. If the generic Html element has an id or name (which probably indicates that it is used in a script) then return true, otherwise ignore it.
    
    Specified by:
    
    shouldBeMapped in class ProxyTestObject
    
    Returns:
    true element has an id or name. false not a supported HTML object type
  - split
```
public static java.lang.String[] split(java.lang.String value,
                       java.lang.String delimiter)
```
    Split the given string. equivalent to String.split(<>)
    
    Parameters:
    value -
    delimiter -
    
    Returns:
    Array of String or null
  - getObject
```
public java.lang.Object getObject()
```
  - getCustomObject
```
public java.lang.Object getCustomObject()
```
  - getObjectClassName
```
public java.lang.String getObjectClassName()
```
    Description copied from class: ProxyTestObject
    
    Returns the class name of the associated object. The default implementation returns the java class name of the associated object.
    
    Overrides:
    
    getObjectClassName in class ProxyTestObject
    
    Returns:
    Class name.
  - getParent
```
public ProxyTestObject getParent(ContextObject contextProxy)
```
    Returns null always because object relationships are not understood at this level of abstaction.
    
    Overrides:
    
    getParent in class ProxyTestObject
    
    Parameters:
    contextProxy - The contextProxy Test object is to set the context while finding the children
    
    Returns:
    null, no known parent.
  - getParent
```
public ProxyTestObject getParent()
```
    Returns null always because object relationships are not understood at this level of abstaction.
    
    Specified by:
    
    getParent in class ProxyTestObject
    
    Returns:
    null, no known parent.
  - getParentN
```
public long getParentN(long handle)
```
  - getMappableParent
```
public ProxyTestObject getMappableParent()
```
    Walks the getParent() relationship until a mappable parent is encountered.
    
    Specified by:
    
    getMappableParent in class ProxyTestObject
    
    Returns:
    The first mappable parent located.
  - getMappableParent
```
public ProxyTestObject getMappableParent(ContextObject contextProxy)
```
    Walks the getParent() relationship until a mappable parent is encountered.
    
    Overrides:
    
    getMappableParent in class ProxyTestObject
    
    Parameters:
    contextProxy - The contextProxy Test object is to set the context while finding the children
    
    Returns:
    The first mappable parent located.
  - isContextObjectSet
```
public boolean isContextObjectSet()
```
  - isContextObjectSet
```
public boolean isContextObjectSet(ProxyTestObject proxy)
```
  - getCustomDomainName
```
public java.lang.String getCustomDomainName(ProxyTestObject proxy)
```
  - getCustomDomainNameForParent
```
public java.lang.String getCustomDomainNameForParent()
```
  - getCustomDomainNameForChildren
```
public java.lang.String getCustomDomainNameForChildren()
```
  - getCustomDomainName
```
public java.lang.String getCustomDomainName(boolean isForParent,
                                   boolean isForChildren)
```
  - getCustomDomainName
```
public java.lang.String getCustomDomainName(ContextObject contextobject)
```
  - setCustomDomainInContext
```
public boolean setCustomDomainInContext(java.lang.String custDomainName)
```
  - restoreAllCustomSubDomains
```
public boolean restoreAllCustomSubDomains()
```
  - addDojoDomain
```
public void addDojoDomain()
```
  - clearCustomSubdomains
```
public java.util.Vector clearCustomSubdomains()
```
  - clearAllSubdomains
```
public void clearAllSubdomains()
```
  - restoreCustomSubDomains
```
public boolean restoreCustomSubDomains(java.util.Vector customDomains)
```
  - getTopParent
```
public ProxyTestObject getTopParent()
```
    Returns a proxy object for the top parent of this object. Returns itself if this object has no parent.
    
    Specified by:
    
    getTopParent in class ProxyTestObject
    
    Returns:
    The proxy for the top parent test object or itself for a top level object.
  - getTopParentInternal
```
protected ProxyTestObject getTopParentInternal()
```
    Returns a proxy object for the top most parent of this object, or null if this object has no parent.
    
    Returns:
    The proxy for the top most parent test object or null if this has no parent.
  - getTopParent
```
public long getTopParent(long handle)
```
  - getTopParentN
```
public long getTopParentN(long handle)
```
  - getTopMappableParent
```
public ProxyTestObject getTopMappableParent()
```
    Returns getTopParent() which is the browser and is always mappable.
    
    Specified by:
    
    getTopMappableParent in class ProxyTestObject
    
    Returns:
    The proxy for the top mappable parent test object or itself for a top level object.
  - getChildrenEnumeration
```
public java.util.Enumeration getChildrenEnumeration()
```
    Enumerate child objects of the Html Element.
    
    Returns:
    java.util.Enumeration - enumeration of all immediate children in the Html container hierarchly of this element. null if no children.
  - getChildren
```
public long getChildren(long handle)
```
  - getChildrenN
```
public long getChildrenN(long handle)
```
  - getChildrenEnumeration
```
public java.util.Enumeration getChildrenEnumeration(long handle)
```
  - addChildrenToVector
```
protected void addChildrenToVector(java.util.Enumeration children,
                       java.util.Vector v)
```
  - addChildrenToVector
```
protected void addChildrenToVector(java.util.Enumeration children,
                       java.util.Vector v,
                       ContextObject contextobject)
```
  - getChildren
```
public ProxyTestObject[] getChildren(ContextObject contextProxy)
```
    Uses getChildrenEnumeration to implement.
    
    Overrides:
    
    getChildren in class ProxyTestObject
    
    Parameters:
    contextProxy - The contextProxy Test object is to set the context while finding the children
    
    Returns:
    null, if no known children.
  - getChildren
```
public ProxyTestObject[] getChildren()
```
    Uses getChildrenEnumeration to implement.
    
    Specified by:
    
    getChildren in class ProxyTestObject
    
    Returns:
    null, if no known children.
  - getClassIndex
```
protected RecognitionIndex getClassIndex()
```
  - setClassIndex
```
protected void setClassIndex()
```
    Calculate and set the classindex for this object.
  - setClassIndex
```
protected void setClassIndex(int index)
```
  - setClassIndex
```
protected void setClassIndex(java.lang.Integer index)
```
  - setClassIndex
```
protected void setClassIndex(RecognitionIndex index)
```
  - setClassIndex
```
protected void setClassIndex(ProxyTestObject proxyTestObject,
                 RecognitionIndex index)
```
  - isClassIndexSet
```
protected boolean isClassIndexSet()
```
    Test if the class index has been set for this object
  - isDocClassIndexSet
```
protected boolean isDocClassIndexSet()
```
    Test if the document class index has been set for this object
  - getDocClassIndex
```
protected RecognitionIndex getDocClassIndex()
```
  - setDocClassIndex
```
protected void setDocClassIndex()
```
  - setDocClassIndex
```
protected void setDocClassIndex(int index)
```
  - setDocClassIndex
```
protected void setDocClassIndex(java.lang.Integer index)
```
  - setDocClassIndex
```
protected void setDocClassIndex(RecognitionIndex index)
```
  - isClassIndexPropertyAndValueDefined
```
protected boolean isClassIndexPropertyAndValueDefined()
```
  - isEqual
```
public boolean isEqual(HtmlProxy sourceElem,
              HtmlProxy targetElem)
```
  - setClassIndexOfChild
```
protected boolean setClassIndexOfChild(HtmlProxy.IntegerByReference startingIndex,
                           ProxyTestObject targetChild,
                           int level)
```
  - calculateParentsTextDescendantsMayBecomeInteresting
```
protected java.lang.Boolean calculateParentsTextDescendantsMayBecomeInteresting()
```
  - getMappableChildren
```
public ProxyTestObject[] getMappableChildren()
```
    Uses getChildrenEnumeration to implement.
    
    Specified by:
    
    getMappableChildren in class ProxyTestObject
    
    Returns:
    null, if no known children.
  - getMappableChildren
```
public ProxyTestObject[] getMappableChildren(ContextObject contextProxy)
```
    Uses getChildrenEnumeration to implement.
    
    Overrides:
    
    getMappableChildren in class ProxyTestObject
    
    Returns:
    null, if no known children.
  - getOwner
```
public ProxyTestObject getOwner()
```
    Returns null always because object relationships are not understood at this level of abstaction.
    
    Specified by:
    
    getOwner in class ProxyTestObject
    
    Returns:
    null, no known parent.
  - getOwnedObjects
```
public ProxyTestObject[] getOwnedObjects()
```
    Description copied from class: ProxyTestObject
    
    Returns an array of proxies for the objects owned by this object.
    
    Specified by:
    
    getOwnedObjects in class ProxyTestObject
    
    Returns:
    An array of proxies of objects owned by this proxy.
  - getOwnedObjects
```
public ProxyTestObject[] getOwnedObjects(java.lang.String domainName)
```
    Returns null only for html because the abstraction is not understood in this way. But this function may return information for cross domain targets.
    
    Overrides:
    
    getOwnedObjects in class ProxyTestObject
    
    Returns:
    null or cross domain target proxies.
  - getMethodSpecForPoint
```
public MethodSpecification getMethodSpecForPoint(java.awt.Point pt)
```
    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
    
    Specified by:
    
    getMethodSpecForPoint in class ProxyTestObject
    
    Parameters:
    action - The event cache and other mouse state information for this mouse action.
    See Also:
    MethodSpecification
  - getRecognitionProperties
```
public java.util.Hashtable getRecognitionProperties()
```
    Returns an enumeration of properties used to uniquely identify the associated test object in the SUT. Really good recognition properties are properties like the programmatic name or a persistent description. Less interesting might be the visible text on a button or label, or the tooltip text, or possibly the foreground color. Uninteresting properties are the transient properties like hasFocus or isShowing type properties.
    
    Specified by:
    
    getRecognitionProperties in class ProxyTestObject
    
    Returns:
    An enumeration of recognition properties. The returned objects are of class TestObjectProperty.
    See Also:
    ProxyTestObject.getRecognitionPropertyWeight(String), ProxyTestObject.getProperty(String), ProxyTestObject.addRecognitionProperty(String,Object,int)
  - isValidRecognitionProperty
```
protected boolean isValidRecognitionProperty(java.lang.String propertyName)
```
    This method may be override by a derived class to keep a property from being added as a recognition property by a base class.
  - addAdditionalRecognitionProperties
```
protected void addAdditionalRecognitionProperties(java.util.Hashtable result)
```
  - getRecognitionPropertyWeight
```
public int getRecognitionPropertyWeight(java.lang.String propertyName)
```
    Returns an indication of how useful this property is for recognition. A value of 0 indicates not useful at all, and a value of 100 indicates that the property is extremely useful for recognition.
    
    Specified by:
    
    getRecognitionPropertyWeight in class ProxyTestObject
    
    Parameters:
    propertyName - The name of the recognition property to return a weight value for.
    See Also:
    ProxyTestObject.getRecognitionProperties()
  - getAddedRecognitionPropertyWeight
```
protected int getAddedRecognitionPropertyWeight(java.lang.String propertyName)
```
  - addRecognitionProperty
```
public void addRecognitionProperty(java.lang.String property,
                          java.lang.Object value,
                          int weight)
```
    This method defines an additional recognition property that this proxy should utilize. Properties defined outside a proxy have the side effect that they must always be attached to the proxy when it is created. This may be problematic in some domains and these properties must be ignored if appropriate proxy caching is not being performed. Properties added to a proxy should be returned through the getRecognitionProperties method.
    
    Specified by:
    
    addRecognitionProperty in class ProxyTestObject
    
    Parameters:
    property - The recognition property name. Care should be taken to avoid conflicts with existing property names.
    value - The value of the added recognition property.
    weight - The weight associated with this recognition property. This value should be returned when the getRecognitionPropertyWeight method is called.
    See Also:
    getRecognitionProperties(), getRecognitionPropertyWeight(String), getProperty(String)
  - hasAddedRecognitionProperties
```
public boolean hasAddedRecognitionProperties()
```
    This method returns true if recocnition properties have been added to this proxy from an external source through the addRecognitionProperty method.
    
    Specified by:
    
    hasAddedRecognitionProperties in class ProxyTestObject
    
    Returns:
    true if recocnition properties have been added to this proxy from an external source through the addRecognitionProperty method.
    See Also:
    addRecognitionProperty(String,Object,int)
  - getAddedRecognitionProperty
```
protected com.rational.test.ft.domain.html.HtmlProxy.AdditionalRecognitionProperty getAddedRecognitionProperty(java.lang.String propertyName)
```
    This method returns the AdditionalRecognitionProperty object identified by propertyName
  - getAddedRecognitionPropertyValue
```
protected java.lang.Object getAddedRecognitionPropertyValue(java.lang.String propertyName)
```
    This method returns the value associated with an added recognition property. This method exists for quick lookup of recognition properties that have been added to this proxies recognition property set.
    
    Parameters:
    propertyName - The name of the added recognition property to look for.
    
    Returns:
    The value associated with the specified recognition property or null if the property does not exist.
  - getDisabledProperty
```
public boolean getDisabledProperty()
```
    Check if the control is disabled. If unable to tell if a control is disabled then a false value is returned (the control is assumed to be enabled).
    
    Returns:
    true is returned if the control is disabled.
    Since:
    
    RFT2.0
  - getReadOnlyProperty
```
public boolean getReadOnlyProperty()
```
  - getProperties
```
public java.util.Hashtable getProperties()
```
    Description copied from class: ProxyTestObject
    
    Returns a complete set of properties for the associated test object. The meaning of a property is specific to the test domain and the test object. Typically, this is a set of name/value pairs that describe the test object and its active state. Properties such as font, colors, and coordinate information are typically associated with a GUI test object. Associated data and state information can also be returned, depending on the test object.
    This method does not return properties whose values are references to objects. The method ProxyTestObject.getNonValueProperties() returns information about such properties.
    
    Specified by:
    
    getProperties in class ProxyTestObject
    
    Returns:
    The set of known properties associated with a test object.
    See Also:
    ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getStandardProperties(), ProxyTestObject.getNonValueProperties()
  - getProperties
```
public java.lang.String[] getProperties(long handle)
```
  - getStandardProperties
```
public java.util.Hashtable getStandardProperties()
```
    Description copied from class: ProxyTestObject
    
    Returns a complete set of consistent properties for the associated test object. Consistent properties are those properties that exist regardless of the platform the test object is running on. Domains that do not support the notion of standard properties should implement this method identically to ProxyTestObject.getProperties(). The HTML domain supports standard properties and returns properties that are consistent across browser versions. The Java domain does not support this notion of standard properties. In this domain, getStandardProperties, and getProperties do the same thing. For HTML, standard properties are a subset of the properties returned by getProperties(). The meaning of a property is specific to the test domain and the test object. Typically, this is a set of name/value pairs that describe the test object and its active state. Properties such as font, colors, and coordinate information are typically associated with a GUI test object. Associated data and state information can also be returned, depending on the test object.
    
    Specified by:
    
    getStandardProperties in class ProxyTestObject
    
    Returns:
    The set of standard properties associated with a test object.
    See Also:
    ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getProperties(), ProxyTestObject.getNonValueProperties()
  - getStandardProperties
```
public java.lang.String[] getStandardProperties(long handle)
```
  - getNonValueProperties
```
public java.util.Hashtable getNonValueProperties()
```
    return the properties that are not supported because of the return value
    
    Specified by:
    
    getNonValueProperties in class ProxyTestObject
    
    Returns:
    The set of properties that are not available.
    See Also:
    ProxyTestObject.getProperties(), ProxyTestObject.getStandardProperties(), ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object)
  - getMethods
```
public MethodInfo[] getMethods()
```
    Returns an array of MethodInfos
    
    Specified by:
    
    getMethods in class ProxyTestObject
    
    Returns:
    An array containing method signatures for all methods accessible against the associated test object.
    See Also:
    ProxyTestObject.getProperties(), ProxyTestObject.getStandardProperties(), ProxyTestObject.getNonValueProperties()
  - getProperty
```
public java.lang.Object getProperty(java.lang.String propertyName)
```
    Get the value for a specific property.
    
    Specified by:
    
    getProperty in class ProxyTestObject
    
    Parameters:
    propertyName - The name of the property to fetch.
    
    Returns:
    The active value of the specified property for the associated test object.
    See Also:
    ProxyTestObject.getProperties(), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getRecognitionProperties(), ProxyTestObject.addRecognitionProperty(String,Object,int)
  - getPropertyInternal
```
public java.lang.Object getPropertyInternal(java.lang.String propertyName)
```
  - fetchProperties
```
public java.lang.Object[] fetchProperties(java.lang.String[] props)
```
  - getPropertyInternalRunnable
```
public java.lang.Object getPropertyInternalRunnable(java.lang.String propertyName)
```
  - getDocumentWindow
```
public Window getDocumentWindow()
```
  - getProperty
```
public java.lang.Object getProperty(long handle,
                           java.lang.String propertyName)
```
  - getJsProps
```
public java.lang.Object getJsProps(long handle,
                          java.lang.String propName)
```
  - getPropertyN
```
public java.lang.Object getPropertyN(long nativeHandle,
                            java.lang.String propertyName)
```
  - setProperty
```
public void setProperty(java.lang.String propertyName,
               java.lang.Object value)
```
    Set the value for a specific property.
    
    Specified by:
    
    setProperty in class ProxyTestObject
    
    Parameters:
    propertyName - The name of the property to redefine. This name is the same as that returned by getProperties().
    See Also:
    ProxyTestObject.getProperties(), ProxyTestObject.getProperty(String)
  - setProperty
```
public boolean setProperty(long handle,
                  java.lang.String propertyName,
                  java.lang.Object value)
```
  - getIndexer
```
public java.lang.Object getIndexer(java.lang.String name,
                          java.lang.Object[] indexes)
```
    Gets the value of an indexed property
    
    Specified by:
    
    getIndexer in class ProxyTestObject
    
    Parameters:
    name - the name of the indexer
    indexes - the indexes to get the value of
  - getIndexers
```
public IndexerInfo[] getIndexers()
```
    Gets information about a TestObject's indexed properties
    
    Specified by:
    
    getIndexers in class ProxyTestObject
    
    See Also:
    com.rational.test.ft.value.IndexerInfo
  - setIndexer
```
public void setIndexer(java.lang.String name,
              java.lang.Object[] indexes,
              java.lang.Object val)
```
    Sets the value of an indexed property
    
    Specified by:
    
    setIndexer in class ProxyTestObject
    
    Parameters:
    name - the name of the indexer
    indexes - the indexes to set the value of
  - releaseElementHandle
```
public void releaseElementHandle(long handle)
                          throws java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalAccessException
  - 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 ProxyTestObject
    
    Returns:
    An object that reflects the active state of the represented test object.
  - detach
```
public long detach()
```
    Detach the native proxy and return its handle. This is used to pass ownership of the handle to another proxy instance.
  - isReleaseRequired
```
public boolean isReleaseRequired()
```
  - release
```
public void release()
```
  - release
```
public void release(long handle)
             throws java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalAccessException
  - releaseN
```
public void releaseN(long nativeHandle)
              throws java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalAccessException
  - getHtmlTag
```
public java.lang.String getHtmlTag()
```
    Return the HTML tag for this element. Since the tag is frequently queried is cached.
  - getText
```
public java.lang.String getText()
```
    Return the text associated with this element. This retrieves the .Text property and casts it to a String.
  - findElementWithName
```
public HtmlProxy findElementWithName(java.lang.String name)
```
    Find the element that is a child of this element which has the given name.
    
    Parameters:
    - - name - element should have this name attribute
  - getDocument
```
public HtmlDocumentProxy getDocument()
```
    Return a Proxy to the Html Document that contains this element.
  - getDocument
```
public HtmlDocumentProxy getDocument(long handle)
```
  - getDocumentHandle
```
public long getDocumentHandle(long handle)
```
  - 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.
    
    Specified by:
    
    getTestDataTypes in class ProxyTestObject
    
    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 ProxyTestObject
    
    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 ProxyTestObject
    
    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
  - isClassIndexConsidered
```
public boolean isClassIndexConsidered(java.util.Vector properties)
```
    Description copied from class: ProxyTestObject
    
    To include or ignore classindex property while scoring the underlying object represented by the ProxyTestObject.
    
    Overrides:
    
    isClassIndexConsidered in class ProxyTestObject
  - getVisualTopParent
```
public ProxyTestObject getVisualTopParent()
```
    Description copied from class: ProxyTestObject
    
    Return the top mappable parent that is sensible for the Visual Object Maps In case of HTML document is top visual parent In case of PDF, page is the top visual parent
    
    Overrides:
    
    getVisualTopParent in class ProxyTestObject
    
    Returns:
    The top mappable Visual Parent
  - getElementHandlesByTag
```
public HtmlProxy.HtmlElementEnumeration getElementHandlesByTag(java.lang.String tag)
```
  - getElementsByTagEnumeration
```
public java.util.Enumeration getElementsByTagEnumeration(long handle,
                                                java.lang.String tag)
```
  - release
```
public void release(long[] handles)
```
  - release
```
public void release(java.util.ArrayList handles)
```
  - release
```
public void release(java.util.ArrayList handles,
           long exceptionHandle)
```
  - release
```
public void release(long[] handles,
           long exceptionHandle)
```
  - getElementsByTag
```
public java.util.Enumeration getElementsByTag(java.lang.String tag)
```
  - getElementObjectsByTag
```
public ProxyTestObject[] getElementObjectsByTag(java.lang.String tag)
```
  - getElementsByTag
```
public long getElementsByTag(long handle,
                    java.lang.String tag)
```
  - getElementsByTagN
```
public long getElementsByTagN(long handle,
                     java.lang.String tag)
```
  - 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 ProxyTestObject
    
    Since:
    
    RFT2.0
    
    See Also:
    ProxyTestObject.getDataDrivableCommands(int)
  - addDataDrivableCommands
```
protected void addDataDrivableCommands(ProxyTestObject proxy,
                           java.util.Vector commands,
                           int includeChildren)
```
    Override this method from the ProxyTestObject. This is called when datadrive is done on any html objects. The method does the same actions as in ProxyTestObject and it prevents the duplicate data drive on the radio buttons.
    
    Overrides:
    
    addDataDrivableCommands in class ProxyTestObject
  - getIgnorableProperties
```
public java.lang.String[] getIgnorableProperties()
```
    Overrides:
    
    getIgnorableProperties in class ProxyTestObject
  - getHtmlTagNameFromClassProperty
```
public static java.lang.String getHtmlTagNameFromClassProperty(java.lang.String classProperty)
```
  - addChildrenHandlesToVector
```
protected void addChildrenHandlesToVector(HtmlProxy.HtmlElementEnumeration children,
                              java.util.Vector v)
```
  - getChildrenHandleEnumeration
```
public HtmlProxy.HtmlElementEnumeration getChildrenHandleEnumeration()
```
  - getChildrenHandles
```
public long[] getChildrenHandles()
```
  - getChildrenWithTagType
```
public ProxyTestObject[] getChildrenWithTagType(java.lang.String tagType)
```
  - enableHtmlCustomDomain
```
public void enableHtmlCustomDomain(java.lang.String domainName)
```
    Enable a html custom subdomain
    
    Specified by:
    
    enableHtmlCustomDomain in interface IHtmlCustomDomainEnablement
  - enableHtmlCustomDomains
```
public void enableHtmlCustomDomains(java.lang.String[] domainNames)
```
    Enable array of custom domains
    
    Specified by:
    
    enableHtmlCustomDomains in interface IHtmlCustomDomainEnablement
  - enableAllHtmlCustomDomains
```
public void enableAllHtmlCustomDomains()
```
    Enable all html custom domain
    
    Specified by:
    
    enableAllHtmlCustomDomains in interface IHtmlCustomDomainEnablement
  - disableHtmlCustomDomain
```
public void disableHtmlCustomDomain(java.lang.String domainName)
```
    Disable a html custom domain
    
    Specified by:
    
    disableHtmlCustomDomain in interface IHtmlCustomDomainEnablement
  - disableAllHtmlCustomDomains
```
public void disableAllHtmlCustomDomains()
```
    Disable all custom domains
    
    Specified by:
    
    disableAllHtmlCustomDomains in interface IHtmlCustomDomainEnablement
  - disableHtmlCustomDomains
```
public void disableHtmlCustomDomains(java.lang.String[] domainNames)
```
    Disable array of custom domains
    
    Specified by:
    
    disableHtmlCustomDomains in interface IHtmlCustomDomainEnablement
  - getInterestingRecogPropsForDynFind
```
public java.util.Vector getInterestingRecogPropsForDynFind(java.util.Vector properties)
```
    Return .customclass or .dojoclass for html customdomins
    
    Specified by:
    
    getInterestingRecogPropsForDynFind in interface IGetInterestingRecogProsForDynFind
  - adjustCustomDomains
```
public void adjustCustomDomains(FindPropertySet fps)
```
    Adjust customdomains based on fps
    
    Specified by:
    
    adjustCustomDomains in interface IHtmlCustomDomainEnablement
  - matches
```
public static boolean matches(java.lang.String toBeCompared,
              java.lang.String pattern)
```
    Utility method to match strings for java 1.3
    
    Parameters:
    pattern -
    toBeCompared -
    
    Returns:
  - replaceAll
```
public static java.lang.String replaceAll(java.lang.String originalString,
                          java.lang.String searchString,
                          java.lang.String toBeReplaced)
```
    utility method for replacing all the patterns in a string equivalent to jdk 1.4 and above
    
    Parameters:
    originalString -
    searchString -
    toBeReplaced -
    
    Returns:
  - isFindOptimized
```
public boolean isFindOptimized(FindPropertySet fps)
```
    Specified by:
    
    isFindOptimized in interface IQuickFind
  - callJqueryFind
```
public boolean callJqueryFind()
```
    Specified by:
    
    callJqueryFind in interface IQuickFind
  - findElementsDirectly
```
public ProxyTestObject[] findElementsDirectly(boolean mappable)
```
    Specified by:
    
    findElementsDirectly in interface IQuickFind
  - shouldDocumentBeAdded
```
protected boolean shouldDocumentBeAdded(java.util.ArrayList docProps,
                            long handle)
```
  - findElementsViaQuery
```
public ProxyTestObject[] findElementsViaQuery(boolean mappable)
```
    Specified by:
    
    findElementsViaQuery in interface IQuickFind
  - getProxyTestObjectsFromEnumeration
```
public ProxyTestObject[] getProxyTestObjectsFromEnumeration(java.util.Enumeration children)
```
  - getElementsByXpath
```
public java.util.Enumeration getElementsByXpath(Property[] props)
```
  - getElementsByXpath
```
public java.util.Enumeration getElementsByXpath(java.lang.String xpath)
```
  - getElementsByXpathEnumeration
```
public java.util.Enumeration getElementsByXpathEnumeration(long handle,
                                                  java.lang.String xpath)
```
  - find
```
public FindResult find(IMappedTestObject[] pathToFind,
              int myLevel)
```
    Specified by:
    
    find in interface IQuickFind
  - findElementWithDynamicFind
```
public FindResult findElementWithDynamicFind(IMappedTestObject[] pathToFind,
                                    int myLevel)
```
    Specified by:
    
    findElementWithDynamicFind in interface IQuickFind
  - getElementsByNameInProxyTestObjects
```
public ProxyTestObject[] getElementsByNameInProxyTestObjects(java.lang.String name)
```
    Specified by:
    
    getElementsByNameInProxyTestObjects in interface IQuickFind
  - getElementsByTagInProxyTestObjects
```
public ProxyTestObject[] getElementsByTagInProxyTestObjects(java.lang.String tag)
```
    Specified by:
    
    getElementsByTagInProxyTestObjects in interface IQuickFind
  - getElementsDirectly
```
public ProxyTestObject[] getElementsDirectly(com.rational.test.ft.vp.impl.Property property,
                                    boolean mappable)
```
    Specified by:
    
    getElementsDirectly in interface IQuickFind
  - getMappableElementsByNameInProxyTestObjects
```
public ProxyTestObject[] getMappableElementsByNameInProxyTestObjects(java.lang.String name)
```
    Specified by:
    
    getMappableElementsByNameInProxyTestObjects in interface IQuickFind
  - getMappableElementsByTagInProxyTestObjects
```
public ProxyTestObject[] getMappableElementsByTagInProxyTestObjects(java.lang.String tag)
```
    Specified by:
    
    getMappableElementsByTagInProxyTestObjects in interface IQuickFind
  - isPropertyOptimizable
```
public boolean isPropertyOptimizable(com.rational.test.ft.vp.impl.Property property)
```
    Specified by:
    
    isPropertyOptimizable in interface IQuickFind
  - isScoreForFindBYIdorName
```
public boolean isScoreForFindBYIdorName()
```
    Specified by:
    
    isScoreForFindBYIdorName in interface IQuickFind
  - findElementsByXpath
```
public ProxyTestObject[] findElementsByXpath(java.lang.String xpath)
```
    Specified by:
    
    findElementsByXpath in interface IXPathFind
  - isXpathSupported
```
public boolean isXpathSupported()
```
    Specified by:
    
    isXpathSupported in interface IXPathFind
  - setClass
```
public void setClass(java.lang.String objectClass)
```

Class HtmlProxy

Nested Class Summary

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

debug

HTMLPROXYCHANNELRUNNABLE_TIMEOUTVALUE

jswarapper

channel

dojoProps

parentsTextDescendantsMayBeInteresting

isSiebelActive

TAGPROPERTY

CLASSPROPERTY

IDPROPERTY

UNIQUEIDPROPERTY

NAMEPROPERTY

BOUNDSPROPERTY

TEXTPROPERTY

TITLEPROPERTY

DISABLEDPROPERTY

CLIENTRECTPROPERTY

BODYTAG

CLASSINDEX

DOCCLASSINDEX

READONLYPROPERTY

domain

TESTDATA_TEXT

Constructor Detail

HtmlProxy

HtmlProxy

Method Detail

getBrowserAppVersion

getValueProperty

getCachedData

setCachedData

getDomain

setDomain

getCustomClassProperty

getJswarapper

setJswarapper

setCustomClassProperty

getCustomClassPropertyValue

setCustomClassPropertyValue

isObjectDead

getChannel

getHandle

equals

isSameObject

getTestObjectClassName

getTestDomain

setSavedDescriptiveName

getSavedDescriptiveName

getDescriptiveName

getRole

processMouseEvent

getUniqueId

shouldBeMapped

split

getObject

getCustomObject

getObjectClassName

getParent

getParent

getParentN

getMappableParent

getMappableParent

isContextObjectSet

isContextObjectSet

getCustomDomainName

getCustomDomainNameForParent

getCustomDomainNameForChildren

getCustomDomainName

getCustomDomainName