com.rational.test.ft.domain.html

Class ActiveXProxy

java.lang.Object

RegisteredObject

com.rational.test.ft.domain.ProxyTestObject

com.rational.test.ft.domain.html.ActiveXProxy

All Implemented Interfaces:

IDataDriven, IProxyBase

public class ActiveXProxy
extends ProxyTestObject

This is the proxy for COM objects embedded in HTML. It is a non-GUI proxy.

• TestObject Interface: TestObject
  

Since:

RFT1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ActiveXProxy.InvalidNativeHandleException
class	ActiveXProxy.NativeProxyReleasedException
class	ActiveXProxy.ReleaseElementHandleRunnable

Field Summary

Fields

Modifier and Type	Field and Description
protected IChannel	channel
protected static FtDebug	debug
protected ProxyTestObject	tempParent
protected static java.lang.String	TESTDATA_TEXT

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

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

Constructor and Description
ActiveXProxy(long handle)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRecognitionProperty(java.lang.String property, java.lang.Object value, int weight) Not implemented
long	detach() Detach the native proxy and return its handle.
boolean	equals(java.lang.Object obj) Overrides the object-level equals with an equality against the handles of the underlying test objects.
HtmlProxy	findElementWithName(java.lang.String name) Element does not have children.
protected java.lang.Object	getAddedRecognitionPropertyValue(java.lang.String propertyName)
IChannel	getChannel() Return the channel associated with this object.
ProxyTestObject[]	getChildren() Objects have no children
java.util.Enumeration	getChildrenEnumeration() Objects have no children
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
protected long	getHandle()
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
ProxyTestObject[]	getMappableChildren() Objects have no children
ProxyTestObject	getMappableParent() Returns null always because object relationships are not applicable.
protected ProxyTestObject	getMappableParentInternal() Returns null always because object relationships are not applicable.
MethodInfo[]	getMethods() Returns an array of MethodInfos
MethodSpecification	getMethodSpecForPoint(java.awt.Point pt) Returns 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 null always
ProxyTestObject	getOwner() Returns null always
ProxyTestObject	getParent() Returns null always because object relationships are not applicable.
java.util.Hashtable	getProperties() Returns a complete set of properties for the associated test object.
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.Object	getPropertyInternal(java.lang.String propertyName) Get the value for a specific property.
java.util.Hashtable	getRecognitionProperties() Not a GUI object so does not have any recogntion properties
int	getRecognitionPropertyWeight(java.lang.String propertyName) Returns an indication of how useful this property is for recognition.
int	getRefCount()
int	getRefCount(long handle)
java.lang.String	getRole() Returns TestObjectRole.ROLE_OBJECT.
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.
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() Returns a valid class name specification.
java.lang.String	getText() Element does not have associated text.
ProxyTestObject	getTopMappableParent() Returns getTopParent() which is the browser and is always mappable.
ProxyTestObject	getTopParent() Returns null always because object relationships are not applicable.
java.lang.String	getUniqueId() Return a unique string for the associated object.
boolean	hasAddedRecognitionProperties() Returns true if recognition properties have been added to this proxy from an external source through addRecognitionProperty().
void	initialize(HtmlTestDomainImplementation domain, IChannel channel)
boolean	isReleaseRequired()
boolean	isSameObject(java.lang.Object obj) Returns true if the supplied test object represents the same underlying object.
long	marshalInterface()
long	marshalInterface(long handle)
void	processMouseEvent(IMouseActionInfo action) Updates the supplied action with an appropriate MethodSpecification to play back the action.
void	release()
protected void	release(long nativeHandle)
void	releaseElementHandle(long handle)
void	releaseMeow(long meowHandle)
void	releaseMeow(long handle, long meowHandle)
void	setIndexer(java.lang.String name, java.lang.Object[] indexes, java.lang.Object val) Sets the value of an indexed property
void	setProperty(java.lang.String propertyName, java.lang.Object value) Set the value for a specific property.
boolean	shouldBeMapped() Returns false, by default only GUI test objects are mapped.
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

addDataDrivableCommands, baseClassMatch, canTakeVP, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChildren, getDataDrivableCommand, getDataDrivableCommands, getElementWithFocus, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualClippableParent, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, 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

channel

protected IChannel channel

tempParent

protected ProxyTestObject tempParent

TESTDATA_TEXT

protected static final java.lang.String TESTDATA_TEXT

See Also:

Constant Field Values

Constructor Detail

ActiveXProxy

public ActiveXProxy(long handle)

Method Detail

initialize

public void initialize(HtmlTestDomainImplementation domain,
              IChannel channel)

getChannel

public IChannel getChannel()

Return the channel associated with this object.

Overrides:

getChannel in class ProxyTestObject

getHandle

protected 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()

Description copied from class: ProxyTestObject

Returns a valid class name specification. The test script (which runs in a separate process) interacts with a class that supports a shared interface with a specific proxy. This class is called a TestObject class. The testObject performs a cross-process (and cross-JVM) call to the same method against an associated proxy, which is this proxy.

This method should never return null, even if shouldBeMapped() returns false. User may still access objects such as this through scripting method calls and can return references to them. If a null were returned, the marshalling code would be confused and would not be able to construct a test object.

This method may be called from any thread.

Specified by:

getTestObjectClassName in interface IProxyBase

Specified by:

getTestObjectClassName in class ProxyTestObject

Returns:

The associated testObject 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.

getDescriptiveName

public java.lang.String getDescriptiveName()

Description copied from class: ProxyTestObject

Returns a name that can be used to describe the associated UI object in a script. This name can be further adjusted to be unique to the script. Only characters used in Java identifiers are returned (alphabetic, numeric, or underscore characters). Other kinds of characters cause script compilation failures. An example of what to return is "OKButton" for a java.awt.Button with the associated text "OK".

Specified by:

getDescriptiveName in class ProxyTestObject

Returns:

A descriptive object name.

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_OBJECT.

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)

Description copied from class: ProxyTestObject

Updates the supplied action with an appropriate MethodSpecification to play back the action. This method is the primary record interface for mouse events against a particular control. Only one MethodSpecification is maintained in the action state. If the active specification is valid, it is not updated.

Specified by:

processMouseEvent in class ProxyTestObject

Parameters:

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

See Also:

IMouseActionInfo, com.rational.test.ft.sys.MethodSpecification

getUniqueId

public java.lang.String getUniqueId()

Return a unique string for the associated object. This string needs to be identical for each call to this method for the same instance of the UI object. This value must also be as unique as possible.

Specified by:

getUniqueId in class ProxyTestObject

Returns:

Return a unique and repeatable identifier for the object being evaluated.

shouldBeMapped

public boolean shouldBeMapped()

Returns false, by default only GUI test objects are mapped.

Specified by:

shouldBeMapped in class ProxyTestObject

Returns:

false not a mappable object type

getObject

public java.lang.Object getObject()

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()

Returns null always because object relationships are not applicable.

Specified by:

getParent in class ProxyTestObject

Returns:

null, no known parent.

getMappableParent

public ProxyTestObject getMappableParent()

Returns null always because object relationships are not applicable.

Specified by:

getMappableParent in class ProxyTestObject

Returns:

null, no known parent.

getMappableParentInternal

protected ProxyTestObject getMappableParentInternal()

Returns null always because object relationships are not applicable.

getTopParent

public ProxyTestObject getTopParent()

Returns null always because object relationships are not applicable.

Specified by:

getTopParent in class ProxyTestObject

Returns:

The proxy for the top parent test object or itself for a top-level object.

getTopMappableParent

public ProxyTestObject getTopMappableParent()

Returns getTopParent() which is the browser and is always mappable.

Specified by:

getTopMappableParent in class ProxyTestObject

Returns:

null, no known parent.

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()

Objects have no children

Returns:

null

getChildren

public ProxyTestObject[] getChildren()

Objects have no children

Specified by:

getChildren in class ProxyTestObject

Returns:

null

getMappableChildren

public ProxyTestObject[] getMappableChildren()

Objects have no children

Specified by:

getMappableChildren in class ProxyTestObject

Returns:

null

getOwner

public ProxyTestObject getOwner()

Returns null always

Specified by:

getOwner in class ProxyTestObject

Returns:

null, no known parent.

getOwnedObjects

public ProxyTestObject[] getOwnedObjects()

Returns null always

Specified by:

getOwnedObjects in class ProxyTestObject

Returns:

null, no known parent.

getMethodSpecForPoint

public MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

Description copied from class: ProxyTestObject

Returns a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default, a method specification for IGraphical.getScreenPoint is returned.

Specified by:

getMethodSpecForPoint in class ProxyTestObject

See Also:

com.rational.test.ft.sys.MethodSpecification

getRecognitionProperties

public java.util.Hashtable getRecognitionProperties()

Not a GUI object so does not have any recogntion 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)

getRecognitionPropertyWeight

public int getRecognitionPropertyWeight(java.lang.String propertyName)

Description copied from class: ProxyTestObject

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. This method must return a value greater than or equal to zero and less than or equal to 100.

Specified by:

getRecognitionPropertyWeight in class ProxyTestObject

Parameters:

propertyName - The name of the recognition property to return a weight value for.

See Also:

ProxyTestObject.getRecognitionProperties()

addRecognitionProperty

public void addRecognitionProperty(java.lang.String property,
                          java.lang.Object value,
                          int weight)

Not implemented

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 is returned when getRecognitionPropertyWeight() is called.

See Also:

ProxyTestObject.getRecognitionProperties(), ProxyTestObject.getRecognitionPropertyWeight(String), ProxyTestObject.getProperty(String)

hasAddedRecognitionProperties

public boolean hasAddedRecognitionProperties()

Description copied from class: ProxyTestObject

Returns true if recognition properties have been added to this proxy from an external source through addRecognitionProperty().

Specified by:

hasAddedRecognitionProperties in class ProxyTestObject

Returns:

true if recognition properties have been added to this proxy from an external source through addRecognitionProperty(String,Object,int).

See Also:

ProxyTestObject.addRecognitionProperty(String,Object,int)

getAddedRecognitionPropertyValue

protected java.lang.Object getAddedRecognitionPropertyValue(java.lang.String propertyName)

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()

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()

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)

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

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)

Get the value for a specific property. Internal, no exceptions thrown.

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)

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()

releaseElementHandle

public void releaseElementHandle(long handle)

release

protected void release(long nativeHandle)

getText

public java.lang.String getText()

Element does not have associated text.

findElementWithName

public HtmlProxy findElementWithName(java.lang.String name)

Element does not have children.

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

marshalInterface

public long marshalInterface()

releaseMeow

public void releaseMeow(long meowHandle)

getRefCount

public int getRefCount()

marshalInterface

public long marshalInterface(long handle)

releaseMeow

public void releaseMeow(long handle,
               long meowHandle)

getRefCount

public int getRefCount(long handle)