JavaScriptFunctions.SAP (SAFS API DOCUMENT)

java.lang.Object
- org.safs.selenium.util.JavaScriptFunctions.SAP

Enclosing class:: JavaScriptFunctions

public static final class JavaScriptFunctions.SAP
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

SAP()

Constructors
Constructor and Description
`SAP()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getSAPClassNameById(boolean includeDependency)` According to the id, find the SAP Object and return its class name depending on: `sap_getObjectById()` depending level: 1 depended by: nothing.
`(package private) static java.lang.String`	`getSAPClassNames()` Recurrsiv function to get class name from metadata of an UI element. The second parameter 'buffer' will contain all the class names. depending on: existing DOM and SAP APIs only. depending level: 0
`static java.lang.String`	`getSAPClassNamesById(boolean includeDependency)` According to the id, find the SAP Object and return its class name and super class names. depending on: `sap_getObjectById()` `getSAPClassNames()` depending level: 1 depended by: nothing.
`(package private) static java.lang.String`	`parse_sap_m_ListItemBase()` Convert a sap.m.ListItemBase object to a standard Item object with known properties like id, disabled, label, value, selected and index depending on: nothing depending level: 0
`(package private) static java.lang.String`	`parse_sap_ui_commons_Tab()` Convert the sap.ui.commons.Tab object to a uniformed Tab object, which contains properties like id, selected, label, disabled and index depending on: nothing depending level: 0
`(package private) static java.lang.String`	`parse_sap_ui_commons_TreeNode()` Convert a sap.ui.commons.TreeNode object to a standard TreeNode object with known properties like id, disabled, label, expanded, selected depending on: nothing depending level: 0
`(package private) static java.lang.String`	`parse_sap_ui_core_Item(boolean includeDependency)` Convert a sap.ui.core.Item object to a standard Item object with known properties like id, disabled, label, value, selected and index depending on: `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_ComboBox_getItems(boolean includeDependency)` Get a set of combo box options. supported sap classes: `ComboBox.SapSelect_ComboBox.supportedClazzes` depending on: `sap_getObject()` `#parse_sap_ui_core_Item()` `JavaScriptFunctions.objectIsInstanceof()` `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_ComboBox_setSelectedKey(boolean includeDependency)` Select a combo box option indicated by key. supported sap classes: `ComboBox.SapSelect_ComboBox.supportedClazzes` depending on: `sap_getObject()` `JavaScriptFunctions.objectIsInstanceof()` depending level: 1
`static java.lang.String`	`sap_getAccessibilityControllerElements(boolean includeDependency)` According to a dom object, find SAP Accessibility Objects associated with the AccessibilityController, if any.. depending on: existing DOM and SAP APIs only. depending level: 0
`static java.lang.String`	`sap_getAccessibilityControllerElementsInfo(boolean includeDependency)` According to a dom object, find SAP Accessibility Objects associated with the AccessibilityController, if any, and return the critical info fields of these. depending on: `#sap_getAccessibilityControllerElements()` depending level: 1
`static java.lang.String`	`sap_getDOMRef()` According to a sap object, find the related DOM Object and return it. depending on: existing DOM and SAP APIs only. depending level: 0
`static java.lang.String`	`sap_getObject()` According to a dom object, find the related SAP Object and return it. depending on: existing DOM and SAP APIs only. depending level: 0
`static java.lang.String`	`sap_getObjectById()` According to the id, find the SAP Object and return it. depending on: existing DOM and SAP APIs only. depending level: 0
`static java.lang.String`	`sap_getProperty(boolean includeDependency, java.lang.String propertyName)` Get the value of a property for the sap object and return it. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_m_List_getItems(boolean includeDependency)` Get a set of list box options for sap_m_List. If some exception happens, this function will set the global errorcode and errormessage, in the java code, user can detect the global errorcode and errormessage to do some necessary work. depending on: `sap_getObject()` `parse_sap_m_ListItemBase()` `JavaScriptFunctions.throw_error()` `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_m_List_getSelectedItems(boolean includeDependency)` Get selected items for a List. depending on: `sap_getObject()` `parse_sap_m_ListItemBase()` `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_m_List_setSelectedItemById(boolean includeDependency)` Set selected item by id for a listbox and fire the 'SelectionChange' event. depending on: `sap_getObject()` `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_m_SelectList_getItems(boolean includeDependency)` Get a set of list box options for sap_m_SelectList. If some exception happens, this function will set the global errorcode and errormessage, in the java code, user can detect the global errorcode and errormessage to do some necessary work. depending on: `sap_getObject()` `#parse_sap_ui_core_Item()` `JavaScriptFunctions.throw_error()` `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_m_SelectList_getSelectedItems(boolean includeDependency)` Get selected items for a SelectList. depending on: `sap_getObject()` `#parse_sap_ui.core.Item()` `JavaScriptFunctions.isType()` depending level: 1
`static java.lang.String`	`sap_m_SelectList_setSelectedItemById(boolean includeDependency)` Set selected item by id for a SelectList and fire the 'SelectionChange' event. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_objectIsInstanceof(boolean includeDependency)` Test if object is an instance of certain classes. depending on: `JavaScriptFunctions.objectIsInstanceof()` `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_commons_CheckBox_getChecked(boolean includeDependency)` Get the value of property 'checked'. depending on: `sap_getObject()` `JavaScriptFunctions.objectIsInstanceof()` depending level: 1
`static java.lang.String`	`sap_ui_commons_CheckBox_setChecked(boolean includeDependency)` Set the value of property 'checked'. depending on: `sap_getObject()` `JavaScriptFunctions.objectIsInstanceof()` depending level: 1
`static java.lang.String`	`sap_ui_commons_ListBox_getItems(boolean includeDependency)` Get a set of list box options for sap_ui_commons_ListBox depending on: `JavaScriptFunctions.throw_error()` `JavaScriptFunctions.isType()` `sap_getObject()` `#parse_sap_ui_core_Item()` depending level: 1
`static java.lang.String`	`sap_ui_commons_ListBox_getSelectedIndices(boolean includeDependency)` Get selected indices for a ListBox, the index is 0-based. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_commons_ListBox_scrollToIndex(boolean includeDependency)` Scroll to the item indicated by index in the list box. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_commons_ListBox_setSelectedIndex(boolean includeDependency)` Set selected index for a listbox and fire the 'select' event. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_commons_Menu_getItems(boolean includeDependency)` Get a hierarchical structure representing a Menu. depending on: `sap_getObject()` `sap_ui_commons_Menu_getItems_Rec(boolean)` depending level: 2
`static java.lang.String`	`sap_ui_commons_TabStrip_getTabs(boolean includeDependency)` Get selected index for a tabcontrol. depending on: `sap_getObject()` `#sap_initializeTabObject()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TabStrip_setSelectedIndex(boolean includeDependency)` Set selected index for a tabcontrol and fire the 'select' event. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_commons_Tree_collapseAll(boolean includeDependency)` Collapse all tree nodes. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_Tree_expandAll(boolean includeDependency)` Expand all tree nodes. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_Tree_getNodes_Rec(boolean includeDependency)` Generate a tree hierarchy structure from a sap tree object.
`static java.lang.String`	`sap_ui_commons_Tree_getNodes(boolean includeDependency)` Get all nodes content of a tree, the result is a tree hierarchy structure. each tree node will contain 2 properties, children and parent.
`static java.lang.String`	`sap_ui_commons_TreeNode_collapse(boolean includeDependency)` Collapse a certain tree node. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_expand(boolean includeDependency)` Expand a certain tree node. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_getExpanded(boolean includeDependency)` Get a tree node's property 'expanded'. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_getIsSelected(boolean includeDependency)` Get a tree node's property 'isSelected'. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_getSelectable(boolean includeDependency)` Get a tree node's property 'selectable'. depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_refresh(boolean includeDependency)` Get a sap.ui.commons.TreeNode object and covert it to a org.safs.selenium.webdriver.lib.model.TreeNode object. depending on: `sap_getObjectById()` `parse_sap_ui_commons_TreeNode()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_select(boolean includeDependency)` Select a certain tree node, show it on the page and fire the related 'Select' event. NOTE: Remember to call sap_ui_commons_Tree_expandAll() firstly!!! depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_TreeNode_showOnPage(boolean includeDependency)` Show a tree node on the page. NOTE: Remember to call sap_ui_commons_Tree_expandAll() firstly!!! depending on: `sap_getObjectById()` depending level: 1
`static java.lang.String`	`sap_ui_commons_xxx_getSelectedIndex(boolean includeDependency)` Get selected index for a ListBox or a TabStrip, the index is 0-based. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_core_Control_attachBrowserEvent(boolean includeDependency, java.lang.String variable)` Attach a generic event callback to a javasript event for an object. depending on: `sap_getObject()` `JavaScriptFunctions.defineGenericEventCallBack(String)` depending level: 1
`static java.lang.String`	`sap_ui_core_Control_detachBrowserEvent(boolean includeDependency, java.lang.String variable)` Detach a generic event callback to a javasript event from an object. depending on: `sap_getObject()` `JavaScriptFunctions.removeGlobalVariable(String)` depending level: 1
`static java.lang.String`	`sap_ui_core_ScrollBar_page(boolean includeDependency)` Pageup/PageDown the scrollbar according to the pages. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sap_ui_core_ScrollBar_scroll(boolean includeDependency)` Scroll the scrollbar according to the steps. depending on: `sap_getObject()` depending level: 1
`static java.lang.String`	`sas_hc_ui_commons_pushmenu_PushMenu_getItems(boolean includeDependency)` Get a hierarchical structure representing a Menu. depending on: `sap_getObject()` `sas_hc_ui_commons_pushmenu_PushMenu_getItems_Rec(boolean)` depending level: 2
`static java.lang.String`	`sas_hc_ui_commons_pushmenu_PushMenu_goHome(boolean includeDependency)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SAP
```
public SAP()
```
- Method Detail
  - sap_getProperty
