ViewContainer | Theia TypeDoc

A view container holds an arbitrary number of widgets inside a split panel. Each widget is wrapped in a part that displays the widget title and toolbar and allows to collapse / expand the widget content.

Hierarchy

BaseWidget
- ViewContainer

Implements

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ViewContainer(options?: IOptions): ViewContainer

Inherited from BaseWidget.constructor
- Defined in packages/core/src/browser/widgets/widget.ts:118
Parameters
- Optional options: IOptions
Returns ViewContainer

Properties

Protected _tabBarDelegate

_tabBarDelegate: Widget = ...

Protected Readonly applicationStateService

applicationStateService: FrontendApplicationStateService

Protected Readonly commandRegistry

commandRegistry: CommandRegistry

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected currentPart

currentPart: undefined | ViewContainerPart

Protected Readonly decoratorService

decoratorService: TabBarDecoratorService

disableDNDBetweenContainers

disableDNDBetweenContainers: boolean = false

Disable dragging parts from/to this view container.

Protected lastVisibleState

lastVisibleState: undefined | ViewContainer.State

Protected Readonly menuRegistry

menuRegistry: MenuModelRegistry

Readonly onDidChangeTrackableWidgets

onDidChangeTrackableWidgets: Event<Widget[]> = ...

Protected Readonly onDidChangeTrackableWidgetsEmitter

onDidChangeTrackableWidgetsEmitter: Emitter<Widget[]> = ...

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

Readonly onDidDispose

onDidDispose: Event<void> = ...

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

Readonly onScrollUp

onScrollUp: Event<void> = ...

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

Readonly options

options: ViewContainerIdentifier

Protected panel

panel: SplitPanel

Protected Readonly progressBarFactory

progressBarFactory: ProgressBarFactory

Protected Optional scrollBar

scrollBar?: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions?: Options

Protected Readonly shell

shell: ApplicationShell

Protected Readonly splitPositionHandler

splitPositionHandler: SplitPositionHandler

Protected titleOptions

titleOptions: undefined | ViewContainerTitleOptions

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnCurrentPart

toDisposeOnCurrentPart: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

toDisposeOnDragEnd

toDisposeOnDragEnd: DisposableCollection = ...

Protected Readonly toDisposeOnUpdateTitle

toDisposeOnUpdateTitle: DisposableCollection = ...

Protected Readonly toRemoveWidgets

toRemoveWidgets: Map<string, DisposableCollection> = ...

Protected Readonly toolbarFactory

toolbarFactory: TabBarToolbarFactory

Protected Readonly toolbarRegistry

toolbarRegistry: TabBarToolbarRegistry

Protected Readonly widgetManager

widgetManager: WidgetManager

Accessors

containerLayout

get containerLayout(): ViewContainerLayout

- Defined in packages/core/src/browser/view-container.ts:480
Returns ViewContainerLayout

Protected contextMenuPath

get contextMenuPath(): MenuPath

- Defined in packages/core/src/browser/view-container.ts:625
Returns MenuPath

Protected enableAnimation

get enableAnimation(): boolean

- Defined in packages/core/src/browser/view-container.ts:492
Returns boolean

Protected globalHideCommandId

get globalHideCommandId(): string

- Defined in packages/core/src/browser/view-container.ts:633
Returns string

Protected orientation

get orientation(): Orientation

- Defined in packages/core/src/browser/view-container.ts:488
Returns Orientation

Methods

activateWidget

activateWidget(id: string): undefined | Widget

Implementation of TrackableWidgetProvider.activateWidget
- Defined in packages/core/src/browser/view-container.ts:659
Make visible and focus a trackable widget for the given id. If not implemented then activate request will be sent to a child widget directly.

Parameters
- id: string
Returns undefined | Widget

Protected addClipboardListener

addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:215
Type Parameters
- K extends "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

Inherited from BaseWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:204
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes, action: ((event: KeyboardEvent) => boolean | void | Object), ...additionalEventTypes: K[]): void

Inherited from BaseWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:208
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes
- action: ((event: KeyboardEvent) => boolean | void | Object)
  - - (event: KeyboardEvent): boolean | void | Object
    - Parameters
      - event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void

Protected addUpdateListener

addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:197
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

addWidget

