Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SplitPanel

A panel which arranges its widgets into resizable sections. The namespace for the SplitPanel class statics.

Notes

This class provides a convenience wrapper around a SplitLayout.

Hierarchy

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Type aliases

Static Alignment

Alignment: Alignment

A type alias for a split panel alignment.

Static IRenderer

IRenderer: IRenderer

A type alias for a split panel renderer.

Static Orientation

Orientation: Orientation

A type alias for a split panel orientation.

Constructors

constructor

Properties

Private _pressData

_pressData: IPressData | null = null

node

node: HTMLElement

Get the DOM node owned by the widget.

Static defaultRenderer

defaultRenderer: Renderer = new Renderer()

The default Renderer instance.

Accessors

alignment

  • Get the content alignment for the split panel.

    Notes

    This is the alignment of the widgets in the layout direction.

    The alignment has no effect if the widgets can expand to fill the entire split panel.

    Returns Alignment

  • Set the content alignment for the split panel.

    Notes

    This is the alignment of the widgets in the layout direction.

    The alignment has no effect if the widgets can expand to fill the entire split panel.

    Parameters

    Returns void

dataset

  • get dataset(): DOMStringMap

disposed

  • get disposed(): ISignal<this, void>
  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

handles

  • get handles(): ReadonlyArray<HTMLDivElement>
  • A read-only array of the split handles in the panel.

    Returns ReadonlyArray<HTMLDivElement>

id

  • get id(): string
  • set id(value: string): void
  • Get the id of the widget's DOM node.

    Returns string

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

isDisposed

  • get isDisposed(): boolean

isHidden

  • get isHidden(): boolean

isVisible

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

    Returns boolean

layout

  • get layout(): Layout | null
  • set layout(value: Layout | null): void
  • Get the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Returns Layout | null

  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    Returns void

orientation

parent

  • get parent(): Widget | null
  • set parent(value: Widget | null): void
  • Get 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.

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

    Parameters

    Returns void

renderer

spacing

  • get spacing(): number
  • set spacing(value: number): void
  • Get the inter-element spacing for the split panel.

    Returns number

  • Set the inter-element spacing for the split panel.

    Parameters

    • value: number

    Returns void

title

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

    Returns Title<Widget>

widgets

  • get widgets(): ReadonlyArray<Widget>

Methods

Private _evtKeyDown

  • _evtKeyDown(event: KeyboardEvent): void
  • Handle the 'keydown' event for the split panel.

    Parameters

    • event: KeyboardEvent

    Returns void

Private _evtMouseDown

  • _evtMouseDown(event: MouseEvent): void
  • Handle the 'mousedown' event for the split panel.

    Parameters

    • event: MouseEvent

    Returns void

Private _evtMouseMove

  • _evtMouseMove(event: MouseEvent): void
  • Handle the 'mousemove' event for the split panel.

    Parameters

    • event: MouseEvent

    Returns void

Private _evtMouseUp

  • _evtMouseUp(event: MouseEvent): void
  • Handle the 'mouseup' event for the split panel.

    Parameters

    • event: MouseEvent

    Returns void

Private _releaseMouse

  • _releaseMouse(): void
  • Release the mouse grab for the split panel.

    Returns 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

addWidget

  • addWidget(widget: Widget): void
  • Add a widget to the end of the panel.

    Parameters

    • widget: Widget

      The widget to add to the panel.

      Notes

      If the widget is already contained in the panel, it will be moved.

    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

    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

handleEvent

  • handleEvent(event: Event): void
  • Handle the DOM events for the split panel.

    Parameters

    • event: Event

      The DOM event sent to the panel.

      Notes

      This method implements the DOM EventListener interface and is called in response to events on the panel's DOM node. It should not be called directly by user code.

    Returns 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

insertWidget

  • insertWidget(index: number, widget: Widget): void
  • Insert a widget at the specified index.

    Parameters

    • index: number

      The index at which to insert the widget.

    • widget: Widget

      The widget to insert into to the panel.

      Notes

      If the widget is already contained in the panel, it will be moved.

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

  • onAfterDetach(msg: Message): 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

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

Protected onChildRemoved

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

  • A message handler invoked on a 'resize' message.

    Notes

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

    Parameters

    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

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

relativeSizes

  • relativeSizes(): number[]
  • Get the relative sizes of the widgets in the panel.

    Returns number[]

    A new array of the relative sizes of the widgets.

    Notes

    The returned sizes reflect the sizes of the widgets normalized relative to their siblings.

    This method does not measure the DOM nodes.

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

setFlag

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

    Notes

    This will not typically be called directly by user code.

    Parameters

    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

setRelativeSizes

  • setRelativeSizes(sizes: number[]): void
  • Set the relative sizes for the widgets in the panel.

    Parameters

    • sizes: number[]

      The relative sizes for the widgets in the panel.

      Notes

      Extra values are ignored, too few will yield an undefined layout.

      The actual geometry of the DOM nodes is updated asynchronously.

    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

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

    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

Static getStretch

  • getStretch(widget: Widget): number
  • Get the split panel stretch factor for the given widget.

    Parameters

    • widget: Widget

      The widget of interest.

    Returns number

    The split panel stretch factor for the widget.

Static setStretch

  • setStretch(widget: Widget, value: number): void
  • Set the split panel stretch factor for the given widget.

    Parameters

    • widget: Widget

      The widget of interest.

    • value: number

      The value for the stretch factor.

    Returns void

Generated using TypeDoc