Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ViewContainer

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

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new widget.

    Parameters

    • Optional options: IOptions

      The options for initializing the widget.

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

Protected panel

panel: SplitPanel

Protected Readonly progressBarFactory

progressBarFactory: ProgressBarFactory

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly shell

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

Protected contextMenuPath

Protected enableAnimation

  • get enableAnimation(): boolean

Protected globalHideCommandId

  • get globalHideCommandId(): string

Protected orientation

  • get orientation(): Orientation

Methods

activateWidget

  • activateWidget(id: string): undefined | Widget

Protected addClipboardListener

Protected addEventListener

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    Returns void

Protected addKeyListener

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

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • 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
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

addWidget

Protected attachNewPart

clearFlag

  • clearFlag(flag: Flag): void

Protected configureLayout

  • configureLayout(layout: PanelLayout): void

Protected createPart

Protected createPartId

  • createPartId(widget: Widget): string

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

dispose

  • dispose(): void

Protected doRestoreState

  • doRestoreState(state: State): void

Protected doStoreState

Protected findOriginalPart

Protected findPartForAnchor

Protected fireDidChangeTrackableWidgets

  • fireDidChangeTrackableWidgets(): void

Protected getDockPanel

  • getDockPanel(): undefined | DockPanel

getPartFor

Protected getPartIndex

  • getPartIndex(partId: undefined | string): number

getParts

Protected getScrollContainer

getTabBarDelegate

  • getTabBarDelegate(): undefined | Widget

Protected getToggleVisibilityGroupLabel

  • getToggleVisibilityGroupLabel(): string

getTrackableWidgets

  • getTrackableWidgets(): Widget[]

handleDragEnter

  • handleDragEnter(event: IDragEvent): void

handleDragLeave

  • handleDragLeave(event: IDragEvent): void

handleDragOver

  • handleDragOver(event: IDragEvent): void

handleDrop

  • handleDrop(event: IDragEvent): void

handleEvent

  • handleEvent(event: Event): void

Protected init

  • init(): void

Protected isCurrentTitle

Protected isSideDockPanel

  • isSideDockPanel(widget: Widget): boolean

Protected moveBefore

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

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

Protected refreshMenu

Protected registerDND

Protected registerPart

Protected registerToolbarItem

  • registerToolbarItem(commandId: string, options?: Partial<Pick<TabBarToolbarItem, "priority" | "tooltip" | "icon" | "text" | "group" | "when" | "onDidChange">>): void

removeWidget

  • removeWidget(widget: Widget): boolean

restoreState

  • restoreState(state: State): void

Protected revealPart

revealWidget

  • revealWidget(id: string): undefined | Widget

setFlag

  • setFlag(flag: Flag): void

setTitleOptions

storeState

Protected toggleVisibilityCommandId

Protected unregisterPart

Protected updateCurrentPart

updateTabBarDelegate

  • updateTabBarDelegate(): void

Protected updateTitle

  • updateTitle(): void

Protected updateToolbarItems