addWidget(widget: Widget, options?: ViewContainer.Factory.WidgetOptions, originalContainerId?: string, originalContainerTitle?: ViewContainerTitleOptions): Disposable

- Defined in packages/core/src/browser/view-container.ts:374
Parameters
- widget: Widget
- Optional options: ViewContainer.Factory.WidgetOptions
- Optional originalContainerId: string
- Optional originalContainerTitle: ViewContainerTitleOptions
Returns Disposable

Protected attachNewPart

attachNewPart(newPart: ViewContainerPart, insertIndex?: number): Disposable

- Defined in packages/core/src/browser/view-container.ts:384
Parameters
- newPart: ViewContainerPart
- Optional insertIndex: number
Returns Disposable

clearFlag

clearFlag(flag: Flag): void

Implementation of TabBarDelegator.clearFlag
Inherited from BaseWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:226
Parameters
- flag: Flag
Returns void

Protected configureLayout

configureLayout(layout: PanelLayout): void

- Defined in packages/core/src/browser/view-container.ts:204
Parameters
- layout: PanelLayout
Returns void

Protected createPart

createPart(widget: Widget, partId: string, originalContainerId: string, originalContainerTitle?: ViewContainerTitleOptions, options?: ViewContainer.Factory.WidgetOptions): ViewContainerPart

- Defined in packages/core/src/browser/view-container.ts:450
Parameters
- widget: Widget
- partId: string
- originalContainerId: string
- Optional originalContainerTitle: ViewContainerTitleOptions
- Optional options: ViewContainer.Factory.WidgetOptions
Returns ViewContainerPart

Protected createPartId

createPartId(widget: Widget): string

- Defined in packages/core/src/browser/view-container.ts:369
Parameters
- widget: Widget
Returns string

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/src/browser/widgets/widget.ts:179
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Implementation of TabBarDelegator.dispose
Inherited from BaseWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:122
Returns void

Protected doRestoreState

doRestoreState(state: ViewContainer.State): void

- Defined in packages/core/src/browser/view-container.ts:530
Parameters
- state: ViewContainer.State
Returns void

Protected doStoreState

doStoreState(): ViewContainer.State

- Defined in packages/core/src/browser/view-container.ts:504
Returns ViewContainer.State

Protected findOriginalPart

findOriginalPart(): undefined | ViewContainerPart

- Defined in packages/core/src/browser/view-container.ts:346
Returns undefined | ViewContainerPart

Protected findPartForAnchor

findPartForAnchor(anchor: Anchor): undefined | ViewContainerPart

- Defined in packages/core/src/browser/view-container.ts:356
Parameters
- anchor: Anchor
Returns undefined | ViewContainerPart

Protected fireDidChangeTrackableWidgets

fireDidChangeTrackableWidgets(): void

- Defined in packages/core/src/browser/view-container.ts:655
Returns void

Protected getDockPanel

getDockPanel(): undefined | DockPanel

- Defined in packages/core/src/browser/view-container.ts:859
Returns undefined | DockPanel

getPartFor

getPartFor(widget: Widget): undefined | ViewContainerPart

- Defined in packages/core/src/browser/view-container.ts:476
Parameters
- widget: Widget
Returns undefined | ViewContainerPart

Protected getPartIndex

getPartIndex(partId: undefined | string): number

- Defined in packages/core/src/browser/view-container.ts:469
Parameters
- partId: undefined | string
Returns number

getParts

getParts(): ViewContainerPart[]

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

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/src/browser/widgets/widget.ts:175
Returns MaybePromise<HTMLElement>

getTabBarDelegate

getTabBarDelegate(): undefined | Widget

Implementation of TabBarDelegator.getTabBarDelegate
- Defined in packages/core/src/browser/view-container.ts:254
Returns undefined | Widget

Protected getToggleVisibilityGroupLabel

getToggleVisibilityGroupLabel(): string

- Defined in packages/core/src/browser/view-container.ts:323
Returns string

getTrackableWidgets

getTrackableWidgets(): Widget[]

Implementation of TrackableWidgetProvider.getTrackableWidgets
- Defined in packages/core/src/browser/view-container.ts:651
Returns Widget[]

handleDragEnter

handleDragEnter(event: IDragEvent): void

