Protected
_Protected
_Protected
appliedOptional
cancelProtected
changeProtected
Readonly
colorProtected
Readonly
contextProtected
Readonly
coreProtected
decorationsProtected
Readonly
decoratorProtected
Readonly
defaultThe default root name to add external search results in the case that a workspace is opened.
Protected
Readonly
editorProtected
Readonly
expansionProtected
Readonly
fileProtected
Readonly
fileProtected
Readonly
filesystemProtected
focuseslint-disable-next-line @typescript-eslint/no-explicit-any
Protected
Readonly
focusProtected
forceProtected
Readonly
handleHandle the double-click mouse event on the expansion toggle.
Protected
Readonly
labelProtected
lastStore the last scroll state.
The scroll left value.
The scroll top value.
Readonly
modelReadonly
nodeGet the DOM node owned by the widget.
Protected
nodeReadonly
onProtected
Readonly
onReadonly
onProtected
Readonly
onReadonly
onProtected
onReadonly
onProtected
Readonly
onReadonly
onProtected
Readonly
onReadonly
onProtected
Readonly
onProtected
Readonly
preferenceProtected
Readonly
progressReadonly
propsProtected
Readonly
renderRender the node row.
Protected
resultProtected
rowsProtected
scheduleProtected
Optional
scrollProtected
ScrollingProtected
Optional
scrollProtected
scrollRow index to ensure visibility.
Protected
searchProtected
Readonly
searchProtected
searchProtected
Readonly
searchProtected
Readonly
searchProtected
searchProtected
Readonly
searchProtected
searchProtected
Readonly
selectionProtected
Readonly
shellProtected
shouldProtected
Readonly
toProtected
Readonly
toProtected
Readonly
toProtected
Readonly
toggleToggle the node.
Protected
treeProtected
Readonly
treeProtected
Readonly
updateUpdate tree decorations.
Protected
updateProtected
viewProtected
Readonly
workspaceThe 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.
Protected
addProtected
addOptional
useCapture: booleanProtected
addProtected
addProtected
appendAppend search results to the result tree.
Search result.
Protected
applyProtected
buildCreate 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.
Protected
collapseCollapse the search-in-workspace file node based on the preference value.
Protected
confirmTest whether a widget is a descendant of this widget.
The descendant widget of interest.
true
if the widget is a descendant, false
otherwise.
Protected
convertConvert a pattern to match all directories.
the uri of the current workspace root.
the pattern to be converted.
Protected
createCreate the container attributes for the widget.
Protected
createProtected
createProtected
createProtected
createProtected
createProtected
createProtected
createProtected
createProtected
decorateDecorate the tree caption.
the tree node.
the additional attributes.
Protected
decorateProtected
decorateDecorate the tree node icon.
the tree node.
the icon.
Protected
decorateProtected
deflateProtected
disableProtected
doActually focus the tree node.
Protected
doGet the editor widget by the node.
the node representing a match in the search results.
The editor widget to which the text replace will be done.
Protected
doActually handle the double-click mouse event on the expansion toggle.
the double-click mouse event.
Protected
doProtected
doProtected
doProtected
doProtected
doActually toggle the tree node.
the mouse click event.
Protected
doProtected
doProtected
filenameProtected
findFind matches for the given editor.
the search term.
the editor widget.
the search options to apply.
the list of matches.
Protected
getProtected
getProtected
getGet the container tree node.
the tree node for the container if available.
Protected
getGet the tree decoration data for the given key.
the tree decoration data at the given key.
Protected
getGet the tree node decorations.
the tree node.
the list of tree decoration data.
Protected
getProtected
getProtected
getProtected
getGet the list of exclude globs.
Optional
excludeOptions: string[]the exclude search option.
the list of exclude globs.
Protected
getProtected
getProtected
getDetermine the classes to use for an icon
the icon name or list of icon names.
Optional
additionalClasses: string[]additional CSS classes.
the icon class name.
Protected
getProtected
getProtected
getProtected
getGet the scroll container.
Protected
getGet the scrollToRow
.
the scrollToRow
if available.
Protected
getGet 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.
Protected
getProtected
handleProtected
handleHandle the single-click mouse event.
the tree node if available.
the mouse single-click event.
Protected
handleHandle the context menu click event.
the tree node if available.
the right-click mouse event.
Protected
handleProtected
handleHandle the down arrow
keyboard event.
the down arrow
keyboard event.
Protected
handleHandle the enter key
keyboard event.
enter
opens the tree node.the enter key
keyboard event.
Protected
handleProtected
handleProtected
handleProtected
handleProtected
handleProtected
handleHandle the left arrow
keyboard event.
the left arrow
keyboard event.
Protected
handleHandle the middle-click mouse event.
the middle-click mouse event.
Protected
handleHandle the right arrow
keyboard event.
the right arrow
keyboard event.
Protected
handleHandle when searching completed.
Optional
cancelIndicator: CancellationTokenSourceProtected
handleHandle the space key
keyboard event.
the space key
keyboard event.
Protected
handleHandle the up arrow
keyboard event.
the up arrow
keyboard event.
Protected
handleTest 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.
Protected
hasDetermine 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.
Protected
hasDetermine 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.
Protected
hasDetermine 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.
Protected
inflateProtected
initProtected
inDetermine if the URI matches any of the patterns.
the editor URI.
the glob patterns to verify.
Protected
isDetermine 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.
Protected
needsProtected
needsIf the node is a composite, a toggle will be rendered. Otherwise we need to add the width and the left, right padding => 18px
Protected
nodeif true, all child nodes will be included in the stringified result.
Protected
notifyProtected
onA message handler invoked on an 'activate-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-attach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-detach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-attach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-detach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'close-request'
message.
The default implementation unparents or detaches the widget.
Protected
onA message handler invoked on a 'fit-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'update-request'
message.
The default implementation of this handler is a no-op.
Protected
refreshProtected
registerProtected
Readonly
removeProtected
renderRender the React widget in the DOM.
Protected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderProtected
renderReplace results under the node passed into the function. If node is undefined, replace all results.
Node in the tree widget where the "replace all" operation is performed
Protected
replaceReplace text either in all search matches under a node or in all search matches, and save the changes.
node in the tree widget in which the "replace all" is performed.
whether the function is to replace all matches under a node. If it is false, replace all.
text to be used for all replacements in the current replacement cycle.
Restore the state.
the old state object.
Protected
rowProtected
scrollScroll to the selected tree node.
Search and populate the result tree with matches.
the search term.
the search options to apply.
Protected
searchSearch the active editor only and update the tree with those results.
Protected
searchPerform a search in the target editor.
the editor widget.
the search term.
the search options to apply.
the search results from the given editor, undefined if the editor is either filtered or has no matches found.
Protected
searchPerform a search in all open editors.
the search term.
the search options to apply.
the tuple of result count, and the list of search results.
Protected
selectProtected
selectProtected
selectProtected
shouldDetermine if the given editor satisfies the filtering criteria. An editor should be searched only if:
excludes
list.includes
list.Protected
shouldProtected
shouldDetermines 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.
Protected
shouldShow 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.
Protected
sortSort the result tree by URIs.
Protected
Readonly
startStore the tree state.
Protected
tapThe effective handler of an unmodified single-click event.
Optional
node: TreeNodeTest whether the given widget flag is set.
This will not typically be called directly by user code.
Protected
toConvert the tree node to context menu arguments.
the selectable tree node.
Protected
toggleToggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optional
force: 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.
Protected
toProtected
toProtected
toProtected
toProtected
toUpdate the node given the caption and highlight.
the caption.
the tree decoration caption highlight.
Protected
updateProtected
updateUpdate the global selection for the tree.
Protected
updateProtected
updateUpdate the scrollToRow
.
A contract for widgets that want to store and restore their inner state, between sessions.