com.rational.test.ft.object.interfaces.SAP
Class SAPGuiUserAreaTestObject

java.lang.Object   com.rational.test.ft.object.interfaces.TestObject
      com.rational.test.ft.object.interfaces.ClientTestObject
          com.rational.test.ft.object.interfaces.GuiTestObject
              com.rational.test.ft.object.interfaces.SAP.SAPGuiUserAreaTestObject

All Implemented Interfaces:

IGraphical

public class SAPGuiUserAreaTestObject
extends GuiTestObject

Field Summary

Fields inherited from class com.rational.test.ft.object.interfaces.TestObject

ref

Constructor Summary

SAPGuiUserAreaTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
For internal use.

SAPGuiUserAreaTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
For internal use.

SAPGuiUserAreaTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
For internal use.

SAPGuiUserAreaTestObject(TestObject obj)
Constructs one TestObject from another.

SAPGuiUserAreaTestObject(com.rational.test.ft.object.TestObjectReference ref)
For internal use.

Method Summary

TestObject[]	dumpState(java.lang.String innerObject) Dumps the state of the object.
TestObject[]	findAllByName(java.lang.String name, java.lang.String type) The methods findByName and findByNameEx return only the first object with matching name and type.
TestObject[]	findAllByNameEx(java.lang.String name, long type) Better performance than FindAllByName
TestObject	findById(java.lang.String id, boolean raiseEx) Search through the object's descendants for a given id.
TestObject	findByLabel(java.lang.String text, java.lang.String type) Find an object based on it's text label.
TestObject	findByName(java.lang.String name, java.lang.String type) Unlike findById, this function does not guarantee a unique result.
TestObject	findByNameEx(java.lang.String name, long type) Better performance than FindByName
java.lang.Object	invoke(java.lang.String method) Invokes a method with no args on the object in the software under test.
java.lang.Object	invoke(java.lang.String method, java.lang.String methodSignature, java.lang.Object[] args) Invokes a method on the object in the software under test. Note that this can directly modify the object in the software under test.
void	selectContextMenuByPosition(java.lang.String positionDesc) Select a context menu item using the position of the item.
void	selectContextMenuItem(java.lang.String functionCode) Select an item from the control's context menu.
void	setFocus() Sets the focus.
void	setHorizontalScrollBar(Position pos) Scroll the horizontal scroll bar to the given position.
void	setVerticalScrollBar(Position pos) Scroll the vertical scroll bar to the given position
boolean	visualize(boolean on, java.lang.String innerObject) Calling this method of a component will display a red frame around the specified component if the parameter on is true.

Methods inherited from class com.rational.test.ft.object.interfaces.GuiTestObject

canTakeVP, click, click, click, click, clickRadio, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, ensureObjectIsVisible, getChildAtPoint, getClippedScreenRectangle, getImage, getImage, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, getVisibleArea, hasFocus, hover, hover, hover, hover, invokeProxyWithGuiDelay, invokeProxyWithGuiDelay, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint

Methods inherited from class com.rational.test.ft.object.interfaces.ClientTestObject

exists, find, find, findAndInvoke, findAndInvokeProxy, invokeProxy, unregister, waitForExistence

Methods inherited from class com.rational.test.ft.object.interfaces.TestObject

compare, compare, compareAndLog, compareAndLog, equals, find, findAndInvoke, getActualData, getChildren, getDescribedObject, getDescribedObjects, getDescriptiveName, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMapProperties, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectCustomClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getProperty, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTestDataTypes, getTopMappableParent, getTopParent, hashCode, invokeProxy, isMappedObject, isSameObject, isScreenTestObject, isTopLevelTestObject, performTest, performTest, performTest, performTest, setIndexer, setIndexer, setMapProperties, setProperty, toString, updateTestData, waitForExistence

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SAPGuiUserAreaTestObject

public SAPGuiUserAreaTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)

For internal use.

Since:

RFT1.0

SAPGuiUserAreaTestObject

public SAPGuiUserAreaTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,                                 TestObject anchor)

For internal use.

Since:

RFT1.0

SAPGuiUserAreaTestObject

public SAPGuiUserAreaTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,                                 TestObject anchor,                                 long scriptCommandFlags)

For internal use.

Since:

RFT1.0

SAPGuiUserAreaTestObject

public SAPGuiUserAreaTestObject(com.rational.test.ft.object.TestObjectReference ref)

For internal use.

Since:

RFT1.0

SAPGuiUserAreaTestObject

public SAPGuiUserAreaTestObject(TestObject obj)

Constructs one TestObject from another. Both are references to the same Object.

Since:

RFT1.0

Method Detail

invoke

public java.lang.Object invoke(java.lang.String method)

Invokes a method with no args on the object in the software under test. Note that this can directly modify the object in the software under test and therefore should be done with extreme care. Whenever possible, you should avoid using invoke, which allows you to modify the software under test in ways that a typical user cannot. If you use this method, you should be sure to discuss its use with the developers of the software you are testing.

If the returned object is not a value class, invoke registers the object and returns a reference to the object in the software under test. As always, registered object references should be released by calling one of the unregister methods.

Overrides:

invoke in class TestObject

Parameters:

method - The name of the method to be called

Returns:

See Also:

invoke(String,String,Object[]), TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

invoke

public java.lang.Object invoke(java.lang.String method,                                java.lang.String methodSignature,                                java.lang.Object[] args)

Invokes a method on the object in the software under test.

Note that this can directly modify the object in the software under test. You should therefore be extremely careful when you do this. Whenever possible, avoid using Invoke, which allows you to modify the software under test in ways that a typical user cannot. If you use this method, be sure to discuss its use with the developers of the software you are testing.

If the returned object is not a value class, invoke registers the object and returns a reference to the object in the software under test. Registered object references are released by calling one of the unregister methods.

The methodSignature uses JNI syntax to describe the parameter types and optionally the return value types for the method. The general syntax has the parameter types in parentheses, followed by the return type: (parameterTypes)returnType. Note that the returnType is not a required part of the signature - it can be omitted. There are specific encodings for the primitive types, and then a general encoding for class types.

Code	Type
Z	boolean
B	byte
C	char
S	short
I	int
J	long
F	float
D	double
V	void
Lfully-qualified-class;	For example: Ljava.lang.string;

In addition, arrays are specified by combining the brace character '[' with another type. For example, [I is an array of integers, [[I is an array of arrays of integers and [Ljava.lang.Object; is an array of Objects. Another example:

void myMethod(long n, string s, int[] arr)

has the following signature:

(JLjava.lang.string;[I)V

Overrides:

invoke in class ClientTestObject

Parameters:

method - the name of the method to be called

methodSignature - the signature of the method to be called (using standard JNI syntax)

args - the arguments to be passed to the method

Returns:

See Also:

TestObject.unregister(), RationalTestScript.unregister(Object[]), RationalTestScript.unregisterAll(), RationalTestScript.getRegisteredTestObjects()

selectContextMenuItem

public void selectContextMenuItem(java.lang.String functionCode)

Select an item from the control's context menu.

Parameters:

functionCode -

selectContextMenuByPosition

public void selectContextMenuByPosition(java.lang.String positionDesc)

Select a context menu item using the position of the item. It is therefore independent of the menu item text.

Parameters:

positionDesc - The parameter is a string containing the path to the item. If the context menu item is on the top level menu, this is just the zero-base index of the item. Otherwise, the positions on the menu and respective submenus should be concatenated, separated by "|".

findByName

public TestObject findByName(java.lang.String name,                              java.lang.String type)

Unlike findById, this function does not guarantee a unique result. It will simply return the first descendant matching both the name and type parameters.This is a more natural description of the object than the complex id, but it only makes sense on dynpro objects as most other objects do not have a meaningfulname.

Parameters:

name -

type -

Returns:

findById

public TestObject findById(java.lang.String id,                            boolean raiseEx)

Search through the object's descendants for a given id. If the parameter is a fully qualified id, the function will first check if thecontainer object's id is a prefix of the id parameter. If that is the case, this prefix is truncated. If no descendant with the given id can be found the function raises an exception unless the optional parameter raise is set to False.

Parameters:

id -

raiseEx -

Returns:

findByNameEx

public TestObject findByNameEx(java.lang.String name,                                long type)

Better performance than FindByName

Parameters:

name -

type -

Returns:

findAllByName

public TestObject[] findAllByName(java.lang.String name,                                   java.lang.String type)

The methods findByName and findByNameEx return only the first object with matching name and type. There may be more than one result returned.

Parameters:

name -

type -

Returns:

findAllByNameEx

public TestObject[] findAllByNameEx(java.lang.String name,                                     long type)

Better performance than FindAllByName

Parameters:

name -

type -

Returns:

findByLabel

public TestObject findByLabel(java.lang.String text,                               java.lang.String type)

Find an object based on it's text label.

Parameters:

text -

type -

Returns:

setVerticalScrollBar

public void setVerticalScrollBar(Position pos)

Scroll the vertical scroll bar to the given position

Parameters:

pos -

setHorizontalScrollBar

public void setHorizontalScrollBar(Position pos)

Scroll the horizontal scroll bar to the given position.

Parameters:

pos -

setFocus

public void setFocus()

Sets the focus.

dumpState

public TestObject[] dumpState(java.lang.String innerObject)

Dumps the state of the object. Refer to the SAP GUI Scripting Programming API for more information.

Parameters:

innerObject - Used to specify what internal object should be dumped (on supported controls)

Returns:

visualize

public boolean visualize(boolean on,                          java.lang.String innerObject)

Calling this method of a component will display a red frame around the specified component if the parameter on is true. The frame will be removed if on is false. Some components such as GuiCtrlGridView support displaying the frame around inner objects, such as cells. The format of the innerObject string is the same as for the dumpState method.

Parameters:

on - bool indicating whether or not the highlight rectangle should be on

innerObject -

Returns: