Construct a new file browser directory listing widget.
Copy the selected items, and optionally cut as well.
Delete the files with the given paths.
Allow the user to rename item on a given row.
Handle the 'click' event for the widget.
Handle the 'dblclick' event for the widget.
Handle the 'lm-dragenter' event for the widget.
Handle the 'lm-dragleave' event for the widget.
Handle the 'lm-dragover' event for the widget.
Handle the 'lm-drop' event for the widget.
Handle the 'keydown' event for the widget.
Handle the 'mousedown' event for the widget.
Handle the 'mousemove' event for the widget.
Handle the 'mouseup' event for the widget.
Handle the drop event for the widget.
Handle the 'scroll' event for the widget.
Handle selection on a file node.
Handle a multiple select on a file item node.
Handle the opening of an item.
Handle an activateRequested signal from the manager.
Handle a fileChanged signal from the model.
Handle the refreshed signal from the model.
Handle a pathChanged signal from the model.
Select a given item.
Start a drag event.
The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
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.
Test whether the widget is visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
Set the layout for the widget.
The layout is single-use only. It cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
Get the DOM node owned by 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.
Get the dir listing content node.
This is the node which holds the item nodes.
Modifying this node directly can lead to undefined behavior.
Get the dir listing header node.
This is the node which holds the header cells.
Modifying this node directly can lead to undefined behavior.
Get the model used by the listing.
A signal fired when an item is opened.
The renderer instance used by the directory listing.
The current sort state.
Post an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
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.
Clear the selected items.
Send a 'close-request' message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
Copy the selected items.
Cut the selected items.
Delete the currently selected item(s).
A promise that resolves when the operation is complete.
Dispose of the resources held by the directory listing.
Download the currently selected item(s).
Duplicate the currently selected item(s).
A promise that resolves when the operation is complete.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Handle the DOM events for the directory listing.
The DOM event sent to the widget.
This method implements the DOM EventListener interface and is
called in response to events on the panel's DOM node. It should
not be called directly by user code.
Test 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.
Get whether an item is selected by name.
The name of of the item.
Whether the item is selected.
Find a model given a click.
The mouse event.
The model for the selected file.
Invoke the message processing routine of the widget's layout.
The message to dispatch to the layout.
This is a no-op if the widget does not have a layout.
This will not typically be called directly by user code.
A message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-attach' message.
A message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-show' message.
A message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-detach' message.
A message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
A message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
A handler invoked on an 'update-request' message.
Paste the items from the clipboard.
A promise that resolves when the operation is complete.
Process a message sent to the widget.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
Rename the first currently selected item.
A promise that resolves with the new name of the item.
Select the first item that starts with prefix being typed.
Select an item by name.
The name of the item to select.
A promise that resolves when the name is selected.
Select next item.
Whether to keep the current selection and add to it.
Select previous item.
Whether to keep the current selection and add to it.
Create an iterator over the listing's selected items.
A new iterator over the listing's selected items.
Show or hide the widget according to a boolean value.
true to hide the widget, or false to show it.
This is a convenience method for hide() and show().
Shut down kernels on the applicable currently selected items.
A promise that resolves when the operation is complete.
Sort the items using a sort condition.
Create an iterator over the listing's sorted items.
A new iterator over the listing's sorted items.
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Whether 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.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
Generated using TypeDoc
A widget which hosts a file list area.