Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccordionPanel

A panel which arranges its widgets into resizable sections separated by a title widget. The namespace for the AccordionPanel class statics.

Notes

This class provides a convenience wrapper around AccordionLayout.

Hierarchy

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Classes

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static Alignment

Alignment: Alignment

A type alias for a split panel alignment. A type alias for a accordion panel alignment.

Static IRenderer

IRenderer: IRenderer

A type alias for a split panel renderer. A type alias for a accordion panel renderer.

Static Orientation

Orientation: Orientation

A type alias for a split panel orientation. A type alias for a accordion panel orientation.

Constructors

constructor

Properties

Private _widgetSizesCache

_widgetSizesCache: WeakMap<Widget, number> = new WeakMap()

node

node: HTMLElement

Get the DOM node owned by the widget.

Static defaultRenderer

defaultRenderer: Renderer = new Renderer()

The default Renderer instance. The default Renderer instance.

Accessors

alignment

dataset

  • get dataset(): DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

handleMoved

  • get handleMoved(): ISignal<this, void>

handles

  • get handles(): ReadonlyArray<HTMLDivElement>

hiddenMode

id

  • get id(): string
  • set id(value: string): 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

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>

titleSpace

  • get titleSpace(): number
  • set titleSpace(value: number): void

  • The section title space.

    This is the height if the panel is vertical and the width if it is horizontal.

    Returns number

  • The section title space.

    This is the height if the panel is vertical and the width if it is horizontal.

    Parameters

    • value: number

    Returns void

titles

  • get titles(): ReadonlyArray<HTMLElement>

widgets

  • get widgets(): ReadonlyArray<Widget>

Methods

Private _computeWidgetSize

  • _computeWidgetSize(index: number): number[] | undefined

  • Compute the size of widgets in this panel on the title click event. On closing, the size of the widget is cached and we will try to expand the last opened widget. On opening, we will use the cached size if it is available to restore the widget. In both cases, if we can not compute the size of widgets, we will let SplitLayout decide.

    Parameters

    • index: number

      The index of widget to be opened of closed

    Returns number[] | undefined

    Relative size of widgets in this panel, if this size can not be computed, return undefined

Private _eventKeyDown

  • _eventKeyDown(event: KeyboardEvent): void

Private _evtClick

  • _evtClick(event: MouseEvent): void

Private _onTitleChanged

Private _toggleExpansion

  • _toggleExpansion(index: number): void

activate

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

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

close

  • close(): void

collapse

  • collapse(index: number): 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

expand

  • expand(index: number): void

fit

  • fit(): void

handleEvent

  • handleEvent(event: Event): void

  • Handle the DOM events for the accordion 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

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

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterHide

  • onAfterHide(msg: Message): void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

Protected onChildAdded

Protected onChildRemoved

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onFitRequest

  • onFitRequest(msg: Message): void

Protected onResize

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

processMessage

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

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[], update?: boolean): void

  • Set the relative sizes for the widgets in the panel.

    Parameters

    • sizes: number[]

      The relative sizes for the widgets in the panel.

    • Default value update: boolean = true

      Update the layout after setting relative sizes. Default is True.

      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

testFlag

  • testFlag(flag: Flag): 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

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