Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ViewContainerPart

Wrapper around a widget held by a view container. Adds a header to display the title, toolbar, and collapse / expand handle.

Hierarchy

Index

Constructors

constructor

Properties

Protected _collapsed

_collapsed: boolean

animatedSize

animatedSize: undefined | number

Protected Readonly body

body: HTMLElement

Protected Readonly collapsedEmitter

collapsedEmitter: Emitter<boolean> = ...

Protected Readonly contextMenuEmitter

contextMenuEmitter: Emitter<MouseEvent> = ...

Protected currentContainerId

currentContainerId: string

Protected Readonly header

header: HTMLElement

Readonly onDidChangeDescription

onDidChangeDescription: Event<void> = ...

Protected Readonly onDidChangeDescriptionEmitter

onDidChangeDescriptionEmitter: Emitter<void> = ...

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

Readonly onDidDispose

onDidDispose: Event<void> = ...

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

Readonly onDidFocus

onDidFocus: Event<ViewContainerPart> = ...

Protected Readonly onDidFocusEmitter

onDidFocusEmitter: Emitter<ViewContainerPart> = ...

Readonly onDidMove

onDidMove: Event<ViewContainer> = ...

Protected Readonly onPartMovedEmitter

onPartMovedEmitter: Emitter<ViewContainer> = ...

Readonly onScrollUp

onScrollUp: Event<void> = ...

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

Readonly onTitleChanged

onTitleChanged: Event<void> = ...

Protected Readonly onTitleChangedEmitter

onTitleChangedEmitter: Emitter<void> = ...

Readonly onVisibilityChanged

onVisibilityChanged: Event<boolean> = ...
deprecated

since 0.11.0, use onDidChangeVisibility instead

Readonly options

options: WidgetOptions = {}

Readonly originalContainerId

originalContainerId: string

Readonly originalContainerTitle

originalContainerTitle: undefined | ViewContainerTitleOptions

Readonly partId

partId: string

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

Protected Readonly toNoDisposeWrapped

toNoDisposeWrapped: Disposable

Protected Readonly toShowHeader

toShowHeader: DisposableCollection = ...

Protected Readonly toolbar

toolbar: TabBarToolbar

Protected Readonly toolbarFactory

toolbarFactory: TabBarToolbarFactory

Protected Readonly toolbarRegistry

toolbarRegistry: TabBarToolbarRegistry

uncollapsedSize

uncollapsedSize: undefined | number

Readonly wrapped

wrapped: Widget

Accessors

canHide

  • get canHide(): boolean

collapsed

  • get collapsed(): boolean
  • set collapsed(collapsed: boolean): void

currentViewContainerId

  • get currentViewContainerId(): string

headerElement

  • get headerElement(): HTMLElement

minSize

  • get minSize(): number

onCollapsed

  • get onCollapsed(): Event<boolean>

onContextMenu

  • get onContextMenu(): Event<MouseEvent>

titleHidden

  • get titleHidden(): boolean

viewContainer

Methods

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

clearFlag

  • clearFlag(flag: Flag): void

Protected createContent

  • createContent(): { body: HTMLElement; disposable: Disposable; header: HTMLElement }

Protected createHeader

  • createHeader(): { disposable: Disposable; header: HTMLElement }

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

dispose

  • dispose(): void

Protected getScrollContainer

  • getScrollContainer(): HTMLElement

hideTitle

  • hideTitle(): void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterHide

  • onAfterHide(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 onBeforeShow

  • onBeforeShow(msg: Message): void

Protected onChildRemoved

  • onChildRemoved(msg: ChildMessage): void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

onPartMoved

Protected onResize

  • onResize(msg: ResizeMessage): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

Protected registerContextMenu

setFlag

  • setFlag(flag: Flag): void

setHidden

  • setHidden(hidden: boolean): void

showTitle

  • showTitle(): void