Class DockviewGroupPanelModel

Hierarchy (view full)

DockviewCompositeDisposable
- DockviewGroupPanelModel

Implements

IDockviewGroupPanelModel

Index

Constructors

Accessors

activePanel dropTargetContainer element hasWatermark header isActive isContentFocused isDisposed isEmpty location locked panels renderContainer size

Constructors

constructor

new DockviewGroupPanelModel(container, accessor, id, options, groupPanel): DockviewGroupPanelModel
Parameters
- container: HTMLElement
- accessor: DockviewComponent
- id: string
- options: GroupOptions
- groupPanel: DockviewGroupPanel
Returns DockviewGroupPanelModel
Overrides DockviewCompositeDisposable.constructor
- Defined in dockview/dockviewGroupPanelModel.ts:382

Properties

`Private` _activePanel

_activePanel: undefined | IDockviewPanel

`Private` `Readonly` _api

_api: DockviewApi

`Private` _height

_height: number = 0

`Private` _isGroupActive

_isGroupActive: boolean = false

`Private` _leftHeaderActions

_leftHeaderActions: undefined | IHeaderActionsRenderer

`Private` `Readonly` _onDidChange

_onDidChange: DockviewEmitter<undefined | IViewSize> = ...

`Private` `Readonly` _onDidDrop

_onDidDrop: DockviewEmitter<DockviewDidDropEvent> = ...

`Private` `Readonly` _onDidPanelParametersChange

_onDidPanelParametersChange: DockviewEmitter<Parameters> = ...

`Private` `Readonly` _onDidPanelTitleChange

_onDidPanelTitleChange: DockviewEmitter<TitleEvent> = ...

`Private` `Readonly` _onDidRemovePanel

_onDidRemovePanel: DockviewEmitter<DockviewGroupChangeEvent> = ...

`Private` `Readonly` _onGroupDragStart

_onGroupDragStart: DockviewEmitter<GroupDragEvent> = ...

`Private` `Readonly` _onMove

_onMove: DockviewEmitter<GroupMoveEvent> = ...

`Private` `Readonly` _onTabDragStart

_onTabDragStart: DockviewEmitter<TabDragEvent> = ...

`Private` `Readonly` _onUnhandledDragOverEvent

_onUnhandledDragOverEvent: DockviewEmitter<DockviewDndOverlayEvent> = ...

`Private` `Readonly` _onWillDrop

_onWillDrop: DockviewEmitter<DockviewWillDropEvent> = ...

`Private` `Readonly` _onWillShowOverlay

_onWillShowOverlay: DockviewEmitter<WillShowOverlayLocationEvent> = ...

`Private` _overwriteDropTargetContainer

_overwriteDropTargetContainer: null | DropTargetAnchorContainer = null

`Private` _overwriteRenderContainer

_overwriteRenderContainer: null | OverlayRenderContainer = null

`Private` `Readonly` _panelDisposables

_panelDisposables: Map<string, DockviewIDisposable> = ...

`Private` `Readonly` _panels

_panels: IDockviewPanel[] = []

`Private` _prefixHeaderActions

_prefixHeaderActions: undefined | IHeaderActionsRenderer

`Private` _rightHeaderActions

_rightHeaderActions: undefined | IHeaderActionsRenderer

`Private` _width

_width: number = 0

`Private` `Readonly` accessor

accessor: DockviewComponent

`Private` `Readonly` container

container: HTMLElement

`Private` `Readonly` contentContainer

contentContainer: IContentContainer

`Private` `Readonly` groupPanel

groupPanel: DockviewGroupPanel

id

id: string

`Private` mostRecentlyUsed

mostRecentlyUsed: IDockviewPanel[] = []

`Readonly` onDidActivePanelChange

onDidActivePanelChange: DockviewEvent<DockviewGroupChangeEvent> = ...

`Readonly` onDidAddPanel

onDidAddPanel: DockviewEvent<DockviewGroupChangeEvent> = ...

`Readonly` onDidChange

onDidChange: DockviewEvent<undefined | IViewSize> = ...

`Readonly` onDidDrop

onDidDrop: DockviewEvent<DockviewDidDropEvent> = ...

`Readonly` onDidPanelParametersChange

onDidPanelParametersChange: DockviewEvent<Parameters> = ...

`Readonly` onDidPanelTitleChange

onDidPanelTitleChange: DockviewEvent<TitleEvent> = ...

`Readonly` onDidRemovePanel

onDidRemovePanel: DockviewEvent<DockviewGroupChangeEvent> = ...

`Readonly` onGroupDragStart

onGroupDragStart: DockviewEvent<GroupDragEvent> = ...

`Readonly` onMove

onMove: DockviewEvent<GroupMoveEvent> = ...

`Readonly` onTabDragStart

onTabDragStart: DockviewEvent<TabDragEvent> = ...

