com.rational.test.ft.domain.flex

Class FlexObjectProxy

java.lang.Object

RegisteredObject

com.rational.test.ft.domain.ProxyTestObject

com.rational.test.ft.domain.flex.FlexObjectProxy

All Implemented Interfaces:

IDataDriven, IProxyBase

Direct Known Subclasses:

FlexButtonProxy, FlexChartProxy, FlexChartSeriesProxy, FlexColorPickerProxy, FlexComboBoxProxy, FlexContainerProxy, FlexDateChooserProxy, FlexLabelProxy, FlexListLabelProxy, FlexMenuBarProxy, FlexNumericStepperProxy, FlexPopUpButtonProxy, FlexProgressBarProxy, FlexScrollBarProxy, FlexScrollControlBaseProxy, FlexSliderProxy, FlexVideoDisplayProxy, SparkRichEditableTextProxy

public class FlexObjectProxy
extends ProxyTestObject

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

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

• Test Object interface:
  flexObjetTestObject
  
• Default Recognition Properties:
  

  Property	Usage
  .class	The flex full class name of the test object.
  .classIndex	The zero-based index of the class relative to the immediate parent in the object map.

  
  

Field Summary

Fields

Modifier and Type	Field and Description
protected HashtableEx	addedRecProps
protected HashtableEx	addedRecPropsWeight
protected static java.lang.String	ARG_SEPARATOR
protected static java.lang.String	COLUMN_SEPARATOR
protected static FtDebug	debug
protected FlexTestDomainImplementation	domain
protected java.lang.String	m_automationID
protected java.lang.String	m_className
protected static int	MAX_NAME
protected ScriptCommandFlags	preDownState
protected static java.lang.String	PROPERTY_AUTOMATIONCLASSNAME
protected static java.lang.String	PROPERTY_AUTOMATIONINDEX
protected static java.lang.String	PROPERTY_AUTOMATIONNAME
protected static java.lang.String	PROPERTY_CLASSNAME
protected static java.lang.String	PROPERTY_CURRENTSTATE
protected static java.lang.String	PROPERTY_ENABLED
protected static java.lang.String	PROPERTY_FOCUSENABLED
protected static java.lang.String	PROPERTY_ID
protected static java.lang.String	PROPERTY_MOUSEENABLED
protected static java.lang.String	PROPERTY_TABENABLED
protected static java.lang.String	PROPERTY_TABINDEX
protected static java.lang.String	PROPERTY_TOOLTIP
protected static java.lang.String	PROPERTY_VISIBLE
protected static java.lang.String[]	ScrollDetailsValue
protected static java.lang.String[]	ScrollDirectionValue
protected long	transactionId

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
FlexObjectProxy(FlexTestDomainImplementation theDomain, IChannel channel, java.lang.String theAutomationID)
FlexObjectProxy(FlexTestDomainImplementation theDomain, java.lang.String theAutomationID)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAdditionalRecognitionProperties(java.util.Hashtable result)
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	changeFocus()
void	changeFocus(boolean shiftKey)
void	changeFocus(boolean shiftKey, java.lang.String keyCode)
void	changeFocus(java.lang.String keyCode)
void	click() Performs a left-mouse click on the center point of the associated TestObject.
void	click(MouseModifiers modifiers) Performs a left-mouse click on the specified object, relative to coordinates within the associated TestObject.
void	click(MouseModifiers modifiers, java.awt.Point pt) Performs a left-mouse click on the specified coordinates, relative to the associated TestObject.
void	doubleClick() Performs a left-mouse double-click on the center point of the associated TestObject.
void	doubleClick(MouseModifiers modifiers) Performs a left-mouse double-click on the specified object, relative to coordinates within the associated TestObject.
void	doubleClick(MouseModifiers modifiers, java.awt.Point pt) Performs a left-mouse double-click on the specified coordinates, relative to the associated TestObject.
void	drag() Performs a MOUSE_LEFT drag action against the associated TestObject.
void	drag(MouseModifiers modifiers) Performs a drag action against the associated TestObject with the supplied set of mouse modifiers.
void	drag(MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2) Performs a drag action against the associated TestObject.
void	drag(java.awt.Point pt1, java.awt.Point pt2) Performs a MOUSE_LEFT drag action against the associated TestObject.
void	dragToScreenPoint(MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt) Performs a drag action against the associated TestObject.
void	dragToScreenPoint(java.awt.Point screenPt) Performs a MOUSE_LEFT drag action against the associated TestObject.
void	dragToScreenPoint(java.awt.Point objectPt, java.awt.Point screenPt) Performs a MOUSE_LEFT drag action against the associated TestObject.
boolean	ensureObjectIsVisible() Ensure the object is visible on the screen This method is not applicable to Flex objects, since scrolling operation gets recorded.
protected com.rational.test.ft.domain.flex.FlexObjectProxy.AdditionalRecognitionProperty	getAddedRecognitionProperty(java.lang.String propertyName) This method returns the AdditionalRecognitionProperty object identified by propertyName
protected java.lang.Object	getAddedRecognitionPropertyValue(java.lang.String propertyName)
protected int	getAddedRecognitionPropertyWeight(java.lang.String propertyName)
FlexObjectProxy	getAutomationChildAt(int id) Finds the automation child object that is at the specified index.
java.lang.Object	getChildAtPoint(java.awt.Point pt) Finds the child object that is at the specified point.
ProxyTestObject[]	getChildren() Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object.
java.awt.Rectangle	getClientRectangle() Get the client rectangle of the control.
java.awt.Rectangle	getClippedScreenRectangle() Returns the clipped-screen rectangle for the associated TestObject, relative to the top-left corner of the screen.
MethodSpecification	getDataDrivableCommand() This method must be implemented by any proxy that wishes to support data driving.
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
java.lang.Object	getIndexer(java.lang.String name, java.lang.Object[] indexes) Returns the value of a TestObject's indexer at the given index.
IndexerInfo[]	getIndexers() Returns information about the TestObject's indexers, if applicable.
java.lang.String	getLabel()
ProxyTestObject[]	getMappableChildren() Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object.
ProxyTestObject	getMappableParent() Returns a proxy object for the mappable parent of this object; returns null if this object has no mappable parent.
MethodInfo[]	getMethods() Returns an array of MethodInfos
MethodSpecification	GetMethodSpec(java.lang.String eventName, java.lang.String eventArgs)
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() Returns the properties that are not supported because the value is a reference to another object.
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	getOwner() Returns a proxy object for the owner of this object; returns null if this object has no owner.
ProxyTestObject	getParent() Returns a proxy object for the parent of this object; returns null if this object has no parent.
protected java.lang.String	getPlayerId()
java.util.Hashtable	getProperties() Returns a complete set of properties for the associated test object.
protected java.util.ArrayList	getPropertiesList()
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value for a specific property defined in getProperties() or getRecognitionProperties().
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 a brief type name that describes the role this object plays in the UI.
java.awt.Point	getScreenPoint() Returns the screen-relative point to a valid point within the object.
java.awt.Point	getScreenPoint(java.awt.Point pt) Returns the screen-relative point given an object-relative point.
java.awt.Rectangle	getScreenRectangle() Returns the rectangle that contains the component being evaluated, relative to the top-left corner of the screen.
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.util.Hashtable	getTestDataTypes() Returns a hashtable of data type descriptions of the verification point data available with the associated object.
TestDomainImplementation	getTestDomain() Returns the TestDomain that this proxy object is associated with.
java.lang.String	getTestObjectClassName() Returns a valid class name specification.
ProxyTestObject	getTopMappableParent() Returns a proxy object for the top mappable parent of this object; returns a pointer to itself if this object has no mappable parent.
ProxyTestObject	getTopParent() Returns a proxy object for the top parent of this object; returns a pointer to itself if this object has no parent.
long	getTransactionId()
java.lang.String	getUniqueId() Returns a string for the associated object.
java.lang.String	getValue()
ProxyTestObject	getVisualTopParent() Returns the top mappable parent for a given proxy.
boolean	hasAddedRecognitionProperties() Returns true if recognition properties have been added to this proxy from an external source through addRecognitionProperty().
boolean	hasFocus() Determines whether the component under evaluation has keyboard focus.
void	hover() Hovers the mouse over the center of the associated TestObject.
void	hover(double secondDelay) Hovers the mouse over the center of the associated TestObject.
void	hover(double secondDelay, java.awt.Point pt) Hovers the mouse over the specified coordinates of the associated TestObject.
void	hover(java.awt.Point pt) Hovers the mouse over the specified coordinates of the associated TestObject.
boolean	isEnabled() Determines whether the component under evaluation is enabled.
boolean	isOpaque() Determines whether the component under evaluation is opaque.
boolean	isPointInObject(java.awt.Point pt) Determines whether the specified screen-relative point is contained in the component under evaluation.
boolean	isShowing() Determine's whether the component under evaluation is showing.
void	mouseMove(MouseModifiers modifiers, java.awt.Point pt) Performs a Move action against the associated TestObject.
void	mouseMove(java.awt.Point pt) Performs a MOUSE_LEFT move action against the associated TestObject.
void	nClick(int clickCount, MouseModifiers modifiers, java.awt.Point pt) Performs a mouse n-click action on the specified coordinates, relative to the associated TestCode.
void	nClickDrag(int clickCount, MouseModifiers modifiers, java.awt.Point pt1, java.awt.Point pt2) Performs a mouse n-click drag action on the specified coordinates, relative to the associated TestObject.
void	nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, java.awt.Point objectPt, java.awt.Point screenPt) Performs a mouse n-click drag action on the specified coordinates, relative the screen-relative screenPt coordinates.
void	performAction(java.lang.String eventName)
void	performAction(java.lang.String eventName, java.lang.Object[] eventArgs)
void	performAction(java.lang.String eventName, java.lang.String eventArgs)
void	performAction(java.lang.String eventName, java.lang.String args1, java.lang.String args2)
void	performAction(java.lang.String eventName, java.lang.String args1, java.lang.String args2, java.lang.String args3)
void	performAction(java.lang.String eventName, java.lang.String args1, java.lang.String args2, java.lang.String args3, java.lang.String args4)
void	processMouseEvent(IMouseActionInfo action) Updates the supplied action with an appropriate MethodSpecification to play back the action.
void	setIndexer(java.lang.String name, java.lang.Object[] indexes, java.lang.Object val) Sets the value of a TestObject's indexer.
void	setProperty(java.lang.String propertyName, java.lang.Object value) Sets the value for a specific property defined in getProperties() or getRecognitionProperties().
void	setTransactionId(long transactionId)
boolean	shouldBeMapped() Determines whether the object is interesting from a persistent testability sense and should therefore be added to the object map.
boolean	suppressKeyAction() Flags the recorder to ignore key events relative to this top-level proxy.

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

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommands, getElementWithFocus, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getTestData, getVisualClippableParent, getVisualClippedRectangle, getVisualMappableChildren, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, updateTestData

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_AUTOMATIONINDEX

protected static final java.lang.String PROPERTY_AUTOMATIONINDEX

See Also:

Constant Field Values

PROPERTY_AUTOMATIONCLASSNAME

protected static final java.lang.String PROPERTY_AUTOMATIONCLASSNAME

See Also:

Constant Field Values

PROPERTY_AUTOMATIONNAME

protected static final java.lang.String PROPERTY_AUTOMATIONNAME

See Also:

Constant Field Values

PROPERTY_CLASSNAME

protected static final java.lang.String PROPERTY_CLASSNAME

See Also:

Constant Field Values

PROPERTY_CURRENTSTATE

protected static final java.lang.String PROPERTY_CURRENTSTATE

See Also:

Constant Field Values

PROPERTY_ENABLED

protected static final java.lang.String PROPERTY_ENABLED

See Also:

Constant Field Values

PROPERTY_FOCUSENABLED

protected static final java.lang.String PROPERTY_FOCUSENABLED

See Also:

Constant Field Values

PROPERTY_ID

protected static final java.lang.String PROPERTY_ID

See Also:

Constant Field Values

PROPERTY_MOUSEENABLED

protected static final java.lang.String PROPERTY_MOUSEENABLED

See Also:

Constant Field Values

PROPERTY_TABENABLED

protected static final java.lang.String PROPERTY_TABENABLED