- Defined in packages/core/src/browser/view-container.ts:747
Parameters
- event: IDragEvent
Returns void

handleDragLeave

handleDragLeave(event: IDragEvent): void

- Defined in packages/core/src/browser/view-container.ts:800
Parameters
- event: IDragEvent
Returns void

handleDragOver

handleDragOver(event: IDragEvent): void

- Defined in packages/core/src/browser/view-container.ts:755
Parameters
- event: IDragEvent
Returns void

handleDrop

handleDrop(event: IDragEvent): void

- Defined in packages/core/src/browser/view-container.ts:808
Parameters
- event: IDragEvent
Returns void

handleEvent

handleEvent(event: Event): void

- Defined in packages/core/src/browser/view-container.ts:730
Parameters
- event: Event
Returns void

Protected init

init(): void

- Defined in packages/core/src/browser/view-container.ts:150
Returns void

Protected isCurrentTitle

isCurrentTitle(titleOptions: undefined | ViewContainerTitleOptions): boolean

- Defined in packages/core/src/browser/view-container.ts:350
Parameters
- titleOptions: undefined | ViewContainerTitleOptions
Returns boolean

Protected isSideDockPanel

isSideDockPanel(widget: Widget): boolean

- Defined in packages/core/src/browser/view-container.ts:872
Parameters
- widget: Widget
Returns boolean

Protected moveBefore

moveBefore(toMovedId: string, moveBeforeThisId: string): void

- Defined in packages/core/src/browser/view-container.ts:637
Parameters
- toMovedId: string
- moveBeforeThisId: string
Returns void

Protected onActivateRequest

onActivateRequest(msg: Message): void

Implementation of TabBarDelegator.onActivateRequest
Overrides BaseWidget.onActivateRequest
- Defined in packages/core/src/browser/view-container.ts:683
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Implementation of TabBarDelegator.onAfterAttach
Overrides BaseWidget.onAfterAttach
- Defined in packages/core/src/browser/view-container.ts:692
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Implementation of TabBarDelegator.onAfterDetach
Overrides BaseWidget.onAfterDetach
- Defined in packages/core/src/browser/view-container.ts:722
Parameters
- msg: Message
Returns void

Protected onAfterShow

onAfterShow(msg: Message): void

Implementation of TabBarDelegator.onAfterShow
Overrides BaseWidget.onAfterShow
- Defined in packages/core/src/browser/view-container.ts:708
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Implementation of TabBarDelegator.onBeforeAttach
Overrides BaseWidget.onBeforeAttach
- Defined in packages/core/src/browser/view-container.ts:714
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Implementation of TabBarDelegator.onBeforeDetach
Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/src/browser/widgets/widget.ts:149
Parameters
- msg: Message
Returns void

Protected onBeforeHide

onBeforeHide(msg: Message): void

Implementation of TabBarDelegator.onBeforeHide
Overrides BaseWidget.onBeforeHide
- Defined in packages/core/src/browser/view-container.ts:703
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Implementation of TabBarDelegator.onCloseRequest
Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:130
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Implementation of TabBarDelegator.onUpdateRequest
Inherited from BaseWidget.onUpdateRequest
- Defined in packages/core/src/browser/widgets/widget.ts:190
Parameters
- msg: Message
Returns void

Protected refreshMenu

refreshMenu(part: ViewContainerPart): void

- Defined in packages/core/src/browser/view-container.ts:601
Register a menu action to toggle the visibility of the new part. The menu action is unregistered first to enable refreshing the order of menu actions.

Parameters
- part: ViewContainerPart
Returns void

Protected registerDND

registerDND(part: ViewContainerPart): Disposable

- Defined in packages/core/src/browser/view-container.ts:829
Parameters
- part: ViewContainerPart
Returns Disposable

Protected registerPart

registerPart(toRegister: ViewContainerPart): void

- Defined in packages/core/src/browser/view-container.ts:573
Register a command to toggle the visibility of the new part.

Parameters
- toRegister: ViewContainerPart
Returns void

Protected registerToolbarItem

registerToolbarItem(commandId: string, options?: Partial<Omit<TabBarToolbarItem, "command" | "id">>): void

- Defined in packages/core/src/browser/view-container.ts:327
Parameters
- commandId: string
- Optional options: Partial<Omit<TabBarToolbarItem, "command" | "id">>
Returns void

