Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KernelProxyPart

This part is a proxy/wrapper around kernel parts that live on the Kernel. The KPP uses a comm to connect to a kernel-side KernelPartManager, and use that to manage the lifecycle of a kernelside part.

Each part connects over the same comm, and that comm provides some helpers for syncing the available parts with the client-side part factory

Hierarchy

  • Part
    • KernelProxyPart

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Constructors

constructor

Properties

CancelRequested

CancelRequested: Observable<void>

RefreshRequested

RefreshRequested: Observable<boolean>

An observable that emits whenever this part should refresh. The PartManager will handle this event by evaluating any stale options and re-rendering the part.

Private bag

bag: OptionsBag | null = null

Private comm

comm: CommManager<Msg.KernelProxyMessage, Msg.KernelResponseMessage>

Protected context

context: PartServices

A set of helper methods for using the framework interactions, such as opening tooltips.

dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

id

id: string

Set the id of the widget's DOM node.

isAttached

isAttached: boolean

Test whether the widget's node is attached to the DOM.

isCanceled

isCanceled: boolean

Whether the part's current state is canceled.

isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

isError

isError: boolean

Whether the part's current state is an error.

isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

isIdle

isIdle: boolean

Whether this part is idle.

Notes

A part is idle if it is not initializing, rendering, or having any of it's options calculated.

isInitialized

isInitialized: boolean

Whether this part has completely initialized.

isVisible

isVisible: boolean

Test whether the widget is visible.

Notes

A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

layout

layout: StackedLayout

Private model

model: MimeModel | null = null

Private msgId

msgId: string

node

node: HTMLElement

Get the DOM node owned by the widget.

parent

parent: Widget | null

Set the parent of the widget.

Notes

Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.

Private renderer

renderer: IRenderer | null = null

state

state: State

The current state of the part

stateDetail

stateDetail: unknown

An object that describes additional detail about the state of this part. If the state is Error, the detail will be the actual error thrown. If the state is Calculating, the detail will be a string list of currently calculating options.

title

title: Title<Widget>

The title object for the widget.

Notes

The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Protected type

type: string

uuid

uuid: string

An external ID that this part will be referenced by

Static _FactoryName

_FactoryName: string

A static identifier for this part set by PartFactory#registerPart.

Methods

activate

  • activate(): void
  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): void
  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

cancel

  • cancel(): void
  • Request that the framework stop evaluating this part's options.

    Returns void

children

  • children(): IIterator<Widget>
  • Create an iterator over the widget's children.

    Returns IIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • clearFlag(flag: Flag): void
  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

close

  • close(): void
  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean
  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

dispose

  • dispose(): void

error

  • error(detail: any, type: "init-error" | "render-error" | "option-error"): void
  • Convenience for sending an error message to this part

    Parameters

    • detail: any
    • type: "init-error" | "render-error" | "option-error"

    Returns void

fit

  • fit(): void
  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

getName

  • getName(): string

hasClass

  • hasClass(name: string): boolean
  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • hide(): void
  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

initialize

  • initialize(): Promise<void>

Protected notifyLayout

  • notifyLayout(msg: Message): void
  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void
  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void
  • A message handler invoked on an 'after-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterCalculate

  • onAfterCalculate(msg: Message): void
  • The framework has successfully calculated all this part's options.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void
  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg: Message): void
  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterInitialize

  • onAfterInitialize(msg: Message): void
  • This part initialized successfully, and is now idle.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onAfterRender

  • onAfterRender(msg: Message): void
  • This part rendered successfully, and is now idle.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void
  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void
  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeCalculate

  • onBeforeCalculate(msg: Message): void
  • The framework is about to calculate this part's options

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void
  • A message handler invoked on a 'before-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void
  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeInitialize

  • onBeforeInitialize(msg: Message): void
  • This part is about to initialize.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onBeforeRender

  • onBeforeRender(msg: Message): void
  • This part is about to render.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void
  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onCancel

  • onCancel(msg: Message): void
  • The part's option evaluations have been canceled.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • onChildAdded(msg: ChildMessage): void
  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

Protected onChildRemoved

  • onChildRemoved(msg: ChildMessage): void
  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void
  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onError

  • onError(msg: ErrorMessage): void
  • An error occurred while this part was being evaluated.

    The message can be investigated for more detail, such as when the error occurred or any detail provided with the error (such as a stack trace)

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: ErrorMessage

    Returns void

Protected onFitRequest

  • onFitRequest(msg: Message): void
  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onOptionCalculated

  • onOptionCalculated(msg: CalculatingMessage): void
  • An option, or set of options, has finished calculating

    Notes

    The default implementation of this function is a no-op. If an option errored out, it will be included in this message.

    Parameters

    • msg: CalculatingMessage

    Returns void

Protected onOptionCalculating

  • onOptionCalculating(msg: CalculatingMessage): void
  • An option, or set of options, is now calculating.

    Notes

    The default implementation of this function is a no-op

    Parameters

    • msg: CalculatingMessage

    Returns void

Protected onResize

  • onResize(msg: ResizeMessage): void
  • A message handler invoked on a 'resize' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void
  • A message handler invoked on an 'update-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

optionCalculating

  • optionCalculating(type: "before-option-calc" | "after-option-calc", optionOrOptions: Iterable<string> | string): void
  • Convenience for sending option calculation updates to this part

    Parameters

    • type: "before-option-calc" | "after-option-calc"
    • optionOrOptions: Iterable<string> | string

    Returns void

processMessage

  • processMessage(msg: Message): void
  • Handle Phosphor messages.

    Notes

    This function should not be called by user code.

    Parameters

    • msg: Message

    Returns void

refresh

  • refresh(): void
  • Request that the framework refresh this part as soon as possible. This is used to do things like clearing error state and reconstructing IFrames after being removed from the DOM.

    Returns void

removeClass

  • removeClass(name: string): void
  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

render

  • render(opts: OptionsBag): Promise<void>

setFlag

  • setFlag(flag: Flag): void
  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setHidden

  • setHidden(hidden: boolean): void
  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

setup

  • setup(): Promise<void>

show

  • show(): void
  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

testFlag

  • testFlag(flag: Flag): boolean
  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: undefined | false | true): boolean
  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: undefined | false | true

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void
  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

userRefresh

  • userRefresh(): void
  • This indicates a refresh was requested by the user.

    Returns void

Static GetMetadata

  • GetMetadata(): PartMetadata
  • Gets the metadata for this part. Override this function to define the options your part will have.

    Returns PartMetadata

    A data structure representing all the options and other metadata about this part.

Generated using TypeDoc