Class ScmHistoryWidget

Hierarchy (view full)

ScmNavigableListWidget<ScmHistoryListNode>
- ScmHistoryWidget

Implements

StatefulWidget

Index

Constructors

constructor

Accessors

indexOfSelected scrollContainer

Constructors

constructor

new ScmHistoryWidget(openerService, shell, fileService, avatarService, widgetManager): ScmHistoryWidget
Parameters
- openerService: OpenerService
- shell: ApplicationShell
- fileService: FileService
- avatarService: ScmAvatarService
- widgetManager: WidgetManager
Returns ScmHistoryWidget
Overrides ScmNavigableListWidget.constructor
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:59

Properties

`Protected` allowScrollToSelected

allowScrollToSelected: boolean

`Protected` `Readonly` avatarService

avatarService: ScmAvatarService

`Private` cancelIndicator

cancelIndicator: CancellationTokenSource

`Protected` `Readonly` fileService

fileService: FileService

`Protected` hasMoreCommits

hasMoreCommits: boolean

`Protected` historySupport

historySupport: undefined | ScmHistorySupport

`Protected` `Readonly` labelProvider

labelProvider: LabelProvider

`Protected` listView

listView: undefined | ScmHistoryList

`Protected` `Readonly` openerService

openerService: OpenerService

`Protected` `Readonly` scmService

scmService: ScmService

setContent

setContent: DebouncedFuncLeading<((options?) => Promise<void>)> = ...

Type declaration

- (options?): Promise<void>
- Parameters
  - Optional options: HistoryWidgetOptions
  Returns Promise<void>

`Protected` `Readonly` shell

shell: ApplicationShell

`Protected` singleFileMode

singleFileMode: boolean

`Protected` status

status: {
    state: "loading";
} | {
    commits: ScmCommitNode[];
    state: "ready";
} | {
    errorMessage: ReactNode;
    state: "error";
}

Type declaration

state: "loading"

Type declaration

commits: ScmCommitNode[]
state: "ready"

Type declaration

errorMessage: ReactNode
state: "error"

`Protected` `Readonly` toDisposeOnRefresh

toDisposeOnRefresh: DisposableCollection = ...

`Protected` `Readonly` toDisposeOnRepositoryChange

toDisposeOnRepositoryChange: DisposableCollection = ...

`Protected` `Readonly` widgetManager

widgetManager: WidgetManager

Accessors

`Protected` indexOfSelected

get indexOfSelected(): number
Returns number
Inherited from ScmNavigableListWidget.indexOfSelected
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:153

`Protected` scrollContainer

get scrollContainer(): string
Returns string
Inherited from ScmNavigableListWidget.scrollContainer
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:54
set scrollContainer(id): void
Parameters
- id: string
Returns void
Inherited from ScmNavigableListWidget.scrollContainer
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:50

Methods

`Protected` addCommits

addCommits(options?): Promise<void>
Parameters
- Optional options: HistoryWidgetOptions
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:181

`Protected` addFileChangeNodes

addFileChangeNodes(commit, scmNodesArrayIndex): Promise<void>
Parameters
- commit: ScmCommitNode
- scmNodesArrayIndex: number
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:256

`Protected` addListNavigationKeyListeners

addListNavigationKeyListeners(container): void
Parameters
- container: HTMLElement
Returns void
Inherited from ScmNavigableListWidget.addListNavigationKeyListeners
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:96

`Protected` addOrRemoveFileChangeNodes

addOrRemoveFileChangeNodes(commit): Promise<void>
Parameters
- commit: ScmCommitNode
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:245

`Protected` createHistoryOptions

createHistoryOptions(): HistoryWidgetOptions
Returns HistoryWidgetOptions
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:111

`Protected` doLoadMoreRows

doLoadMoreRows(index): Promise<void>
Parameters
- index: number
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:370

`Protected` doRenderCommit

doRenderCommit(commit): ReactNode
Parameters
- commit: ScmCommitNode
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:390

`Protected` doRenderFileChangeList

doRenderFileChangeList(fileChange): ReactNode
Parameters
- fileChange: ScmFileChangeNode
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:451

`Protected` doSetContent

