BoxPanel | @phosphor/widgets

A panel which arranges its widgets in a single row or column. The namespace for the BoxPanel class statics.

Notes

This class provides a convenience wrapper around a BoxLayout.

Hierarchy

Panel
- BoxPanel

Implements

IDisposable
IMessageHandler

Index

Modules

Panel

Interfaces

IOptions

Type aliases

Constructors

constructor

Properties

node

Accessors

Type aliases

Static Alignment

Alignment: Alignment

A type alias for a box panel alignment.

Static Direction

Direction: Direction

A type alias for a box panel direction.

Constructors

constructor

new BoxPanel(options?: IOptions): BoxPanel

Overrides Panel.constructor
- Defined in boxpanel.ts:28
Construct a new box panel.

Parameters
- Default value options: IOptions = {}
  
  The options for initializing the box panel.
Returns BoxPanel

Properties

node

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

alignment

get alignment(): Alignment
set alignment(value: Alignment): void

- Defined in boxpanel.ts:62
Get the content alignment for the box 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 box layout.

Returns Alignment
- Defined in boxpanel.ts:75
Set the content alignment for the box 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 box layout.

Parameters
- value: Alignment
Returns void

dataset

get dataset(): DOMStringMap

Inherited from Widget.dataset
- Defined in widget.ts:170
The dataset for the widget's DOM node.

Returns DOMStringMap

direction

get direction(): Direction
set direction(value: Direction): void

- Defined in boxpanel.ts:42
Get the layout direction for the box panel.

Returns Direction
- Defined in boxpanel.ts:49
Set the layout direction for the box panel.

Parameters
- value: Direction
Returns void

disposed

get disposed(): ISignal<this, void>

Inherited from Widget.disposed
- Defined in widget.ts:97
A signal emitted when the widget is disposed.

Returns ISignal<this, void>

id

get id(): string
set id(value: string): void

Inherited from Widget.id
- Defined in widget.ts:156
Get the id of the widget's DOM node.

Returns string
Inherited from Widget.id
- Defined in widget.ts:163
Set the id of the widget's DOM node.

Parameters
- value: string
Returns void

isAttached

get isAttached(): boolean

Inherited from Widget.isAttached
- Defined in widget.ts:116
Test whether the widget's node is attached to the DOM.

Returns boolean

isDisposed

get isDisposed(): boolean

Inherited from Widget.isDisposed
- Defined in widget.ts:109
Test whether the widget has been disposed.

Returns boolean

isHidden

get isHidden(): boolean

Inherited from Widget.isHidden
- Defined in widget.ts:123
Test whether the widget is explicitly hidden.

Returns boolean

isVisible

get isVisible(): boolean

Inherited from Widget.isVisible
- Defined in widget.ts:134
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

Inherited from Widget.layout
- Defined in widget.ts:216
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
Inherited from Widget.layout
- Defined in widget.ts:229
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: Layout | null
Returns void

parent

get parent(): Widget | null
set parent(value: Widget | null): void

Inherited from Widget.parent
- Defined in widget.ts:177
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
Inherited from Widget.parent
- Defined in widget.ts:192
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: Widget | null
Returns void

spacing

get spacing(): number
set spacing(value: number): void

- Defined in boxpanel.ts:82
Get the inter-element spacing for the box panel.

Returns number
- Defined in boxpanel.ts:89
Set the inter-element spacing for the box panel.

Parameters
- value: number
Returns void

title

get title(): Title<Widget>

Inherited from Widget.title
- Defined in widget.ts:149
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>

Inherited from Panel.widgets
- Defined in panel.ts:43
A read-only array of the widgets in the panel.

Returns ReadonlyArray<Widget>

Methods

activate

activate(): void

Inherited from Widget.activate
- Defined in widget.ts:367
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

Inherited from Widget.addClass
- Defined in widget.ts:297
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

Inherited from Panel.addWidget
- Defined in panel.ts:55
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>

Inherited from Widget.children
- Defined in widget.ts:256
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

Inherited from Widget.clearFlag
- Defined in widget.ts:475
Clear the given widget flag.

Notes

This will not typically be called directly by user code.

Parameters
- flag: Flag
Returns void

close

close(): void

Inherited from Widget.close
- Defined in widget.ts:377
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

Inherited from Widget.contains
- Defined in widget.ts:267
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

Inherited from Widget.dispose
- Defined in widget.ts:65
Dispose of the widget and its descendant widgets.

Notes

It is unsafe to use the widget after it has been disposed.

All calls made to this method after the first are a no-op.

Returns void

fit

fit(): void

Inherited from Widget.fit
- Defined in widget.ts:357
Post a 'fit-request' message to the widget.

Notes

This is a simple convenience method for posting the message.

Returns void

hasClass

hasClass(name: string): boolean

Inherited from Widget.hasClass
- Defined in widget.ts:283
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

Inherited from Widget.hide
- Defined in widget.ts:415
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

Inherited from Panel.insertWidget
- Defined in panel.ts:69
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

Inherited from Widget.notifyLayout
- Defined in widget.ts:573
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

Inherited from Widget.onActivateRequest
- Defined in widget.ts:623
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

Inherited from Widget.onAfterAttach
- Defined in widget.ts:671
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

Inherited from Widget.onAfterDetach
- Defined in widget.ts:687
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

Inherited from Widget.onAfterHide
- Defined in widget.ts:655
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

Inherited from Widget.onAfterShow
- Defined in widget.ts:639
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

Inherited from Widget.onBeforeAttach
- Defined in widget.ts:663
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(msg: Message): void

Inherited from Widget.onBeforeDetach
- Defined in widget.ts:679
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

Inherited from Widget.onBeforeHide
- Defined in widget.ts:647
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

Inherited from Widget.onBeforeShow
- Defined in widget.ts:631
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

Overrides Widget.onChildAdded
- Defined in boxpanel.ts:96
A message handler invoked on a 'child-added' message.

Parameters
- msg: ChildMessage
Returns void

Protected onChildRemoved

onChildRemoved(msg: ChildMessage): void

Overrides Widget.onChildRemoved
- Defined in boxpanel.ts:103
A message handler invoked on a 'child-removed' message.

Parameters
- msg: ChildMessage
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from Widget.onCloseRequest
- Defined in widget.ts:585
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

Inherited from Widget.onFitRequest
- Defined in widget.ts:615
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

Inherited from Widget.onResize
- Defined in widget.ts:599
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

Inherited from Widget.onUpdateRequest
- Defined in widget.ts:607
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

Inherited from Widget.processMessage
- Defined in widget.ts:487
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

Inherited from Widget.removeClass
- Defined in widget.ts:311
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

Inherited from Widget.setFlag
- Defined in widget.ts:465
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

Inherited from Widget.setHidden
- Defined in widget.ts:441
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

Inherited from Widget.show
- Defined in widget.ts:389
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

Inherited from Widget.testFlag
- Defined in widget.ts:455
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?: boolean): boolean

Inherited from Widget.toggleClass
- Defined in widget.ts:329
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.

update

update(): void

Inherited from Widget.update
- Defined in widget.ts:347
Post an 'update-request' message to the widget.

Notes

This is a simple convenience method for posting the message.

Returns void

Static getSizeBasis

getSizeBasis(widget: Widget): number

- Defined in boxpanel.ts:194
Get the box panel size basis for the given widget.

Parameters
- widget: Widget
  
  The widget of interest.
Returns number

The box panel size basis for the widget.

Static getStretch

getStretch(widget: Widget): number

- Defined in boxpanel.ts:170
Get the box panel stretch factor for the given widget.

Parameters
- widget: Widget
  
  The widget of interest.
Returns number

The box panel stretch factor for the widget.

Static setSizeBasis

setSizeBasis(widget: Widget, value: number): void

- Defined in boxpanel.ts:206
Set the box panel size basis for the given widget.

Parameters
- widget: Widget
  
  The widget of interest.
- value: number
  
  The value for the size basis.
Returns void

Static setStretch

setStretch(widget: Widget, value: number): void

- Defined in boxpanel.ts:182
Set the box panel stretch factor for the given widget.

Parameters
- widget: Widget
  
  The widget of interest.
- value: number
  
  The value for the stretch factor.
Returns void

Notes

Hierarchy

Implements

Index

Modules

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static Alignment

Static Direction

Constructors

constructor

Parameters

Default value options: IOptions = {}

Returns BoxPanel

Properties

node

Accessors

alignment

Notes

Returns Alignment

Notes

Parameters

value: Alignment

Returns void

dataset

Returns DOMStringMap

direction

Returns Direction

Parameters

value: Direction

Returns void

disposed

Returns ISignal<this, void>

id

Returns string

Parameters

value: string

Returns void

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Returns boolean

isVisible

Notes

Returns boolean

layout

Notes

Returns Layout | null

Notes

Parameters

value: Layout | null

Returns void

parent

Notes

Returns Widget | null

Notes

Parameters

value: Widget | null

Returns void

spacing

Returns number

Parameters

value: number

Returns void

title

Notes

Returns Title<Widget>

widgets

Returns ReadonlyArray<Widget>

Methods

activate

Notes

Returns void