ScmWidget | Theia TypeDoc

Hierarchy

BaseWidget
- ScmWidget

Implements

StatefulWidget

Index

Constructors

constructor

Accessors

Constructors

constructor

new ScmWidget(): ScmWidget

Overrides BaseWidget.constructor
- Defined in packages/scm/src/browser/scm-widget.tsx:52
Returns ScmWidget

Properties

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 panel

panel: Panel

Readonly resourceWidget

resourceWidget: ScmTreeWidget

Protected Readonly scmPreferences

scmPreferences: PreferenceProxy<ScmConfiguration>

Protected Readonly scmService

scmService: ScmService

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toDisposeOnRefresh

toDisposeOnRefresh: DisposableCollection = ...

Static ID

ID: string = 'scm-view'

Accessors

containerLayout

get containerLayout(): PanelLayout

- Defined in packages/scm/src/browser/scm-widget.tsx:90
Returns PanelLayout

viewMode

get viewMode(): "tree" | "list"
set viewMode(mode: "tree" | "list"): void

- Defined in packages/scm/src/browser/scm-widget.tsx:50
Returns "tree" | "list"
- Defined in packages/scm/src/browser/scm-widget.tsx:47
Parameters
- mode: "tree" | "list"
Returns void

Methods

Protected addClipboardListener

addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:83
Type parameters
- K: "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

Inherited from BaseWidget.addEventListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:81
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
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

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

Inherited from BaseWidget.addKeyListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:82
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

Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:80
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

Inherited from BaseWidget.clearFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:85
Parameters
- flag: Flag
Returns void

collapseScmTree

collapseScmTree(): void

- Defined in packages/scm/src/browser/scm-widget.tsx:179
Returns void

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/lib/browser/widgets/widget.d.ts:78
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from BaseWidget.dispose
- Defined in packages/core/lib/browser/widgets/widget.d.ts:71
Returns void

Protected focusInput

focusInput(): void

- Defined in packages/scm/src/browser/scm-widget.tsx:161
Returns void

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/lib/browser/widgets/widget.d.ts:77
Returns MaybePromise<HTMLElement>

Protected init

init(): void

- Defined in packages/scm/src/browser/scm-widget.tsx:63
Returns void

Protected onActivateRequest

onActivateRequest(msg: Message): void

Overrides BaseWidget.onActivateRequest
- Defined in packages/scm/src/browser/scm-widget.tsx:151
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Overrides BaseWidget.onAfterAttach
- Defined in packages/scm/src/browser/scm-widget.tsx:141
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:74
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from BaseWidget.onBeforeAttach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:73
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:75
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:72
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Overrides BaseWidget.onUpdateRequest
- Defined in packages/scm/src/browser/scm-widget.tsx:133
Parameters
- msg: Message
Returns void

Protected refresh

refresh(): void

- Defined in packages/scm/src/browser/scm-widget.tsx:103
Returns void

restoreState

restoreState(oldState: any): void

Implementation of StatefulWidget.restoreState
- Defined in packages/scm/src/browser/scm-widget.tsx:173
Parameters
- oldState: any
Returns void

setFlag

setFlag(flag: Flag): void

Inherited from BaseWidget.setFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:84
Parameters
- flag: Flag
Returns void

storeState

storeState(): any

Implementation of StatefulWidget.storeState
- Defined in packages/scm/src/browser/scm-widget.tsx:165
Returns any

Protected updateImmediately

updateImmediately(): void

- Defined in packages/scm/src/browser/scm-widget.tsx:129
Returns void

Protected updateViewMode

updateViewMode(preference: "tree" | "list"): void

- Defined in packages/scm/src/browser/scm-widget.tsx:98
Updates the view mode based on the preference value.

Parameters
- preference: "tree" | "list"
  
  the view mode preference.
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ScmWidget

Properties

Protected Readonly amendWidget

Protected Readonly commitWidget

Readonly noRepositoryWidget

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected panel

Readonly resourceWidget

Protected Readonly scmPreferences

Protected Readonly scmService

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Protected Readonly toDisposeOnRefresh

Static ID

Accessors

containerLayout

Returns PanelLayout

viewMode

Returns "tree" | "list"

Parameters

mode: "tree" | "list"

Returns void

Methods

Protected addClipboardListener

Type parameters

K: "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type parameters

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener

Type parameters

Parameters

element: HTMLElement

keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]

action: (event: KeyboardEvent) => boolean | void | Object

Parameters

event: KeyboardEvent

Returns boolean | void | Object

Rest ...additionalEventTypes: K[]

Returns void

Protected addUpdateListener

Type parameters

Parameters

element: HTMLElement

type: K

Optional useCapture: boolean

Returns void

clearFlag

Parameters

flag: Flag

Returns void

collapseScmTree