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

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

All Implemented Interfaces:

IGraphical

public class SAPGuiCtrlTreeTestObject
extends GuiTestObject

Field Summary

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

ref

Constructor Summary

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

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

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

SAPGuiCtrlTreeTestObject(TestObject obj)
Constructs one TestObject from another.

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

Method Summary

void	changeCheckbox(Subitem nodePath, java.lang.String itemName, boolean check) Emulates changing a checkbox state.
void	clickLink(Subitem nodePath, java.lang.String itemName) Emulates triggering a link.
void	clickLinkByKey(java.lang.String nodeKey, java.lang.String itemName) Emulates triggering a link.
void	collapseNode(Subitem nodePath) Closes the node with the name nodeName.
void	collapseNodeByKey(java.lang.String nodeKey) Closes the node with the key nodeKey.
void	defaultContextMenu() Requests a context menu for the whole Tree Control.
void	doubleClickItem(Subitem nodePath, java.lang.String itemName) Emulates double clicking on a text item.
void	doubleClickItemByKey(java.lang.String nodeKey, java.lang.String itemName) Emulates double clicking on a text item.
void	doubleClickNode(Subitem nodePath) Emulates double clicking a node.
void	doubleClickNodeByKey(java.lang.String nodeKey) Emulates double clicking a node.
TestObject[]	dumpState(java.lang.String innerObject) Dumps the state of the object.
void	ensureVisibleHorizontalItem(Subitem nodePath, java.lang.String itemName) Scrolls the Tree horizontally until the Item is visible.
void	ensureVisibleHorizontalItemByKey(java.lang.String nodeKey, java.lang.String itemName) Scrolls the Tree horizontally until the Item is visible.
void	expandNode(Subitem nodePath) Expands the node with the key nodeKey.
void	expandNodeByKey(java.lang.String nodeKey) Expands the node with the key nodeKey.
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	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	findnodeKeyByPath(java.lang.String path) Find the key of the tree node from path
java.lang.Object	findnodeKeyByPath(Subitem nodePath) Find the key of the tree node from path
int	getCheckBoxState(Subitem nodePath, java.lang.String itemName) Retrieves the CheckBox state (1 = Checked, 0 = Unchecked).
int	getCheckBoxStateByKey(java.lang.String nodeKey, java.lang.String itemName) Retrieves the CheckBox state (1 = Checked, 0 = Unchecked).
java.lang.String[]	getColumnCol(java.lang.String colName) Returns the keys of all the items in the given column.
java.lang.String[]	getColumnHeaders() Returns the collection of the titles of the columns.
java.lang.String	getColumnNameFromTitle(java.lang.String colTitle) Gets the SAP dictionary specific name of the column in the tree given the diplayed title
java.lang.String[]	getColumnNames() Returns a collection of the column names.
java.lang.String	getColumnTitleFromName(java.lang.String colName) Gets the displayed Column Title given the name of the column
java.lang.String[]	getColumnTitles()
java.lang.String	getFocusedNodeKey() Gets the key of the focused tree node.
java.lang.String	getItemText(java.lang.String key, java.lang.String name) Returns the text of the item specified by the key and name parameters.
java.lang.String	getNextNodeKey(Subitem nodePath) Returns the next node key of the tree node.
java.lang.String	getNextNodeKeyByKey(java.lang.String nodeKey) Returns the next node key of the tree node.
int	getNodeChildrenCount(java.lang.String key) Returns the number of children of the node given by the key parameter.
int	getNodeChildrenCountByPath(java.lang.String path) Returns the number of children of the node given by the path parameter.
int	getNodeChildrenCountByPath(Subitem nodePath) Returns the number of children of the node given by the path parameter.
java.lang.String	getNodeKeyByPath(java.lang.String path) Return the key of the node specified by the given path description.
java.lang.String	getNodeKeyByPath(Subitem nodePath) Return the key of the node specified by the given path description.
java.lang.String	getNodePathByKey(java.lang.String key) Given a node key, the path is retrieved (e.g.
java.lang.String[]	getNodesCol() Returns the collection that contains the node keys of all the nodes in the tree.
java.lang.String	getNodeTextByKey(java.lang.String key) This function returns the text of the node specified by the given key.
java.lang.String	getNodeTextByPath(java.lang.String path) Returns the text of a node defined by the given path.
java.lang.Object	getSelectedNodes() Returns the selected nodes.
int	getSelectionMode() Selection mode of the tree controls
java.lang.String[]	getSubNodesCol(java.lang.String key) Returns the collection of the keys of all subnodes of the node specified by the given key.
int	getTreeType() Retruns the type of the tree control.
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.
boolean	IsFolder(Subitem nodePath) Check if the node with the node name is a folder.
boolean	IsFolderExpandable(Subitem nodePath) Check if the folder node is expandable.
boolean	IsFolderExpanded(Subitem nodePath) Check if the folder is expanded.
void	itemContextMenu(Subitem nodePath, java.lang.String itemName) Requests a context menu for an item.
void	itemContextMenuByKey(java.lang.String nodeKey, java.lang.String itemName) Requests a context menu for an item.
void	nodeContextMenu(Subitem nodePath) Requests a context menu for a node.
void	nodeContextMenuByKey(java.lang.String nodeKey) Requests a context menu for a node.
void	pressButton(Subitem nodePath, java.lang.String itemName) Emulates pressing a button.
void	pressButtonByKey(java.lang.String nodeKey, java.lang.String itemName) Emulates pressing a button.
void	pressHeader(java.lang.String headerName) Emulates clicking a header.
void	pressKey(java.lang.String key) Emulates pressing a key.
java.lang.String	selectColumn(java.lang.String columnName) Adds a column to the column selection.
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	selectContextMenuItemByText(java.lang.String text) Select an item in a context menu based on it's text, optionally with text from parent menu items.
java.lang.String	selectedItemColumn() selectedItemColumn
java.lang.String	selectedItemNode() selectedItemNode
void	selectItem(Subitem nodePath, java.lang.String itemName) Emulates the selection of an item.
void	selectItemByKey(java.lang.String nodeKey, java.lang.String itemName) Emulates the selection of an item.
void	selectNode(Subitem nodePath) The node with the name nodeName is added to the Node Selection.
void	selectNodeByKey(java.lang.String nodeKey) The node with the key nodeKey is added to the Node Selection.
java.lang.Object	setCheckBoxState(Subitem nodePath, java.lang.String itemName, int state) Sets the state of the checkbox.
java.lang.Object	setCheckBoxStateByKey(java.lang.String nodeKey, java.lang.String itemName, int state) Sets the state of the checkbox.
java.lang.Object	setColumnWidth(java.lang.String columnName, int Width) Sets the width of a column in pixels.
void	setFocus() Sets the focus.
void	setHierarchyHeaderWidth(int width) Sets the width of the Hierarchy Header in pixels.
void	setSelectedNode(Subitem nodePath) Set the currently selected node to tree node with nodeName.
void	setSelectedNodeByKey(java.lang.String nodeKey) Set the currently selected node to tree node with nodeKey.
void	setTopNode(Subitem nodePath) Sets the top node to the tree node with the name nodeName.
void	setTopNodeByKey(java.lang.String nodeKey) Sets the top node to the tree node with the key nodeKey.
void	unselectAll() Removes all selection.
void	unselectColumn(java.lang.String columnName) Removes a column from the column selection.
void	unselectNode(Subitem nodePath)
void	unselectNodeByKey(java.lang.String nodeKey) Removes the node with the name nodeNmae from the Node selection.
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

SAPGuiCtrlTreeTestObject

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

For internal use.

SAPGuiCtrlTreeTestObject

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

For internal use.

SAPGuiCtrlTreeTestObject

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

For internal use.

SAPGuiCtrlTreeTestObject

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

For internal use.

SAPGuiCtrlTreeTestObject

public SAPGuiCtrlTreeTestObject(TestObject obj)

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

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

doubleClickNodeByKey

public void doubleClickNodeByKey(java.lang.String nodeKey)

Emulates double clicking a node.

Parameters:

nodeKey - key of the tree node

doubleClickNode

public void doubleClickNode(Subitem nodePath)

Emulates double clicking a node.

Parameters:

nodeName - name of the tree node

changeCheckbox

public void changeCheckbox(Subitem nodePath,                            java.lang.String itemName,                            boolean check)

Emulates changing a checkbox state.

Parameters:

nodeName - name of the Node

itemName - itemName

check - true/false

clickLinkByKey

public void clickLinkByKey(java.lang.String nodeKey,                            java.lang.String itemName)

Emulates triggering a link.

Parameters:

nodeKey - key of the TreeNode

itemName - item Name

clickLink

public void clickLink(Subitem nodePath,                       java.lang.String itemName)

Emulates triggering a link.

Parameters:

nodeName - name of the TreeNode

itemName - item Name

collapseNodeByKey

public void collapseNodeByKey(java.lang.String nodeKey)

Closes the node with the key nodeKey.

Parameters:

nodeKey - key of the TreeNode

collapseNode

public void collapseNode(Subitem nodePath)

Closes the node with the name nodeName.

Parameters:

nodeName - name of the TreeNode

defaultContextMenu

public void defaultContextMenu()

Requests a context menu for the whole Tree Control.

doubleClickItemByKey

public void doubleClickItemByKey(java.lang.String nodeKey,                                  java.lang.String itemName)

Emulates double clicking on a text item.

Parameters:

nodeName - key of the tree node

itemName - item name

doubleClickItem

public void doubleClickItem(Subitem nodePath,                             java.lang.String itemName)

Emulates double clicking on a text item.

Parameters:

nodeName - name of the tree node

itemName - item name

ensureVisibleHorizontalItemByKey

public void ensureVisibleHorizontalItemByKey(java.lang.String nodeKey,                                              java.lang.String itemName)

Scrolls the Tree horizontally until the Item is visible.

Parameters:

nodeKey - key of the node tree

itemName - item name

ensureVisibleHorizontalItem

public void ensureVisibleHorizontalItem(Subitem nodePath,                                         java.lang.String itemName)

Scrolls the Tree horizontally until the Item is visible.

Parameters:

nodeName - name of the node tree

itemName - item name

expandNodeByKey

public void expandNodeByKey(java.lang.String nodeKey)

Expands the node with the key nodeKey.

Parameters:

nodeKey - key of the tree node

expandNode

public void expandNode(Subitem nodePath)

Expands the node with the key nodeKey.

Parameters:

nodeName - name of the tree node

findnodeKeyByPath

public java.lang.Object findnodeKeyByPath(java.lang.String path)

Find the key of the tree node from path

Parameters:

path - path of the tree node

Returns:

the key of the tree node

findnodeKeyByPath

public java.lang.Object findnodeKeyByPath(Subitem nodePath)

Find the key of the tree node from path

Parameters:

path - path of the tree node

Returns:

the key of the tree node

getCheckBoxStateByKey

public int getCheckBoxStateByKey(java.lang.String nodeKey,                                  java.lang.String itemName)

Retrieves the CheckBox state (1 = Checked, 0 = Unchecked).

Parameters:

nodeKey - key of the tree node.

itemName - item name.

Returns:

checkbox state(1 = Checked, 0 = Unchecked).

getCheckBoxState

public int getCheckBoxState(Subitem nodePath,                             java.lang.String itemName)

Retrieves the CheckBox state (1 = Checked, 0 = Unchecked).

Parameters:

nodeName - name of the tree node.

itemName - item name.

Returns:

checkbox state(1 = Checked, 0 = Unchecked).

getColumnCol

public java.lang.String[] getColumnCol(java.lang.String colName)

Returns the keys of all the items in the given column.

Parameters:

colName - name of the column

Returns:

getColumnHeaders

public java.lang.String[] getColumnHeaders()

Returns the collection of the titles of the columns.

Returns:

getColumnNames

public java.lang.String[] getColumnNames()

Returns a collection of the column names.

Returns:

getColumnTitles

public java.lang.String[] getColumnTitles()

getColumnTitleFromName

public java.lang.String getColumnTitleFromName(java.lang.String colName)

Gets the displayed Column Title given the name of the column

getColumnNameFromTitle

public java.lang.String getColumnNameFromTitle(java.lang.String colTitle)

Gets the SAP dictionary specific name of the column in the tree given the diplayed title

getFocusedNodeKey

public java.lang.String getFocusedNodeKey()

Gets the key of the focused tree node.

Returns:

the key of the focused tree node.

getItemText

public java.lang.String getItemText(java.lang.String key,                                     java.lang.String name)

Returns the text of the item specified by the key and name parameters.

Parameters:

key -

name -

Returns:

getNextNodeKeyByKey

public java.lang.String getNextNodeKeyByKey(java.lang.String nodeKey)

Returns the next node key of the tree node.

Parameters:

nodeKey -

Returns:

getNextNodeKey

public java.lang.String getNextNodeKey(Subitem nodePath)

Returns the next node key of the tree node.

Parameters:

nodeName -

Returns:

getNodeChildrenCount

public int getNodeChildrenCount(java.lang.String key)

Returns the number of children of the node given by the key parameter.

Parameters:

key - key of the tree node.

Returns:

getNodeChildrenCountByPath

public int getNodeChildrenCountByPath(java.lang.String path)

Returns the number of children of the node given by the path parameter.

Parameters:

path -

Returns:

getNodeChildrenCountByPath

public int getNodeChildrenCountByPath(Subitem nodePath)

Returns the number of children of the node given by the path parameter.

Parameters:

path -

Returns:

getNodeKeyByPath

public java.lang.String getNodeKeyByPath(java.lang.String path)

Return the key of the node specified by the given path description.

Parameters:

path - path of the tree node.

Returns:

getNodeKeyByPath

public java.lang.String getNodeKeyByPath(Subitem nodePath)

Return the key of the node specified by the given path description.

Parameters:

path - path of the tree node.

Returns:

getNodePathByKey

public java.lang.String getNodePathByKey(java.lang.String key)

Given a node key, the path is retrieved (e.g. 2\1\2).

Parameters:

key -

Returns:

getNodesCol

public java.lang.String[] getNodesCol()

Returns the collection that contains the node keys of all the nodes in the tree.

Returns:

getNodeTextByKey

public java.lang.String getNodeTextByKey(java.lang.String key)

This function returns the text of the node specified by the given key.

Parameters:

key -

Returns:

getNodeTextByPath

public java.lang.String getNodeTextByPath(java.lang.String path)

Returns the text of a node defined by the given path.

Parameters:

path - the path of the tree node.

Returns:

getSelectedNodes

public java.lang.Object getSelectedNodes()

Returns the selected nodes.

Returns:

getSelectionMode

public int getSelectionMode()

Selection mode of the tree controls

Returns:

0: Single Node Only one node can be selected. 1: Multiple Node Several nodes may be selected. 2: Single Item Just one item can be selected. 3: Multiple Item Complete nodes can be selected.

getSubNodesCol

public java.lang.String[] getSubNodesCol(java.lang.String key)

Returns the collection of the keys of all subnodes of the node specified by the given key.

Parameters:

key -

Returns:

getTreeType

public int getTreeType()

Retruns the type of the tree control.

Returns:

0 : Simple tree 1 : List tree 2 : Column tree

IsFolder

public boolean IsFolder(Subitem nodePath)

Check if the node with the node name is a folder.

Parameters:

nodeName - name of the tree node.

Returns:

IsFolderExpandable

public boolean IsFolderExpandable(Subitem nodePath)

Check if the folder node is expandable.

Parameters:

nodeName - name of the tree node

Returns:

IsFolderExpanded

public boolean IsFolderExpanded(Subitem nodePath)

Check if the folder is expanded.

Parameters:

nodeName - name of the tree node.

Returns:

itemContextMenuByKey

public void itemContextMenuByKey(java.lang.String nodeKey,                                  java.lang.String itemName)

Requests a context menu for an item.

Parameters:

nodeKey -

itemName -

itemContextMenu

public void itemContextMenu(Subitem nodePath,                             java.lang.String itemName)

Requests a context menu for an item.

Parameters:

nodeName -

itemName -

nodeContextMenuByKey

public void nodeContextMenuByKey(java.lang.String nodeKey)

Requests a context menu for a node.

Parameters:

nodeKey -

nodeContextMenu

public void nodeContextMenu(Subitem nodePath)

Requests a context menu for a node.

Parameters:

nodeName -

pressButtonByKey

public void pressButtonByKey(java.lang.String nodeKey,                              java.lang.String itemName)

Emulates pressing a button.

Parameters:

nodeKey -

itemName -

pressButton

public void pressButton(Subitem nodePath,                         java.lang.String itemName)

Emulates pressing a button.

Parameters:

nodeName -

itemName -

pressHeader

public void pressHeader(java.lang.String headerName)

Emulates clicking a header.

Parameters:

headerName -

pressKey

public void pressKey(java.lang.String key)

Emulates pressing a key.

Parameters:

key - Possible values are: F1, F4, Delete, Insert, Enter, Cut, Copy, and Paste

selectColumn

public java.lang.String selectColumn(java.lang.String columnName)

Adds a column to the column selection. A node or item selection is removed.

Parameters:

columnName -

Returns:

selectedItemColumn

public java.lang.String selectedItemColumn()

selectedItemColumn

Returns:

selectItemByKey

public void selectItemByKey(java.lang.String nodeKey,                             java.lang.String itemName)

Emulates the selection of an item. This selection removes all other selections.

Parameters:

nodeKey - key of the tree node

itemName - item name

selectItem

public void selectItem(Subitem nodePath,                        java.lang.String itemName)

Emulates the selection of an item. This selection removes all other selections.

Parameters:

nodeName - key of the tree node

itemName - item name

selectNodeByKey

public void selectNodeByKey(java.lang.String nodeKey)

The node with the key nodeKey is added to the Node Selection.

Parameters:

nodeKey - key of the tree node

selectNode

public void selectNode(Subitem nodePath)

The node with the name nodeName is added to the Node Selection.

Parameters:

nodeName - name of the tree node

selectedItemNode

public java.lang.String selectedItemNode()

selectedItemNode

Returns:

setSelectedNodeByKey

public void setSelectedNodeByKey(java.lang.String nodeKey)

Set the currently selected node to tree node with nodeKey.

Parameters:

nodeKey - key of the tree node

setSelectedNode

public void setSelectedNode(Subitem nodePath)

Set the currently selected node to tree node with nodeName.

Parameters:

nodeName - name of the tree node

setCheckBoxStateByKey

public java.lang.Object setCheckBoxStateByKey(java.lang.String nodeKey,                                               java.lang.String itemName,                                               int state)

Sets the state of the checkbox.

Parameters:

nodeKey - key of the tree node

itemName - item name

state - state

Returns:

setCheckBoxState

public java.lang.Object setCheckBoxState(Subitem nodePath,                                          java.lang.String itemName,                                          int state)

Sets the state of the checkbox.

Parameters:

nodeName - name of the tree node

itemName - item name

state - state

Returns:

setColumnWidth

public java.lang.Object setColumnWidth(java.lang.String columnName,                                        int Width)

Sets the width of a column in pixels.

Parameters:

columnName -

Width -

Returns:

setHierarchyHeaderWidth

public void setHierarchyHeaderWidth(int width)

Sets the width of the Hierarchy Header in pixels.

Parameters:

width -

setTopNodeByKey

public void setTopNodeByKey(java.lang.String nodeKey)

Sets the top node to the tree node with the key nodeKey.

Parameters:

nodeKey -

setTopNode

public void setTopNode(Subitem nodePath)

Sets the top node to the tree node with the name nodeName.

Parameters:

nodeName -

unselectAll

public void unselectAll()

Removes all selection.

unselectColumn

public void unselectColumn(java.lang.String columnName)

Removes a column from the column selection.

Parameters:

columnName -

unselectNodeByKey

public void unselectNodeByKey(java.lang.String nodeKey)

Removes the node with the name nodeNmae from the Node selection.

Parameters:

nodeKey -

unselectNode

public void unselectNode(Subitem nodePath)

selectContextMenuItem

public void selectContextMenuItem(java.lang.String functionCode)

Select an item from the control's context menu.

Parameters:

functionCode -

selectContextMenuItemByText

public void selectContextMenuItemByText(java.lang.String text)

Select an item in a context menu based on it's text, optionally with text from parent menu items.

Parameters:

text -

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

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:

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: