Interface IHTMLViewerTracker

A class that tracks HTML viewer widgets.

interface IHTMLViewerTracker {
    currentChanged: ISignal<IHTMLViewerTracker, null | HTMLViewer>;
    currentWidget: null | HTMLViewer;
    isDisposed: boolean;
    restored: Promise<void>;
    size: number;
    widgetAdded: ISignal<IHTMLViewerTracker, HTMLViewer>;
    widgetUpdated: ISignal<IHTMLViewerTracker, HTMLViewer>;
    dispose(): void;
    filter(fn): HTMLViewer[];
    find(fn): undefined | HTMLViewer;
    forEach(fn): void;
    has(obj): boolean;
    inject(obj): void;
}

Hierarchy (view full)

Properties

currentChanged: ISignal<IHTMLViewerTracker, null | HTMLViewer>

A signal emitted when the current instance changes.

Notes

If the last instance being tracked is disposed, null will be emitted.

currentWidget: null | HTMLViewer

The current widget is the most recently focused or added widget.

Notes

It is the most recently focused widget, or the most recently added widget if no widget has taken focus.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

restored: Promise<void>

A promise that is resolved when the widget tracker has been restored from a serialized state.

Notes

Most client code will not need to use this, since they can wait for the whole application to restore. However, if an extension wants to perform actions during the application restoration, but after the restoration of another widget tracker, they can use this promise.

size: number

The number of instances held by the tracker.

A signal emitted when a widget is added.

A signal emitted when a widget is updated.

Methods

  • 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

  • Filter the instances in the tracker based on a predicate.

    Parameters

    • fn: ((obj) => boolean)

      The function by which to filter.

        • (obj): boolean
        • Parameters

          Returns boolean

    Returns HTMLViewer[]

  • Find the first instance in the tracker that satisfies a filter function.

    Parameters

    • fn: ((obj) => boolean)

      The filter function to call on each instance.

      Notes

      If nothing is found, the value returned is undefined.

        • (obj): boolean
        • Parameters

          Returns boolean

    Returns undefined | HTMLViewer

  • Iterate through each instance in the tracker.

    Parameters

    • fn: ((obj) => void)

      The function to call on each instance.

    Returns void

  • Check if this tracker has the specified instance.

    Parameters

    • obj: Widget

      The object whose existence is being checked.

    Returns boolean

  • Inject an instance into the widget tracker without the tracker handling its restoration lifecycle.

    Parameters

    • obj: HTMLViewer

      The instance to inject into the tracker.

    Returns void