GuiTree class

An SAP Tree control (type 122 — GuiShell subclass).

Provides tree navigation operations: selectNode, expandNode, collapseNode, doubleClickNode, unselectAll, and item-level methods (changeCheckbox, clickLink, pressButton, selectItem).

Also supports defaultContextMenu and headerContextMenu for right-click context menus on tree nodes.

GuiTree? tree = session.findTree('wnd[0]/usr/cntlSHELL/shellcont/shell');
tree?.expandNode('ROOT');
tree?.selectNode('ROOT\\CHILD_1');
tree?.doubleClickNode('ROOT\\CHILD_1');
Inheritance

Constructors

GuiTree(ISapObject obj)

Properties

accDescription → String
no setterinherited
accLabelCollection → GuiComponentCollection<GuiLabel>
no setterinherited
accText → String
no setterinherited
accTextOnRequest → String
no setterinherited
accTooltip → String
no setterinherited
changeable → bool
no setterinherited
children → GuiComponentCollection<GuiComponent>
no setterinherited
columnOrder ↔ List<String>?
getter/setter pair
containerType → bool
no setterinherited
defaultTooltip → String
no setterinherited
dragDropSupported → bool
no setterinherited
handle → int
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
height → int
no setterinherited
hierarchyHeaderWidth ↔ int
getter/setter pair
iconName → String
no setterinherited
id → String
no setterinherited
isSymbolFont → bool
no setterinherited
left → int
no setterinherited
modified ↔ bool
getter/setter pairinherited
name → String
no setterinherited
obj → ISapObject
finalinherited
ocxEvents → ISapObject?
no setterinherited
parent → GuiComponent?
no setterinherited
parentFrame → GuiComponent?
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenLeft → int
no setterinherited
screenTop → int
no setterinherited
selectedNode ↔ String
getter/setter pair
subType → String
no setterinherited
text ↔ String
getter/setter pairinherited
tooltip → String
no setterinherited
top → int
no setterinherited
topNode ↔ String
getter/setter pair
type → String
no setterinherited
typeAsNumber → int
no setterinherited
width → int
no setterinherited

Methods

changeCheckbox(String nodeKey, String itemName, bool checked) → void
collapseNode(String nodeKey) → void
defaultContextMenu() → void
doubleClickItem(String nodeKey, String itemName) → void
doubleClickNode(String nodeKey) → void
dumpState([String innerObject = ""]) → GuiComponentCollection<GuiComponent>
inherited
ensureVisibleHorizontalItem(String nodeKey, String itemName) → void
expandNode(String nodeKey) → void
findAllByName(String name, String type) → GuiComponentCollection<GuiComponent>
inherited
findAllByNameEx(String name, int typeAsNumber) → GuiComponentCollection<GuiComponent>
inherited
findBarChart(String id, {bool raise = true}) → GuiBarChart?
inherited
findBox(String id, {bool raise = true}) → GuiBox?
inherited
findButton(String id, {bool raise = true}) → GuiButton?
inherited
findById(String id, {bool raise = true}) → ISapObject?
inherited
findByName(String name, String type) → GuiComponent?
inherited
findByNameEx(String name, int typeAsNumber) → GuiComponent?
inherited
findCalendar(String id, {bool raise = true}) → GuiCalendar?
inherited
findChart(String id, {bool raise = true}) → GuiChart?
inherited
findCheckBox(String id, {bool raise = true}) → GuiCheckBox?
inherited
findComboBox(String id, {bool raise = true}) → GuiComboBox?
inherited
findComboBoxControl(String id, {bool raise = true}) → GuiComboBoxControl?
inherited
findComboBoxEntry(String id, {bool raise = true}) → GuiComboBoxEntry?
inherited
findComponent(String id, {bool raise = true}) → GuiComponent?
inherited
findContainerShell(String id, {bool raise = true}) → GuiContainerShell?
inherited
findCTextField(String id, {bool raise = true}) → GuiCTextField?
inherited
findCustomControl(String id, {bool raise = true}) → GuiCustomControl?
inherited
findDialogShell(String id, {bool raise = true}) → GuiDialogShell?
inherited
findDockShell(String id, {bool raise = true}) → GuiDockShell?
inherited
findEAIViewer2D(String id, {bool raise = true}) → GuiEAIViewer2D?
inherited
findEAIViewer3D(String id, {bool raise = true}) → GuiEAIViewer3D?
inherited
findFrameWindow(String id, {bool raise = true}) → GuiFrameWindow?
inherited
findGOSShell(String id, {bool raise = true}) → GuiGOSShell?
inherited
findGridView(String id, {bool raise = true}) → GuiGridView?
inherited
findHTMLViewer(String id, {bool raise = true}) → GuiHTMLViewer?
inherited
findInputFieldControl(String id, {bool raise = true}) → GuiInputFieldControl?
inherited
findLabel(String id, {bool raise = true}) → GuiLabel?
inherited
findMainWindow(String id, {bool raise = true}) → GuiMainWindow?
inherited
findMenu(String id, {bool raise = true}) → GuiMenu?
inherited
findMenuBar(String id, {bool raise = true}) → GuiMenuBar?
inherited
findMessageWindow(String id, {bool raise = true}) → GuiMessageWindow?
inherited
findNetChart(String id, {bool raise = true}) → GuiNetChart?
inherited
findOfficeIntegration(String id, {bool raise = true}) → GuiOfficeIntegration?
inherited
findOkCodeField(String id, {bool raise = true}) → GuiOkCodeField?
inherited
findPicture(String id, {bool raise = true}) → GuiPicture?
inherited
findRadioButton(String id, {bool raise = true}) → GuiRadioButton?
inherited
findSapChart(String id, {bool raise = true}) → GuiSapChart?
inherited
findScrollBar(String id, {bool raise = true}) → GuiScrollbar?
inherited
findScrollContainer(String id, {bool raise = true}) → GuiScrollContainer?
inherited
findShell(String id, {bool raise = true}) → GuiShell?
inherited
findSimpleContainer(String id, {bool raise = true}) → GuiSimpleContainer?
inherited
findSplitterContainer(String id, {bool raise = true}) → GuiSplitterContainer?
inherited
findSplitterShell(String id, {bool raise = true}) → GuiSplit?
inherited
findStage(String id, {bool raise = true}) → GuiStage?
inherited
findStatusbar(String id, {bool raise = true}) → GuiStatusbar?
inherited
inherited
findStatusPane(String id, {bool raise = true}) → GuiStatusPane?
inherited
findTab(String id, {bool raise = true}) → GuiTab?
inherited
findTableControl(String id, {bool raise = true}) → GuiTableControl?
inherited
findTabStrip(String id, {bool raise = true}) → GuiTabStrip?
inherited
findTextedit(String id, {bool raise = true}) → GuiTextedit?
inherited
findTextField(String id, {bool raise = true}) → GuiTextField?
inherited
findTitlebar(String id, {bool raise = true}) → GuiTitlebar?
inherited
findToolbar(String id, {bool raise = true}) → GuiToolbar?
inherited
findToolbarControl(String id, {bool raise = true}) → GuiToolbarControl?
inherited
findTree(String id, {bool raise = true}) → GuiTree?
inherited
findUserArea(String id, {bool raise = true}) → GuiUserArea?
inherited
findVHViewSwitch(String id, {bool raise = true}) → GuiVHViewSwitch?
inherited
getAllNodeKeys() → List<String>?
getCheckBoxState(String nodeKey, String itemName) → bool
getColumnHeaders() → List<String>?
getColumnNames() → List<String>?
getItemText(String key, String name) → String
getNodeTextByKey(String key) → String
getNodeTextByPath(String path) → String
getSelectedNodes() → List<String>?
getTreeType() → int
Return tree type: 0 (Simple), 1 (List), 2 (Column)
headerContextMenu(String headerName) → void
isFolder(String nodeKey) → bool
isFolderExpandable(String nodeKey) → bool
isFolderExpanded(String nodeKey) → bool
itemContextMenu(String nodeKey, String itemName) → void
nodeContextMenu(String nodeKey) → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pressButton(String nodeKey, String itemName) → void
pressKey(String key) → void
selectContextMenuItem(String functionCode) → void
inherited
selectContextMenuItemByPosition(String positionDesc) → void
inherited
selectContextMenuItemByText(String text) → void
inherited
selectItem(String nodeKey, String itemName) → void
selectNode(String nodeKey) → void
setFocus() → void
inherited
toString() → String
A string representation of this object.
inherited
unselectAll() → void
unselectNode(String nodeKey) → void
visualize(bool on, [String innerObject = ""]) → int
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited