Class ViewContainerLayout

Hierarchy

SplitLayout
- ViewContainerLayout

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ViewContainerLayout(options: Options, splitPositionHandler: SplitPositionHandler): ViewContainerLayout

Overrides SplitLayout.constructor
- Defined in packages/core/src/browser/view-container.ts:1265
Parameters
- options: Options
- splitPositionHandler: SplitPositionHandler
Returns ViewContainerLayout

Properties

Protected options

options: Options

Protected Readonly splitPositionHandler

splitPositionHandler: SplitPositionHandler

Accessors

Protected items

get items(): readonly (LayoutItem & Item)[]

- Defined in packages/core/src/browser/view-container.ts:1271
Returns readonly (LayoutItem & Item)[]

widgets

get widgets(): ViewContainerPart[]

- Defined in packages/core/src/browser/view-container.ts:1280
Returns ViewContainerPart[]

Methods

attachWidget

attachWidget(index: number, widget: ViewContainerPart): void

Overrides SplitLayout.attachWidget
- Defined in packages/core/src/browser/view-container.ts:1284
Parameters
- index: number
- widget: ViewContainerPart
Returns void

getAvailableSize

getAvailableSize(): number

- Defined in packages/core/src/browser/view-container.ts:1387
Determine the size of the split panel area that is available for widget content, i.e. excluding part headers and split handles.

Returns number

getPartSize

getPartSize(part: ViewContainerPart): undefined | number

- Defined in packages/core/src/browser/view-container.ts:1311
Parameters
- part: ViewContainerPart
Returns undefined | number

iter

iter(): IIterator<ViewContainerPart>

Overrides SplitLayout.iter
- Defined in packages/core/src/browser/view-container.ts:1276
Returns IIterator<ViewContainerPart>

moveWidget

moveWidget(fromIndex: number, toIndex: number, widget: Widget): void

Overrides SplitLayout.moveWidget
- Defined in packages/core/src/browser/view-container.ts:1295
Parameters
- fromIndex: number
- toIndex: number
- widget: Widget
Returns void

Protected onFitRequest

onFitRequest(msg: Message): void

Overrides SplitLayout.onFitRequest
- Defined in packages/core/src/browser/view-container.ts:1480
Parameters
- msg: Message
Returns void

setHandlePosition

setHandlePosition(index: number, position: number): Promise<void>

- Defined in packages/core/src/browser/view-container.ts:1509
Parameters
- index: number
- position: number
Returns Promise<void>

setPartSizes

setPartSizes(weights: (undefined | number)[]): void

- Defined in packages/core/src/browser/view-container.ts:1327
Set the sizes of the view container parts according to the given weights by moving the split handles. This is similar to setRelativeSizes defined in SplitLayout, but here we properly consider the collapsed / expanded state.

Parameters
- weights: (undefined | number)[]
Returns void

Protected tween

tween(t: number): number

- Defined in packages/core/src/browser/view-container.ts:1505
Sinusoidal tween function for smooth animation.

Parameters
- t: number
Returns number

updateCollapsed

updateCollapsed(part: ViewContainerPart, enableAnimation: boolean): void

- Defined in packages/core/src/browser/view-container.ts:1411
Update a view container part that has been collapsed or expanded. The transition to the new state is animated.

Parameters
- part: ViewContainerPart
- enableAnimation: boolean
Returns void