Class DockviewGroupPanelModel

Hierarchy (view full)

DockviewCompositeDisposable
- DockviewGroupPanelModel

Implements

IDockviewGroupPanelModel

Index

Constructors

Accessors

activePanel 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:431

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` _location

_location: DockviewGroupLocation = ...

`Private` _locked

_locked: DockviewGroupPanelLocked = false

`Private` `Readonly` _onDidActivePanelChange

_onDidActivePanelChange: DockviewEmitter<DockviewGroupChangeEvent> = ...

`Private` `Readonly` _onDidAddPanel

_onDidAddPanel: DockviewEmitter<DockviewGroupChangeEvent> = ...

`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` _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:333

element

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

hasWatermark

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

header

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

isActive

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

isContentFocused

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

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:363

location

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

locked

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

panels

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

renderContainer

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

size

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

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:841

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:993

closeAllPanels

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

closePanel

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

containsPanel

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

dispose

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

`Private` doAddPanel

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

`Private` doClose

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

`Private` doRemovePanel

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

`Private` doSetActivePanel

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

focus

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

focusContent

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

`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:1011

indexOf

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

init

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

initialize

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

isPanelActive

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

layout

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

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:629

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:655

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:701

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:752

rerender

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

setActive

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

toJSON

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

update

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

updateActions

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

`Private` updateContainer

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

`Private` updateMru

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

Generated using TypeDoc