```
public static java.lang.String sap_getProperty(boolean includeDependency,
                                               java.lang.String propertyName)
```
    Get the value of a property for the sap object and return it.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    propertyName - (Java) String, the property name.
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    property - (Javascript) String, the property name.
  - sap_getDOMRef
```
public static java.lang.String sap_getDOMRef()
```
    According to a sap object, find the related DOM Object and return it.
    
    depending on: existing DOM and SAP APIs only.
    
    depending level: 0
    
    Parameters:
    
    sapElement - (Javascript) Object, the SAP object.
  - sap_getObject
```
public static java.lang.String sap_getObject()
```
    According to a dom object, find the related SAP Object and return it.
    
    depending on: existing DOM and SAP APIs only.
    
    depending level: 0
    
    Parameters:
    
    domElement - (Javascript) Object (WebElement), the dom object of the SAP object.
  - sap_getAccessibilityControllerElements
```
public static java.lang.String sap_getAccessibilityControllerElements(boolean includeDependency)
```
    According to a dom object, find SAP Accessibility Objects associated with the AccessibilityController, if any..
    
    depending on: existing DOM and SAP APIs only.
    
    depending level: 0
    
    Parameters:
    
    domElement - (Javascript) Object (WebElement), the dom object of the SAP object.
  - sap_getAccessibilityControllerElementsInfo
