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 (view full)

Constructors

constructor

Properties

_content _directoryPending _filePending _header _manager _navigateToCurrentDirectory _showFileCheckboxes _showFileSizeColumn _showHiddenFiles _showLastModifiedColumn _sortNotebooksFirst _toolbar _trans crumbs listing mainPanel model node translator

Accessors

content dataset disposed header hiddenMode id isAttached isDisposed isHidden isVisible layout navigateToCurrentDirectory parent showFileCheckboxes showFileSizeColumn showFullPath showHiddenFiles showLastModifiedColumn sortNotebooksFirst title toolbar widgets

Methods

_createNew _onConnectionFailure _toDrivePath activate addClass addWidget children clearFlag clearSelectedItems close contains copy createDirListing createNewDirectory createNewFile cut delete dispose download duplicate fit goUp hasClass hide insertWidget modelForClick notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest paste processMessage removeClass rename selectItemByName selectNext selectPrevious selectedItems setFlag setHidden show shutdownKernels testFlag toggleClass update

Constructors

constructor

Properties

Protected _content

_content: Panel

Private _directoryPending

_directoryPending: null | Promise<Contents.IModel> = null

Private _filePending

_filePending: null | Promise<Contents.IModel> = null

Protected _header

_header: Panel

Private _manager

_manager: IDocumentManager

Private _navigateToCurrentDirectory

_navigateToCurrentDirectory: boolean

Private _showFileCheckboxes

_showFileCheckboxes: boolean = false

Private _showFileSizeColumn

_showFileSizeColumn: boolean = false

Private _showHiddenFiles

_showHiddenFiles: boolean = false

Private _showLastModifiedColumn

_showLastModifiedColumn: boolean = true

Private _sortNotebooksFirst

_sortNotebooksFirst: boolean = false

Protected _toolbar

_toolbar: Toolbar<Widget>

Protected _trans

_trans: IRenderMime.TranslationBundle

Protected crumbs

crumbs: BreadCrumbs

Protected listing

listing: DirListing

Protected mainPanel

mainPanel: Panel

Readonly model

model: FilterFileBrowserModel

The model used by the file browser.

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Protected translator

translator: ITranslator

Accessors

content

  • get content(): Panel

  • The content hosted by the widget.

    Returns Panel

dataset

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

header

  • get header(): Panel

  • A panel for widgets that sit on top of the widget.

    Returns Panel

hiddenMode

  • 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

id

  • 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

isAttached

  • get isAttached(): boolean

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

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Returns boolean

isVisible

  • 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

layout

  • get layout(): null | Layout

  • Get the layout for the widget.

    Returns null | 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: null | Layout

    Returns void

navigateToCurrentDirectory

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | 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

showFileCheckboxes

showFileSizeColumn

showFullPath

showHiddenFiles

showLastModifiedColumn

sortNotebooksFirst

title

  • 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>

toolbar

  • get toolbar(): Toolbar<Widget>

  • The toolbar hosted by the widget.

    It sits between the header and the content

    Returns Toolbar<Widget>

widgets

  • get widgets(): readonly Widget[]

  • A read-only array of the widgets in the content panel.

    Returns readonly Widget[]

Methods

Private _createNew

Private _onConnectionFailure

Private _toDrivePath

  • _toDrivePath(driveName, localPath): string

  • Given a drive name and a local path, return the full drive path which includes the drive name and the local path.

    Parameters

    • driveName: string

      the name of the drive

    • localPath: string

      the local path on the drive.

    Returns string

    the full drive path

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): 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

addWidget

  • addWidget(widget): void

  • Add a widget to the content panel bottom.

    Parameters

    Returns void

children

  • children(): IterableIterator<Widget>

  • 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.

clearFlag

  • clearFlag(flag): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

clearSelectedItems

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): 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

Protected createDirListing

createNewDirectory

createNewFile

cut

delete

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

duplicate

fit

  • fit(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

goUp

hasClass

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

insertWidget

  • insertWidget(index, widget): void

  • Insert a widget at the given position in the content panel.

    Parameters

    Returns void

modelForClick

Protected notifyLayout

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

Protected onChildRemoved

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

Protected onCloseRequest

  • onCloseRequest(msg): 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): 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): void

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

    Notes

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

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

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

processMessage

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

selectItemByName

selectNext

selectPrevious

selectedItems

setFlag

  • setFlag(flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setHidden

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

testFlag

  • testFlag(flag): boolean

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

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

Settings

Member Visibility

Theme

On This Page

constructor_content_directoryPending_filePending_header_manager_navigateToCurrentDirectory_showFileCheckboxes_showFileSizeColumn_showHiddenFiles_showLastModifiedColumn_sortNotebooksFirst_toolbar_transcrumbslistingmainPanelmodelnodetranslatorcontentdatasetdisposedheaderhiddenModeidisAttachedisDisposedisHiddenisVisiblelayoutnavigateToCurrentDirectoryparentshowFileCheckboxesshowFileSizeColumnshowFullPathshowHiddenFilesshowLastModifiedColumnsortNotebooksFirsttitletoolbarwidgets_createNew_onConnectionFailure_toDrivePathactivateaddClassaddWidgetchildrenclearFlagclearSelectedItemsclosecontainscopycreateDirListingcreateNewDirectorycreateNewFilecutdeletedisposedownloadduplicatefitgoUphasClasshideinsertWidgetmodelForClicknotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonFitRequestonResizeonUpdateRequestpasteprocessMessageremoveClassrenameselectItemByNameselectNextselectPreviousselectedItemssetFlagsetHiddenshowshutdownKernelstestFlagtoggleClassupdate