Options
All
  • Public
  • Public/Protected
  • All
Menu

A notebook widget that supports interactivity. The namespace for the Notebook class statics.

Hierarchy

Implements

  • IDisposable
  • IMessageHandler

Index

Constructors

constructor

Properties

Private _activeCell

_activeCell: Cell = null

Private _activeCellChanged

_activeCellChanged: Signal<this, Cell> = new Signal<this, Cell>(this)

Private _activeCellIndex

_activeCellIndex: number = -1

Private _drag

_drag: Drag = null

Private _dragData

_dragData: object = null

Type declaration

Private _mode

_mode: NotebookMode = "command"

Private _selectionChanged

_selectionChanged: Signal<this, void> = new Signal<this, void>(this)

Private _stateChanged

_stateChanged: Signal<this, IChangedArgs<any>> = new Signal<this, IChangedArgs<any>>(this)

contentFactory

contentFactory: IContentFactory

The cell factory used by the widget.

dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

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.

isAttached

isAttached: boolean

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

isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

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

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.

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.

rendermime

rendermime: RenderMime

The Rendermime instance used by the widget.

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.

Static defaultContentFactory

defaultContentFactory: IContentFactory = new ContentFactory()

Accessors

activeCell

  • get activeCell(): Cell

activeCellChanged

  • get activeCellChanged(): ISignal<this, Cell>
  • A signal emitted when the active cell changes.

    Notes

    This can be due to the active index changing or the cell at the active index changing.

    Returns ISignal<this, Cell>

activeCellIndex

  • get activeCellIndex(): number
  • set activeCellIndex(newValue: number): void
  • The active cell index of the notebook.

    Notes

    The index will be clamped to the bounds of the notebook cells.

    Returns number

  • The active cell index of the notebook.

    Notes

    The index will be clamped to the bounds of the notebook cells.

    Parameters

    • newValue: number

    Returns void

codeMimetype

  • get codeMimetype(): string

mode

model

modelChanged

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

modelContentChanged

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

selectionChanged

  • get selectionChanged(): ISignal<this, void>
  • A signal emitted when the selection state of the notebook changes.

    Returns ISignal<this, void>

stateChanged

widgets

  • get widgets(): ReadonlyArray<Cell>

Methods

Private _ensureFocus

  • _ensureFocus(force?: boolean): void
  • Ensure that the notebook has proper focus.

    Parameters

    • Default value force: boolean = false

    Returns void

Private _evtBlur

  • _evtBlur(event: MouseEvent): void

Private _evtDblClick

  • _evtDblClick(event: MouseEvent): void

Private _evtDragEnter

  • _evtDragEnter(event: IDragEvent): void

Private _evtDragLeave

  • _evtDragLeave(event: IDragEvent): void

Private _evtDragOver

  • _evtDragOver(event: IDragEvent): void

Private _evtDrop

  • _evtDrop(event: IDragEvent): void

Private _evtFocus

  • _evtFocus(event: MouseEvent): void

Private _evtMouseDown

  • _evtMouseDown(event: MouseEvent): void

Private _evtMousemove

  • _evtMousemove(event: MouseEvent): void

Private _evtMouseup

  • _evtMouseup(event: MouseEvent): void

Private _extendSelectionTo

  • _extendSelectionTo(index: number): void

Private _findCell

  • _findCell(node: HTMLElement): number
  • Find the cell index containing the target html element.

    Notes

    Returns -1 if the cell is not found.

    Parameters

    • node: HTMLElement

    Returns number

Private _onEdgeRequest

Private _startDrag

  • _startDrag(index: number, clientX: number, clientY: number): void

Private _trimSelections

  • _trimSelections(): void

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: Flag): void
  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    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.

deselect

  • deselect(widget: Cell): void
  • Deselect a cell widget.

    Notes

    It is a no-op if the value does not change. It will emit the selectionChanged signal.

    Parameters

    Returns void

deselectAll

  • deselectAll(): void

dispose

  • dispose(): void

fit

  • fit(): void
  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

handleEvent

  • handleEvent(event: Event): void
  • Handle the DOM events for the widget.

    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 notebook panel's node. It should not be called directly by user code.

    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

isSelected

  • isSelected(widget: Cell): boolean

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
  • Handle 'activate-request' messages.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void
  • Handle after-attach messages for the widget.

    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
  • Handle before-detach messages for the widget.

    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 onCellInserted

  • onCellInserted(index: number, cell: Cell): void

Protected onCellMoved

  • onCellMoved(fromIndex: number, toIndex: number): void

Protected onCellRemoved

  • onCellRemoved(index: number, cell: Cell): void

Protected onChildAdded

  • onChildAdded(msg: ChildMessage): 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: ChildMessage): 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: 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 onMetadataChanged

Protected onModelChanged

Protected onModelContentChanged

Protected onResize

  • onResize(msg: ResizeMessage): 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: Message): void
  • Handle update-request messages sent to the widget.

    Parameters

    • msg: Message

    Returns void

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

scrollToPosition

  • scrollToPosition(position: number, threshold?: number): void
  • Scroll so that the given position is visible.

    Parameters

    • position: number

      The vertical position in the notebook widget.

    • Default value threshold: number = 25

      An optional threshold for the scroll. Defaults to 25 percent of the widget height.

    Returns void

select

  • select(widget: Cell): void
  • Select a cell widget.

    Notes

    It is a no-op if the value does not change. It will emit the selectionChanged signal.

    Parameters

    Returns void

setFlag

  • setFlag(flag: 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: 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

testFlag

  • testFlag(flag: 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: 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