Class SplitWidget

A widget containing a number of panes in a split layout.

Hierarchy (view full)

BaseWidget
- SplitWidget

Implements

Index

Constructors

Properties

compositeSaveable navigatable? onDidChangeTrackableWidgets onDidChangeTrackableWidgetsEmitter onDidChangeVisibility onDidChangeVisibilityEmitter onDidDispose onDidDisposeEmitter onScrollUp onScrollUpEmitter onScrollYReachEnd onScrollYReachEndEmitter scrollBar? scrollOptions? splitPanel toDispose toDisposeOnDetach

Accessors

handles orientation panes saveable

Constructors

constructor

new SplitWidget(options?): SplitWidget
Parameters
- Optional options: IOptions & {
  navigatable?: Navigatable;
  }
Returns SplitWidget
Overrides BaseWidget.constructor
- Defined in packages/core/src/browser/widgets/split-widget.ts:37

Properties

`Protected` `Readonly` compositeSaveable

compositeSaveable: CompositeSaveable = ...

`Protected` `Optional` navigatable

navigatable?: Navigatable

`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> = ...

`Protected` `Optional` scrollBar

scrollBar?: PerfectScrollbar

`Protected` `Optional` scrollOptions

scrollOptions?: Options

`Protected` `Readonly` splitPanel

splitPanel: SplitPanel

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

Accessors

handles

get handles(): readonly HTMLDivElement[]
Returns readonly HTMLDivElement[]
- Defined in packages/core/src/browser/widgets/split-widget.ts:84

orientation

get orientation(): Orientation
Returns Orientation
- Defined in packages/core/src/browser/widgets/split-widget.ts:68
set orientation(value): void
Parameters
- value: Orientation
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:72

panes

get panes(): readonly Widget[]
Returns readonly Widget[]
- Defined in packages/core/src/browser/widgets/split-widget.ts:117

saveable

get saveable(): Saveable
Returns Saveable
Implementation of SaveableSource.saveable
- Defined in packages/core/src/browser/widgets/split-widget.ts:88

Methods

`Protected` addClipboardListener

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

`Protected` addEventListener

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

`Protected` addKeyListener

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

addPane

addPane(pane): void
Parameters
- pane: Widget
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:129

`Protected` addUpdateListener

addUpdateListener<K>(element, type, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void
Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:199

clearFlag

clearFlag(flag): void
Parameters
- flag: Flag
Returns void
Inherited from BaseWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:232

createMoveToUri

createMoveToUri(resourceUri): undefined | URI
Creates a new URI to which this navigatable should moved based on the given target resource URI.
Parameters
- resourceUri: URI
Returns undefined | URI
Implementation of Navigatable.createMoveToUri
- Defined in packages/core/src/browser/widgets/split-widget.ts:96

`Protected` disableScrollBarFocus

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

dispose

dispose(): void
Returns void
Inherited from BaseWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:124

`Protected` fireDidChangeTrackableWidgets

fireDidChangeTrackableWidgets(): void
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:125

getPreviewNode

getPreviewNode(): undefined | Node
Returns undefined | Node
Inherited from BaseWidget.getPreviewNode
- Defined in packages/core/src/browser/widgets/widget.ts:221

getResourceUri

getResourceUri(): undefined | URI
Return an underlying resource URI.

Returns undefined | URI
Implementation of Navigatable.getResourceUri
- Defined in packages/core/src/browser/widgets/split-widget.ts:92

`Protected` getScrollContainer

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

getTrackableWidgets

getTrackableWidgets(): Widget[]
Returns Widget[]
Implementation of TrackableWidgetProvider.getTrackableWidgets
- Defined in packages/core/src/browser/widgets/split-widget.ts:121

insertPane

insertPane(index, pane): void
Parameters
- index: number
- pane: Widget
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:133

`Protected` onActivateRequest

onActivateRequest(msg): void
Parameters
- msg: Message
Returns void
Overrides BaseWidget.onActivateRequest
- Defined in packages/core/src/browser/widgets/split-widget.ts:151

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onAfterAttach
- Defined in packages/core/src/browser/widgets/widget.ts:156

`Protected` onAfterDetach

onAfterDetach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/src/browser/widgets/widget.ts:144

`Protected` onBeforeAttach

onBeforeAttach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onBeforeAttach
- Defined in packages/core/src/browser/widgets/widget.ts:137

`Protected` onBeforeDetach

onBeforeDetach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/src/browser/widgets/widget.ts:151

`Protected` onCloseRequest

onCloseRequest(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:132

`Protected` onPaneAdded

onPaneAdded(pane): void
Parameters
- pane: Widget
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:137

`Protected` onPaneRemoved

onPaneRemoved(pane): void
Parameters
- pane: Widget
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:144

`Protected` onUpdateRequest

onUpdateRequest(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onUpdateRequest
- Defined in packages/core/src/browser/widgets/widget.ts:192

relativeSizes

relativeSizes(): number[]
Returns number[]
- Defined in packages/core/src/browser/widgets/split-widget.ts:76

restoreState

restoreState(oldState): void
Called when the widget got created by the storage service
Parameters
- oldState: core.State
Returns void
Implementation of StatefulWidget.restoreState
- Defined in packages/core/src/browser/widgets/split-widget.ts:104

setFlag

setFlag(flag): void
Parameters
- flag: Flag
Returns void
Inherited from BaseWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:225

setRelativeSizes

setRelativeSizes(sizes): void
Parameters
- sizes: number[]
Returns void
- Defined in packages/core/src/browser/widgets/split-widget.ts:80

storeState

storeState(): core.State
Called on unload to store the inner state. Returns 'undefined' if the widget cannot be stored.

Returns core.State
Implementation of StatefulWidget.storeState
- Defined in packages/core/src/browser/widgets/split-widget.ts:100

Class SplitWidget

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SplitWidget

Properties

Protected Readonly compositeSaveable

Protected Optional navigatable

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

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly splitPanel

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Accessors

handles

Returns readonly HTMLDivElement[]

orientation

Returns Orientation

Parameters

Returns void

panes

Returns readonly Widget[]

saveable

Returns Saveable

Methods

Protected addClipboardListener

Type Parameters

Parameters

Returns void

Protected addEventListener

Type Parameters

Parameters

Returns void

Protected addKeyListener

Type Parameters

Parameters

Parameters

Returns boolean | void | Object

Returns void

addPane

Parameters

Returns void

Protected addUpdateListener

Type Parameters

Parameters

Returns void

clearFlag

Parameters

Returns void

createMoveToUri

Parameters

Returns undefined | URI

Protected disableScrollBarFocus

Parameters

Returns void

dispose

Returns void

Protected fireDidChangeTrackableWidgets

Returns void

getPreviewNode

Returns undefined | Node

getResourceUri

Returns undefined | URI

`Protected` `Readonly` compositeSaveable

`Protected` `Optional` navigatable

`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

`Protected` `Optional` scrollBar

`Protected` `Optional` scrollOptions

`Protected` `Readonly` splitPanel

`Protected` `Readonly` toDispose

`Protected` `Readonly` toDisposeOnDetach

`Protected` addClipboardListener

`Protected` addEventListener

`Protected` addKeyListener

`Protected` addUpdateListener

`Protected` disableScrollBarFocus

`Protected` fireDidChangeTrackableWidgets

`Protected` getScrollContainer

`Protected` onActivateRequest

`Protected` onAfterAttach

`Protected` onAfterDetach

`Protected` onBeforeAttach

`Protected` onBeforeDetach

`Protected` onCloseRequest

`Protected` onPaneAdded

`Protected` onPaneRemoved

`Protected` onUpdateRequest