Class GridLayout

A layout which arranges its widgets in a grid.

Hierarchy (view full)

Layout
- GridLayout

Constructors

constructor

new GridLayout(options?): GridLayout
Construct a new grid layout.
Parameters
- options: GridLayout.IOptions = {}
  The options for initializing the layout.
Returns GridLayout
Overrides Layout.constructor
- Defined in widgets/src/gridlayout.ts:33

Properties

`Private` _box

_box: null | IBoxSizing = null

`Private` _columnSizers

_columnSizers: BoxSizer[] = ...

`Private` _columnSpacing

_columnSpacing: number = 4

`Private` _columnStarts

_columnStarts: number[] = []

`Private` _dirty

_dirty: boolean = false

`Private` _items

_items: LayoutItem[] = []

`Private` _rowSizers

_rowSizers: BoxSizer[] = ...

`Private` _rowSpacing

_rowSpacing: number = 4

`Private` _rowStarts

_rowStarts: number[] = []

Accessors

columnCount

get columnCount(): number
Get the number of columns in the layout.

Returns number
- Defined in widgets/src/gridlayout.ts:103
set columnCount(value): void
Set the number of columns in the layout.

Notes
The minimum column count is 1.
Parameters
- value: number
Returns void
- Defined in widgets/src/gridlayout.ts:113

columnSpacing

get columnSpacing(): number
Get the column spacing for the layout.

Returns number
- Defined in widgets/src/gridlayout.ts:159
set columnSpacing(value): void
Set the col spacing for the layout.
Parameters
- value: number
Returns void
- Defined in widgets/src/gridlayout.ts:166

fitPolicy

get fitPolicy(): FitPolicy
Get the fit policy for the layout.

Notes
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.

Some layout implementations may ignore the fit policy.

Returns FitPolicy
Inherited from Layout.fitPolicy
- Defined in widgets/src/layout.ts:108
set fitPolicy(value): void
Set the fit policy for the layout.

Notes
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.

Some layout implementations may ignore the fit policy.

Changing the fit policy will clear the current size constraint for the parent widget and then re-fit the parent.
Parameters
- value: FitPolicy
Returns void
Inherited from Layout.fitPolicy
- Defined in widgets/src/layout.ts:124

isDisposed

get isDisposed(): boolean
Test whether the layout is disposed.

Returns boolean
Inherited from Layout.isDisposed
- Defined in widgets/src/layout.ts:67

parent

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

Returns null | Widget
Inherited from Layout.parent
- Defined in widgets/src/layout.ts:74
set parent(value): void
Set the parent widget of the layout.

Notes
This is set automatically when installing the layout on the parent widget. The parent widget should not be set directly by user code.
Parameters
- value: null | Widget
Returns void
Inherited from Layout.parent
- Defined in widgets/src/layout.ts:85

rowCount

get rowCount(): number
Get the number of rows in the layout.

Returns number
- Defined in widgets/src/gridlayout.ts:75
set rowCount(value): void
Set the number of rows in the layout.

Notes
The minimum row count is 1.
Parameters
- value: number
Returns void
- Defined in widgets/src/gridlayout.ts:85

rowSpacing

get rowSpacing(): number
Get the row spacing for the layout.

Returns number
- Defined in widgets/src/gridlayout.ts:131
set rowSpacing(value): void
Set the row spacing for the layout.
Parameters
- value: number
Returns void
- Defined in widgets/src/gridlayout.ts:138

Methods

[iterator]

[iterator](): IterableIterator<Widget>
Create an iterator over the widgets in the layout.

Returns IterableIterator<Widget>
A new iterator over the widgets in the layout.
Overrides Layout.[iterator]
- Defined in widgets/src/gridlayout.ts:291

`Private` _fit

_fit(): void
Fit the layout to the total size required by the widgets.

Returns void
- Defined in widgets/src/gridlayout.ts:473

`Private` _update

_update(offsetWidth, offsetHeight): void
Update the layout position and size of the widgets.

The parent offset dimensions should be -1 if unknown.
Parameters
- offsetWidth: number
- offsetHeight: number
Returns void
- Defined in widgets/src/gridlayout.ts:577

addWidget

addWidget(widget): void
Add a widget to the grid layout.
Parameters
- widget: Widget
  The widget to add to the layout.
  
  Notes
  If the widget is already contained in the layout, this is no-op.
Returns void
- Defined in widgets/src/gridlayout.ts:305

`Protected` attachWidget

attachWidget(widget): void
Attach a widget to the parent's DOM node.
Parameters
- widget: Widget
  The widget to attach to the parent.
Returns void
- Defined in widgets/src/gridlayout.ts:372

columnStretch

columnStretch(index): number
Get the stretch factor for a specific column.
Parameters
- index: number
  The column index of interest.
Returns number
The stretch factor for the column.

Notes
This returns -1 if the index is out of range.
- Defined in widgets/src/gridlayout.ts:245

`Protected` detachWidget

detachWidget(widget): void
Detach a widget from the parent's DOM node.
Parameters
- widget: Widget
  The widget to detach from the parent.
Returns void
- Defined in widgets/src/gridlayout.ts:395

dispose

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

Returns void
Overrides Layout.dispose
- Defined in widgets/src/gridlayout.ts:52

`Protected` init

init(): void
Perform layout initialization which requires the parent widget.

Returns void
Overrides Layout.init
- Defined in widgets/src/gridlayout.ts:360

`Protected` onAfterAttach

onAfterAttach(msg): void
A message handler invoked on an 'after-attach' message.

Notes
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

This may be reimplemented by subclasses as needed.
Parameters
- msg: Message
Returns void
Inherited from Layout.onAfterAttach
- Defined in widgets/src/layout.ts:309

`Protected` onAfterDetach

onAfterDetach(msg): void
A message handler invoked on an 'after-detach' message.

Notes
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

This may be reimplemented by subclasses as needed.
Parameters
- msg: Message
Returns void
Inherited from Layout.onAfterDetach
- Defined in widgets/src/layout.ts:341

`Protected` onAfterHide

onAfterHide(msg): void
A message handler invoked on an 'after-hide' message.

Notes
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

This may be reimplemented by subclasses as needed.
Parameters
- msg: Message
Returns void
Inherited from Layout.onAfterHide
- Defined in widgets/src/layout.ts:411

`Protected` onAfterShow

onAfterShow(msg): void
A message handler invoked on an 'after-show' message.

Notes
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

This may be reimplemented by subclasses as needed.
Parameters
- msg: Message
Returns void
Inherited from Layout.onAfterShow
- Defined in widgets/src/layout.ts:375

`Protected` onBeforeAttach

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

`Protected` onBeforeDetach

onBeforeDetach(msg): void
A message handler invoked on a 'before-detach' message.

Notes
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

This may be reimplemented by subclasses as needed.
Parameters
- msg: Message
Returns void
Inherited from Layout.onBeforeDetach
- Defined in widgets/src/layout.ts:325

`Protected` onBeforeHide

onBeforeHide(msg): void
A message handler invoked on a 'before-hide' message.

Notes
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

This may be reimplemented by subclasses as needed.
Parameters
- msg: Message
Returns void
Inherited from Layout.onBeforeHide
- Defined in widgets/src/layout.ts:393

`Protected` onBeforeShow

onBeforeShow(msg): void
A message handler invoked on a 'before-show' message.
Parameters
- msg: Message
Returns void
Overrides Layout.onBeforeShow
- Defined in widgets/src/gridlayout.ts:416

`Protected` onChildHidden

onChildHidden(msg): void
A message handler invoked on a 'child-hidden' message.
Parameters
- msg: ChildMessage
Returns void
Overrides Layout.onChildHidden
- Defined in widgets/src/gridlayout.ts:439

`Protected` onChildRemoved

onChildRemoved(msg): void
A message handler invoked on a 'child-removed' message.

Notes
This will remove the child widget from the layout.

Subclasses should not typically reimplement this method.
Parameters
- msg: ChildMessage
Returns void
Inherited from Layout.onChildRemoved
- Defined in widgets/src/layout.ts:427

`Protected` onChildShown

onChildShown(msg): void
A message handler invoked on a 'child-shown' message.
Parameters
- msg: ChildMessage
Returns void
Overrides Layout.onChildShown
- Defined in widgets/src/gridlayout.ts:432

`Protected` onFitRequest

onFitRequest(msg): void
A message handler invoked on a 'fit-request' message.
Parameters
- msg: Message
Returns void
Overrides Layout.onFitRequest
- Defined in widgets/src/gridlayout.ts:464

`Protected` onResize

onResize(msg): void
A message handler invoked on a 'resize' message.
Parameters
- msg: ResizeMessage
Returns void
Overrides Layout.onResize
- Defined in widgets/src/gridlayout.ts:446

`Protected` onUpdateRequest

onUpdateRequest(msg): void
A message handler invoked on an 'update-request' message.
Parameters
- msg: Message
Returns void
Overrides Layout.onUpdateRequest
- Defined in widgets/src/gridlayout.ts:455

processParentMessage

processParentMessage(msg): void
Process a message sent to the parent widget.
Parameters
- msg: Message
  The message sent to the parent widget.
  
  Notes
  This method is called by the parent widget to process a message.
  
  Subclasses may reimplement this method as needed.
Returns void
Inherited from Layout.processParentMessage
- Defined in widgets/src/layout.ts:179

removeWidget

removeWidget(widget): void
Remove a widget from the grid layout.
Parameters
- widget: Widget
  The widget to remove from the layout.
  
  Notes
  A widget is automatically removed from the layout when its parent is set to null. This method should only be invoked directly when removing a widget from a layout which has yet to be installed on a parent widget.
  
  This method does not modify the widget's parent.
Returns void
Overrides Layout.removeWidget
- Defined in widgets/src/gridlayout.ts:336

rowStretch

rowStretch(index): number
Get the stretch factor for a specific row.
Parameters
- index: number
  The row index of interest.
Returns number
The stretch factor for the row.

Notes
This returns -1 if the index is out of range.
- Defined in widgets/src/gridlayout.ts:194

setColumnStretch

setColumnStretch(index, value): void
Set the stretch factor for a specific column.
Parameters
- index: number
  The column index of interest.
- value: number
  The stretch factor for the column.
  
  Notes
  This is a no-op if the index is out of range.
Returns void
- Defined in widgets/src/gridlayout.ts:260

setRowStretch

setRowStretch(index, value): void
Set the stretch factor for a specific row.
Parameters
- index: number
  The row index of interest.
- value: number
  The stretch factor for the row.
  
  Notes
  This is a no-op if the index is out of range.
Returns void
- Defined in widgets/src/gridlayout.ts:209

Class GridLayout

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GridLayout

Properties

Private _box

Private _columnSizers

Private _columnSpacing

Private _columnStarts

Private _dirty

Private _items

Private _rowSizers

Private _rowSpacing

Private _rowStarts

Accessors

columnCount

Returns number

Parameters

Returns void

columnSpacing

Returns number

Parameters

Returns void

fitPolicy

Returns FitPolicy

Parameters

Returns void

isDisposed

Returns boolean

parent

Returns null | Widget

Parameters

Returns void

rowCount

Returns number

Parameters

Returns void

rowSpacing

Returns number

Parameters

Returns void

Methods

[iterator]

Returns IterableIterator<Widget>

Private _fit

Returns void

Private _update

Parameters

Returns void

addWidget

Parameters

Returns void

Protected attachWidget

Parameters

Returns void

columnStretch

Parameters

Returns number

Protected detachWidget

Parameters

Returns void

dispose

Returns void

Protected init

Returns void

Protected onAfterAttach

Parameters

Returns void

Protected onAfterDetach

Parameters

Returns void

Protected onAfterHide

Parameters

`Private` _box

`Private` _columnSizers

`Private` _columnSpacing

`Private` _columnStarts

`Private` _dirty

`Private` _items

`Private` _rowSizers

`Private` _rowSpacing

`Private` _rowStarts

`Private` _fit

`Private` _update

`Protected` attachWidget

`Protected` detachWidget

`Protected` init

`Protected` onAfterAttach

`Protected` onAfterDetach

`Protected` onAfterHide

`Protected` onAfterShow

`Protected` onBeforeAttach

`Protected` onBeforeDetach

`Protected` onBeforeHide

`Protected` onBeforeShow

`Protected` onChildHidden

`Protected` onChildRemoved

`Protected` onChildShown

`Protected` onFitRequest

`Protected` onResize

`Protected` onUpdateRequest