Class ABCWidgetFactory<T, U>Abstract

The default implementation of a widget factory.

Type Parameters

Hierarchy

Implements

Constructors

Properties

_autoStartDefault: any
_canStartKernel: any
_defaultFor: any
_defaultRendered: any
_fileTypes: any
_isDisposed: any
_label: any
_modelName: any
_name: any
_preferKernel: any
_readOnly: any
_shutdownOnClose: any
_toolbarFactory: any
_translator: any
_widgetCreated: any

Accessors

  • get autoStartDefault(): boolean
  • Whether to automatically select the preferred kernel during a kernel start

    Returns boolean

  • set autoStartDefault(value): void
  • Whether to automatically start the preferred kernel

    Parameters

    • value: boolean

    Returns void

  • get canStartKernel(): boolean
  • Whether the widgets can start a kernel when opened.

    Returns boolean

  • get defaultFor(): string[]
  • The file types for which the factory should be the default.

    Returns string[]

  • get defaultRendered(): string[]
  • The file types for which the factory should be the default for rendering a document model, if different from editing.

    Returns string[]

  • get fileTypes(): string[]
  • The file types the widget can view.

    Returns string[]

  • get isDisposed(): boolean
  • Get whether the model factory has been disposed.

    Returns boolean

  • get label(): string
  • The label of the widget to display in dialogs. If not given, name is used instead.

    Returns string

  • get modelName(): string
  • The registered name of the model type used to create the widgets.

    Returns string

  • get name(): string
  • A unique name identifying of the widget.

    Returns string

  • get preferKernel(): boolean
  • Whether the widgets prefer having a kernel started.

    Returns boolean

  • get readOnly(): boolean
  • Whether the widget factory is read only.

    Returns boolean

  • get shutdownOnClose(): boolean
  • Whether the kernel should be shutdown when the widget is closed.

    Returns boolean

  • set shutdownOnClose(value): void
  • Whether the kernel should be shutdown when the widget is closed.

    Parameters

    • value: boolean

    Returns void

Methods

  • Create a new widget given a document model and a context.

    Notes

    It should emit the [widgetCreated] signal with the new widget.

    Parameters

    • context: IContext<U>
    • Optional source: T

    Returns T

  • Create a widget for a context.

    Parameters

    • context: IContext<U>
    • Optional source: T

    Returns T

  • Dispose of the resources used by the document manager.

    Returns void

Generated using TypeDoc