`Readonly` onUnhandledDragOverEvent

onUnhandledDragOverEvent: DockviewEvent<DockviewDndOverlayEvent> = ...

`Readonly` onWillDrop

onWillDrop: DockviewEvent<DockviewWillDropEvent> = ...

`Readonly` onWillShowOverlay

onWillShowOverlay: DockviewEvent<WillShowOverlayLocationEvent> = ...

`Private` `Readonly` options

options: GroupOptions

`Private` `Readonly` tabsContainer

tabsContainer: ITabsContainer

`Private` `Optional` watermark

watermark?: IWatermarkRenderer

Accessors

activePanel

get activePanel(): undefined | IDockviewPanel
Returns undefined | IDockviewPanel
Implementation of IDockviewGroupPanelModel.activePanel
- Defined in dockview/dockviewGroupPanelModel.ts:284

dropTargetContainer

get dropTargetContainer(): null | DropTargetAnchorContainer
Returns null | DropTargetAnchorContainer
- Defined in dockview/dockviewGroupPanelModel.ts:493
set dropTargetContainer(value): void
Parameters
- value: null | DropTargetAnchorContainer
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:489

element

get element(): HTMLElement
Returns HTMLElement
- Defined in dockview/dockviewGroupPanelModel.ts:280

hasWatermark

get hasWatermark(): boolean
Returns boolean
- Defined in dockview/dockviewGroupPanelModel.ts:318

header

get header(): IHeader
Returns IHeader
Implementation of IDockviewGroupPanelModel.header
- Defined in dockview/dockviewGroupPanelModel.ts:324

isActive

get isActive(): boolean
Returns boolean
Implementation of IDockviewGroupPanelModel.isActive
- Defined in dockview/dockviewGroupPanelModel.ts:302

isContentFocused

get isContentFocused(): boolean
Returns boolean
Implementation of IDockviewGroupPanelModel.isContentFocused
- Defined in dockview/dockviewGroupPanelModel.ts:328

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from CompositeDisposable.isDisposed
- Defined in lifecycle.ts:30

isEmpty

get isEmpty(): boolean
Returns boolean
- Defined in dockview/dockviewGroupPanelModel.ts:314

location

get location(): DockviewGroupLocation
Returns DockviewGroupLocation
- Defined in dockview/dockviewGroupPanelModel.ts:338
set location(value): void
Parameters
- value: DockviewGroupLocation
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:342

locked

get locked(): DockviewGroupPanelLocked
Returns DockviewGroupPanelLocked
Implementation of IDockviewGroupPanelModel.locked
- Defined in dockview/dockviewGroupPanelModel.ts:288
set locked(value): void
Parameters
- value: DockviewGroupPanelLocked
Returns void
Implementation of IDockviewGroupPanelModel.locked
- Defined in dockview/dockviewGroupPanelModel.ts:292

panels

get panels(): IDockviewPanel[]
Returns IDockviewPanel[]
Implementation of IDockviewGroupPanelModel.panels
- Defined in dockview/dockviewGroupPanelModel.ts:306

renderContainer

get renderContainer(): OverlayRenderContainer
Returns OverlayRenderContainer
- Defined in dockview/dockviewGroupPanelModel.ts:482
set renderContainer(value): void
Parameters
- value: null | OverlayRenderContainer
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:470

size

get size(): number
Returns number
Implementation of IDockviewGroupPanelModel.size
- Defined in dockview/dockviewGroupPanelModel.ts:310

Methods

`Private` _removePanel

_removePanel(panel, options): IDockviewPanel
Parameters
- panel: IDockviewPanel
- options: {
  skipSetActive?: boolean;
  skipSetActiveGroup?: boolean;
  }
  - Optional skipSetActive?: boolean
  - Optional skipSetActiveGroup?: boolean
Returns IDockviewPanel
- Defined in dockview/dockviewGroupPanelModel.ts:803

addDisposables

addDisposables(...args): void
Parameters
- Rest ...args: DockviewIDisposable[]
Returns void
Inherited from DockviewCompositeDisposable.addDisposables
- Defined in lifecycle.ts:38

canDisplayOverlay

canDisplayOverlay(event, position, target): boolean
Parameters
- event: DragEvent
- position: Position
- target: DockviewGroupDropLocation
Returns boolean
Implementation of IDockviewGroupPanelModel.canDisplayOverlay
- Defined in dockview/dockviewGroupPanelModel.ts:955

closeAllPanels

closeAllPanels(): void
Returns void
Implementation of IDockviewGroupPanelModel.closeAllPanels
- Defined in dockview/dockviewGroupPanelModel.ts:737

closePanel

closePanel(panel): void
Parameters
- panel: IDockviewPanel
Returns void
Implementation of IDockviewGroupPanelModel.closePanel
- Defined in dockview/dockviewGroupPanelModel.ts:749

containsPanel

containsPanel(panel): boolean
Parameters
- panel: IDockviewPanel
Returns boolean
Implementation of IDockviewGroupPanelModel.containsPanel
- Defined in dockview/dockviewGroupPanelModel.ts:647

dispose

dispose(): void
Returns void
Implementation of IDockviewGroupPanelModel.dispose
Overrides DockviewCompositeDisposable.dispose
- Defined in dockview/dockviewGroupPanelModel.ts:1089

`Private` doAddPanel

doAddPanel(panel, index?, options?): void
Parameters
- panel: IDockviewPanel
- index: number = ...
- options: {
  skipSetActive: boolean;
  } = ...
  - skipSetActive: boolean
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:857

`Private` doClose

doClose(panel): void
Parameters
- panel: IDockviewPanel
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:753

`Private` doRemovePanel

doRemovePanel(panel): void
Parameters
- panel: IDockviewPanel
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:833

`Private` doSetActivePanel

doSetActivePanel(panel): void
Parameters
- panel: undefined | IDockviewPanel
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:899

focus

focus(): void
Returns void
Implementation of IDockviewGroupPanelModel.focus
- Defined in dockview/dockviewGroupPanelModel.ts:659

focusContent

focusContent(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:466

`Private` handleDropEvent

handleDropEvent(type, event, position, index?): void
Parameters
- type: "header" | "content"
- event: DragEvent
- position: Position
- Optional index: number
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:973

indexOf

indexOf(panel): number
Parameters
- panel: IDockviewPanel
Returns number
Implementation of IDockviewGroupPanelModel.indexOf
- Defined in dockview/dockviewGroupPanelModel.ts:569

init

init(_params): void
Parameters
- _params: PanelInitParameters
Returns void
Implementation of IDockviewGroupPanelModel.init
- Defined in dockview/dockviewGroupPanelModel.ts:651

initialize

initialize(): void
Returns void
Implementation of IDockviewGroupPanelModel.initialize
- Defined in dockview/dockviewGroupPanelModel.ts:500

isPanelActive

isPanelActive(panel): boolean
Parameters
- panel: IDockviewPanel
Returns boolean
Implementation of IDockviewGroupPanelModel.isPanelActive
- Defined in dockview/dockviewGroupPanelModel.ts:765

layout

layout(width, height): void
Parameters
- width: number
- height: number
Returns void
Implementation of IDockviewGroupPanelModel.layout
- Defined in dockview/dockviewGroupPanelModel.ts:792

moveToNext

moveToNext(options?): void
Parameters
- Optional options: {
  panel?: IDockviewPanel;
  suppressRoll?: boolean;
  }
  - Optional panel?: IDockviewPanel
  - Optional suppressRoll?: boolean
Returns void
Implementation of IDockviewGroupPanelModel.moveToNext
- Defined in dockview/dockviewGroupPanelModel.ts:591

moveToPrevious

moveToPrevious(options?): void
Parameters
- Optional options: {
  panel?: IDockviewPanel;
  suppressRoll?: boolean;
  }
  - Optional panel?: IDockviewPanel
  - Optional suppressRoll?: boolean
Returns void
Implementation of IDockviewGroupPanelModel.moveToPrevious
- Defined in dockview/dockviewGroupPanelModel.ts:617

openPanel

openPanel(panel, options?): void
Parameters
- panel: IDockviewPanel
- options: {
      index?: number;
      skipSetActive?: boolean;
      skipSetGroupActive?: boolean;
  } = {}
  - Optional index?: number
  - Optional skipSetActive?: boolean
  - Optional skipSetGroupActive?: boolean
Returns void
Implementation of IDockviewGroupPanelModel.openPanel
- Defined in dockview/dockviewGroupPanelModel.ts:663

removePanel

removePanel(groupItemOrId, options?): IDockviewPanel
Parameters
- groupItemOrId: string | IDockviewPanel
- options: {
  skipSetActive?: boolean;
  skipSetActiveGroup?: boolean;
  } = ...
  - Optional skipSetActive?: boolean
  - Optional skipSetActiveGroup?: boolean
Returns IDockviewPanel
Implementation of IDockviewGroupPanelModel.removePanel
- Defined in dockview/dockviewGroupPanelModel.ts:714

rerender

rerender(panel): void
Parameters
- panel: IDockviewPanel
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:565

setActive

setActive(isGroupActive, force?): void
Parameters
- isGroupActive: boolean
- force: boolean = false
Returns void
Implementation of IDockviewGroupPanelModel.setActive
- Defined in dockview/dockviewGroupPanelModel.ts:773

toJSON

toJSON(): GroupPanelViewState
Returns GroupPanelViewState
Implementation of IDockviewGroupPanelModel.toJSON
- Defined in dockview/dockviewGroupPanelModel.ts:573

update

update(_params): void
Parameters
- _params: PanelUpdateEvent<Parameters>
Returns void
Implementation of IDockviewGroupPanelModel.update
- Defined in dockview/dockviewGroupPanelModel.ts:655

updateActions

updateActions(element): void
Parameters
- element: undefined | HTMLElement
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:769

`Private` updateContainer

updateContainer(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:929

updateDragAndDropState

updateDragAndDropState(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1085

`Private` updateMru

updateMru(panel): void
Parameters
- panel: IDockviewPanel
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:919

Class DockviewGroupPanelModel

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

container: HTMLElement

accessor: DockviewComponent

id: string

options: GroupOptions

groupPanel: DockviewGroupPanel

Returns DockviewGroupPanelModel

Properties

Private _activePanel

Private Readonly _api

Private _height

Private _isGroupActive

Private _leftHeaderActions

Private _location

Private _locked

Private Readonly _onDidActivePanelChange

Private Readonly _onDidAddPanel

Private Readonly _onDidChange

Private Readonly _onDidDrop

Private Readonly _onDidPanelParametersChange

Private Readonly _onDidPanelTitleChange

Private Readonly _onDidRemovePanel

Private Readonly _onGroupDragStart

Private Readonly _onMove

Private Readonly _onTabDragStart

Private Readonly _onUnhandledDragOverEvent

Private Readonly _onWillDrop

Private Readonly _onWillShowOverlay

Private _overwriteDropTargetContainer

Private _overwriteRenderContainer

Private Readonly _panelDisposables

Private Readonly _panels

Private _prefixHeaderActions

Private _rightHeaderActions

Private _width

Private Readonly accessor

Private Readonly container

Private Readonly contentContainer

Private Readonly groupPanel

id

Private mostRecentlyUsed

Readonly onDidActivePanelChange

Readonly onDidAddPanel

Readonly onDidChange

Readonly onDidDrop

Readonly onDidPanelParametersChange

Readonly onDidPanelTitleChange

Readonly onDidRemovePanel

Readonly onGroupDragStart

Readonly onMove

Readonly onTabDragStart

Readonly onUnhandledDragOverEvent

Readonly onWillDrop

Readonly onWillShowOverlay

Private Readonly options

Private Readonly tabsContainer

Private Optional watermark

Accessors

activePanel

Returns undefined | IDockviewPanel

dropTargetContainer

Returns null | DropTargetAnchorContainer

Parameters

value: null | DropTargetAnchorContainer

Returns void

element

Returns HTMLElement

hasWatermark

Returns boolean

header

`Private` _activePanel

`Private` `Readonly` _api

`Private` _height

`Private` _isGroupActive

`Private` _leftHeaderActions

`Private` _location

`Private` _locked

`Private` `Readonly` _onDidActivePanelChange

`Private` `Readonly` _onDidAddPanel

`Private` `Readonly` _onDidChange

`Private` `Readonly` _onDidDrop

`Private` `Readonly` _onDidPanelParametersChange

`Private` `Readonly` _onDidPanelTitleChange

`Private` `Readonly` _onDidRemovePanel

`Private` `Readonly` _onGroupDragStart

`Private` `Readonly` _onMove

`Private` `Readonly` _onTabDragStart

`Private` `Readonly` _onUnhandledDragOverEvent

`Private` `Readonly` _onWillDrop

`Private` `Readonly` _onWillShowOverlay

`Private` _overwriteDropTargetContainer

`Private` _overwriteRenderContainer

`Private` `Readonly` _panelDisposables

`Private` `Readonly` _panels

`Private` _prefixHeaderActions

`Private` _rightHeaderActions

`Private` _width

`Private` `Readonly` accessor

`Private` `Readonly` container

`Private` `Readonly` contentContainer

`Private` `Readonly` groupPanel

`Private` mostRecentlyUsed

`Readonly` onDidActivePanelChange

`Readonly` onDidAddPanel

`Readonly` onDidChange

`Readonly` onDidDrop

`Readonly` onDidPanelParametersChange

`Readonly` onDidPanelTitleChange

`Readonly` onDidRemovePanel

`Readonly` onGroupDragStart

`Readonly` onMove

`Readonly` onTabDragStart

`Readonly` onUnhandledDragOverEvent

`Readonly` onWillDrop

`Readonly` onWillShowOverlay

`Private` `Readonly` options

`Private` `Readonly` tabsContainer

`Private` `Optional` watermark

`Private` _removePanel

options: {
skipSetActive?: boolean;
skipSetActiveGroup?: boolean;
}

`Optional` skipSetActive?: boolean

`Optional` skipSetActiveGroup?: boolean

`Rest` ...args: DockviewIDisposable[]

`Private` doAddPanel

options: {
skipSetActive: boolean;
} = ...

`Private` doClose

`Private` doRemovePanel