doSetContent(options?): Promise<void>
Parameters
- Optional options: HistoryWidgetOptions
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:158

`Protected` getRepositoryLabel

getRepositoryLabel(uri): undefined | string
Parameters
- uri: string
Returns undefined | string
Inherited from ScmNavigableListWidget.getRepositoryLabel
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:79

`Protected` getSelected

getSelected(): undefined | ScmHistoryListNode
Returns undefined | ScmHistoryListNode
Inherited from ScmNavigableListWidget.getSelected
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:124

`Protected` handleListEnter

handleListEnter(): void
Returns void
Overrides ScmNavigableListWidget.handleListEnter
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:498

`Protected` init

init(): void
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:81

`Protected` `Readonly` loadMoreRows

loadMoreRows(index): Promise<void>
Parameters
- index: number
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:369

`Protected` navigateDown

navigateDown(): void
Returns void
Inherited from ScmNavigableListWidget.navigateDown
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:116

`Protected` navigateLeft

navigateLeft(): void
Returns void
Overrides ScmNavigableListWidget.navigateLeft
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:466

`Protected` navigateRight

navigateRight(): void
Returns void
Overrides ScmNavigableListWidget.navigateRight
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:486

`Protected` navigateUp

navigateUp(): void
Returns void
Inherited from ScmNavigableListWidget.navigateUp
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:112

`Protected` onActivateRequest

onActivateRequest(msg): void
Parameters
- msg: Message
Returns void
Inherited from ScmNavigableListWidget.onActivateRequest
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:44

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Overrides ScmNavigableListWidget.onAfterAttach
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:142

`Protected` onDataReady

onDataReady(): void
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:286

`Protected` onResize

onResize(msg): void
Parameters
- msg: ResizeMessage
Returns void
Inherited from ScmNavigableListWidget.onResize
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:74

`Protected` onUpdateRequest

onUpdateRequest(msg): void
Parameters
- msg: Message
Returns void
Inherited from ScmNavigableListWidget.onUpdateRequest
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:58

`Protected` openDetailWidget

openDetailWidget(commitNode): Promise<void>
Parameters
- commitNode: ScmCommitNode
Returns Promise<void>
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:438

`Protected` openFile

openFile(change): void
Parameters
- change: ScmFileChange
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:514

`Protected` refresh

refresh(): void
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:118

`Protected` refreshOnRepositoryChange

refreshOnRepositoryChange(): void
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:91

`Protected` removeFileChangeNodes

removeFileChangeNodes(commit, scmNodesArrayIndex): void
Parameters
- commit: ScmCommitNode
- scmNodesArrayIndex: number
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:264

`Protected` render

render(): ReactNode
Returns ReactNode
Overrides ScmNavigableListWidget.render
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:293

`Protected` `Readonly` renderCommit

renderCommit(commit): ReactNode
Parameters
- commit: ScmCommitNode
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:389

`Protected` renderCommitList

renderCommitList(): ReactNode
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:354

`Protected` `Readonly` renderFileChangeList

renderFileChangeList(fileChange): ReactNode
Parameters
- fileChange: ScmFileChangeNode
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:450

`Protected` renderHeaderRow

renderHeaderRow(__namedParameters): ReactNode
Parameters
- __namedParameters: {
      classNames?: string[];
      name: string;
      title?: string;
      value: ReactNode;
  }
  - Optional classNames?: string[]
  - name: string
  - Optional title?: string
  - value: ReactNode
Returns ReactNode
Inherited from ScmNavigableListWidget.renderHeaderRow
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:85

`Protected` renderHistoryHeader

renderHistoryHeader(): ReactNode
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:336

`Protected` renderScmItem

renderScmItem(change, commitSha): ReactNode
Parameters
- change: ScmFileChangeNode
- commitSha: string
Returns ReactNode
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:456

`Protected` resetState

resetState(options?): void
Parameters
- Optional options: HistoryWidgetOptions
Returns void
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:175

restoreState

restoreState(oldState): void
Parameters
- oldState: any
Returns void
Implementation of StatefulWidget.restoreState
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:279

`Protected` selectNextNode

selectNextNode(): void
Returns void
Inherited from ScmNavigableListWidget.selectNextNode
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:137

`Protected` selectNode

selectNode(node): void
Parameters
- node: ScmHistoryListNode
Returns void
Inherited from ScmNavigableListWidget.selectNode
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:128

`Protected` selectPreviousNode

selectPreviousNode(): void
Returns void
Inherited from ScmNavigableListWidget.selectPreviousNode
- Defined in packages/scm-extra/src/browser/scm-navigable-list-widget.tsx:146

storeState

storeState(): object
Returns object
Implementation of StatefulWidget.storeState
- Defined in packages/scm-extra/src/browser/history/scm-history-widget.tsx:270

Class ScmHistoryWidget

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScmHistoryWidget

Properties

Protected allowScrollToSelected

Protected Readonly avatarService

Private cancelIndicator

Protected Readonly fileService

Protected hasMoreCommits

Protected historySupport

Protected Readonly labelProvider

Protected listView

Protected Readonly openerService

Protected options

Protected Readonly scmLabelProvider

Protected scmNodes

Protected Readonly scmService

setContent

Type declaration

Parameters

Returns Promise<void>

Protected Readonly shell

Protected singleFileMode

Protected status

Type declaration

state: "loading"

Type declaration

commits: ScmCommitNode[]

state: "ready"

Type declaration

errorMessage: ReactNode

state: "error"

Protected Readonly toDisposeOnRefresh

Protected Readonly toDisposeOnRepositoryChange

Protected Readonly widgetManager

Accessors

Protected indexOfSelected

Returns number

Protected scrollContainer

Returns string

Parameters

Returns void

Methods

Protected addCommits

Parameters

Returns Promise<void>

Protected addFileChangeNodes

Parameters

Returns Promise<void>

Protected addListNavigationKeyListeners

Parameters

Returns void

Protected addOrRemoveFileChangeNodes

Parameters

Returns Promise<void>

Protected createHistoryOptions

Returns HistoryWidgetOptions

Protected doLoadMoreRows

Parameters

Returns Promise<void>

Protected doRenderCommit

Parameters

Returns ReactNode

Protected doRenderFileChangeList

Parameters

Returns ReactNode

Protected doSetContent

Parameters

Returns Promise<void>

Protected getRepositoryLabel

Parameters

`Protected` allowScrollToSelected

`Protected` `Readonly` avatarService

`Private` cancelIndicator

`Protected` `Readonly` fileService

`Protected` hasMoreCommits

`Protected` historySupport

`Protected` `Readonly` labelProvider

`Protected` listView

`Protected` `Readonly` openerService

`Protected` options

`Protected` `Readonly` scmLabelProvider

`Protected` scmNodes

`Protected` `Readonly` scmService

`Protected` `Readonly` shell

`Protected` singleFileMode

`Protected` status

`Protected` `Readonly` toDisposeOnRefresh

`Protected` `Readonly` toDisposeOnRepositoryChange

`Protected` `Readonly` widgetManager

`Protected` indexOfSelected

`Protected` scrollContainer

`Protected` addCommits

`Protected` addFileChangeNodes

`Protected` addListNavigationKeyListeners

`Protected` addOrRemoveFileChangeNodes

`Protected` createHistoryOptions

`Protected` doLoadMoreRows

`Protected` doRenderCommit

`Protected` doRenderFileChangeList

`Protected` doSetContent

`Protected` getRepositoryLabel

`Protected` getSelected

`Protected` handleListEnter

`Protected` init

`Protected` `Readonly` loadMoreRows

`Protected` navigateDown

`Protected` navigateLeft

`Protected` navigateRight

`Protected` navigateUp

`Protected` onActivateRequest

`Protected` onAfterAttach

`Protected` onDataReady

`Protected` onResize

`Protected` onUpdateRequest

`Protected` openDetailWidget

`Protected` openFile

`Protected` refresh

`Protected` refreshOnRepositoryChange

`Protected` removeFileChangeNodes

`Protected` render

`Protected` `Readonly` renderCommit

`Protected` renderCommitList

`Protected` `Readonly` renderFileChangeList

`Protected` renderHeaderRow

`Optional` classNames?: string[]

`Optional` title?: string

`Protected` renderHistoryHeader

`Protected` renderScmItem

`Protected` resetState