Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutManager

Base layout for Maven Dashboards

This class manages the layout operations of a set of widgets, which are arranged in a tree and consist of DashboardLayoutRegions. These regions have a set of layout properties that describe appearance and layout behavior- for instance, all regions have properties like borderWidth.px and borderColor.

Hierarchy

  • Widget
    • LayoutManager

Implements

  • IMessageHandler
  • IObservableDisposable
  • IDirtyable

Index

Modules

Enumerations

Classes

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _OnDirty

_OnDirty: Observable<void> = this._OnDirtySrc.asObservable()

Private _OnDirtySrc

_OnDirtySrc: Subject<void> = new Subject<void>()

Private _focusedRegion

_focusedRegion: DashboardLayoutRegion<any> | null = null

Private _forceTitlebars

_forceTitlebars: boolean = false

Private _isDirty

_isDirty: boolean = false

Private _maximizedRegion

_maximizedRegion: DashboardLayoutRegion<any> | null = null

Private _onFocusedChanged

_onFocusedChanged: Signal<this, null | DashboardLayoutRegion<any>> = new Signal<this, DashboardLayoutRegion<any> | null>(this)

dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

dockPreview

dockPreview: DockPreview

Private externalParts

externalParts: Map<string, Widget> = new Map<string, Widget>()

Private factory

factory: IFactory

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: PanelLayout

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 partManager

partManager: IPartManager

root

root: StackPanelLayoutRegion

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.

Accessors

OnDirty

  • get OnDirty(): Observable<void>

  • An Observable that emits whenever this layout becomes dirty

    Returns Observable<void>

bounds

  • get bounds(): object

focusedRegion

focusedRegionChanged

  • A signal that emits when the focused layout region changes.

    Notes

    A region's focus is not related to DOM focus.

    see

    DashboardLayoutRegion.LayoutMsg.BeforeFocus

    Returns ISignal<this, DashboardLayoutRegion<any> | null>

forceTitlebars

  • get forceTitlebars(): boolean
  • set forceTitlebars(force: boolean): void

isDirty

  • get isDirty(): boolean

Methods

Private _handleFocus

  • _handleFocus(ev: FocusEvent): void

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

addPartToRegion

  • addPartToRegion(target: string, type: string): Promise<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

fit

  • fit(): void

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

getParentRegion

getPart

  • getPart(id: string): undefined | Widget

getRegion

handleEvent

  • handleEvent(ev: FocusEvent): void

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

initLayout

moveToRelativeZone

  • moveToRelativeZone(zone: RelativeDropZone, target: string, reference: string): void

moveToRootZone

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

processMessage

  • processMessage(msg: Message): void

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    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

removeRegion

  • removeRegion(uuid: string): void

setClean

  • setClean(): void

  • Mark this layout as having been synchronized with the model

    Returns void

Private setDirty

  • setDirty(): void

setExternalParts

  • setExternalParts(parts: Map<string, Widget>): 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

Private setFocusedRegion

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

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

showAddPartDialog

  • showAddPartDialog(): Promise<undefined | null>

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

Protected updateMaximizedRegion

  • updateMaximizedRegion(): void

Static attach

  • attach(widget: Widget, host: HTMLElement, ref?: HTMLElement | null): void

  • Attach a widget to a host DOM node.

    Parameters

    • widget: Widget

      The widget of interest.

    • host: HTMLElement

      The DOM node to use as the widget's host.

    • Optional ref: HTMLElement | null

      The child of host to use as the reference element. If this is provided, the widget will be inserted before this node in the host. The default is null, which will cause the widget to be added as the last child of the host.

      Notes

      This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.

    Returns void

Static detach

  • detach(widget: Widget): void

  • Detach the widget from its host DOM node.

    Parameters

    • widget: Widget

      The widget of interest.

      Notes

      This will throw an error if the widget is not a root widget, or if the widget is not attached to the DOM.

    Returns void

Generated using TypeDoc