Package com.hp.lft.sdk.sap.gui

Interface ToolBar

All Superinterfaces:

Element, EnabledProvider, LocationInfoProvider, SupportsNativeObject, TestObject, TestObjectDescriber, WaitUntilEnabledProvider

public interface ToolBar
extends Element, WaitUntilEnabledProvider

A toolbar control in a SAP GUI for Windows application,

Method Summary

Modifier and Type	Method	Description
String	buildMenuPath(Object... menuPathParts)	Returns the path of the specified menu item.
void	pressButton(String buttonId)	Presses the specified toolbar button.
void	pressContextButton(String buttonId)	Presses the specified toolbar button to open the button's context menu.
void	selectMenuItem(int index)	Selects the specified menu item from the toolbar button context menu.
void	selectMenuItem(String path)	Selects the specified menu item from the toolbar button context menu.
void	selectMenuItemById(String id)	Selects the specified menu item from the toolbar button context menu by SAP ID.

Methods inherited from interface com.hp.lft.sdk.sap.gui.Element

getId, getName, getType

Methods inherited from interface com.hp.lft.sdk.EnabledProvider

isEnabled

Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider

getAbsoluteLocation, getLocation, getSize

Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject

getNativeObject

Methods inherited from interface com.hp.lft.sdk.TestObject

callFTMethod, callFTMethod, exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists

Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

describe

Methods inherited from interface com.hp.lft.sdk.WaitUntilEnabledProvider

waitUntilEnabled, waitUntilEnabled

Method Details

buildMenuPath

String buildMenuPath(Object... menuPathParts)
              throws GeneralLeanFtException

Returns the path of the specified menu item.

Parameters:

menuPathParts - the menu path parts can be: logical name(String), full path(String), or 1-based index(Integer).

Returns:

the path of the specified menu item.

Throws:

GeneralLeanFtException - if error occurs during execution

pressButton

void pressButton(String buttonId)
          throws GeneralLeanFtException

Presses the specified toolbar button.

Parameters:

buttonId - the button's ID in text format.

Throws:

GeneralLeanFtException - if error occurs during execution

pressContextButton

void pressContextButton(String buttonId)
                 throws GeneralLeanFtException

Presses the specified toolbar button to open the button's context menu.

Parameters:

buttonId - the button's ID in text format.

Throws:

GeneralLeanFtException - if error occurs during execution

selectMenuItem

void selectMenuItem(String path)
             throws GeneralLeanFtException

Selects the specified menu item from the toolbar button context menu. You can use buildMenuPath(Object...) to build the item path string to be used as the itemPath argument for this method.

Parameters:

path - the menu item name

Throws:

GeneralLeanFtException - if error occurs during execution

selectMenuItem

void selectMenuItem(int index)
             throws GeneralLeanFtException

Selects the specified menu item from the toolbar button context menu.

Parameters:

index - 1-based.

Throws:

GeneralLeanFtException - if error occurs during execution

selectMenuItemById

void selectMenuItemById(String id)
                 throws GeneralLeanFtException

Selects the specified menu item from the toolbar button context menu by SAP ID.

Parameters:

id - the SAP ID of the context menu item.

Throws:

GeneralLeanFtException - if error occurs during execution