Class ScmContribution

Representation of a tabbar toolbar contribution.

Hierarchy (View Summary)

AbstractViewContribution<ScmWidget>
- ScmContribution

Implements

Constructors

constructor

new ScmContribution(): ScmContribution
Returns ScmContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/scm/src/browser/scm-contribution.ts:148

Properties

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected` `Readonly`commands

commands: CommandService

`Protected` `Readonly`contextKeys

contextKeys: ContextKeyService

`Protected` `Readonly`dirtyDiffNavigator

dirtyDiffNavigator: DirtyDiffNavigator

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`scmDecorationsService

scmDecorationsService: ScmDecorationsService

`Protected`scmFocus

scmFocus: ContextKey<boolean>

`Protected` `Readonly`scmQuickOpenService

scmQuickOpenService: ScmQuickOpenService

`Protected` `Readonly`scmService

scmService: ScmService

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`statusBar

statusBar: StatusBar

`Protected` `Readonly`statusBarDisposable

statusBarDisposable: DisposableCollection = ...

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:35

Methods

`Protected`acceptInput

acceptInput(): Promise<void>
Returns Promise<void>
- Defined in packages/scm/src/browser/scm-contribution.ts:356

`Protected`acceptInputCommand

acceptInputCommand(): undefined | ScmCommand
Returns undefined | ScmCommand
- Defined in packages/scm/src/browser/scm-contribution.ts:362

closeView

closeView(): Promise<undefined | ScmWidget>
Returns Promise<undefined | ScmWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

`Protected`init

init(): void
Returns void
- Defined in packages/scm/src/browser/scm-contribution.ts:163

initializeLayout

initializeLayout(): Promise<void>
Called after the application shell has been attached in case there is no previous workbench layout state. Should return a promise if it runs asynchronously.

Returns Promise<void>
Implementation of FrontendApplicationContribution.initializeLayout
- Defined in packages/scm/src/browser/scm-contribution.ts:167

onStart

onStart(): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.

Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in packages/scm/src/browser/scm-contribution.ts:171

openView

openView(args?: Partial<OpenViewArguments>): Promise<ScmWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<ScmWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

registerColors

registerColors(colors: ColorRegistry): void
It should be aligned with https://github.com/microsoft/vscode/blob/0dfa355b3ad185a6289ba28a99c141ab9e72d2be/src/vs/workbench/contrib/scm/browser/dirtydiffDecorator.ts#L808
Parameters
- colors: ColorRegistry
Returns void
Implementation of ColorContribution.registerColors
- Defined in packages/scm/src/browser/scm-contribution.ts:405

registerCommands

registerCommands(commandRegistry: CommandRegistry): void
Register commands and handlers.
Parameters
- commandRegistry: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/scm/src/browser/scm-contribution.ts:189

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/scm/src/browser/scm-contribution.ts:322

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/scm/src/browser/scm-contribution.ts:246

registerThemeStyle

registerThemeStyle(theme: ColorTheme, collector: CssStyleCollector): void
Parameters
- theme: ColorTheme
- collector: CssStyleCollector
Returns void
Implementation of StylingParticipant.registerThemeStyle
- Defined in packages/scm/src/browser/scm-contribution.ts:482

registerToolbarItems

registerToolbarItems(registry: TabBarToolbarRegistry): void
Registers toolbar items.
Parameters
- registry: TabBarToolbarRegistry
  the tabbar toolbar registry.
Returns void
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/scm/src/browser/scm-contribution.ts:260

`Protected`setStatusBarEntry

setStatusBarEntry(id: string, entry: StatusBarEntry): void
Parameters
- id: string
- entry: StatusBarEntry
Returns void
- Defined in packages/scm/src/browser/scm-contribution.ts:397

toggleView

toggleView(): Promise<ScmWidget>
Returns Promise<ScmWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:40

tryGetWidget

tryGetWidget(): undefined | ScmWidget
Returns undefined | ScmWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

`Protected`updateContextKeys

updateContextKeys(): void
Returns void
- Defined in packages/scm/src/browser/scm-contribution.ts:185

`Protected`updateStatusBar

updateStatusBar(): void
Returns void
- Defined in packages/scm/src/browser/scm-contribution.ts:371