Skip to content

Commit

Permalink
#27823 Implement view visibility using when context key expression
Browse files Browse the repository at this point in the history
  • Loading branch information
@sandy081
sandy081 committed Jun 7, 2017
1 parent 4324e9f commit 7434001
Show file tree
Hide file tree
Showing 7 changed files with 154 additions and 76 deletions.
13 changes: 11 additions & 2 deletions src/vs/base/browser/ui/splitview/splitview.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ export abstract class AbstractCollapsibleView extends HeaderView {

export abstract class CollapsibleView extends AbstractCollapsibleView {

private previousSize: number;
previousSize: number;

constructor(opts: ICollapsibleViewOptions) {
super(opts);
Expand Down Expand Up @@ -555,7 +555,7 @@ export class SplitView implements
}

/**
* Reset size to null. This will layout newly added viees to initial weights.
* Reset size to null. This will layout newly added views to initial weights.
*/
this.size = null;

Expand Down Expand Up @@ -599,13 +599,22 @@ export class SplitView implements
this.viewFocusNextListeners.splice(index, 0, view.addListener('focusNext', () => index < this.views.length && this.views[index + 1].focus()));
}

updateWeight(view: IView, weight: number) {
let index = this.views.indexOf(view);
if (index < 0) {
return;
}
this.initialWeights[index] = weight;
}

removeView(view: IView): void {
let index = this.views.indexOf(view);

if (index < 0) {
return;
}

this.size = null;
let deadView = new DeadView(view);
this.views[index] = deadView;
this.onViewChange(deadView, 0);
Expand Down
6 changes: 4 additions & 2 deletions src/vs/workbench/parts/debug/browser/debugViewlet.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import { IStorageService } from 'vs/platform/storage/common/storage';
import { IThemeService } from 'vs/platform/theme/common/themeService';
import { ViewLocation } from 'vs/workbench/parts/views/browser/viewsRegistry';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';

export class DebugViewlet extends ComposedViewsViewlet {

Expand All @@ -34,9 +35,10 @@ export class DebugViewlet extends ComposedViewsViewlet {
@IInstantiationService instantiationService: IInstantiationService,
@IWorkspaceContextService contextService: IWorkspaceContextService,
@IStorageService storageService: IStorageService,
@IThemeService themeService: IThemeService
@IThemeService themeService: IThemeService,
@IContextKeyService contextKeyService: IContextKeyService
) {
super(VIEWLET_ID, ViewLocation.Debug, `${VIEWLET_ID}.state`, telemetryService, storageService, instantiationService, themeService, contextService);
super(VIEWLET_ID, ViewLocation.Debug, `${VIEWLET_ID}.state`, telemetryService, storageService, instantiationService, themeService, contextService, contextKeyService);

this.progressRunner = null;

Expand Down
2 changes: 1 addition & 1 deletion src/vs/workbench/parts/files/browser/explorerViewlet.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class ExplorerViewlet extends ComposedViewsViewlet {
@IContextKeyService contextKeyService: IContextKeyService,
@IThemeService themeService: IThemeService
) {
super(VIEWLET_ID, ViewLocation.Explorer, ExplorerViewlet.EXPLORER_VIEWS_STATE, telemetryService, storageService, instantiationService, themeService, contextService);
super(VIEWLET_ID, ViewLocation.Explorer, ExplorerViewlet.EXPLORER_VIEWS_STATE, telemetryService, storageService, instantiationService, themeService, contextService, contextKeyService);

this.viewletState = new FileViewletState();
this.viewletVisibleContextKey = ExplorerViewletVisibleContext.bindTo(contextKeyService);
Expand Down
32 changes: 19 additions & 13 deletions src/vs/workbench/parts/views/browser/treeView.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,21 +128,27 @@ export class TreeView extends CollapsibleViewletView {
return super.setVisible(visible);
}

public setInput(): TPromise<void> {
if (this.listenToDataProvider()) {
this.treeInputPromise = this.tree.setInput(new Root());
return this.treeInputPromise;
}
this.treeInputPromise = new TPromise<void>((c, e) => {
this.dataProviderRegisteredListener = ViewsRegistry.onTreeViewDataProviderRegistered(id => {
if (this.id === id) {
if (this.listenToDataProvider()) {
this.tree.setInput(new Root()).then(() => c(null));
this.dataProviderRegisteredListener.dispose();
public create(): TPromise<void> {
return super.create().then(() => this.setInput());
}

private setInput(): TPromise<void> {
if (this.tree && !this.treeInputPromise) {
if (this.listenToDataProvider()) {
this.treeInputPromise = this.tree.setInput(new Root());
return this.treeInputPromise;
}
this.treeInputPromise = new TPromise<void>((c, e) => {
this.dataProviderRegisteredListener = ViewsRegistry.onTreeViewDataProviderRegistered(id => {
if (this.id === id) {
if (this.listenToDataProvider()) {
this.tree.setInput(new Root()).then(() => c(null));
this.dataProviderRegisteredListener.dispose();
}
}
}
});
});
});
}
return TPromise.as(null);
}

Expand Down
159 changes: 103 additions & 56 deletions src/vs/workbench/parts/views/browser/views.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { IThemeService } from 'vs/platform/theme/common/themeService';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IStorageService, StorageScope } from 'vs/platform/storage/common/storage';
import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';

export interface IViewletViewOptions extends IViewOptions {
viewletSettings: any;
Expand Down Expand Up @@ -129,9 +130,10 @@ export abstract class AdaptiveCollapsibleViewletView extends FixedCollapsibleVie
}

public setVisible(visible: boolean): TPromise<void> {
this.isVisible = visible;

updateTreeVisibility(this.tree, visible && this.state === CollapsibleState.EXPANDED);
if (this.isVisible !== visible) {
this.isVisible = visible;
updateTreeVisibility(this.tree, visible && this.state === CollapsibleState.EXPANDED);
}

return TPromise.as(null);
}
Expand Down Expand Up @@ -264,9 +266,10 @@ export abstract class CollapsibleViewletView extends CollapsibleView implements
}

public setVisible(visible: boolean): TPromise<void> {
this.isVisible = visible;

updateTreeVisibility(this.tree, visible && this.state === CollapsibleState.EXPANDED);
if (this.isVisible !== visible) {
this.isVisible = visible;
updateTreeVisibility(this.tree, visible && this.state === CollapsibleState.EXPANDED);
}

return TPromise.as(null);
}
Expand Down Expand Up @@ -396,16 +399,18 @@ export class ComposedViewsViewlet extends Viewlet {
@IStorageService protected storageService: IStorageService,
@IInstantiationService protected instantiationService: IInstantiationService,
@IThemeService themeService: IThemeService,
@IWorkspaceContextService protected contextService: IWorkspaceContextService
@IWorkspaceContextService protected contextService: IWorkspaceContextService,
@IContextKeyService protected contextKeyService: IContextKeyService
) {
super(id, telemetryService, themeService);

this.views = [];
this.viewletSettings = this.getMemento(storageService, Scope.WORKSPACE);
this.viewsStates = this.loadViewsStates();

this._register(ViewsRegistry.onViewsRegistered(viewDescriptors => this.createViews(viewDescriptors.filter(viewDescriptor => this.location === viewDescriptor.location))));
this._register(ViewsRegistry.onViewsDeregistered(viewDescriptors => this.removeViews(viewDescriptors.filter(viewDescriptor => this.location === viewDescriptor.location))));
this._register(ViewsRegistry.onViewsRegistered(viewDescriptors => this.addViews(viewDescriptors.filter(viewDescriptor => this.location === viewDescriptor.location))));
this._register(ViewsRegistry.onViewsDeregistered(viewDescriptors => this.updateViews([], viewDescriptors.filter(viewDescriptor => this.location === viewDescriptor.location))));
this._register(contextKeyService.onDidChangeContext(keys => this.onContextChanged(keys)));
}

public create(parent: Builder): TPromise<void> {
Expand All @@ -415,11 +420,11 @@ export class ComposedViewsViewlet extends Viewlet {
this.splitView = this._register(new SplitView(this.viewletContainer));
this._register(this.splitView.onFocus((view: IViewletView) => this.lastFocusedView = view));

const views = ViewsRegistry.getViews(this.location);
return this.createViews(views)
.then(() => this.lastFocusedView = this.views[0])
.then(() => this.setVisible(this.isVisible()))
.then(() => this.focus());
return this.addViews(ViewsRegistry.getViews(this.location))
.then(() => {
this.lastFocusedView = this.views[0];
this.focus();
});
}

public getActions(): IAction[] {
Expand All @@ -436,62 +441,72 @@ export class ComposedViewsViewlet extends Viewlet {
return [];
}

private createViews(viewDescriptors: IViewDescriptor[]): TPromise<void> {
if (!this.splitView || !viewDescriptors.length) {
private addViews(viewDescriptors: IViewDescriptor[]): TPromise<void> {
viewDescriptors = viewDescriptors.filter(viewDescriptor => this.contextKeyService.contextMatchesRules(viewDescriptor.when));
return this.updateViews(viewDescriptors, []);
}

private updateViews(toAdd: IViewDescriptor[], toRemove: IViewDescriptor[]): TPromise<void> {
if (!this.splitView || (!toAdd.length && !toRemove.length)) {
return TPromise.as(null);
}

const views = [];
const sorted = ViewsRegistry.getViews(this.location).sort((a, b) => {
if (b.order === void 0 || b.order === null) {
return -1;
for (const view of this.views) {
let viewState = this.viewsStates.get(view.id);
if (viewState && view.size !== viewState.size) {
viewState = this.getViewState(view);
this.viewsStates.set(view.id, viewState);
this.splitView.updateWeight(view, viewState.size);
}
if (a.order === void 0 || a.order === null) {
return 1;
}

if (toRemove.length) {
for (const viewDescriptor of toRemove) {
let view = this.getView(viewDescriptor.id);
if (view) {
this.views.splice(this.views.indexOf(view), 1);
this.splitView.removeView(view);
}
}
return a.order - b.order;
});
for (const viewDescriptor of viewDescriptors) {
}

const toCreate = [];
const viewsInOrder = ViewsRegistry.getViews(this.location)
.filter(viewDescriptor => this.contextKeyService.contextMatchesRules(viewDescriptor.when))
.sort((a, b) => {
if (b.order === void 0 || b.order === null) {
return -1;
}
if (a.order === void 0 || a.order === null) {
return 1;
}
return a.order - b.order;
});

for (const viewDescriptor of toAdd) {
let viewState = this.viewsStates.get(viewDescriptor.id);
let index = sorted.indexOf(viewDescriptor);
let index = viewsInOrder.indexOf(viewDescriptor);
const view = this.createView(viewDescriptor, {
name: viewDescriptor.name,
actionRunner: this.getActionRunner(),
collapsed: viewState ? viewState.collapsed : true,
viewletSettings: this.viewletSettings
});
if (index !== -1) {
this.views.splice(index, 0, view);
} else {
this.views.push(view);
}
views.push(view);
attachHeaderViewStyler(view, this.themeService);
this.splitView.addView(view, viewState ? Math.max(viewState.size, 1) : viewDescriptor.size, index);
}
toCreate.push(view);

return TPromise.join(views.map(view => view.create()))
.then(() => this.onViewsUpdated());
}


private removeViews(viewDescriptors: IViewDescriptor[]): void {
if (!this.splitView || !viewDescriptors.length) {
return;
}

for (const viewDescriptor of viewDescriptors) {
let view = this.getView(viewDescriptor.id);
if (view) {
this.views.splice(this.views.indexOf(view), 1);
this.splitView.removeView(view);
this.views.splice(index, 0, view);
attachHeaderViewStyler(view, this.themeService);
if (view instanceof CollapsibleView && viewState && viewState.size) {
view.previousSize = Math.max(viewState.size, 1);
}
this.splitView.addView(view, viewState && viewState.size ? Math.max(viewState.size, 1) : viewDescriptor.size, index);
}

this.onViewsUpdated();
return TPromise.join(toCreate.map(view => view.create()))
.then(() => this.onViewsUpdated());
}

private onViewsUpdated(): void {
private onViewsUpdated(): TPromise<void> {
if (this.views.length === 1) {
this.views[0].hideHeader();
if (!this.views[0].isExpanded()) {
Expand All @@ -509,6 +524,28 @@ export class ComposedViewsViewlet extends Viewlet {

// Update title area since the title actions have changed.
this.updateTitleArea();

return this.setVisible(this.isVisible());
}

private onContextChanged(keys: string[]): void {
let viewsToCreate: IViewDescriptor[] = [];
let viewsToRemove: IViewDescriptor[] = [];

for (const viewDescriptor of ViewsRegistry.getViews(this.location)) {
const view = this.getView(viewDescriptor.id);
if (this.contextKeyService.contextMatchesRules(viewDescriptor.when)) {
if (!view) {
viewsToCreate.push(viewDescriptor);
}
} else {
if (view) {
viewsToRemove.push(viewDescriptor);
}
}
}

this.updateViews(viewsToCreate, viewsToRemove);
}

public setVisible(visible: boolean): TPromise<void> {
Expand All @@ -527,6 +564,10 @@ export class ComposedViewsViewlet extends Viewlet {
public layout(dimension: Dimension): void {
this.dimension = dimension;
this.splitView.layout(dimension.height);
for (const view of this.views) {
let viewState = this.getViewState(view);
this.viewsStates.set(view.id, viewState);
}
}

public getOptimalWidth(): number {
Expand All @@ -543,10 +584,7 @@ export class ComposedViewsViewlet extends Viewlet {

protected saveViewsStates(): void {
const viewletState = this.views.reduce((result, view) => {
result[view.id] = {
collapsed: !view.isExpanded(),
size: view.size > 0 ? view.size : void 0
};
result[view.id] = this.getViewState(view);
return result;
}, {});
this.storageService.store(this.viewletStateStorageId, JSON.stringify(viewletState), this.contextService.hasWorkspace() ? StorageScope.WORKSPACE : StorageScope.GLOBAL);
Expand All @@ -567,4 +605,13 @@ export class ComposedViewsViewlet extends Viewlet {
protected getView(id: string): IViewletView {
return this.views.filter(view => view.id === id)[0];
}

private getViewState(view: IViewletView): IViewState {
const collapsed = !view.isExpanded();
const size = collapsed && view instanceof CollapsibleView ? view.previousSize : view.size;
return {
collapsed,
size: size && size > 0 ? size : void 0
};
}
}
Loading

0 comments on commit 7434001

Please sign in to comment.