TreeItem class
A tree item is an UI element of the tree. Tree items are created by the {@link TreeDataProviderdata provider}.
- Available extensions
- Annotations
-
- @JS()
- @staticInterop
Constructors
- TreeItem.$1()
-
factory
- TreeItem.$2(Object label, [TreeItemCollapsibleState? collapsibleState])
-
factory
- TreeItem.$3(Uri resourceUri, [TreeItemCollapsibleState? collapsibleState])
-
factory
Properties
- accessibilityInformation ↔ AccessibilityInformation
-
Available on TreeItem, provided by the TreeItem$Typings extension
Accessibility information used when screen reader interacts with this tree item. Generally, a TreeItem has no need to set therole
of the accessibilityInformation; however, there are cases where a TreeItem is not displayed in a tree-like way where setting therole
may make sense.getter/setter pair - checkboxState ↔ Object
-
Available on TreeItem, provided by the TreeItem$Typings extension
{@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item. {@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem.checkboxState checkboxState} changes.getter/setter pair - collapsibleState ↔ TreeItemCollapsibleState
-
Available on TreeItem, provided by the TreeItem$Typings extension
{@link TreeItemCollapsibleState} of the tree item.getter/setter pair - command ↔ Command
-
Available on TreeItem, provided by the TreeItem$Typings extension
The {@link Command} that should be executed when the tree item is selected.getter/setter pair - contextValue ↔ String
-
Available on TreeItem, provided by the TreeItem$Typings extension
Context value of the tree item. This can be used to contribute item specific actions in the tree. For example, a tree item is given a context value asfolder
. When contributing actions toview/item/context
usingmenus
extension point, you can specify context value for keyviewItem
inwhen
expression likeviewItem == folder
.getter/setter pair - description ↔ Object
-
Available on TreeItem, provided by the TreeItem$Typings extension
A human-readable string which is rendered less prominent. Whentrue
, it is derived from {@link TreeItem.resourceUri resourceUri} and whenfalsy
, it is not shown.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- iconPath ↔ Object
-
Available on TreeItem, provided by the TreeItem$Typings extension
The icon path or {@link ThemeIcon} for the tree item. Whenfalsy
, {@link ThemeIcon.Folder Folder Theme Icon} is assigned, if item is collapsible otherwise {@link ThemeIcon.File File Theme Icon}. When a file or folder {@link ThemeIcon} is specified, icon is derived from the current file icon theme for the specified theme icon using {@link TreeItem.resourceUri resourceUri} (if provided).getter/setter pair - id ↔ String
-
Available on TreeItem, provided by the TreeItem$Typings extension
Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.getter/setter pair - label ↔ Object
-
Available on TreeItem, provided by the TreeItem$Typings extension
A human-readable string describing this item. Whenfalsy
, it is derived from {@link TreeItem.resourceUri resourceUri}.getter/setter pair - resourceUri ↔ Uri
-
Available on TreeItem, provided by the TreeItem$Typings extension
The {@link Uri} of the resource representing this item.getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- tooltip ↔ dynamic
-
Available on TreeItem, provided by the TreeItem$Typings extension
The tooltip text when you hover over this item.getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited