Interface IManager

A manager of running items grouped under a single section.

interface IManager {
    name: string;
    runningChanged: ISignal<any, any>;
    shutdownAllConfirmationText?: string | (() => string);
    shutdownAllLabel?: string;
    shutdownItemIcon?: LabIcon;
    shutdownLabel?: string | ((item) => string);
    supportsMultipleViews?: boolean;
    toolbarButtons?: (ToolbarButton | CommandToolbarButton)[];
    refreshRunning(): void;
    running(options): IRunningItem[];
    shutdownAll(): void;
}

Properties

name runningChanged shutdownAllConfirmationText? shutdownAllLabel? shutdownItemIcon? shutdownLabel? supportsMultipleViews? toolbarButtons?

Methods

refreshRunning running shutdownAll

Properties

name

name: string

Name that is shown to the user in plural.

runningChanged

runningChanged: ISignal<any, any>

A signal that should be emitted when the item list has changed.

Optional shutdownAllConfirmationText

shutdownAllConfirmationText?: string | (() => string)

A string used as the body text in the shutdown all confirmation dialog.

Type declaration

    • (): string

    • Returns string

Optional shutdownAllLabel

shutdownAllLabel?: string

A string used to describe the shutdown all action.

Optional shutdownItemIcon

shutdownItemIcon?: LabIcon

The icon to show for shutting down an individual item in this section.

Optional shutdownLabel

shutdownLabel?: string | ((item) => string)

A string used to describe the shutdown action.

Type declaration

Optional supportsMultipleViews

supportsMultipleViews?: boolean

Whether the manager supports tree view for its items or only a flat list.

Optional toolbarButtons

toolbarButtons?: (ToolbarButton | CommandToolbarButton)[]

Used to add arbitrary buttons to this section

Methods

refreshRunning

running

shutdownAll

Settings

Member Visibility

Theme

On This Page

namerunningChangedshutdownAllConfirmationTextshutdownAllLabelshutdownItemIconshutdownLabelsupportsMultipleViewstoolbarButtonsrefreshRunningrunningshutdownAll