Skip to content

Commit b368ea7

Browse files
committed
list: renames
1 parent 20ce983 commit b368ea7

21 files changed

Lines changed: 76 additions & 77 deletions

File tree

src/vs/base/browser/ui/list/list.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,16 @@
55

66
import { GestureEvent } from 'vs/base/browser/touch';
77

8-
export interface IVirtualDelegate<T> {
8+
export interface IListVirtualDelegate<T> {
99
getHeight(element: T): number;
1010
getTemplateId(element: T): string;
1111
}
1212

13-
// TODO@joao rename to IListRenderer
14-
export interface IRenderer<TElement, TTemplateData> {
13+
export interface IListRenderer<T, TTemplateData> {
1514
templateId: string;
1615
renderTemplate(container: HTMLElement): TTemplateData;
17-
renderElement(element: TElement, index: number, templateData: TTemplateData): void;
18-
disposeElement(element: TElement, index: number, templateData: TTemplateData): void;
16+
renderElement(element: T, index: number, templateData: TTemplateData): void;
17+
disposeElement(element: T, index: number, templateData: TTemplateData): void;
1918
disposeTemplate(templateData: TTemplateData): void;
2019
}
2120

src/vs/base/browser/ui/list/listPaging.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
import 'vs/css!./list';
77
import { IDisposable } from 'vs/base/common/lifecycle';
88
import { range } from 'vs/base/common/arrays';
9-
import { IVirtualDelegate, IRenderer, IListEvent, IListContextMenuEvent } from './list';
9+
import { IListVirtualDelegate, IListRenderer, IListEvent, IListContextMenuEvent } from './list';
1010
import { List, IListStyles, IListOptions } from './listWidget';
1111
import { IPagedModel } from 'vs/base/common/paging';
1212
import { Event, mapEvent } from 'vs/base/common/event';
1313
import { CancellationTokenSource } from 'vs/base/common/cancellation';
1414

15-
export interface IPagedRenderer<TElement, TTemplateData> extends IRenderer<TElement, TTemplateData> {
15+
export interface IPagedRenderer<TElement, TTemplateData> extends IListRenderer<TElement, TTemplateData> {
1616
renderPlaceholder(index: number, templateData: TTemplateData): void;
1717
}
1818

@@ -21,7 +21,7 @@ export interface ITemplateData<T> {
2121
disposable: IDisposable;
2222
}
2323

24-
class PagedRenderer<TElement, TTemplateData> implements IRenderer<number, ITemplateData<TTemplateData>> {
24+
class PagedRenderer<TElement, TTemplateData> implements IListRenderer<number, ITemplateData<TTemplateData>> {
2525

2626
get templateId(): string { return this.renderer.templateId; }
2727

@@ -71,7 +71,7 @@ export class PagedList<T> implements IDisposable {
7171

7272
constructor(
7373
container: HTMLElement,
74-
virtualDelegate: IVirtualDelegate<number>,
74+
virtualDelegate: IListVirtualDelegate<number>,
7575
renderers: IPagedRenderer<T, any>[],
7676
options: IListOptions<any> = {}
7777
) {

src/vs/base/browser/ui/list/listView.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { domEvent } from 'vs/base/browser/event';
1212
import { ScrollableElement } from 'vs/base/browser/ui/scrollbar/scrollableElement';
1313
import { ScrollEvent, ScrollbarVisibility } from 'vs/base/common/scrollable';
1414
import { RangeMap, shift } from './rangeMap';
15-
import { IVirtualDelegate, IRenderer, IListMouseEvent, IListTouchEvent, IListGestureEvent } from './list';
15+
import { IListVirtualDelegate, IListRenderer, IListMouseEvent, IListTouchEvent, IListGestureEvent } from './list';
1616
import { RowCache, IRow } from './rowCache';
1717
import { isWindows } from 'vs/base/common/platform';
1818
import * as browser from 'vs/base/browser/browser';
@@ -60,7 +60,7 @@ export class ListView<T> implements ISpliceable<T>, IDisposable {
6060
private itemId: number;
6161
private rangeMap: RangeMap;
6262
private cache: RowCache<T>;
63-
private renderers = new Map<string, IRenderer<T, any>>();
63+
private renderers = new Map<string, IListRenderer<T, any>>();
6464
private lastRenderTop: number;
6565
private lastRenderHeight: number;
6666
private _domNode: HTMLElement;
@@ -78,8 +78,8 @@ export class ListView<T> implements ISpliceable<T>, IDisposable {
7878

7979
constructor(
8080
container: HTMLElement,
81-
private virtualDelegate: IVirtualDelegate<T>,
82-
renderers: IRenderer<T, any>[],
81+
private virtualDelegate: IListVirtualDelegate<T>,
82+
renderers: IListRenderer<T, any>[],
8383
options: IListViewOptions = DefaultOptions
8484
) {
8585
this.items = [];

src/vs/base/browser/ui/list/listWidget.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import { KeyCode } from 'vs/base/common/keyCodes';
1616
import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
1717
import { Event, Emitter, EventBufferer, chain, mapEvent, anyEvent } from 'vs/base/common/event';
1818
import { domEvent } from 'vs/base/browser/event';
19-
import { IVirtualDelegate, IRenderer, IListEvent, IListContextMenuEvent, IListMouseEvent, IListTouchEvent, IListGestureEvent } from './list';
19+
import { IListVirtualDelegate, IListRenderer, IListEvent, IListContextMenuEvent, IListMouseEvent, IListTouchEvent, IListGestureEvent } from './list';
2020
import { ListView, IListViewOptions } from './listView';
2121
import { Color } from 'vs/base/common/color';
2222
import { mixin } from 'vs/base/common/objects';
@@ -41,7 +41,7 @@ interface IRenderedContainer {
4141
index: number;
4242
}
4343

44-
class TraitRenderer<T> implements IRenderer<T, ITraitTemplateData>
44+
class TraitRenderer<T> implements IListRenderer<T, ITraitTemplateData>
4545
{
4646
private renderedElements: IRenderedContainer[] = [];
4747

@@ -807,11 +807,11 @@ function relativeComplement(one: number[], other: number[]): number[] {
807807

808808
const numericSort = (a: number, b: number) => a - b;
809809

810-
class PipelineRenderer<T> implements IRenderer<T, any> {
810+
class PipelineRenderer<T> implements IListRenderer<T, any> {
811811

812812
constructor(
813813
private _templateId: string,
814-
private renderers: IRenderer<T, any>[]
814+
private renderers: IListRenderer<T, any>[]
815815
) { }
816816

817817
get templateId(): string {
@@ -903,8 +903,8 @@ export class List<T> implements ISpliceable<T>, IDisposable {
903903

904904
constructor(
905905
container: HTMLElement,
906-
virtualDelegate: IVirtualDelegate<T>,
907-
renderers: IRenderer<T, any>[],
906+
virtualDelegate: IListVirtualDelegate<T>,
907+
renderers: IListRenderer<T, any>[],
908908
options: IListOptions<T> = DefaultOptions
909909
) {
910910
this.focus = new FocusTrait(i => this.getElementDomId(i));

src/vs/base/browser/ui/list/rowCache.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Licensed under the MIT License. See License.txt in the project root for license information.
44
*--------------------------------------------------------------------------------------------*/
55

6-
import { IRenderer } from './list';
6+
import { IListRenderer } from './list';
77
import { IDisposable } from 'vs/base/common/lifecycle';
88
import { $, removeClass } from 'vs/base/browser/dom';
99

@@ -25,7 +25,7 @@ export class RowCache<T> implements IDisposable {
2525

2626
private cache = new Map<string, IRow[]>();
2727

28-
constructor(private renderers: Map<string, IRenderer<T, any>>) { }
28+
constructor(private renderers: Map<string, IListRenderer<T, any>>) { }
2929

3030
/**
3131
* Returns a row either by creating a new one or reusing

src/vs/base/browser/ui/selectBox/selectBoxCustom.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import * as dom from 'vs/base/browser/dom';
1414
import * as arrays from 'vs/base/common/arrays';
1515
import { IContextViewProvider, AnchorPosition } from 'vs/base/browser/ui/contextview/contextview';
1616
import { List } from 'vs/base/browser/ui/list/listWidget';
17-
import { IVirtualDelegate, IRenderer, IListEvent } from 'vs/base/browser/ui/list/list';
17+
import { IListVirtualDelegate, IListRenderer, IListEvent } from 'vs/base/browser/ui/list/list';
1818
import { domEvent } from 'vs/base/browser/event';
1919
import { ScrollbarVisibility } from 'vs/base/common/scrollable';
2020
import { ISelectBoxDelegate, ISelectBoxOptions, ISelectBoxStyles, ISelectData } from 'vs/base/browser/ui/selectBox/selectBox';
@@ -38,7 +38,7 @@ interface ISelectListTemplateData {
3838
disposables: IDisposable[];
3939
}
4040

41-
class SelectListRenderer implements IRenderer<ISelectOptionItem, ISelectListTemplateData> {
41+
class SelectListRenderer implements IListRenderer<ISelectOptionItem, ISelectListTemplateData> {
4242

4343
get templateId(): string { return SELECT_OPTION_ENTRY_TEMPLATE_ID; }
4444

@@ -90,7 +90,7 @@ class SelectListRenderer implements IRenderer<ISelectOptionItem, ISelectListTemp
9090
}
9191
}
9292

93-
export class SelectBoxList implements ISelectBoxDelegate, IVirtualDelegate<ISelectOptionItem> {
93+
export class SelectBoxList implements ISelectBoxDelegate, IListVirtualDelegate<ISelectOptionItem> {
9494

9595
private static readonly DEFAULT_DROPDOWN_MINIMUM_BOTTOM_MARGIN = 32;
9696
private static readonly DEFAULT_DROPDOWN_MINIMUM_TOP_MARGIN = 2;

src/vs/base/browser/ui/tree/abstractTree.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import 'vs/css!./tree';
77
import { IDisposable, dispose } from 'vs/base/common/lifecycle';
88
import { IListOptions, List, IIdentityProvider, IMultipleSelectionController, IListStyles } from 'vs/base/browser/ui/list/listWidget';
9-
import { IVirtualDelegate, IRenderer, IListMouseEvent, IListEvent, IListContextMenuEvent } from 'vs/base/browser/ui/list/list';
9+
import { IListVirtualDelegate, IListRenderer, IListMouseEvent, IListEvent, IListContextMenuEvent } from 'vs/base/browser/ui/list/list';
1010
import { append, $ } from 'vs/base/browser/dom';
1111
import { Event, Relay, chain } from 'vs/base/common/event';
1212
import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
@@ -45,9 +45,9 @@ export function createComposedTreeListOptions<T, N extends { element: T }>(optio
4545
};
4646
}
4747

48-
export class ComposedTreeDelegate<T, N extends { element: T }> implements IVirtualDelegate<N> {
48+
export class ComposedTreeDelegate<T, N extends { element: T }> implements IListVirtualDelegate<N> {
4949

50-
constructor(private delegate: IVirtualDelegate<T>) { }
50+
constructor(private delegate: IListVirtualDelegate<T>) { }
5151

5252
getHeight(element: N): number {
5353
return this.delegate.getHeight(element.element);
@@ -71,7 +71,7 @@ function renderDefaultTwistie<T>(node: ITreeNode<T, any>, twistie: HTMLElement):
7171
}
7272
}
7373

74-
class TreeRenderer<T, TFilterData, TTemplateData> implements IRenderer<ITreeNode<T, TFilterData>, ITreeListTemplateData<TTemplateData>> {
74+
class TreeRenderer<T, TFilterData, TTemplateData> implements IListRenderer<ITreeNode<T, TFilterData>, ITreeListTemplateData<TTemplateData>> {
7575

7676
readonly templateId: string;
7777
private renderedElements = new Map<T, ITreeNode<T, TFilterData>>();
@@ -182,7 +182,7 @@ export abstract class AbstractTree<T, TFilterData, TRef> implements IDisposable
182182

183183
constructor(
184184
container: HTMLElement,
185-
delegate: IVirtualDelegate<T>,
185+
delegate: IListVirtualDelegate<T>,
186186
renderers: ITreeRenderer<T, TFilterData, any>[],
187187
options?: ITreeOptions<T, TFilterData>
188188
) {

src/vs/base/browser/ui/tree/dataTree.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import { ITreeOptions, ComposedTreeDelegate, createComposedTreeListOptions } from 'vs/base/browser/ui/tree/abstractTree';
77
import { ObjectTree } from 'vs/base/browser/ui/tree/objectTree';
8-
import { IVirtualDelegate } from 'vs/base/browser/ui/list/list';
8+
import { IListVirtualDelegate } from 'vs/base/browser/ui/list/list';
99
import { ITreeElement, ITreeNode, ITreeRenderer } from 'vs/base/browser/ui/tree/tree';
1010
import { IDisposable, dispose } from 'vs/base/common/lifecycle';
1111
import { Emitter, Event } from 'vs/base/common/event';
@@ -107,7 +107,7 @@ export class DataTree<T extends NonNullable<any>, TFilterData = void> implements
107107

108108
constructor(
109109
container: HTMLElement,
110-
delegate: IVirtualDelegate<T>,
110+
delegate: IListVirtualDelegate<T>,
111111
renderers: ITreeRenderer<T, TFilterData, any>[],
112112
private dataSource: IDataSource<T>,
113113
options?: ITreeOptions<T, TFilterData>

src/vs/base/browser/ui/tree/tree.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import { Event } from 'vs/base/common/event';
77
import { Iterator } from 'vs/base/common/iterator';
8-
import { IRenderer } from 'vs/base/browser/ui/list/list';
8+
import { IListRenderer } from 'vs/base/browser/ui/list/list';
99

1010
export const enum TreeVisibility {
1111
Hidden,
@@ -67,7 +67,7 @@ export interface ITreeModel<T, TFilterData, TRef> {
6767
getLastElementAncestor(location: TRef): T | null;
6868
}
6969

70-
export interface ITreeRenderer<T, TFilterData, TTemplateData> extends IRenderer<ITreeNode<T, TFilterData>, TTemplateData> {
70+
export interface ITreeRenderer<T, TFilterData, TTemplateData> extends IListRenderer<ITreeNode<T, TFilterData>, TTemplateData> {
7171
renderTwistie?(element: T, twistieElement: HTMLElement): boolean;
7272
onDidChangeTwistieState?: Event<T>;
7373
}

src/vs/base/test/browser/ui/list/listView.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import * as assert from 'assert';
77
import { ListView } from 'vs/base/browser/ui/list/listView';
8-
import { IVirtualDelegate, IRenderer } from 'vs/base/browser/ui/list/list';
8+
import { IListVirtualDelegate, IListRenderer } from 'vs/base/browser/ui/list/list';
99
import { range } from 'vs/base/common/arrays';
1010

1111
suite('ListView', function () {
@@ -14,14 +14,14 @@ suite('ListView', function () {
1414
element.style.height = '200px';
1515
element.style.width = '200px';
1616

17-
const delegate: IVirtualDelegate<number> = {
17+
const delegate: IListVirtualDelegate<number> = {
1818
getHeight() { return 20; },
1919
getTemplateId() { return 'template'; }
2020
};
2121

2222
let templatesCount = 0;
2323

24-
const renderer: IRenderer<number, void> = {
24+
const renderer: IListRenderer<number, void> = {
2525
templateId: 'template',
2626
renderTemplate() { templatesCount++; },
2727
renderElement() { },

0 commit comments

Comments
 (0)