```
public static java.lang.String sap_getAccessibilityControllerElementsInfo(boolean includeDependency)
```
    According to a dom object, find SAP Accessibility Objects associated with the AccessibilityController, if any, and return the critical info fields of these.
    
    depending on:
    #sap_getAccessibilityControllerElements()
    
    depending level: 1
    
    Parameters:
    
    domElement - (Javascript) Object (WebElement), the dom object of the SAP object.
    
    includeDependency - true if we need to also prepend the getAccessibilityControllerElements JS code.
    
    Returns:
    
    accessibilities (Javascript) Array, an array of accessibility object containing 'accessibilityFrame', 'accessibilityHint', 'accessibilityLabel', 'terseAccessibilityLabel', 'isSelected' etc.
    
    See Also:
    
    #sap_getAccessibilityControllerElements()
  - sap_getObjectById
```
public static java.lang.String sap_getObjectById()
```
    According to the id, find the SAP Object and return it.
    
    depending on: existing DOM and SAP APIs only.
    
    depending level: 0
    
    Parameters:
    
    id - (Javascript) String, the html id of the SAP object.
  - getSAPClassNames
```
static java.lang.String getSAPClassNames()
```
    Recurrsiv function to get class name from metadata of an UI element.
    The second parameter 'buffer' will contain all the class names.
    
    depending on: existing DOM and SAP APIs only.
    
    depending level: 0
    
    Parameters:
    
    buffer - (Javascript) Array, a javascript array to contain class names.
    
    metadata - (Javascript) sap.ui.base.Metadata, the runtime metadata for an UI element.
  - sap_objectIsInstanceof
```
public static java.lang.String sap_objectIsInstanceof(boolean includeDependency)
```
    Test if object is an instance of certain classes.
    
    depending on:
    JavaScriptFunctions.objectIsInstanceof()
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, dom-element used to find a javascript object.
    
    clazzes - (Javascript) Array, the classes to compare with.
  - getSAPClassNamesById
```
public static java.lang.String getSAPClassNamesById(boolean includeDependency)
```
    According to the id, find the SAP Object and return its class name and super class names.
    
    depending on:
    sap_getObjectById()
    getSAPClassNames()
    
    depending level: 1
    
    depended by:
    nothing.
    
    Parameters:
    
    includeDependency - boolean, if true the output string will contain the depending javascript functions.
    
    id - (Javascript) String, the html id of the SAP object.
    
    classNames - (Javascript) Array (out) , a javascript array to contain class names.
  - getSAPClassNameById
```
public static java.lang.String getSAPClassNameById(boolean includeDependency)
```
    According to the id, find the SAP Object and return its class name
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    depended by:
    nothing.
    
    Parameters:
    
    includeDependency - boolean, if true the output string will contain the depending javascript functions.
    
    id - (Javascript) String, the html id of the SAP object.
  - sap_ComboBox_setSelectedKey
```
public static java.lang.String sap_ComboBox_setSelectedKey(boolean includeDependency)
```
    Select a combo box option indicated by key.
    supported sap classes: ComboBox.SapSelect_ComboBox.supportedClazzes
    
    depending on:
    sap_getObject()
    JavaScriptFunctions.objectIsInstanceof()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, Dom Object is used to find a SAP object.
    
    key - (Javascript) String, the option's key to set.
    
    Since:
    
    FEB 13, 2014 (Lei Wang) Call SAP combobox API fireChange() to invoke the associated callbacks.
  - sap_ComboBox_getItems
```
public static java.lang.String sap_ComboBox_getItems(boolean includeDependency)
```
    Get a set of combo box options.
    supported sap classes: ComboBox.SapSelect_ComboBox.supportedClazzes
    
    depending on:
    sap_getObject()
    #parse_sap_ui_core_Item()
    JavaScriptFunctions.objectIsInstanceof()
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, Dom Object is used to find a SAP object.
  - sap_ui_commons_xxx_getSelectedIndex
```
public static java.lang.String sap_ui_commons_xxx_getSelectedIndex(boolean includeDependency)
```
    Get selected index for a ListBox or a TabStrip, the index is 0-based.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    Returns:
    
    index (Javascript) int, the selected tab's index, 0-based.
  - sap_ui_commons_ListBox_getSelectedIndices
```
public static java.lang.String sap_ui_commons_ListBox_getSelectedIndices(boolean includeDependency)
```
    Get selected indices for a ListBox, the index is 0-based.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    Returns:
    
    index (Javascript) int[], the selected tab's indices, 0-based.
  - sap_ui_commons_ListBox_setSelectedIndex
```
public static java.lang.String sap_ui_commons_ListBox_setSelectedIndex(boolean includeDependency)
```
    Set selected index for a listbox and fire the 'select' event.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    index - (Javascript) int, the index to select, 0-based.
  - sap_ui_commons_ListBox_scrollToIndex
```
public static java.lang.String sap_ui_commons_ListBox_scrollToIndex(boolean includeDependency)
```
    Scroll to the item indicated by index in the list box.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    index - (Javascript) int, the index to scroll to, 0-based.
  - sap_m_List_getItems
```
public static java.lang.String sap_m_List_getItems(boolean includeDependency)
```
    Get a set of list box options for sap_m_List.
    If some exception happens, this function will set the global errorcode and errormessage,
    in the java code, user can detect the global errorcode and errormessage to do some necessary work.
    
    depending on:
    sap_getObject()
    parse_sap_m_ListItemBase()
    JavaScriptFunctions.throw_error()
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, List Dom Object is used to find a SAP object.
  - sap_m_SelectList_getItems
```
public static java.lang.String sap_m_SelectList_getItems(boolean includeDependency)
```
    Get a set of list box options for sap_m_SelectList.
    If some exception happens, this function will set the global errorcode and errormessage,
    in the java code, user can detect the global errorcode and errormessage to do some necessary work.
    
    depending on:
    sap_getObject()
    #parse_sap_ui_core_Item()
    JavaScriptFunctions.throw_error()
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, List Dom Object is used to find a SAP object.
  - sap_m_SelectList_getSelectedItems
```
public static java.lang.String sap_m_SelectList_getSelectedItems(boolean includeDependency)
```
    Get selected items for a SelectList.
    
    depending on:
    sap_getObject()
    #parse_sap_ui.core.Item()
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    Returns:
    
    items (Javascript) Items[], the selected items.
  - sap_m_SelectList_setSelectedItemById
```
public static java.lang.String sap_m_SelectList_setSelectedItemById(boolean includeDependency)
```
    Set selected item by id for a SelectList and fire the 'SelectionChange' event.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    id - (Javascript) String, the id of the item to be selected.
  - sap_m_List_getSelectedItems
```
public static java.lang.String sap_m_List_getSelectedItems(boolean includeDependency)
```
    Get selected items for a List.
    
    depending on:
    sap_getObject()
    parse_sap_m_ListItemBase()
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    Returns:
    
    items (Javascript) Items[], the selected items.
  - sap_m_List_setSelectedItemById
```
public static java.lang.String sap_m_List_setSelectedItemById(boolean includeDependency)
```
    Set selected item by id for a listbox and fire the 'SelectionChange' event.
    
    depending on:
    sap_getObject()
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    id - (Javascript) String, the id of the item to be selected.
  - sap_ui_commons_ListBox_getItems
```
public static java.lang.String sap_ui_commons_ListBox_getItems(boolean includeDependency)
```
    Get a set of list box options for sap_ui_commons_ListBox
    
    depending on:
    JavaScriptFunctions.throw_error()
    JavaScriptFunctions.isType() sap_getObject()
    #parse_sap_ui_core_Item()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, List Dom Object is used to find a SAP object.
  - sap_ui_commons_Menu_getItems
```
public static java.lang.String sap_ui_commons_Menu_getItems(boolean includeDependency)
```
    Get a hierarchical structure representing a Menu.
    
    depending on:
    sap_getObject()
    sap_ui_commons_Menu_getItems_Rec(boolean)
    
    depending level: 2
    
    Parameters:
    
    domelement - (Javascript) Object, MenuBar Dom Object is used to find a SAP object.
  - sas_hc_ui_commons_pushmenu_PushMenu_goHome
```
public static java.lang.String sas_hc_ui_commons_pushmenu_PushMenu_goHome(boolean includeDependency)
```
  - sas_hc_ui_commons_pushmenu_PushMenu_getItems
```
public static java.lang.String sas_hc_ui_commons_pushmenu_PushMenu_getItems(boolean includeDependency)
```
    Get a hierarchical structure representing a Menu.
    
    depending on:
    sap_getObject()
    sas_hc_ui_commons_pushmenu_PushMenu_getItems_Rec(boolean)
    
    depending level: 2
    
    Parameters:
    
    domelement - (Javascript) Object, PushMenu DOM Object is used to find a SAP object.
  - sap_ui_commons_Tree_getNodes
```
public static java.lang.String sap_ui_commons_Tree_getNodes(boolean includeDependency)
```
    Get all nodes content of a tree, the result is a tree hierarchy structure.
    each tree node will contain 2 properties, children and parent. children is an
    array, each child is a tree node; parent is the parent tree node.
    
    depending on:
    sap_getObject()
    sap_ui_commons_Tree_getNodes_Rec(boolean)
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, Tree Dom Object is used to find a SAP object.
  - sap_ui_commons_Tree_getNodes_Rec