See Also:

Constant Field Values

PROPERTY_TABINDEX

protected static final java.lang.String PROPERTY_TABINDEX

See Also:

Constant Field Values

PROPERTY_TOOLTIP

protected static final java.lang.String PROPERTY_TOOLTIP

See Also:

Constant Field Values

PROPERTY_VISIBLE

protected static final java.lang.String PROPERTY_VISIBLE

See Also:

Constant Field Values

domain

protected FlexTestDomainImplementation domain

preDownState

protected ScriptCommandFlags preDownState

m_className

protected java.lang.String m_className

m_automationID

protected java.lang.String m_automationID

MAX_NAME

protected static final int MAX_NAME

See Also:

Constant Field Values

ARG_SEPARATOR

protected static final java.lang.String ARG_SEPARATOR

See Also:

Constant Field Values

COLUMN_SEPARATOR

protected static final java.lang.String COLUMN_SEPARATOR

See Also:

Constant Field Values

addedRecProps

protected HashtableEx addedRecProps

addedRecPropsWeight

protected HashtableEx addedRecPropsWeight

debug

protected static FtDebug debug

transactionId

protected long transactionId

ScrollDirectionValue

protected static final java.lang.String[] ScrollDirectionValue

ScrollDetailsValue

protected static final java.lang.String[] ScrollDetailsValue

Constructor Detail

FlexObjectProxy

public FlexObjectProxy(FlexTestDomainImplementation theDomain,
               IChannel channel,
               java.lang.String theAutomationID)

FlexObjectProxy

public FlexObjectProxy(FlexTestDomainImplementation theDomain,
               java.lang.String theAutomationID)

Method Detail

getTransactionId

public long getTransactionId()

setTransactionId

public void setTransactionId(long transactionId)

getTestObjectClassName

public java.lang.String getTestObjectClassName()

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.

Since:

RFT7.0.1

getTestDomain

public TestDomainImplementation getTestDomain()

Returns the TestDomain that this proxy object is associated with.

Specified by:

getTestDomain in interface IProxyBase

Specified by:

getTestDomain in class ProxyTestObject

Returns:

The associated TestDomain class full name.

Since:

RFT7.0.1

getDescriptiveName

public java.lang.String getDescriptiveName()

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.

Since:

RFT7.0.1

getRole

public java.lang.String getRole()

Returns a brief type name that describes the role this object plays in the UI. For instance a java.awt.Button might return button. There are suggested role constants in the TestObjectRole class. However, proxies are not limited to these constants.

The role is used for several purposes by the test infrastructure. First, the role can be used in the construction of object names in scripts, augmenting the name returned by getDescriptiveName(). The role is also used in the UI to decorate nodes in the map with icons that help users quickly associate the nodes with the roles they play in the system under test.

Overrides:

getRole in class ProxyTestObject

Returns:

A brief type name that describes the role this object plays in the UI.

Since:

RFT7.0.1

getObjectClassName

public java.lang.String getObjectClassName()

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.

Since:

RFT7.0.1

getUniqueId

public java.lang.String getUniqueId()

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

Determines whether the object is interesting from a persistent testability sense and should therefore be added to the object map. An object is considered interesting under one or more of the following conditions:

• Significant user actions can be performed against the object.
• The object contains testable properties.
• The object has interesting data associated with it.

Examples of objects that are not interesting include:

• Simple container objects with no interesting data.
• Decorative objects with no interesting side effects.
• Duplicate objects (mirroring data from another available object).

Note that if the object is a container, the children are examined even if this method returns false.

Specified by:

shouldBeMapped in class ProxyTestObject

Returns:

true if the represented control is interesting other than for nested objects.

Since:

RFT7.0.1

getParent

public ProxyTestObject getParent()

Returns a proxy object for the parent of this object; returns null if this object has no parent.

Specified by:

getParent in class ProxyTestObject

Returns:

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

Since:

RFT7.0.1

getMappableParent

public ProxyTestObject getMappableParent()

Returns a proxy object for the mappable parent of this object; returns null if this object has no mappable parent. Note that only a proxy that shouldBeMapped should be returned from this method.

Specified by:

getMappableParent in class ProxyTestObject

Returns:

The proxy for the first mappable parent test object or null for a top-level mapped object.

Since:

RFT7.0.1

getTopParent

public ProxyTestObject getTopParent()

Returns a proxy object for the top parent of this object; returns a pointer to 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.

Since:

RFT7.0.1

getTopMappableParent

public ProxyTestObject getTopMappableParent()

Returns a proxy object for the top mappable parent of this object; returns a pointer to itself if this object has no mappable parent.

Specified by:

getTopMappableParent in class ProxyTestObject

Returns:

The proxy for the top parent test object or itself for a test object with no mappable parent.

Since:

RFT7.0.1

getChildren

public ProxyTestObject[] getChildren()

Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object.

Specified by:

getChildren in class ProxyTestObject

Returns:

An array of child proxies of this proxy.

Since:

RFT7.0.1

getMappableChildren

public ProxyTestObject[] getMappableChildren()

Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object. This method is always used when building up the test objects to be added to a map, because a side additional recognition properties may be added to the child objects.

Specified by:

getMappableChildren in class ProxyTestObject

Returns:

An array of child proxies of this proxy.

Since:

RFT7.0.1

getOwner

public ProxyTestObject getOwner()

Returns a proxy object for the owner of this object; returns null if this object has no owner.

Specified by:

getOwner in class ProxyTestObject

Returns:

The proxy for the owning object, or null for a top object without an owner.

Since:

RFT7.0.1

getOwnedObjects

public ProxyTestObject[] getOwnedObjects()

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.

Since:

RFT7.0.1

suppressKeyAction

public boolean suppressKeyAction()

Flags the recorder to ignore key events relative to this top-level proxy. This method is used to suppress the recording of key events against top-level proxy objects that capture key text in other fashions.

Overrides:

suppressKeyAction in class ProxyTestObject

Returns:

true for a top-level proxy that wants to suppress the generation of inputKeys method calls.

Since:

RFT7.0.1

processMouseEvent

public void processMouseEvent(IMouseActionInfo action)

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.

Since:

RFT7.0.1

See Also:

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

getScriptCommandFlags

public ScriptCommandFlags getScriptCommandFlags()

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.

GetMethodSpec

public MethodSpecification GetMethodSpec(java.lang.String eventName,
                                java.lang.String eventArgs)

getMethodSpecForPoint

public MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

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

Parameters:

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

Since:

RFT7.0.1

See Also:

com.rational.test.ft.sys.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)

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)

getAddedRecognitionPropertyValue

protected java.lang.Object getAddedRecognitionPropertyValue(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)

getAddedRecognitionProperty

protected com.rational.test.ft.domain.flex.FlexObjectProxy.AdditionalRecognitionProperty getAddedRecognitionProperty(java.lang.String propertyName)

This method returns the AdditionalRecognitionProperty object identified by propertyName

hasAddedRecognitionProperties

public boolean hasAddedRecognitionProperties()

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

Since:

RFT7.0.1

See Also:

addRecognitionProperty(String,Object,int)

getProperties

public java.util.Hashtable getProperties()

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 getNonValueProperties() returns information about such properties.

Specified by:

getProperties in class ProxyTestObject

Returns:

The set of known properties associated with a test object.

Since:

RFT7.0.1

See Also:

getProperty(String), setProperty(String,Object), getStandardProperties(), getNonValueProperties()

getPropertiesList

protected java.util.ArrayList getPropertiesList()

getStandardProperties

public java.util.Hashtable getStandardProperties()

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

Since:

RFT7.0.1

See Also:

getProperty(String), setProperty(String,Object), getProperties(), getNonValueProperties()

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Gets the value for a specific property defined in getProperties() or getRecognitionProperties(). If the property is not defined by either of these methods, this method throws PropertyNotFoundException.

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.

Since:

RFT7.0.1

See Also:

getProperties(), setProperty(String,Object), getRecognitionProperties(), addRecognitionProperty(String,Object,int)

setProperty

public void setProperty(java.lang.String propertyName,
               java.lang.Object value)

Sets the value for a specific property defined in getProperties() or getRecognitionProperties(). Properties not defined by either of these methods, and properties whose values cannot be modified throw an appropriately populated PropertyNotFoundException.

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

Since:

RFT7.0.1

See Also:

getProperties(), getProperty(String)

getNonValueProperties

public java.util.Hashtable getNonValueProperties()

Returns the properties that are not supported because the value is a reference to another object. These properties can still be accessed using getProperty(). If such a property is returned to the test script, it is manifested as a TestObject containing a reference to the object in the SUT. The test script should call the TestObject method unregister() to release the object.

When an object is unregistered, the release() method that all ProxyTestObjects inherit from RegisteredObject is called.

Specified by:

getNonValueProperties in class ProxyTestObject

Returns:

The set of properties that are not available.

Since:

RFT7.0.1

See Also:

getProperties(), getStandardProperties(), getProperty(String), setProperty(String,Object)

getIndexer

public java.lang.Object getIndexer(java.lang.String name,
                          java.lang.Object[] indexes)

Returns the value of a TestObject's indexer at the given index. If the value has a value class then the value class is returned, otherwise a TestObject is registered and returned. Information about a TestObject's indexer properties can be obtained via getIndexers().

Specified by:

getIndexer in class ProxyTestObject

Parameters:

name - the name of the indexer

indexes - the indexes to get the value of

Since:

RFT2.0

getIndexers

public IndexerInfo[] getIndexers()

Returns information about the TestObject's indexers, if applicable.

Specified by:

getIndexers in class ProxyTestObject

Since:

RFT2.0

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 a TestObject's indexer.

Specified by:

setIndexer in class ProxyTestObject

Parameters:

name - the name of the indexer

indexes - the indexes to set the value of

value - the value to set the index to

Since:

RFT2.0

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

getTestDataTypes

public java.util.Hashtable getTestDataTypes()

Returns a hashtable of data type descriptions of the verification point data available with the associated object. 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 different from 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.

Since:

RFT7.0.1

See Also:

ProxyTestObject.getTestData(String), com.rational.test.ft.vp.ITestData

getPlayerId

protected java.lang.String getPlayerId()

ensureObjectIsVisible

public boolean ensureObjectIsVisible()

Ensure the object is visible on the screen This method is not applicable to Flex objects, since scrolling operation gets recorded.

Returns:

true if the component is visible; false otherwise.

Since:

RFT7.0.1

isShowing

public boolean isShowing()

Determine's whether the component under evaluation is showing.

Returns:

true if the component is showing; false otherwise.

Since:

RFT7.0.1

isEnabled

public boolean isEnabled()

Determines whether the component under evaluation is enabled.

Returns:

true if the component is enabled; false otherwise.

isOpaque

public boolean isOpaque()

Determines whether the component under evaluation is opaque.

Returns:

true if the component is opaque; false otherwise.

hasFocus

public boolean hasFocus()

Determines whether the component under evaluation has keyboard focus.

Returns:

true if the component has keyboard focus; false otherwise.

Since:

RFT7.0.1

isPointInObject

public boolean isPointInObject(java.awt.Point pt)

Determines whether the specified screen-relative point is contained in the component under evaluation. Note that the point is relative to the top-left corner of the screen and not to the component itself, or its parent.

This functionality is performed by the proxy due to potentially unusual aspects associated with functionality. While typically the getScreenRectangle is used to resolve this query, this is not accurate in certain situations. For example, if the clickable region on a button is not rectangular, just checking whether the point is in the rectangle would not yield a valid result.

Parameters:

pt - Screen-relative point to check

Returns:

true if component contains thePoint; false otherwise.

Since:

RFT7.0.1

See Also:

getScreenRectangle()

getChildAtPoint

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

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

Parameters:

pt - Screen-relative point to check

Returns:

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

Since:

RFT7.0.1

See Also:

getScreenRectangle()

getAutomationChildAt

public FlexObjectProxy getAutomationChildAt(int id)

Finds the automation child object that is at the specified index.

Parameters:

id - index from which the child is to be retrieved

Returns:

The object at the index, or null if no child object is found

Since:

RFT7.0.1

getScreenRectangle

public java.awt.Rectangle getScreenRectangle()

Returns the rectangle that contains the component being evaluated, relative to the top-left corner of the screen. This typically consists of two operations (getLocationOnScreen and getSize) combined into a single operation. The rectangle is exposed so that actions may be directly scripted against a visible GUI object. If the GUI object does not show, null is returned.

Since:

RFT7.0.1

See Also:

isPointInObject(java.awt.Point), getClippedScreenRectangle()

getClippedScreenRectangle

public java.awt.Rectangle getClippedScreenRectangle()

Returns the clipped-screen rectangle for the associated TestObject, relative to the top-left corner of the screen. While getScreenRectangle() returns the true rectangle of the TestObject, this method clips the true screen rectangle to the bounds of any clipping parent TestObject. Clipping parents, such as scroll panes or a browser window, may hide part or all of the true screen rectangle. Only the screen-level viewable rectangle is returned, or null if the object is not showing, or is completely clipped by a clipping parent.

Returns:

The clipped screen rectangle, or null if the object cannot be seen in any window on the screen.

Since:

RFT7.0.1

See Also:

getScreenRectangle()

getClientRectangle

public java.awt.Rectangle getClientRectangle()

Get the client rectangle of the control.

getScreenPoint

public java.awt.Point getScreenPoint()

Returns the screen-relative point to a valid point within the object.

Since:

RFT7.0.1

getScreenPoint

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

Returns the screen-relative point given an object-relative point.

Parameters:

pt - The object-relative point

Since:

RFT7.0.1

click

public void click()

Performs a left-mouse click on the center point of the associated TestObject. This method is a shortcut to the click method with a modifier parameter. (The modifier is set to MOUSE_LEFT).

Since:

RFT7.0.1

changeFocus

public void changeFocus()

changeFocus

public void changeFocus(boolean shiftKey,
               java.lang.String keyCode)

changeFocus

public void changeFocus(java.lang.String keyCode)

changeFocus

public void changeFocus(boolean shiftKey)

click

public void click(MouseModifiers modifiers)

Performs a left-mouse click on the specified object, relative to coordinates within the associated TestObject.

Since:

RFT7.0.1

click

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

Performs a left-mouse click on the specified coordinates, relative to the associated TestObject.

Since:

RFT7.0.1

doubleClick

public void doubleClick()

Performs a left-mouse double-click on the center point of the associated TestObject. This method is a shortcut to the doubleClick method with a modifier parameter. (The modifier is set to MOUSE_LEFT).

Since:

RFT7.0.1

doubleClick

public void doubleClick(MouseModifiers modifiers)

Performs a left-mouse double-click on the specified object, relative to coordinates within the associated TestObject.

Since:

RFT7.0.1

doubleClick

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

Performs a left-mouse double-click on the specified coordinates, relative to the associated TestObject.

Since:

RFT7.0.1

nClick

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

Performs a mouse n-click action on the specified coordinates, relative to the associated TestCode.

Since:

RFT7.0.1

drag

public void drag()

Performs a MOUSE_LEFT drag action against the associated TestObject. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Since:

RFT7.0.1

drag

public void drag(MouseModifiers modifiers)

Performs a drag action against the associated TestObject with the supplied set of mouse modifiers. This method is used to simulate drag actions against controls that are typically not sensitive to drag actions.

Since:

RFT7.0.1

drag

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

Performs a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates, relative to this TestObject.

Since:

RFT10

drag

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

Performs a drag action against the associated TestObject. The action is performed from (x1, y1) to (x2, y2) coordinates, relative to this TestObject.

nClickDrag

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

Performs a mouse n-click drag action on the specified coordinates, relative to the associated TestObject.

Since:

RFT7.0.1

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point screenPt)

Performs a MOUSE_LEFT drag action against the associated TestObject. The action is performed from a valid point within this TestObject to the screen-relative screenPt coordinates.

Since:

RFT7.0.1

dragToScreenPoint

public void dragToScreenPoint(java.awt.Point objectPt,
                     java.awt.Point screenPt)

Performs a MOUSE_LEFT drag action against the associated TestObject. The action is performed from (x, y,) relative to this TestObject, to the screen-relative screenPt coordinates.

Since:

RFT7.0.1

dragToScreenPoint

public void dragToScreenPoint(MouseModifiers modifiers,
                     java.awt.Point objectPt,
                     java.awt.Point screenPt)

Performs a drag action against the associated TestObject. The action is performed from (x, y), relative to this TestObject to the screen-relative screenPt coordinates.

Since:

RFT7.0.1

nClickDragToScreenPoint

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

Performs a mouse n-click drag action on the specified coordinates, relative the screen-relative screenPt coordinates.

Since:

RFT7.0.1

mouseMove

public void mouseMove(java.awt.Point pt)

Performs a MOUSE_LEFT move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates, relative to this TestObject.

mouseMove

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

Performs a Move action against the associated TestObject. The action is performed from current mouse coordinates to (x, y) coordinates, relative to this TestObject.

Since:

RFT7.0.1

hover

public void hover(double secondDelay)

Hovers the mouse over the center of the associated TestObject. The mouse is moved to the center of the TestObject and stays there for at least the specified number of seconds.

Since:

RFT7.0.1

hover

public void hover()

Hovers the mouse over the center of the associated TestObject. The mouse is moved to the center of the TestObject and stays there for the default length of time.

Since:

RFT7.0.1

hover

public void hover(java.awt.Point pt)

Hovers the mouse over the specified coordinates of the associated TestObject. The mouse is moved to the object, relative to the coordinates of the TestObject. It stays there for the default length of time.

Since:

RFT7.0.1

hover

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

Hovers the mouse over the specified coordinates of the associated TestObject. The mouse is moved to the object, relative to the coordinates of the TestObject. It stays there for at least the specified number of seconds.

Since:

RFT7.0.1

getValue

public java.lang.String getValue()

getLabel

public java.lang.String getLabel()

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)

getVisualTopParent

public ProxyTestObject getVisualTopParent()

Returns the top mappable parent for a given proxy. As of now, in flex it is returning null to stop capturing VOM's

Overrides:

getVisualTopParent in class ProxyTestObject

Returns:

The top mappable Visual Parent

performAction

public void performAction(java.lang.String eventName)

performAction

public void performAction(java.lang.String eventName,
                 java.lang.String eventArgs)

performAction

public void performAction(java.lang.String eventName,
                 java.lang.String args1,
                 java.lang.String args2)

performAction

public void performAction(java.lang.String eventName,
                 java.lang.String args1,
                 java.lang.String args2,
                 java.lang.String args3)

performAction

public void performAction(java.lang.String eventName,
                 java.lang.String args1,
                 java.lang.String args2,
                 java.lang.String args3,
                 java.lang.String args4)

performAction

public void performAction(java.lang.String eventName,
                 java.lang.Object[] eventArgs)