Interface IWidgetFactory<T, U>

The interface for a widget factory.

interface IWidgetFactory<
    T extends IDocumentWidget,
    U extends DocumentRegistry.IModel,
> {
    autoStartDefault?: boolean;
    canStartKernel?: boolean;
    contentProviderId?: string;
    defaultFor?: readonly string[];
    defaultRendered?: readonly string[];
    fileTypes: readonly string[];
    isDisposed: boolean;
    label?: string;
    modelName?: string;
    name: string;
    preferKernel?: boolean;
    readOnly?: boolean;
    shutdownOnClose?: boolean;
    toolbarFactory?: (
        widget: Widget,
    ) =>
        | DocumentRegistry.IToolbarItem[]
        | IObservableList<DocumentRegistry.IToolbarItem>;
    translator?: IRenderMime.ITranslator;
    widgetCreated: ISignal<IWidgetFactory<T, U>, T>;
    createNew(context: IContext<U>, source?: T): T;
    dispose(): void;
}

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

autoStartDefault? canStartKernel? contentProviderId? defaultFor? defaultRendered? fileTypes isDisposed label? modelName? name preferKernel? readOnly? shutdownOnClose? toolbarFactory? translator? widgetCreated

Methods

createNew dispose

Properties

Optional ReadonlyautoStartDefault

autoStartDefault?: boolean

Whether to automatically start the preferred kernel

Optional ReadonlycanStartKernel

canStartKernel?: boolean

Whether the widgets can start a kernel when opened.

Optional ExperimentalcontentProviderId

contentProviderId?: string

Identifier of the content provider required for the widget (if any).

Optional ReadonlydefaultFor

defaultFor?: readonly string[]

The file types for which the factory should be the default.

Optional ReadonlydefaultRendered

defaultRendered?: readonly string[]

The file types for which the factory should be the default for rendering, if that is different than the default factory (which may be for editing) If undefined, then it will fall back on the default file type.

ReadonlyfileTypes

fileTypes: readonly string[]

The file types the widget can view.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Optional Readonlylabel

label?: string

The label of the widget to display in dialogs. If not given, name is used instead.

Optional ReadonlymodelName

modelName?: string

The name of the document model type.

Readonlyname

name: string

The name of the widget to display in dialogs.

Optional ReadonlypreferKernel

preferKernel?: boolean

Whether the widgets prefer having a kernel started.

Optional ReadonlyreadOnly

readOnly?: boolean

Whether the widget factory is read only.

Optional ReadonlyshutdownOnClose

shutdownOnClose?: boolean

Whether the kernel should be shutdown when the widget is closed.

Optional ReadonlytoolbarFactory

toolbarFactory?: (
    widget: Widget,
) =>
    | DocumentRegistry.IToolbarItem[]
    | IObservableList<DocumentRegistry.IToolbarItem>

A function producing toolbar widgets, overriding the default toolbar widgets.

Optional Readonlytranslator

translator?: IRenderMime.ITranslator

The application language translator.

widgetCreated

widgetCreated: ISignal<IWidgetFactory<T, U>, T>

A signal emitted when a new widget is created.

Methods

createNew

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

Settings

Member Visibility

On This Page

Properties
Methods