removeWidget

removeWidget(widget: Widget): boolean

- Defined in packages/core/src/browser/view-container.ts:456
Parameters
- widget: Widget
Returns boolean

restoreState

restoreState(state: ViewContainer.State): void

Implementation of StatefulWidget.restoreState
- Defined in packages/core/src/browser/view-container.ts:526
Called when the widget got created by the storage service

Parameters
- state: ViewContainer.State
Returns void

Protected revealPart

revealPart(id: string): undefined | ViewContainerPart

- Defined in packages/core/src/browser/view-container.ts:674
Parameters
- id: string
Returns undefined | ViewContainerPart

revealWidget

revealWidget(id: string): undefined | Widget

Implementation of TrackableWidgetProvider.revealWidget
- Defined in packages/core/src/browser/view-container.ts:669
Make visible a trackable widget for the given id. If not implemented then a widget should be always visible when an owner is visible.

Parameters
- id: string
Returns undefined | Widget

setFlag

setFlag(flag: Flag): void

Implementation of TabBarDelegator.setFlag
Inherited from BaseWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:219
Parameters
- flag: Flag
Returns void

setTitleOptions

setTitleOptions(titleOptions: undefined | ViewContainerTitleOptions): void

- Defined in packages/core/src/browser/view-container.ts:237
Parameters
- titleOptions: undefined | ViewContainerTitleOptions
Returns void

storeState

storeState(): ViewContainer.State

Implementation of StatefulWidget.storeState
- Defined in packages/core/src/browser/view-container.ts:498
Called on unload to store the inner state. Returns 'undefined' if the widget cannot be stored.

Returns ViewContainer.State

Protected toggleVisibilityCommandId

toggleVisibilityCommandId(part: ViewContainerPart): string

- Defined in packages/core/src/browser/view-container.ts:629
Parameters
- part: ViewContainerPart
Returns string

Protected unregisterPart

unregisterPart(part: ViewContainerPart): void

- Defined in packages/core/src/browser/view-container.ts:619
Parameters
- part: ViewContainerPart
Returns void

Protected updateCurrentPart

updateCurrentPart(part?: ViewContainerPart): void

- Defined in packages/core/src/browser/view-container.ts:210
Parameters
- Optional part: ViewContainerPart
Returns void

Protected updateSplitterVisibility

updateSplitterVisibility(): void

- Defined in packages/core/src/browser/view-container.ts:222
Returns void

updateTabBarDelegate

updateTabBarDelegate(): void

- Defined in packages/core/src/browser/view-container.ts:245
Returns void

Protected updateTitle

updateTitle(): void

- Defined in packages/core/src/browser/view-container.ts:258
Returns void

Protected updateToolbarItems

updateToolbarItems(allParts: ViewContainerPart[]): void

- Defined in packages/core/src/browser/view-container.ts:312
Parameters
- allParts: ViewContainerPart[]
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: IOptions

Returns ViewContainer

Properties

Protected _tabBarDelegate

Protected Readonly applicationStateService

Protected Readonly commandRegistry

Protected Readonly contextMenuRenderer

Protected currentPart

Protected Readonly decoratorService

disableDNDBetweenContainers

Protected lastVisibleState

Protected Readonly menuRegistry

Readonly onDidChangeTrackableWidgets

Protected Readonly onDidChangeTrackableWidgetsEmitter

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Readonly options

Protected panel

Protected Readonly progressBarFactory

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly shell

Protected Readonly splitPositionHandler

Protected titleOptions

Protected Readonly toDispose

Protected Readonly toDisposeOnCurrentPart

Protected Readonly toDisposeOnDetach

toDisposeOnDragEnd

Protected Readonly toDisposeOnUpdateTitle

Protected Readonly toRemoveWidgets

Protected Readonly toolbarFactory

Protected Readonly toolbarRegistry

Protected Readonly widgetManager

Accessors

containerLayout

Returns ViewContainerLayout

Protected contextMenuPath

Returns MenuPath

Protected enableAnimation

Returns boolean

Protected globalHideCommandId

Returns string

Protected orientation

Returns Orientation

Methods

activateWidget

Parameters

id: string

Returns undefined | Widget

Protected addClipboardListener

Type Parameters

K extends "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>