Class AccordionPanel

A panel which arranges its widgets into resizable sections separated by a title widget.

Notes

This class provides a convenience wrapper around AccordionLayout.

Hierarchy (view full)

SplitPanel
- AccordionPanel

Constructors

constructor

new AccordionPanel(options?): AccordionPanel
Construct a new accordion panel.
Parameters
- options: AccordionPanel.IOptions = {}
  The options for initializing the accordion panel.
Returns AccordionPanel
Overrides SplitPanel.constructor
- Defined in widgets/src/accordionpanel.ts:25

Properties

`Private` _expansionToggled

_expansionToggled: Signal<AccordionPanel, number> = ...

`Private` _widgetSizesCache

_widgetSizesCache: WeakMap<Widget, number> = ...

`Readonly` node

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

alignment

get alignment(): SplitLayout.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 SplitLayout.Alignment
Inherited from SplitPanel.alignment
- Defined in widgets/src/splitpanel.ts:74
set alignment(value): void
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
- value: SplitLayout.Alignment
Returns void
Inherited from SplitPanel.alignment
- Defined in widgets/src/splitpanel.ts:87

dataset

get dataset(): DOMStringMap
The dataset for the widget's DOM node.

Returns DOMStringMap
Inherited from SplitPanel.dataset
- Defined in widgets/src/widget.ts:163

disposed

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

Returns ISignal<this, void>
Inherited from SplitPanel.disposed
- Defined in widgets/src/widget.ts:90

expansionToggled

get expansionToggled(): ISignal<this, number>
A signal emitted when a widget of the AccordionPanel is collapsed or expanded.

Returns ISignal<this, number>
- Defined in widgets/src/accordionpanel.ts:60

handleMoved

get handleMoved(): ISignal<this, void>
A signal emitted when a split handle has moved.

Returns ISignal<this, void>
Inherited from SplitPanel.handleMoved
- Defined in widgets/src/splitpanel.ts:115

handles

get handles(): readonly HTMLDivElement[]
A read-only array of the split handles in the panel.

Returns readonly HTMLDivElement[]
Inherited from SplitPanel.handles
- Defined in widgets/src/splitpanel.ts:122

hiddenMode

get hiddenMode(): HiddenMode
Get the method for hiding the widget.

Returns HiddenMode
Inherited from SplitPanel.hiddenMode
- Defined in widgets/src/widget.ts:170
set hiddenMode(value): void
Set the method for hiding the widget.
Parameters
- value: HiddenMode
Returns void
Inherited from SplitPanel.hiddenMode
- Defined in widgets/src/widget.ts:177

id

get id(): string
Get the id of the widget's DOM node.

Returns string
Inherited from SplitPanel.id
- Defined in widgets/src/widget.ts:149
set id(value): void
Set the id of the widget's DOM node.
Parameters
- value: string
Returns void
Inherited from SplitPanel.id
- Defined in widgets/src/widget.ts:156

isAttached

get isAttached(): boolean
Test whether the widget's node is attached to the DOM.

Returns boolean
Inherited from SplitPanel.isAttached
- Defined in widgets/src/widget.ts:109

isDisposed

get isDisposed(): boolean
Test whether the widget has been disposed.

Returns boolean
Inherited from SplitPanel.isDisposed
- Defined in widgets/src/widget.ts:102

isHidden

get isHidden(): boolean
Test whether the widget is explicitly hidden.

Returns boolean
Inherited from SplitPanel.isHidden
- Defined in widgets/src/widget.ts:116

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
Inherited from SplitPanel.isVisible
- Defined in widgets/src/widget.ts:127

layout

get layout(): null | Layout
Get the layout for the widget.

Returns null | Layout
Inherited from SplitPanel.layout
- Defined in widgets/src/widget.ts:243
set layout(value): void
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
- value: null | Layout
Returns void
Inherited from SplitPanel.layout
- Defined in widgets/src/widget.ts:256

orientation

get orientation(): SplitLayout.Orientation
Get the layout orientation for the split panel.

Returns SplitLayout.Orientation
Inherited from SplitPanel.orientation
- Defined in widgets/src/splitpanel.ts:54
set orientation(value): void
Set the layout orientation for the split panel.
Parameters
- value: SplitLayout.Orientation
Returns void
Inherited from SplitPanel.orientation
- Defined in widgets/src/splitpanel.ts:61

parent

get parent(): null | Widget
Get the parent of the widget.

Returns null | Widget
Inherited from SplitPanel.parent
- Defined in widgets/src/widget.ts:204
set parent(value): void
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
- value: null | Widget
Returns void
Inherited from SplitPanel.parent
- Defined in widgets/src/widget.ts:219

renderer

get renderer(): AccordionLayout.IRenderer
The renderer used by the accordion panel.

Returns AccordionLayout.IRenderer
Overrides SplitPanel.renderer
- Defined in widgets/src/accordionpanel.ts:33

spacing

get spacing(): number
Get the inter-element spacing for the split panel.

