A widget which hosts a file list area.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

  • Construct a new file browser directory listing widget.

    Parameters

    Returns DirListing

Properties

_allSelectedBetween: any

Are all of the items between two provided indices selected?

The items at the indices are not considered.

Param

Index of one item.

Param

Index of another item. Note: may be less or greater than first index.

Returns

True if and only if all items between the j and k are selected. Returns undefined if j and k are the same.

_clipboard: any
_copy: any

Copy the selected items, and optionally cut as well.

_delete: any

Delete the files with the given paths.

_doRename: any

Allow the user to rename item on a given row.

_drag: any
_dragData: any
_editNode: any
_evtClick: any

Handle the 'click' event for the widget.

_evtMousedown: any

Handle the 'mousedown' event for the widget.

_evtMousemove: any

Handle the 'mousemove' event for the widget.

_evtMouseup: any

Handle the 'mouseup' event for the widget.

_evtScroll: any

Handle the 'scroll' event for the widget.

_focusIndex: any
_focusItem: any

(Re-)focus an item in the directory listing.

Param

The index of the item node to focus

_getNextFocusIndex: any

Calculate the next focus index, given the current focus index and a direction, keeping within the bounds of the directory listing.

Param

Current focus index

Param

1 (up) or 1 (down)

Returns

The next focus index, which could be the same as the current focus index if at the boundary.

_handleArrowY: any

Handle the up or down arrow key.

Param

The keyboard event

Param

1 (up) or 1 (down)

_handleMultiSelect: any

Handle a multiple select on a file item node.

_hiddenColumns: any
_inRename: any
_isCut: any
_isDirty: any
_items: any
_manager: any
_onActivateRequested: any

Handle an activateRequested signal from the manager.

_onFileChanged: any

Handle a fileChanged signal from the model.

_onItemOpened: any
_onModelRefreshed: any

Handle the refreshed signal from the model.

_onPathChanged: any

Handle a pathChanged signal from the model.

_prevPath: any
_renderer: any
_searchPrefix: any
_searchPrefixTimer: any
_selectItem: any

Select a given item.

_selectTimer: any
_softSelection: any
_sortNotebooksFirst: any
_sortState: any
_sortedItems: any
_startDrag: any

Start a drag event.

_trans: any

Get the DOM node owned by the widget.

selection: {
    [key: string]: boolean;
}

Type declaration

  • [key: string]: boolean
translator: ITranslator

Accessors

  • get contentNode(): HTMLElement
  • Get the dir listing content node.

    Notes

    This is the node which holds the item nodes.

    Modifying this node directly can lead to undefined behavior.

    Returns HTMLElement

  • get dataset(): DOMStringMap
  • The dataset for the widget's DOM node.

    Returns DOMStringMap

  • get disposed(): ISignal<this, void>
  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

  • get headerNode(): HTMLElement
  • Get the dir listing header node.

    Notes

    This is the node which holds the header cells.

    Modifying this node directly can lead to undefined behavior.

    Returns HTMLElement

  • get hiddenMode(): HiddenMode
  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void
  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

  • get id(): string
  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void
  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

  • get isAttached(): boolean
  • Test whether the widget's node is attached to the DOM.

    Returns boolean

  • get isDisposed(): boolean
  • Test whether the widget has been disposed.

    Returns boolean

  • get isHidden(): boolean
  • Test whether the widget is explicitly hidden.

    Returns boolean

  • get isVisible(): boolean
  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

  • get layout(): Layout
  • Get the layout for the widget.

    Returns Layout

  • set layout(value): void
  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    • value: Layout

    Returns void

  • get parent(): Widget
  • Get the parent of the widget.

    Returns Widget

  • set parent(value): void
  • Set the parent of the widget.

    Notes

    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.

    Parameters

    Returns void

  • get title(): Title<Widget>
  • The title object for the widget.

    Notes

    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.

    Returns Title<Widget>

Methods

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    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 given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

  • Clear the selected items.

    Returns void

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

  • Copy the selected items.

    Returns void

  • Cut the selected items.

    Returns void

  • Delete the currently selected item(s).

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Dispose of the resources held by the directory listing.

    Returns void

  • Download the currently selected item(s).

    Returns Promise<void>

  • Duplicate the currently selected item(s).

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Handle the 'dblclick' event for the widget.

    Parameters

    Returns void

  • Handle the 'lm-dragenter' event for the widget.

    Parameters

    • event: Event

    Returns void

  • Handle the 'lm-dragleave' event for the widget.

    Parameters

    • event: Event

    Returns void

  • Handle the 'lm-dragover' event for the widget.

    Parameters

    • event: Event

    Returns void

  • Handle the 'lm-drop' event for the widget.

    Parameters

    • event: Event

    Returns void

  • Handle the 'keydown' event for the widget.

    Parameters

    Returns void

  • Handle the drop event for the widget.

    Parameters

    Returns void

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

  • cd ..

    Go up one level in the directory tree.

    Returns Promise<void>

  • Handle the DOM events for the directory listing.

    Parameters

    • event: Event

      The DOM event sent to the widget.

      Notes

      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.

    Returns void

  • Handle selection on a file node.

    Parameters

    Returns void

  • Handle the opening of an item.

    Parameters

    Returns void

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

  • Get whether an item is selected by name.

    Parameters

    • name: string

      The name of of the item.

    Returns boolean

    Whether the item is selected.

  • Would this click (or other event type) hit the checkbox by default?

    Parameters

    Returns boolean

  • Find a model given a click.

    Parameters

    Returns Contents.IModel

    The model for the selected file.

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-attach' message.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-show' message.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-detach' message.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • Parameters

    • msg: ResizeMessage

    Returns void

  • A handler invoked on an 'update-request' message.

    Parameters

    • msg: Message

    Returns void

  • Paste the items from the clipboard.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

  • Rename the first currently selected item.

    Returns Promise<string>

    A promise that resolves with the new name of the item.

  • Select the first item that starts with prefix being typed.

    Returns void

  • Select an item by name.

    Parameters

    • name: string

      The name of the item to select.

    • Optional focus: boolean

      Whether to move focus to the selected item.

    Returns Promise<void>

    A promise that resolves when the name is selected.

  • Select next item.

    Parameters

    • Optional keepExisting: boolean

      Whether to keep the current selection and add to it.

    Returns void

  • Select previous item.

    Parameters

    • Optional keepExisting: boolean

      Whether to keep the current selection and add to it.

    Returns void

  • Create an iterator over the listing's selected items.

    Returns IterableIterator<Contents.IModel>

    A new iterator over the listing's selected items.

  • Parameters

    Returns void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

  • Update the setting to sort notebooks above files. This sorts the items again if the internal value is modified.

    Parameters

    • isEnabled: boolean

    Returns void

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

  • Shut down kernels on the applicable currently selected items.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

  • Sort the items using a sort condition.

    Parameters

    Returns void

  • Create an iterator over the listing's sorted items.

    Returns IterableIterator<Contents.IModel>

    A new iterator over the listing's sorted items.

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: boolean

      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.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Generated using TypeDoc