Protected ReadonlycolorsProtected ReadonlycontextProtected ReadonlycontextProtected ReadonlycoreProtecteddecorationsProtected ReadonlydecorationsProtected ReadonlydecoratorProtected ReadonlydiffProtected ReadonlyeditorProtected ReadonlyfocusProtected ReadonlyhandleHandle the double-click mouse event on the expansion toggle.
Protected ReadonlyiconProtected ReadonlylabelProtectedlastStore the last scroll state.
The scroll left value.
The scroll top value.
Protected ReadonlymenusReadonlymodelTODO: Make TreeWidget generic to better type those fields.
ReadonlynodeGet the DOM node owned by the widget.
ProtectednodeReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonProtected ReadonlypreferenceReadonlypropsProtected ReadonlyrenderRender the node row.
ProtectedrowsProtectedscheduleProtected OptionalscrollProtectedScrollingProtected OptionalscrollProtectedscrollRow index to ensure visibility.
ProtectedsearchProtected ReadonlysearchProtectedsearchProtected ReadonlyselectionProtectedshouldProtected ReadonlythemeProtected ReadonlytoProtected ReadonlytoProtected ReadonlytoggleToggle the node.
ProtectedtreeProtected ReadonlytreeProtected ReadonlyupdateUpdate tree decorations.
ProtectedupdateProtectedviewStaticIDStaticRESOURCE_StaticRESOURCE_StaticRESOURCE_StaticRESOURCE_StaticRESOURCE_StaticRESOURCE_The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
Get the method for hiding the widget.
Get the id of the widget's DOM node.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
Get the parent of the widget.
Set the parent of the widget.
Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.
The widget will be automatically removed from its old parent.
This is a no-op if there is no effective parent change.
The title object for the widget.
The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.
Since not all widgets will use the title, it is created on demand.
The owner property of the title is set to this widget.
ProtectedaddProtectedaddOptionaluseCapture: booleanProtectedaddProtectedaddProtectedapplyApply font styles to the tree.
the original css properties.
the optional fontData.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
ProtectedcreateCreate the container attributes for the widget.
ProtectedcreateProtectedcreateProtectedcreateProtecteddecorateProtecteddecorateDecorate the tree node icon.
the tree node.
the icon.
ProtecteddecorateDecorate the node style.
the tree node.
the optional CSS properties.
the CSS styles if available.
ProtecteddeflateProtecteddisableProtecteddoActually focus the tree node.
ProtecteddoActually handle the double-click mouse event on the expansion toggle.
the double-click mouse event.
ProtecteddoProtecteddoActually toggle the tree node.
the mouse click event.
ProtecteddoProtecteddoProtectedgetProtectedgetProtectedgetGet the container tree node.
the tree node for the container if available.
ProtectedgetGet the tree decoration data for the given key.
the tree decoration data at the given key.
ProtectedgetGet the tree node decorations.
the tree node.
the list of tree decoration data.
ProtectedgetProtectedgetProtectedgetProtectedgetProtectedgetDetermine the classes to use for an icon
the icon name or list of icon names.
OptionaladditionalClasses: string[]additional CSS classes.
the icon class name.
ProtectedgetProtectedgetProtectedgetGet the scroll container.
ProtectedgetGet the scrollToRow.
the scrollToRow if available.
ProtectedgetGet the current scroll state from the virtualized view. This should be used instead of accessing the DOM scroll properties directly when the tree is virtualized.
ProtectedhandleHandle the middle-click mouse event.
the tree node if available.
the middle-click mouse event.
ProtectedhandleHandle the single-click mouse event.
the tree node if available.
the mouse single-click event.
ProtectedhandleHandle the context menu click event.
the tree node if available.
the right-click mouse event.
ProtectedhandleHandle the double-click mouse event.
the tree node if available.
the double-click mouse event.
ProtectedhandleHandle the down arrow keyboard event.
the down arrow keyboard event.
ProtectedhandleHandle the enter key keyboard event.
enter opens the tree node.the enter key keyboard event.
ProtectedhandleProtectedhandleProtectedhandleProtectedhandleProtectedhandleProtectedhandleThe ARROW_LEFT key controls both the movement around the file tree and also the movement through the change chunks within a file.
If the selected tree node is a folder then the ARROW_LEFT key behaves exactly as it does in explorer. It collapses the tree node if the folder is expanded and it moves the selection up to the parent folder if the folder is collapsed (no-op if no parent folder, as group headers are not selectable). This behavior is the default behavior implemented in the TreeWidget super class.
If the selected tree node is a file then the ARROW_LEFT key moves up through the change chunks within each file. If the selected chunk is the first chunk in the file then the file selection is moved to the previous file (no-op if no previous file).
Note that when cursoring through change chunks, the ARROW_LEFT key cannot be used to move up through the parent folders of the file tree. If users want to do this, using keys only, then they must press ARROW_UP repeatedly until the selected node is the folder node and then press ARROW_LEFT.
ProtectedhandleHandle the middle-click mouse event.
the middle-click mouse event.
ProtectedhandleThe ARROW_RIGHT key controls both the movement around the file tree and also the movement through the change chunks within a file.
If the selected tree node is a folder then the ARROW_RIGHT key behaves exactly as it does in explorer. It expands the tree node if the folder is collapsed and it moves the selection to the first child node if the folder is expanded. This behavior is the default behavior implemented in the TreeWidget super class.
If the selected tree node is a file then the ARROW_RIGHT key moves down through the change chunks within each file. If the selected chunk is the last chunk in the file then the file selection is moved to the next file (no-op if no next file).
ProtectedhandleHandle the space key keyboard event.
the space key keyboard event.
ProtectedhandleHandle the up arrow keyboard event.
the up arrow keyboard event.
ProtectedhandleTest whether the widget's DOM node has the given class name.
The class name of interest.
true if the node has the class, false otherwise.
ProtectedhasDetermine if the tree modifier aware event has a ctrlcmd mask.
the tree modifier aware event.
true if the tree modifier aware event contains the ctrlcmd mask.
ProtectedhasDetermine if the tree modifier aware event has a shift mask.
the tree modifier aware event.
true if the tree modifier aware event contains the shift mask.
ProtectedhasDetermine if the tree node contains trailing suffixes.
the tree node.
true if the tree node contains trailing suffices.
Hide the widget and make it hidden to its parent widget.
This causes the isHidden property to be true.
If the widget is explicitly hidden, this is a no-op.
ProtectedinflateProtectedinitProtectedisProtectedisDetermine if the tree node is expandable.
the tree node.
true if the tree node is expandable.
Check if the tree is scrolled to the bottom. Works with both virtualized and non-virtualized trees.
ProtectedmoveProtectedmoveProtectedneedsProtectedneedsIf the node is a composite, a toggle will be rendered. Otherwise we need to add the width and the left, right padding => 18px
ProtectednotifyProtectedonA message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-attach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-show' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-detach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
ProtectedonA message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'update-request' message.
The default implementation of this handler is a no-op.
ProtectedopenProtectedregisterProtectedrenderRender the React widget in the DOM.
ProtectedrenderProtectedrenderProtectedrenderProtectedrenderProtectedrenderProtectedrenderProtectedrenderProtectedrenderProtectedrenderProtectedrenderRestore the state.
the old state object.
ProtectedrowProtectedscrollScroll to the selected tree node.
ProtectedshouldProtectedshouldDetermines whether an indentation div should be rendered for the specified tree node. If there are multiple tree nodes inside of a single rendered row, this method should only return true for the first node.
ProtectedshouldShow the widget and make it visible to its parent widget.
This causes the isHidden property to be false.
If the widget is not explicitly hidden, this is a no-op.
Store the tree state.
ProtectedtapThe effective handler of an unmodified single-click event.
Optionalnode: TreeNodeTest whether the given widget flag is set.
This will not typically be called directly by user code.
ProtectedtoConvert the tree node to context menu arguments.
the selectable tree node.
ProtectedtoggleToggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optionalforce: booleanWhether to force add the class (true) or force
remove the class (false). If not provided, the presence of
the class will be toggled from its current state.
true if the class is now present, false otherwise.
The class name must not contain whitespace.
ProtectedtoProtectedtoProtectedtoProtectedtoProtectedtoUpdate the node given the caption and highlight.
the caption.
the tree decoration caption highlight.
ProtectedupdateUpdate the global selection for the tree.
ProtectedupdateUpdate the scrollToRow.
A contract for widgets that want to store and restore their inner state, between sessions.