Construct a new file browser directory listing widget.
Private _allAre all of the items between two provided indices selected?
The items at the indices are not considered.
Index of one item.
Index of another item. Note: may be less or greater than first index.
True if and only if all items between the j and k are selected. Returns undefined if j and k are the same.
Private _clipboardPrivate _copyCopy the selected items, and optionally cut as well.
Private _deleteDelete the files with the given paths.
Private _doAllow the user to rename item on a given row.
Private _dragPrivate _dragPrivate _editPrivate _evtHandle the 'click' event for the widget.
Private _evtHandle the 'mousedown' event for the widget.
Private _evtHandle the 'mousemove' event for the widget.
Private _evtHandle the 'mouseup' event for the widget.
Private _evtHandle the 'scroll' event for the widget.
Private _focusPrivate _focus(Re-)focus an item in the directory listing.
The index of the item node to focus
Private _getCalculate the next focus index, given the current focus index and a direction, keeping within the bounds of the directory listing.
Current focus index
1 (up) or 1 (down)
The next focus index, which could be the same as the current focus index if at the boundary.
Private _handleHandle the up or down arrow key.
The keyboard event
1 (up) or 1 (down)
Private _handleHandle a multiple select on a file item node.
Private _hiddenPrivate _inPrivate _isPrivate _isPrivate _itemsPrivate _managerProtected _modelPrivate _onHandle an activateRequested signal from the manager.
Private _onHandle a fileChanged signal from the model.
Private _onPrivate _onHandle the refreshed signal from the model.
Private _onHandle a pathChanged signal from the model.
Private _prevPrivate _rendererPrivate _searchPrivate _searchPrivate _selectSelect a given item.
Private _selectSelect an item by name.
The name of the item to select.
Whether to move focus to the selected item.
Whether to proceed with selection even if the file was already selected.
A promise that resolves when the name is selected.
Private _selectPrivate _softPrivate _sortPrivate _sortPrivate _sortedPrivate _startStart a drag event.
Private _transReadonly nodeGet the DOM node owned by the widget.
Protected selectionProtected translatorGet the dir listing content node.
This is the node which holds the item nodes.
Modifying this node directly can lead to undefined behavior.
The dataset for the widget's DOM node.
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 method for hiding the widget.
Set 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.
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.
Get the layout for the widget.
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 model used by the listing.
A signal fired when an item is opened.
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 renderer instance used by the directory listing.
The current sort state.
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.
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.
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.
Protected evtHandle the 'dblclick' event for the widget.
Protected evtProtected evtProtected evtProtected evtProtected evtHandle the 'keydown' event for the widget.
Protected evtHandle the drop event for the widget.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Protected handleHandle selection on a file node.
Protected handleProtected isWould this click (or other event type) hit the checkbox by default?
Find a model given a click.
The mouse event.
The model for the selected file.
Protected notifyInvoke 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.
Protected onA message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
Protected onProtected 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 onProtected onA message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
Protected onProtected 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 onRemove 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.
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().
Sort the items using a sort condition.
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.
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.
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.