Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileBrowser

A widget which hosts a file browser.

The widget uses the Jupyter Contents API to retrieve contents, and presents itself as a flat list of files and directories with breadcrumbs.

Hierarchy

  • Widget
    • FileBrowser

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new file browser.

    Parameters

    Returns FileBrowser

Properties

Private _crumbs

_crumbs: any

Private _directoryPending

_directoryPending: any

Private _filenameSearcher

_filenameSearcher: any

Private _listing

_listing: any

Private _manager

_manager: any

Private _navigateToCurrentDirectory

_navigateToCurrentDirectory: any

Private _onConnectionFailure

_onConnectionFailure: any

Handle a connection lost signal from the model.

Private _trans

_trans: any

Private _useFuzzyFilter

_useFuzzyFilter: any

Readonly dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

Readonly disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

id

id: string

Set the id of the widget's DOM node.

Readonly isAttached

isAttached: boolean

Test whether the widget's node is attached to the DOM.

Readonly isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

Readonly isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

Readonly isVisible

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.

layout

layout: PanelLayout

Override Widget.layout with a more specific PanelLayout type.

Readonly model

model: FilterFileBrowserModel

The model used by the file browser.

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

parent

parent: Widget | null

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.

Readonly title

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.

Readonly toolbar

toolbar: Toolbar<Widget>

The toolbar used by the file browser.

Protected translator

translator: ITranslator

Accessors

navigateToCurrentDirectory

  • get navigateToCurrentDirectory(): boolean
  • set navigateToCurrentDirectory(value: boolean): any

  • Whether to show active file in file browser

    Returns boolean

  • Whether to show active file in file browser

    Parameters

    • value: boolean

    Returns any

useFuzzyFilter

  • set useFuzzyFilter(value: boolean): any

  • Whether to use fuzzy filtering on file names.

    Parameters

    • value: boolean

    Returns any

Methods

activate

  • activate(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): 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

children

  • children(): IIterator<Widget>

  • Create an iterator over the widget's children.

    Returns IIterator<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.

clearFlag

  • clearFlag(flag: Widget.Flag): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Widget.Flag

    Returns void

clearSelectedItems

  • clearSelectedItems(): void

  • Returns void

close

  • close(): void

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

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean

  • 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

  • copy(): void

  • Copy the selected items.

    Returns void

createNewDirectory

  • createNewDirectory(): void

  • Create a new directory

    Returns void

cut

  • cut(): void

  • Cut the selected items.

    Returns void

delete

  • delete(): Promise<void>

  • Delete the currently selected item(s).

    Returns Promise<void>

    A promise that resolves when the operation is complete.

dispose

  • dispose(): void

  • Dispose of the widget and its descendant widgets.

    Notes

    It is unsafe to use the widget after it has been disposed.

    All calls made to this method after the first are a no-op.

    Returns void

download

  • download(): Promise<void>

  • Download the currently selected item(s).

    Returns Promise<void>

duplicate

  • duplicate(): Promise<void>

  • Duplicate the currently selected item(s).

    Returns Promise<void>

    A promise that resolves when the operation is complete.

fit

  • fit(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

hasClass

  • hasClass(name: string): boolean

  • 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

  • hide(): void

  • 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

modelForClick

  • modelForClick(event: MouseEvent): IModel | undefined

  • Find a model given a click.

    Parameters

    • event: MouseEvent

      The mouse event.

    Returns IModel | undefined

    The model for the selected file.

Protected notifyLayout

  • notifyLayout(msg: Message): void

  • 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

Protected onActivateRequest

  • onActivateRequest(msg: Message): 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

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): 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

Protected onAfterHide

  • onAfterHide(msg: Message): 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

Protected onAfterShow

  • onAfterShow(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): 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

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • onBeforeHide(msg: Message): 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

Protected onBeforeShow

  • onBeforeShow(msg: Message): 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

Protected onChildAdded

  • onChildAdded(msg: Widget.ChildMessage): void

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

    Notes

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

    Parameters

    • msg: Widget.ChildMessage

    Returns void

Protected onChildRemoved

  • onChildRemoved(msg: Widget.ChildMessage): void

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

    Notes

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

    Parameters

    • msg: Widget.ChildMessage

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

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

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onFitRequest

  • onFitRequest(msg: Message): 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

Protected onResize

  • onResize(msg: Widget.ResizeMessage): void

  • A message handler invoked on a 'resize' message.

    Notes

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

    Parameters

    • msg: Widget.ResizeMessage

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

paste

  • paste(): Promise<void>

  • Paste the items from the clipboard.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

processMessage

  • processMessage(msg: Message): void

  • 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

removeClass

  • removeClass(name: string): 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

  • rename(): Promise<string>

  • Rename the first currently selected item.

    Returns Promise<string>

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

selectItemByName

  • selectItemByName(name: string): Promise<void>

  • Select an item by name.

    Parameters

    • name: string

      The name of the item to select.

    Returns Promise<void>

selectNext

  • selectNext(): void

  • Select next item.

    Returns void

selectPrevious

  • selectPrevious(): void

  • Select previous item.

    Returns void

selectedItems

  • selectedItems(): IIterator<IModel>

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

    Returns IIterator<IModel>

    A new iterator over the listing's selected items.

setFlag

  • setFlag(flag: Widget.Flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Widget.Flag

    Returns void

setHidden

  • setHidden(hidden: boolean): 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

show

  • show(): 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

shutdownKernels

  • shutdownKernels(): Promise<void>

  • Shut down kernels on the applicable currently selected items.

    Returns Promise<void>

    A promise that resolves when the operation is complete.

testFlag

  • testFlag(flag: Widget.Flag): boolean

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Widget.Flag

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: boolean): 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.

update

  • update(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Generated using TypeDoc