Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Part
    • UDPWrapperPart

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 bubbleHandler

bubbleHandler: DisposableDelegate | undefined

configObject

configObject: IUDPModel

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.

Private frame

frame: Widget

Private frameSetupMutex

frameSetupMutex: Mutex = new AsyncTools.Mutex()

Private hasInitialized

hasInitialized: boolean = false

Private hasSetupFrame

hasSetupFrame: boolean = false

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.

isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

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 mustWaitForSetup

mustWaitForSetup: boolean = false

node

node: HTMLElement

Get the DOM node owned by the widget.

Private onFrameSetup

onFrameSetup: PromiseDelegate<void> = new PromiseDelegate<void>()

Private onInitialized

onInitialized: PromiseDelegate<IUDPThisBinding> = new PromiseDelegate<IUDPThisBinding>()

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 path

path: string

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.

Private udpThis

udpThis: IUDPThisBinding | undefined

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.

Accessors

isCanceled

  • get isCanceled(): boolean

isError

  • get isError(): boolean
  • Whether the part's current state is an error.

    Returns boolean

isIdle

  • get 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.

    Returns boolean

isInitialized

  • get isInitialized(): boolean

state

stateDetail

  • get 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.

    Returns unknown

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
  • Get the name of this part as it appeared in the factory.

    remarks

    Wrapper parts may override this and provide their own behavior.

    Returns 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>

Private isFrameValid

  • isFrameValid(): boolean
  • A helper function to affirm that the frame is in a healthy state.

    This is to ensure that the frame remains in a consistent state after a display:none or detatch/reattach. Some of these actions are destructive to the frame (depending on browser), so if the frame is no longer in a good state it needs to be fixed.

    Returns boolean

Private maybeRefreshFrame

  • maybeRefreshFrame(): Promise<undefined>
  • Refresh the part if the frame is invalid.

    see

    verifyFrameValidity

    Returns Promise<undefined>

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(): Promise<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(): 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(): 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

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

  • 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

    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

  • 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

    Returns void

Protected onOptionCalculating

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

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

Private setupFrame

  • setupFrame(): 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

Static GetMetadata

  • 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