Returns number
Inherited from SplitPanel.spacing
- Defined in widgets/src/splitpanel.ts:94
set spacing(value): void
Set the inter-element spacing for the split panel.
Parameters
- value: number
Returns void
Inherited from SplitPanel.spacing
- Defined in widgets/src/splitpanel.ts:101

title

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

Returns Title<Widget>
Inherited from SplitPanel.title
- Defined in widgets/src/widget.ts:142

titleSpace

get titleSpace(): number
The section title space.

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

Returns number
- Defined in widgets/src/accordionpanel.ts:43
set titleSpace(value): void
Parameters
- value: number
Returns void
- Defined in widgets/src/accordionpanel.ts:46

titles

get titles(): readonly HTMLElement[]
A read-only array of the section titles in the panel.

Returns readonly HTMLElement[]
- Defined in widgets/src/accordionpanel.ts:53

widgets

get widgets(): readonly Widget[]
A read-only array of the widgets in the panel.

Returns readonly Widget[]
Inherited from SplitPanel.widgets
- Defined in widgets/src/panel.ts:39

Methods

`Private` _computeWidgetSize

_computeWidgetSize(index): undefined | number[]
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 undefined | number[]
Relative size of widgets in this panel, if this size can not be computed, return undefined
- Defined in widgets/src/accordionpanel.ts:192

`Private` _eventKeyDown

_eventKeyDown(event): void
Handle the 'keydown' event for the accordion panel.
Parameters
- event: KeyboardEvent
Returns void
- Defined in widgets/src/accordionpanel.ts:272

`Private` _evtClick

_evtClick(event): void
Handle the 'click' event for the accordion panel
Parameters
- event: MouseEvent
Returns void
- Defined in widgets/src/accordionpanel.ts:253

`Private` _onTitleChanged

_onTitleChanged(sender): void
Handle the changed signal of a title object.
Parameters
- sender: Title<Widget>
Returns void
- Defined in widgets/src/accordionpanel.ts:167

`Private` _toggleExpansion

_toggleExpansion(index): void
Parameters
- index: number
Returns void
- Defined in widgets/src/accordionpanel.ts:323

activate

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

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from SplitPanel.activate
- Defined in widgets/src/widget.ts:396

addClass

addClass(name): 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
Inherited from SplitPanel.addClass
- Defined in widgets/src/widget.ts:326

addWidget

addWidget(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
Overrides SplitPanel.addWidget
- Defined in widgets/src/accordionpanel.ts:72

children

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

Returns IterableIterator<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.
Inherited from SplitPanel.children
- Defined in widgets/src/widget.ts:283

clearFlag

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

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns void
Inherited from SplitPanel.clearFlag
- Defined in widgets/src/widget.ts:506

close

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

Notes
This is a simple convenience method for sending the message.

Returns void
Inherited from SplitPanel.close
- Defined in widgets/src/widget.ts:406

collapse

collapse(index): void
Collapse the widget at position index.

Notes
If no widget is found for index, this will bail.
Parameters
- index: number
  Widget index
Returns void
- Defined in widgets/src/accordionpanel.ts:85

contains

contains(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.
Inherited from SplitPanel.contains
- Defined in widgets/src/widget.ts:296

dispose

dispose(): void
Dispose of the resources held by the panel.

Returns void
Inherited from SplitPanel.dispose
- Defined in widgets/src/splitpanel.ts:46

expand

expand(index): void
Expand the widget at position index.

Notes
If no widget is found for index, this will bail.
Parameters
- index: number
  Widget index
Returns void
- Defined in widgets/src/accordionpanel.ts:101

fit

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

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from SplitPanel.fit
- Defined in widgets/src/widget.ts:386

handleEvent

handleEvent(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
Overrides SplitPanel.handleEvent
- Defined in widgets/src/accordionpanel.ts:134

hasClass

hasClass(name): 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.
Inherited from SplitPanel.hasClass
- Defined in widgets/src/widget.ts:312

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
Inherited from SplitPanel.hide
- Defined in widgets/src/widget.ts:445

insertWidget

insertWidget(index, 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
Overrides SplitPanel.insertWidget
- Defined in widgets/src/accordionpanel.ts:119

`Protected` notifyLayout

notifyLayout(msg): 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
Inherited from SplitPanel.notifyLayout
- Defined in widgets/src/widget.ts:604

`Protected` onActivateRequest

onActivateRequest(msg): 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
Inherited from SplitPanel.onActivateRequest
- Defined in widgets/src/widget.ts:654

`Protected` onAfterAttach

onAfterAttach(msg): 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
Inherited from SplitPanel.onAfterAttach
- Defined in widgets/src/widget.ts:702

`Protected` onAfterDetach

onAfterDetach(msg): void
A message handler invoked on an 'after-detach' message.
Parameters
- msg: Message
Returns void
Overrides SplitPanel.onAfterDetach
- Defined in widgets/src/accordionpanel.ts:158

`Protected` onAfterHide

onAfterHide(msg): 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
Inherited from SplitPanel.onAfterHide
- Defined in widgets/src/widget.ts:686

`Protected` onAfterShow

onAfterShow(msg): 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
Inherited from SplitPanel.onAfterShow
- Defined in widgets/src/widget.ts:670

`Protected` onBeforeAttach

onBeforeAttach(msg): void
A message handler invoked on a 'before-attach' message.
Parameters
- msg: Message
Returns void
Overrides SplitPanel.onBeforeAttach
- Defined in widgets/src/accordionpanel.ts:149

`Protected` onBeforeDetach

onBeforeDetach(msg): 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
Inherited from SplitPanel.onBeforeDetach
- Defined in widgets/src/widget.ts:710

`Protected` onBeforeHide

onBeforeHide(msg): 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
Inherited from SplitPanel.onBeforeHide
- Defined in widgets/src/widget.ts:678

`Protected` onBeforeShow

onBeforeShow(msg): 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
Inherited from SplitPanel.onBeforeShow
- Defined in widgets/src/widget.ts:662

`Protected` onChildAdded

onChildAdded(msg): void
A message handler invoked on a 'child-added' message.
Parameters
- msg: ChildMessage
Returns void
Inherited from SplitPanel.onChildAdded
- Defined in widgets/src/splitpanel.ts:206

`Protected` onChildRemoved

onChildRemoved(msg): void
A message handler invoked on a 'child-removed' message.
Parameters
- msg: ChildMessage
Returns void
Inherited from SplitPanel.onChildRemoved
- Defined in widgets/src/splitpanel.ts:214

`Protected` onCloseRequest

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

Notes
The default implementation unparents or detaches the widget.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onCloseRequest
- Defined in widgets/src/widget.ts:616

`Protected` onFitRequest

onFitRequest(msg): 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
Inherited from SplitPanel.onFitRequest
- Defined in widgets/src/widget.ts:646

`Protected` onResize

onResize(msg): 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
Inherited from SplitPanel.onResize
- Defined in widgets/src/widget.ts:630

`Protected` onUpdateRequest

onUpdateRequest(msg): 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
Inherited from SplitPanel.onUpdateRequest
- Defined in widgets/src/widget.ts:638

processMessage

processMessage(msg): 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
Inherited from SplitPanel.processMessage
- Defined in widgets/src/widget.ts:518

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.
Inherited from SplitPanel.relativeSizes
- Defined in widgets/src/splitpanel.ts:137

removeClass

removeClass(name): 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
Inherited from SplitPanel.removeClass
- Defined in widgets/src/widget.ts:340

setFlag

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

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns void
Inherited from SplitPanel.setFlag
- Defined in widgets/src/widget.ts:496

setHidden

setHidden(hidden): 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
Inherited from SplitPanel.setHidden
- Defined in widgets/src/widget.ts:472

setRelativeSizes

setRelativeSizes(sizes, update?): void
Set the relative sizes for the widgets in the panel.
Parameters
- sizes: number[]
  The relative sizes for the widgets in the panel.
- 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
Inherited from SplitPanel.setRelativeSizes
- Defined in widgets/src/splitpanel.ts:153

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
Inherited from SplitPanel.show
- Defined in widgets/src/widget.ts:418

testFlag

testFlag(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
Inherited from SplitPanel.testFlag
- Defined in widgets/src/widget.ts:486

toggleClass

toggleClass(name, force?): boolean
Toggle a class name on the widget's DOM node.
Parameters
- name: string
  The class name to toggle on the node.
- Optional force: boolean
  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.
Inherited from SplitPanel.toggleClass
- Defined in widgets/src/widget.ts:358

update

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

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from SplitPanel.update
- Defined in widgets/src/widget.ts:376

Class AccordionPanel

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AccordionPanel

Properties

Private _expansionToggled

Private _widgetSizesCache

Readonly node

Accessors

alignment

Returns SplitLayout.Alignment

Parameters

Returns void

dataset

Returns DOMStringMap

disposed

Returns ISignal<this, void>

expansionToggled

Returns ISignal<this, number>

handleMoved

Returns ISignal<this, void>

handles

Returns readonly HTMLDivElement[]

hiddenMode

Returns HiddenMode

Parameters

Returns void

id

Returns string

Parameters

Returns void

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Returns boolean

isVisible

Returns boolean

layout

Returns null | Layout

Parameters

Returns void

orientation

Returns SplitLayout.Orientation

Parameters

Returns void

parent

Returns null | Widget

Parameters

Returns void

renderer

Returns AccordionLayout.IRenderer

spacing

Returns number

Parameters

Returns void

title

Returns Title<Widget>

titleSpace

Returns number

Parameters

Returns void

titles

Returns readonly HTMLElement[]

widgets

Returns readonly Widget[]

Methods

Private _computeWidgetSize

Parameters

Returns undefined | number[]

Private _eventKeyDown

Parameters

`Private` _expansionToggled

`Private` _widgetSizesCache

`Readonly` node

`Private` _computeWidgetSize

`Private` _eventKeyDown

`Private` _evtClick

`Private` _onTitleChanged

`Private` _toggleExpansion

`Protected` notifyLayout