```
public static java.lang.String sap_ui_commons_Tree_getNodes_Rec(boolean includeDependency)
```
    Generate a tree hierarchy structure from a sap tree object. A sap tree object is already
    a tree-hierarchy structure, but it contains too many information, and it is super-time-consuming
    when return it to Java side by Selenium. So we will create a light-tree-structure to contain
    only the necessary information thru this function.
    
    depending on:
    #parse_sap_ui_commons_TreeNode(boolean)
    JavaScriptFunctions.isType()
    
    depending level: 1
    
    Parameters:
    
    nodeObject - (Javascript) Object, SAP Tree/TreeNode Object.
    
    node - (Javascript) Object, has structure of org.safs.selenium.webdriver.lib.model.TreeNode and represents the first parameter nodeObject, it will contain all children of nodeObject.
  - sap_ui_commons_Tree_collapseAll
```
public static java.lang.String sap_ui_commons_Tree_collapseAll(boolean includeDependency)
```
    Collapse all tree nodes.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeId - (Javascript) String, SAP Tree's ID.
  - sap_ui_commons_Tree_expandAll
```
public static java.lang.String sap_ui_commons_Tree_expandAll(boolean includeDependency)
```
    Expand all tree nodes.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeId - (Javascript) String, SAP Tree's ID.
  - sap_ui_commons_TreeNode_collapse
```
public static java.lang.String sap_ui_commons_TreeNode_collapse(boolean includeDependency)
```
    Collapse a certain tree node.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
    
    bCollapseChildren - (Javascript) Boolean, if collapse the children of this node.
  - sap_ui_commons_TreeNode_expand
```
public static java.lang.String sap_ui_commons_TreeNode_expand(boolean includeDependency)
```
    Expand a certain tree node.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
    
    bExpandChildren - (Javascript) Boolean, if expand the children of this node.
  - sap_ui_commons_TreeNode_select
```
public static java.lang.String sap_ui_commons_TreeNode_select(boolean includeDependency)
```
    Select a certain tree node, show it on the page and fire the related 'Select' event.
    NOTE: Remember to call sap_ui_commons_Tree_expandAll() firstly!!!
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeId - (Javascript) String, SAP Tree's ID.
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
  - sap_ui_commons_TreeNode_showOnPage
```
public static java.lang.String sap_ui_commons_TreeNode_showOnPage(boolean includeDependency)
```
    Show a tree node on the page.
    NOTE: Remember to call sap_ui_commons_Tree_expandAll() firstly!!!
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
  - sap_ui_commons_TreeNode_getIsSelected
```
public static java.lang.String sap_ui_commons_TreeNode_getIsSelected(boolean includeDependency)
```
    Get a tree node's property 'isSelected'.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
  - sap_ui_commons_TreeNode_getExpanded
```
public static java.lang.String sap_ui_commons_TreeNode_getExpanded(boolean includeDependency)
```
    Get a tree node's property 'expanded'.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
  - sap_ui_commons_TreeNode_getSelectable
```
public static java.lang.String sap_ui_commons_TreeNode_getSelectable(boolean includeDependency)
```
    Get a tree node's property 'selectable'.
    
    depending on:
    sap_getObjectById()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
  - sap_ui_commons_TreeNode_refresh
```
public static java.lang.String sap_ui_commons_TreeNode_refresh(boolean includeDependency)
```
    Get a sap.ui.commons.TreeNode object and covert it to a org.safs.selenium.webdriver.lib.model.TreeNode object.
    
    depending on:
    sap_getObjectById()
    parse_sap_ui_commons_TreeNode()
    
    depending level: 1
    
    Parameters:
    
    treeNodeId - (Javascript) String, SAP Tree Node's ID.
  - parse_sap_ui_core_Item
```
static java.lang.String parse_sap_ui_core_Item(boolean includeDependency)
```
    Convert a sap.ui.core.Item object to a standard Item object with known properties
    like id, disabled, label, value, selected and index
    
    depending on:
    JavaScriptFunctions.isType()
    depending level: 1
    
    Parameters:
    
    itemobject - (Javascript) Object, sap.ui.core.Item object or its subclass.
    
    index - (Javascript) int, the index of the item within a combobox/list.
    
    selectedKeyArray - (Javascript) Array, an array of 'selected key'. To compare with item's key.
    
    Returns:
    
    Item (Javascript) Object, the uniformed Item object.
  - parse_sap_m_ListItemBase
```
static java.lang.String parse_sap_m_ListItemBase()
```
    Convert a sap.m.ListItemBase object to a standard Item object with known properties
    like id, disabled, label, value, selected and index
    
    depending on: nothing
    
    depending level: 0
    
    Parameters:
    
    itemobject - (Javascript) Object, sap.m.ListItemBase object or its subclass.
    
    index - (Javascript) int, the index of the item within a list.
    
    Returns:
    
    Item (Javascript) Object, the uniformed Item object.
    
    Throws:
    
    error - (Javascript) Error, if some exception occurs
  - parse_sap_ui_commons_TreeNode
```
static java.lang.String parse_sap_ui_commons_TreeNode()
```
    Convert a sap.ui.commons.TreeNode object to a standard TreeNode object with known properties
    like id, disabled, label, expanded, selected
    
    depending on: nothing
    
    depending level: 0
    
    Parameters:
    
    itemobject - (Javascript) Object, sap.ui.commons.TreeNode object.
    
    Returns:
    
    TreeNode (Javascript) Object, the uniformed TreeNode object.
  - sap_ui_core_ScrollBar_page
```
public static java.lang.String sap_ui_core_ScrollBar_page(boolean includeDependency)
```
    Pageup/PageDown the scrollbar according to the pages.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    pages - (Javascript) int, the pages to move for scrollbar. positive --> pagedown; negative --> pageup
  - sap_ui_core_ScrollBar_scroll
```
public static java.lang.String sap_ui_core_ScrollBar_scroll(boolean includeDependency)
```
    Scroll the scrollbar according to the steps.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    steps - (Javascript) int, the steps to move for scrollbar.
  - sap_ui_commons_CheckBox_setChecked
```
public static java.lang.String sap_ui_commons_CheckBox_setChecked(boolean includeDependency)
```
    Set the value of property 'checked'.
    
    depending on:
    sap_getObject()
    JavaScriptFunctions.objectIsInstanceof()
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    bChecked - (Javascript) boolean, the value to set.
    
    Since:
    
    FEB 13, 2014 (Lei Wang) Call SAP checkbox API fireChange() to invoke the associated callbacks.
    SEP 11, 2014 (Lei Wang) Add support for sap.m.CheckBox
  - sap_ui_commons_CheckBox_getChecked
```
public static java.lang.String sap_ui_commons_CheckBox_getChecked(boolean includeDependency)
```
    Get the value of property 'checked'.
    
    depending on:
    sap_getObject()
    JavaScriptFunctions.objectIsInstanceof()
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    Since:
    
    SEP 11, 2014 (Lei Wang) Add support for sap.m.CheckBox
  - sap_ui_core_Control_attachBrowserEvent
```
public static java.lang.String sap_ui_core_Control_attachBrowserEvent(boolean includeDependency,
                                                                      java.lang.String variable)
```
    Attach a generic event callback to a javasript event for an object.
    
    depending on:
    sap_getObject()
    JavaScriptFunctions.defineGenericEventCallBack(String)
    
    depending level: 1
    
    Parameters:
    
    includeDependency - boolean, if true, will return the depended js as part of result.
    
    variable - String, the javascript global variable name, used by the 'generic event callback'.
    
    domNode - (Javascript) Object (WebElement), used to find a SAP object.
    
    eventname - (Javascript) String, the event name, like 'click', 'blur' or 'mousedown' etc.
    
    Returns:
  - sap_ui_core_Control_detachBrowserEvent
```
public static java.lang.String sap_ui_core_Control_detachBrowserEvent(boolean includeDependency,
                                                                      java.lang.String variable)
```
    Detach a generic event callback to a javasript event from an object.
    
    depending on:
    sap_getObject()
    JavaScriptFunctions.removeGlobalVariable(String)
    
    depending level: 1
    
    Parameters:
    
    includeDependency - boolean, if true, will return the depended js as part of result.
    
    variable - String, the javascript global variable name, used by the 'generic event callback'.
    
    domNode - (Javascript) Object (WebElement), used to find a SAP object.
    
    eventname - (Javascript) String, the event name, like 'click', 'blur' or 'mousedown' etc.
    
    Returns:
  - sap_ui_commons_TabStrip_setSelectedIndex
```
public static java.lang.String sap_ui_commons_TabStrip_setSelectedIndex(boolean includeDependency)
```
    Set selected index for a tabcontrol and fire the 'select' event.
    
    depending on:
    sap_getObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    index - (Javascript) int, the index to select, 0-based.
  - parse_sap_ui_commons_Tab
```
static java.lang.String parse_sap_ui_commons_Tab()
```
    Convert the sap.ui.commons.Tab object to a uniformed Tab object, which contains properties
    like id, selected, label, disabled and index
    
    depending on: nothing
    
    depending level: 0
    
    Parameters:
    
    tabobject - (Javascript) Object, the SAP sap.ui.commons.Tab object.
    
    index - (Javascript) int, the index of the SAP tab object within the tabcontrol.
    
    Returns:
    
    Tab (Javascript) Object, the uniformed Tab object.
  - sap_ui_commons_TabStrip_getTabs
```
public static java.lang.String sap_ui_commons_TabStrip_getTabs(boolean includeDependency)
```
    Get selected index for a tabcontrol.
    
    depending on:
    sap_getObject()
    #sap_initializeTabObject()
    
    depending level: 1
    
    Parameters:
    
    domelement - (Javascript) Object, the dom-element used to find a SAP object.
    
    Returns:
    
    tabs (Javascript) an array of map, the map containing the properties of a tab.

Class JavaScriptFunctions.SAP

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SAP

Method Detail

sap_getProperty

sap_getDOMRef

sap_getObject

sap_getAccessibilityControllerElements

sap_getAccessibilityControllerElementsInfo

sap_getObjectById

getSAPClassNames

sap_objectIsInstanceof

getSAPClassNamesById

getSAPClassNameById

sap_ComboBox_setSelectedKey

sap_ComboBox_getItems

sap_ui_commons_xxx_getSelectedIndex

sap_ui_commons_ListBox_getSelectedIndices

sap_ui_commons_ListBox_setSelectedIndex

sap_ui_commons_ListBox_scrollToIndex

sap_m_List_getItems

sap_m_SelectList_getItems

sap_m_SelectList_getSelectedItems

sap_m_SelectList_setSelectedItemById

sap_m_List_getSelectedItems

sap_m_List_setSelectedItemById

sap_ui_commons_ListBox_getItems

sap_ui_commons_Menu_getItems

sas_hc_ui_commons_pushmenu_PushMenu_goHome

sas_hc_ui_commons_pushmenu_PushMenu_getItems

sap_ui_commons_Tree_getNodes

sap_ui_commons_Tree_getNodes_Rec

sap_ui_commons_Tree_collapseAll

sap_ui_commons_Tree_expandAll

sap_ui_commons_TreeNode_collapse

sap_ui_commons_TreeNode_expand

sap_ui_commons_TreeNode_select

sap_ui_commons_TreeNode_showOnPage

sap_ui_commons_TreeNode_getIsSelected

sap_ui_commons_TreeNode_getExpanded

sap_ui_commons_TreeNode_getSelectable

sap_ui_commons_TreeNode_refresh

parse_sap_ui_core_Item

parse_sap_m_ListItemBase

parse_sap_ui_commons_TreeNode

sap_ui_core_ScrollBar_page

sap_ui_core_ScrollBar_scroll

sap_ui_commons_CheckBox_setChecked

sap_ui_commons_CheckBox_getChecked

sap_ui_core_Control_attachBrowserEvent

sap_ui_core_Control_detachBrowserEvent

sap_ui_commons_TabStrip_setSelectedIndex

parse_sap_ui_commons_Tab

sap_ui_commons_TabStrip_getTabs