Interface IModel

An interface for the launcher model

interface IModel {
    isDisposed: boolean;
    stateChanged: ISignal<ILauncher.IModel, void>;
    add(options): IDisposable;
    dispose(): void;
    items(): IterableIterator<ILauncher.IItemOptions>;
}

Hierarchy (view full)

ILauncher
VDomRenderer.IModel
- IModel

Implemented by

LauncherModel

Index

Properties

isDisposed stateChanged

Methods

add dispose items

Properties

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly` stateChanged

stateChanged: ISignal<ILauncher.IModel, void>

A signal emitted when any model state changes.

Methods

add

add(options): IDisposable
Add a command item to the launcher, and trigger re-render event for parent widget.
Parameters
- options: ILauncher.IItemOptions
  The specification options for a launcher item.
Returns IDisposable
A disposable that will remove the item from Launcher, and trigger re-render event for parent widget.
Inherited from ILauncher.add
- Defined in packages/launcher/src/tokens.ts:36

dispose

dispose(): void
Dispose of the resources held by the object.

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IModel.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

items

items(): IterableIterator<ILauncher.IItemOptions>
Return an iterator of launcher items.

Returns IterableIterator<ILauncher.IItemOptions>
- Defined in packages/launcher/src/tokens.ts:50