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

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Constructors

constructor

Properties

Protected _collapsed

_collapsed: boolean

animatedSize

animatedSize: number | undefined

Protected Readonly body

body: HTMLElement

Protected Readonly collapsedEmitter

collapsedEmitter: Emitter<boolean> = new Emitter<boolean>()

Protected Readonly contextMenuEmitter

contextMenuEmitter: Emitter<MouseEvent> = new Emitter<MouseEvent>()

Readonly dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

Readonly disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

Protected Readonly header

header: HTMLElement

id

id: string

Set the id of the widget's DOM node.

Readonly isAttached

isAttached: boolean

Test whether the widget's node is attached to the DOM.

Readonly isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

Readonly isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

Readonly isVisible

isVisible: boolean

Test whether the widget is visible.

Notes

A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

layout

layout: Layout | null

Set the layout for the widget.

Notes

The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = this.onDidChangeVisibilityEmitter.event

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = new Emitter<boolean>()

Readonly onDidDispose

onDidDispose: Event<void> = this.onDidDisposeEmitter.event

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = new Emitter<void>()

Readonly onDidFocus

onDidFocus: Event<this> = this.onDidFocusEmitter.event

Protected Readonly onDidFocusEmitter

onDidFocusEmitter: Emitter<this> = new Emitter<this>()

Readonly onScrollUp

onScrollUp: Event<void> = this.onScrollUpEmitter.event

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = new Emitter<void>()

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = this.onScrollYReachEndEmitter.event

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = new Emitter<void>()

Readonly onTitleChanged

onTitleChanged: Event<void> = this.onTitleChangedEmitter.event

Protected Readonly onTitleChangedEmitter

onTitleChangedEmitter: Emitter<void> = new Emitter<void>()

Readonly onVisibilityChanged

onVisibilityChanged: Event<boolean> = this.onDidChangeVisibility
deprecated

since 0.11.0, use onDidChangeVisibility instead

Readonly options

options: WidgetOptions

parent

parent: Widget | null

Set the parent of the widget.

Notes

Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.

Readonly partId

partId: string

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: PerfectScrollbar.Options

Readonly title

title: Title<Widget>

The title object for the widget.

Notes

The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Protected Readonly toDispose

toDispose: DisposableCollection = new DisposableCollection(this.onDidDisposeEmitter,Disposable.create(() => this.onDidDisposeEmitter.fire()),this.onScrollYReachEndEmitter,this.onScrollUpEmitter,this.onDidChangeVisibilityEmitter)

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = new DisposableCollection()

Protected Readonly toHideToolbar

toHideToolbar: DisposableCollection = new DisposableCollection()

Protected Readonly toNoDisposeWrapped

toNoDisposeWrapped: Disposable

Protected Readonly toShowHeader

toShowHeader: DisposableCollection = new DisposableCollection()

Protected toolbar

toolbar: TabBarToolbar | undefined

Protected Readonly toolbarFactory

toolbarFactory: TabBarToolbarFactory

Protected Readonly toolbarRegistry

toolbarRegistry: TabBarToolbarRegistry

uncollapsedSize

uncollapsedSize: number | undefined

Readonly wrapped

wrapped: Widget

Static HEADER_HEIGHT

HEADER_HEIGHT: 22 = 22

Make sure to adjust the line-height of the .theia-view-container .part > .header CSS class when modifying this, and vice versa.

Accessors

canHide

  • get canHide(): boolean

collapsed

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

minSize

  • get minSize(): number

onCollapsed

  • get onCollapsed(): Event<boolean>

onContextMenu

  • get onContextMenu(): Event<MouseEvent>

titleHidden

  • get titleHidden(): boolean

toolbarHidden

  • get toolbarHidden(): boolean

Methods

activate

  • activate(): void
  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): void
  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

Protected addClipboardListener

Protected addEventListener

Protected addKeyListener

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

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: undefined | false | true): void

children

  • children(): IIterator<Widget>
  • Create an iterator over the widget's children.

    Returns IIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • clearFlag(flag: Flag): void

close

  • close(): void
  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean
  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

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

fit

  • fit(): void
  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Protected getScrollContainer

  • getScrollContainer(): HTMLElement

hasClass

  • hasClass(name: string): boolean
  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • hide(): void
  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

hideTitle

  • hideTitle(): void

hideToolbar

  • hideToolbar(): void

Protected notifyLayout

  • notifyLayout(msg: Message): void
  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

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

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    Returns void

Protected onChildRemoved

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onFitRequest

  • onFitRequest(msg: Message): void
  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onResize

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

processMessage

  • processMessage(msg: Message): void
  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

Protected registerContextMenu

removeClass

  • removeClass(name: string): void
  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

setFlag

  • setFlag(flag: Flag): void

setHidden

  • setHidden(hidden: boolean): void

show

  • show(): void
  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

showTitle

  • showTitle(): void

showToolbar

  • showToolbar(): void

testFlag

  • testFlag(flag: Flag): boolean
  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: undefined | false | true): boolean
  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: undefined | false | true

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void
  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Static closestPart

  • closestPart(element: Element | EventTarget | null, selector?: string): Element | undefined