TreeView

SAPGUI. TreeView

new TreeView(propsopt) → {TreeView}

The description of a TreeView test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a TreeView test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
TreeView

Methods

absoluteLocation(locationopt) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

id(idopt) → {string|Description}

The element's unique identifier in text format.
Parameters:
NameTypeAttributesDescription
idstring <optional>
When provided, this method acts as a setter and sets the id value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored id value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isEnabled(isEnabledopt) → {boolean|Description}

Indicates whether the tree can accept user input.
Parameters:
NameTypeAttributesDescription
isEnabledboolean <optional>
When provided, this method acts as a setter and sets the isEnabled value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

location(locationopt) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

name(nameopt) → {string|Description}

The name of the element.
Parameters:
NameTypeAttributesDescription
namestring <optional>
When provided, this method acts as a setter and sets the name value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

selectedItem(selectedItemopt) → {string|Description}

The value of the selected item in the tree node.
Parameters:
NameTypeAttributesDescription
selectedItemstring <optional>
When provided, this method acts as a setter and sets the selectedItem value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored selectedItem value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

selectedNodePath(selectedNodePathopt) → {string|Description}

The path of the selected node in the tree.
Parameters:
NameTypeAttributesDescription
selectedNodePathstring <optional>
When provided, this method acts as a setter and sets the selectedNodePath value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored selectedNodePath value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

selectionMode(selectionModeopt) → {boolean|Description}

Indicates which selections can be made in the tree.
Parameters:
NameTypeAttributesDescription
selectionModeSAPGUI.TreeSelectionMode | string <optional>
When provided, this method acts as a setter and sets the selectionMode value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored selectionMode value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

size(sizeopt) → {Size|Description}

The object's size in pixels.
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

treeType(treeTypeopt) → {boolean|Description}

The type of the tree.
Parameters:
NameTypeAttributesDescription
treeTypeSAPGUI.TreeType | string <optional>
When provided, this method acts as a setter and sets the treeType value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored treeType value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

type(typeopt) → {SAPGUI.ComponentType|Description}

The numeric identification of the GUI component type.
Parameters:
NameTypeAttributesDescription
typeSAPGUI.ComponentType <optional>
When provided, this method acts as a setter and sets the type value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored type value; otherwise it returns 'this' for use with the builder pattern.
Type
SAPGUI.ComponentType | Description