Toolbar | @jupyterlab (original) (raw)

activate

• activate(): void

• Returns void

addClass

• addClass(name: string): void

• Returns void

addItem

• addItem(name: string, widget: T): boolean

• Parameters

  • name: string
  • widget: T

Returns boolean

Whether the item was added to toolbar. Returns false if an item of the same name is already in the toolbar.

Notes

The item can be removed from the toolbar by setting its parent to null.

children

• children(): IterableIterator<Widget>

• 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: Flag): void

• Returns void

close

• close(): void

• Returns void

contains

• contains(widget: Widget): boolean

• Returns boolean

true if the widget is a descendant, false otherwise.

dispose

• dispose(): void

• Returns void

fit

• fit(): void

• Returns void

ProtectedhandleClick

• handleClick(event: Event): void

• Returns void

handleEvent

• handleEvent(event: Event): void

• Returns void

hasClass

• hasClass(name: string): boolean

• Returns boolean

true if the node has the class, false otherwise.

hide

• hide(): void

• Returns void

insertAfter

• insertAfter(at: string, name: string, widget: T): boolean

• Parameters

  • at: string
  • name: string
  • widget: T

Returns boolean

Whether the item was added to the toolbar. Returns false if an item of the same name is already in the toolbar.

Notes

The index will be clamped to the bounds of the items. The item can be removed from the toolbar by setting its parent to null.

insertBefore

• insertBefore(at: string, name: string, widget: T): boolean

• Parameters

  • at: string
  • name: string
  • widget: T

Returns boolean

Whether the item was added to the toolbar. Returns false if an item of the same name is already in the toolbar.

Notes

The index will be clamped to the bounds of the items. The item can be removed from the toolbar by setting its parent to null.

insertItem

• insertItem(index: number, name: string, widget: T): boolean

• Parameters

  • index: number
  • name: string
  • widget: T

Returns boolean

Whether the item was added to the toolbar. Returns false if an item of the same name is already in the toolbar.

Notes

The index will be clamped to the bounds of the items. The item can be removed from the toolbar by setting its parent to null.

ProtectedinsertRelative

• insertRelative(at: string, offset: number, name: string, widget: T): boolean

• Parameters

  • at: string
  • offset: number
  • name: string
  • widget: T

Returns boolean

names

• names(): IterableIterator<string>

• Returns IterableIterator<string>

An iterator over the toolbar item names.

ProtectednotifyLayout

• notifyLayout(msg: Message): void

• Returns void

ProtectedonActivateRequest

• onActivateRequest(msg: Message): void

• Returns void

ProtectedonAfterAttach

• onAfterAttach(msg: Message): void

• Returns void

ProtectedonAfterDetach

• onAfterDetach(msg: Message): void

• Returns void

ProtectedonAfterHide

• onAfterHide(msg: Message): void

• Returns void

ProtectedonAfterShow

• onAfterShow(msg: Message): void

• Returns void

ProtectedonBeforeAttach

• onBeforeAttach(msg: Message): void

• Returns void

ProtectedonBeforeDetach

• onBeforeDetach(msg: Message): void

• Returns void

ProtectedonBeforeHide

• onBeforeHide(msg: Message): void

• Returns void

ProtectedonBeforeShow

• onBeforeShow(msg: Message): void

• Returns void

ProtectedonChildAdded

• onChildAdded(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonChildRemoved

• onChildRemoved(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonCloseRequest

• onCloseRequest(msg: Message): void

• Returns void

ProtectedonFitRequest

• onFitRequest(msg: Message): void

• Returns void

ProtectedonResize

• onResize(msg: ResizeMessage): void

• Parameters

  • msg: ResizeMessage

Returns void

ProtectedonUpdateRequest

• onUpdateRequest(msg: Message): void

• Returns void

processMessage

• processMessage(msg: Message): void

• Returns void

removeClass

• removeClass(name: string): void

• Returns void

setFlag

• setFlag(flag: Flag): void

• Returns void

setHidden

• setHidden(hidden: boolean): void

• Parameters

  • hidden: boolean

Returns void

show

• show(): void

• Returns void

testFlag

• testFlag(flag: Flag): boolean

• Returns boolean

toggleClass

• toggleClass(name: string, force?: boolean): boolean

• Parameters

  • name: string
  • Optionalforce: boolean

Returns boolean

true if the class is now present, false otherwise.

Notes

The class name must not contain whitespace.

update

• update(): void

• Returns void