quickOpenWidget.ts 26.4 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5 6 7
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
'use strict';

import 'vs/css!./quickopen';
B
Benjamin Pasero 已提交
8
import nls = require('vs/nls');
9
import {TPromise} from 'vs/base/common/winjs.base';
E
Erich Gamma 已提交
10 11 12 13 14 15
import platform = require('vs/base/common/platform');
import browser = require('vs/base/browser/browser');
import {EventType} from 'vs/base/common/events';
import types = require('vs/base/common/types');
import errors = require('vs/base/common/errors');
import uuid = require('vs/base/common/uuid');
16
import {IQuickNavigateConfiguration, IAutoFocus, IEntryRunContext, IModel, Mode} from 'vs/base/parts/quickopen/common/quickOpen';
17
import {Filter, Renderer, DataSource, IModelProvider, AccessibilityProvider} from 'vs/base/parts/quickopen/browser/quickOpenViewer';
E
Erich Gamma 已提交
18
import {Dimension, Builder, $} from 'vs/base/browser/builder';
J
Joao Moreno 已提交
19
import {ISelectionEvent, IFocusEvent, ITree, ContextMenuEvent} from 'vs/base/parts/tree/browser/tree';
20 21
import {InputBox, MessageType} from 'vs/base/browser/ui/inputbox/inputBox';
import Severity from 'vs/base/common/severity';
E
Erich Gamma 已提交
22 23 24 25 26 27
import {Tree} from 'vs/base/parts/tree/browser/treeImpl';
import {ProgressBar} from 'vs/base/browser/ui/progressbar/progressbar';
import {StandardKeyboardEvent} from 'vs/base/browser/keyboardEvent';
import {DefaultController, ClickBehavior} from 'vs/base/parts/tree/browser/treeDefaults';
import DOM = require('vs/base/browser/dom');
import {IActionProvider} from 'vs/base/parts/tree/browser/actionsRenderer';
28
import {KeyCode, KeyMod, CommonKeybindings} from 'vs/base/common/keyCodes';
B
Benjamin Pasero 已提交
29
import {IDisposable, dispose} from 'vs/base/common/lifecycle';
30
import {ScrollbarVisibility} from 'vs/base/common/scrollable';
E
Erich Gamma 已提交
31 32 33 34 35 36

export interface IQuickOpenCallbacks {
	onOk: () => void;
	onCancel: () => void;
	onType: (value: string) => void;
	onShow?: () => void;
37
	onHide?: (focusLost?: boolean) => void;
E
Erich Gamma 已提交
38 39 40 41 42 43 44 45 46 47 48 49
	onFocusLost?: () => boolean /* veto close */;
}

export interface IQuickOpenOptions {
	minItemsToShow?: number;
	maxItemsToShow?: number;
	inputPlaceHolder: string;
	inputAriaLabel?: string;
	actionProvider?: IActionProvider;
	enableAnimations?: boolean;
}

B
Benjamin Pasero 已提交
50 51 52 53 54
export interface IShowOptions {
	quickNavigateConfiguration?: IQuickNavigateConfiguration;
	autoFocus?: IAutoFocus;
}

E
Erich Gamma 已提交
55 56 57 58
export interface IQuickOpenUsageLogger {
	publicLog(eventName: string, data?: any): void;
}

59 60
export class QuickOpenController extends DefaultController {

61
	public onContextMenu(tree: ITree, element: any, event: ContextMenuEvent): boolean {
62 63 64 65 66 67 68 69
		if (platform.isMacintosh) {
			return this.onLeftClick(tree, element, event); // https://github.com/Microsoft/vscode/issues/1011
		}

		return super.onContextMenu(tree, element, event);
	}
}

B
Benjamin Pasero 已提交
70
export enum HideReason {
71 72 73 74 75
	ELEMENT_SELECTED,
	FOCUS_LOST,
	CANCELED
}

76 77
const DEFAULT_INPUT_ARIA_LABEL = nls.localize('quickOpenAriaLabel', "Quick picker. Type to narrow down results.");

E
Erich Gamma 已提交
78 79
export class QuickOpenWidget implements IModelProvider {

B
Benjamin Pasero 已提交
80 81
	private static MAX_WIDTH = 600;				// Max total width of quick open widget
	private static MAX_ITEMS_HEIGHT = 20 * 22;	// Max height of item list below input field
E
Erich Gamma 已提交
82 83 84 85 86 87 88 89 90 91 92 93

	private options: IQuickOpenOptions;
	private builder: Builder;
	private tree: ITree;
	private inputBox: InputBox;
	private inputContainer: Builder;
	private helpText: Builder;
	private treeContainer: Builder;
	private progressBar: ProgressBar;
	private visible: boolean;
	private isLoosingFocus: boolean;
	private callbacks: IQuickOpenCallbacks;
A
Alex Dima 已提交
94
	private toUnbind: IDisposable[];
E
Erich Gamma 已提交
95 96 97
	private currentInputToken: string;
	private quickNavigateConfiguration: IQuickNavigateConfiguration;
	private container: HTMLElement;
98 99
	private treeElement: HTMLElement;
	private inputElement: HTMLElement;
E
Erich Gamma 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
	private usageLogger: IQuickOpenUsageLogger;
	private layoutDimensions: Dimension;
	private model: IModel<any>;

	constructor(container: HTMLElement, callbacks: IQuickOpenCallbacks, options: IQuickOpenOptions, usageLogger?: IQuickOpenUsageLogger) {
		this.toUnbind = [];
		this.container = container;
		this.callbacks = callbacks;
		this.options = options;
		this.usageLogger = usageLogger;
		this.model = null;
	}

	getModel(): IModel<any> {
		return this.model;
	}

	public setCallbacks(callbacks: IQuickOpenCallbacks): void {
		this.callbacks = callbacks;
	}

	public create(): void {
		this.builder = $().div((div: Builder) => {

			// Eventing
			div.on(DOM.EventType.KEY_DOWN, (e: KeyboardEvent) => {
				let keyboardEvent: StandardKeyboardEvent = new StandardKeyboardEvent(e);
				if (keyboardEvent.keyCode === KeyCode.Escape) {
					DOM.EventHelper.stop(e, true);

130
					this.hide(HideReason.CANCELED);
E
Erich Gamma 已提交
131 132
				}
			})
B
Benjamin Pasero 已提交
133 134 135
				.on(DOM.EventType.CONTEXT_MENU, (e: Event) => DOM.EventHelper.stop(e, true)) // Do this to fix an issue on Mac where the menu goes into the way
				.on(DOM.EventType.FOCUS, (e: Event) => this.gainingFocus(), null, true)
				.on(DOM.EventType.BLUR, (e: Event) => this.loosingFocus(e), null, true);
E
Erich Gamma 已提交
136 137 138 139 140 141 142 143 144 145

			// Progress Bar
			this.progressBar = new ProgressBar(div.clone());
			this.progressBar.getContainer().hide();

			// Input Field
			div.div({ 'class': 'quick-open-input' }, (inputContainer) => {
				this.inputContainer = inputContainer;
				this.inputBox = new InputBox(inputContainer.getHTMLElement(), null, {
					placeholder: this.options.inputPlaceHolder || '',
146
					ariaLabel: DEFAULT_INPUT_ARIA_LABEL
E
Erich Gamma 已提交
147
				});
148 149 150 151 152 153 154

				// ARIA
				this.inputElement = this.inputBox.inputElement;
				this.inputElement.setAttribute('role', 'combobox');
				this.inputElement.setAttribute('aria-haspopup', 'false');
				this.inputElement.setAttribute('aria-autocomplete', 'list');

E
Erich Gamma 已提交
155 156 157
				DOM.addDisposableListener(this.inputBox.inputElement, DOM.EventType.KEY_DOWN, (e: KeyboardEvent) => {
					let keyboardEvent: StandardKeyboardEvent = new StandardKeyboardEvent(e);

158 159 160 161 162 163 164 165 166
					if (platform.isMacintosh) {
						if (keyboardEvent.equals(CommonKeybindings.WINCTRL_N)) {
							keyboardEvent.keyCode = KeyCode.DownArrow;
						}
						else if (keyboardEvent.equals(CommonKeybindings.WINCTRL_P)) {
							keyboardEvent.keyCode = KeyCode.UpArrow;
						}
					}

167 168 169 170 171
					// Do not handle Tab: It is used to navigate between elements without mouse
					if (keyboardEvent.keyCode === KeyCode.Tab) {
						return;
					}

E
Erich Gamma 已提交
172
					// Pass tree navigation keys to the tree but leave focus in input field
173
					else if (keyboardEvent.keyCode === KeyCode.Tab || keyboardEvent.keyCode === KeyCode.DownArrow || keyboardEvent.keyCode === KeyCode.UpArrow || keyboardEvent.keyCode === KeyCode.PageDown || keyboardEvent.keyCode === KeyCode.PageUp) {
E
Erich Gamma 已提交
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
						DOM.EventHelper.stop(e, true);

						this.navigateInTree(keyboardEvent.keyCode, keyboardEvent.shiftKey);
					}

					// Select element on Enter
					else if (keyboardEvent.keyCode === KeyCode.Enter) {
						DOM.EventHelper.stop(e, true);

						let focus = this.tree.getFocus();
						if (focus) {
							this.elementSelected(focus, e);
						}
					}

					// Bug in IE 9: onInput is not fired for Backspace or Delete keys
					else if (browser.isIE9 && (keyboardEvent.keyCode === KeyCode.Backspace || keyboardEvent.keyCode === KeyCode.Delete)) {
						this.onType();
					}
				});

				DOM.addDisposableListener(this.inputBox.inputElement, DOM.EventType.INPUT, (e: Event) => {
					this.onType();
				});
			});

			// Tree
			this.treeContainer = div.div({
				'class': 'quick-open-tree'
			}, (div: Builder) => {
				this.tree = new Tree(div.getHTMLElement(), {
					dataSource: new DataSource(this),
206
					controller: new QuickOpenController({ clickBehavior: ClickBehavior.ON_MOUSE_UP }),
E
Erich Gamma 已提交
207
					renderer: new Renderer(this),
208 209
					filter: new Filter(this),
					accessibilityProvider: new AccessibilityProvider(this)
E
Erich Gamma 已提交
210
				}, {
B
Benjamin Pasero 已提交
211 212 213 214 215 216
						twistiePixels: 11,
						indentPixels: 0,
						alwaysFocused: true,
						verticalScrollMode: ScrollbarVisibility.Visible,
						ariaLabel: nls.localize('treeAriaLabel', "Quick Picker")
					});
E
Erich Gamma 已提交
217

218 219
				this.treeElement = this.tree.getHTMLElement();

E
Erich Gamma 已提交
220
				// Handle Focus and Selection event
A
Alex Dima 已提交
221
				this.toUnbind.push(this.tree.addListener2(EventType.FOCUS, (event: IFocusEvent) => {
E
Erich Gamma 已提交
222 223 224
					this.elementFocused(event.focus, event);
				}));

A
Alex Dima 已提交
225
				this.toUnbind.push(this.tree.addListener2(EventType.SELECTION, (event: ISelectionEvent) => {
E
Erich Gamma 已提交
226 227 228 229 230
					if (event.selection && event.selection.length > 0) {
						this.elementSelected(event.selection[0], event);
					}
				}));
			}).
B
Benjamin Pasero 已提交
231 232
				on(DOM.EventType.KEY_DOWN, (e: KeyboardEvent) => {
					let keyboardEvent: StandardKeyboardEvent = new StandardKeyboardEvent(e);
E
Erich Gamma 已提交
233

B
Benjamin Pasero 已提交
234 235 236 237
					// Only handle when in quick navigation mode
					if (!this.quickNavigateConfiguration) {
						return;
					}
238

239 240 241 242 243 244 245 246 247
					if (platform.isMacintosh) {
						if (keyboardEvent.equals(CommonKeybindings.WINCTRL_N)) {
							keyboardEvent.keyCode = KeyCode.DownArrow;
						}
						else if (keyboardEvent.equals(CommonKeybindings.WINCTRL_P)) {
							keyboardEvent.keyCode = KeyCode.UpArrow;
						}
					}

B
Benjamin Pasero 已提交
248 249 250
					// Support keyboard navigation in quick navigation mode
					if (keyboardEvent.keyCode === KeyCode.DownArrow || keyboardEvent.keyCode === KeyCode.UpArrow || keyboardEvent.keyCode === KeyCode.PageDown || keyboardEvent.keyCode === KeyCode.PageUp) {
						DOM.EventHelper.stop(e, true);
251

B
Benjamin Pasero 已提交
252
						this.navigateInTree(keyboardEvent.keyCode);
E
Erich Gamma 已提交
253
					}
B
Benjamin Pasero 已提交
254 255 256 257
				}).
				on(DOM.EventType.KEY_UP, (e: KeyboardEvent) => {
					let keyboardEvent: StandardKeyboardEvent = new StandardKeyboardEvent(e);
					let keyCode = keyboardEvent.keyCode;
E
Erich Gamma 已提交
258

B
Benjamin Pasero 已提交
259 260 261
					// Only handle when in quick navigation mode
					if (!this.quickNavigateConfiguration) {
						return;
262
					}
263

B
Benjamin Pasero 已提交
264 265 266 267 268 269 270 271
					// Select element when keys are pressed that signal it
					let quickNavKeys = this.quickNavigateConfiguration.keybindings;
					let wasTriggerKeyPressed = keyCode === KeyCode.Enter || quickNavKeys.some((k) => {
						if (k.hasShift() && keyCode === KeyCode.Shift) {
							if (keyboardEvent.ctrlKey || keyboardEvent.altKey || keyboardEvent.metaKey) {
								return false; // this is an optimistic check for the shift key being used to navigate back in quick open
							}

E
Erich Gamma 已提交
272 273 274
							return true;
						}

B
Benjamin Pasero 已提交
275
						if (k.hasAlt() && keyCode === KeyCode.Alt) {
E
Erich Gamma 已提交
276 277 278
							return true;
						}

B
Benjamin Pasero 已提交
279 280 281 282 283 284 285 286 287
						// Mac is a bit special
						if (platform.isMacintosh) {
							if (k.hasCtrlCmd() && keyCode === KeyCode.Meta) {
								return true;
							}

							if (k.hasWinCtrl() && keyCode === KeyCode.Ctrl) {
								return true;
							}
E
Erich Gamma 已提交
288 289
						}

B
Benjamin Pasero 已提交
290 291 292 293 294 295 296 297 298
						// Windows/Linux are not :)
						else {
							if (k.hasCtrlCmd() && keyCode === KeyCode.Ctrl) {
								return true;
							}

							if (k.hasWinCtrl() && keyCode === KeyCode.Meta) {
								return true;
							}
E
Erich Gamma 已提交
299 300
						}

B
Benjamin Pasero 已提交
301 302
						return false;
					});
E
Erich Gamma 已提交
303

B
Benjamin Pasero 已提交
304 305 306 307 308
					if (wasTriggerKeyPressed) {
						let focus = this.tree.getFocus();
						if (focus) {
							this.elementSelected(focus, e);
						}
E
Erich Gamma 已提交
309
					}
B
Benjamin Pasero 已提交
310 311
				}).
				clone();
E
Erich Gamma 已提交
312 313
		})

B
Benjamin Pasero 已提交
314 315 316 317
			// Widget Attributes
			.addClass('quick-open-widget')
			.addClass((browser.isIE10orEarlier) ? ' no-shadow' : '')
			.build(this.container);
E
Erich Gamma 已提交
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

		// Support layout
		if (this.layoutDimensions) {
			this.layout(this.layoutDimensions);
		}
	}

	private onType(): void {
		let value = this.inputBox.value;

		// Adjust help text as needed if present
		if (this.helpText) {
			if (value) {
				this.helpText.hide();
			} else {
				this.helpText.show();
			}
		}

		// Send to callbacks
		this.callbacks.onType(value);
	}

	public quickNavigate(configuration: IQuickNavigateConfiguration, next: boolean): void {
		if (this.isVisible) {

			// Transition into quick navigate mode if not yet done
			if (!this.quickNavigateConfiguration) {
				this.quickNavigateConfiguration = configuration;
				this.tree.DOMFocus();
			}

			// Navigate
			this.navigateInTree(next ? KeyCode.DownArrow : KeyCode.UpArrow);
		}
	}

	private navigateInTree(keyCode: KeyCode, isShift?: boolean): void {
		const model: IModel<any> = this.tree.getInput();
		const entries = model ? model.entries : [];
		let focus = this.tree.getFocus();
		let cycled = false;
		let revealToTop = false;

		// Support cycle-through navigation
		if (entries.length > 1) {

			// Up from no entry or first entry goes down to last
			if ((keyCode === KeyCode.UpArrow || (keyCode === KeyCode.Tab && isShift)) && (focus === entries[0] || !focus)) { // TODO@Ben should not make ordering assumptions
				this.tree.focusLast();
				cycled = true;
			}

			// Down from last entry goes to up to first
			else if ((keyCode === KeyCode.DownArrow || keyCode === KeyCode.Tab && !isShift) && focus === entries[entries.length - 1]) { // TODO@Ben should not make ordering assumptions
				this.tree.focusFirst();
				cycled = true;
			}
		}

		// Normal Navigation
		if (!cycled) {
			switch (keyCode) {
				case KeyCode.DownArrow:
					this.tree.focusNext();
					break;

				case KeyCode.UpArrow:
					this.tree.focusPrevious();
					break;

				case KeyCode.PageDown:
					this.tree.focusNextPage();
					break;

				case KeyCode.PageUp:
					this.tree.focusPreviousPage();
					break;

				case KeyCode.Tab:
					if (isShift) {
						this.tree.focusPrevious();
					} else {
						this.tree.focusNext();
					}
					break;
			}
		}

		// Reveal
		focus = this.tree.getFocus();
		if (focus) {
410
			revealToTop ? this.tree.reveal(focus, 0).done(null, errors.onUnexpectedError) : this.tree.reveal(focus).done(null, errors.onUnexpectedError);
E
Erich Gamma 已提交
411 412 413 414 415 416 417 418
		}
	}

	private elementFocused(value: any, event?: any): void {
		if (!value || !this.isVisible()) {
			return;
		}

419 420 421
		// ARIA
		this.inputElement.setAttribute('aria-activedescendant', this.treeElement.getAttribute('aria-activedescendant'));

422
		const context: IEntryRunContext = { event: event, keymods: this.extractKeyMods(event), quickNavigateConfiguration: this.quickNavigateConfiguration };
E
Erich Gamma 已提交
423 424 425 426 427 428 429 430
		this.model.runner.run(value, Mode.PREVIEW, context);
	}

	private elementSelected(value: any, event?: any): void {
		let hide = true;

		// Trigger open of element on selection
		if (this.isVisible()) {
431
			const context: IEntryRunContext = { event: event, keymods: this.extractKeyMods(event), quickNavigateConfiguration: this.quickNavigateConfiguration };
E
Erich Gamma 已提交
432 433 434
			hide = this.model.runner.run(value, Mode.OPEN, context);
		}

P
Pascal Borreli 已提交
435
		// add telemetry when an item is accepted, logging the index of the item in the list and the length of the list
E
Erich Gamma 已提交
436 437 438 439 440 441 442 443 444
		// to measure the rate of the success and the relevance of the order
		if (this.usageLogger) {
			let indexOfAcceptedElement = this.model.entries.indexOf(value);
			let entriesCount = this.model.entries.length;
			this.usageLogger.publicLog('quickOpenWidgetItemAccepted', { index: indexOfAcceptedElement, count: entriesCount, isQuickNavigate: this.quickNavigateConfiguration ? true : false });
		}

		// Hide if command was run successfully
		if (hide) {
445
			this.hide(HideReason.ELEMENT_SELECTED);
E
Erich Gamma 已提交
446 447
		}
	}
448 449 450 451 452

	private extractKeyMods(event: any): number[] {
		const isCtrlCmd = event && (event.ctrlKey || event.metaKey || (event.payload && event.payload.originalEvent && (event.payload.originalEvent.ctrlKey || event.payload.originalEvent.metaKey)));

		return isCtrlCmd ? [KeyMod.CtrlCmd] : [];
B
Benjamin Pasero 已提交
453
	}
E
Erich Gamma 已提交
454

B
Benjamin Pasero 已提交
455 456 457
	public show(prefix: string, options?: IShowOptions): void;
	public show(input: IModel<any>, options?: IShowOptions): void;
	public show(param: any, options?: IShowOptions): void {
E
Erich Gamma 已提交
458 459
		this.visible = true;
		this.isLoosingFocus = false;
B
Benjamin Pasero 已提交
460
		this.quickNavigateConfiguration = options ? options.quickNavigateConfiguration : void 0;
E
Erich Gamma 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

		// Adjust UI for quick navigate mode
		if (this.quickNavigateConfiguration) {
			this.inputContainer.hide();
			if (this.options.enableAnimations) {
				this.treeContainer.removeClass('transition');
			}
			this.builder.show();
			this.tree.DOMFocus();
		}

		// Otherwise use normal UI
		else {
			this.inputContainer.show();
			if (this.options.enableAnimations) {
				this.treeContainer.addClass('transition');
			}
			this.builder.show();
			this.inputBox.focus();
		}

		// Adjust Help text for IE
		if (this.helpText) {
			if (this.quickNavigateConfiguration || types.isString(param)) {
				this.helpText.hide();
			} else {
				this.helpText.show();
			}
		}

		// Show based on param
		if (types.isString(param)) {
			this.doShowWithPrefix(param);
		} else {
B
Benjamin Pasero 已提交
495
			this.doShowWithInput(param, options && options.autoFocus ? options.autoFocus : {});
E
Erich Gamma 已提交
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
		}

		if (this.callbacks.onShow) {
			this.callbacks.onShow();
		}
	}

	private doShowWithPrefix(prefix: string): void {
		this.inputBox.value = prefix;
		this.callbacks.onType(prefix);
	}

	private doShowWithInput(input: IModel<any>, autoFocus: IAutoFocus): void {
		this.setInput(input, autoFocus);
	}

	private setInputAndLayout(input: IModel<any>, autoFocus: IAutoFocus): void {

		// Use a generated token to avoid race conditions from setting input
		let currentInputToken = uuid.generateUuid();
		this.currentInputToken = currentInputToken;

		// setInput and Layout
		this.setTreeHeightForInput(input).then(() => {
			if (this.currentInputToken === currentInputToken) {
				this.tree.setInput(null).then(() => {
					this.model = input;
523 524 525 526

					// ARIA
					this.inputElement.setAttribute('aria-haspopup', String(input && input.entries && input.entries.length > 0));

E
Erich Gamma 已提交
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
					return this.tree.setInput(input);
				}).done(() => {
					// Indicate entries to tree
					this.tree.layout();

					// Handle auto focus
					if (input && input.entries.some(e => this.isElementVisible(input, e))) {
						this.autoFocus(input, autoFocus);
					}
				}, errors.onUnexpectedError);
			}
		});
	}

	private isElementVisible<T>(input: IModel<T>, e: T): boolean {
		if (!input.filter) {
			return true;
		}

		return input.filter.isVisible(e);
	}

	private autoFocus(input: IModel<any>, autoFocus: IAutoFocus = {}): void {
		const entries = input.entries.filter(e => this.isElementVisible(input, e));

		// First check for auto focus of prefix matches
		if (autoFocus.autoFocusPrefixMatch) {
			let caseSensitiveMatch: any;
			let caseInsensitiveMatch: any;
			let prefix = autoFocus.autoFocusPrefixMatch;
			let lowerCasePrefix = prefix.toLowerCase();
			for (let i = 0; i < entries.length; i++) {
				let entry = entries[i];
				const label = input.dataSource.getLabel(entry);

				if (!caseSensitiveMatch && label.indexOf(prefix) === 0) {
					caseSensitiveMatch = entry;
				} else if (!caseInsensitiveMatch && label.toLowerCase().indexOf(lowerCasePrefix) === 0) {
					caseInsensitiveMatch = entry;
				}

				if (caseSensitiveMatch && caseInsensitiveMatch) {
					break;
				}
			}

			let entryToFocus = caseSensitiveMatch || caseInsensitiveMatch;
			if (entryToFocus) {
				this.tree.setFocus(entryToFocus);
576
				this.tree.reveal(entryToFocus, 0).done(null, errors.onUnexpectedError);
E
Erich Gamma 已提交
577 578 579 580 581 582 583 584

				return;
			}
		}

		// Second check for auto focus of first entry
		if (autoFocus.autoFocusFirstEntry) {
			this.tree.focusFirst();
585
			this.tree.reveal(this.tree.getFocus(), 0).done(null, errors.onUnexpectedError);
E
Erich Gamma 已提交
586 587 588 589 590 591
		}

		// Third check for specific index option
		else if (typeof autoFocus.autoFocusIndex === 'number') {
			if (entries.length > autoFocus.autoFocusIndex) {
				this.tree.focusNth(autoFocus.autoFocusIndex);
592
				this.tree.reveal(this.tree.getFocus()).done(null, errors.onUnexpectedError);
E
Erich Gamma 已提交
593 594 595
			}
		}

596
		// Check for auto focus of second entry
E
Erich Gamma 已提交
597 598 599 600 601
		else if (autoFocus.autoFocusSecondEntry) {
			if (entries.length > 1) {
				this.tree.focusNth(1);
			}
		}
602 603 604 605 606 607 608

		// Finally check for auto focus of last entry
		else if (autoFocus.autoFocusLastEntry) {
			if (entries.length > 1) {
				this.tree.focusLast();
			}
		}
E
Erich Gamma 已提交
609 610 611 612 613 614 615 616 617 618 619 620 621 622
	}

	public refresh(input: IModel<any>, autoFocus: IAutoFocus): void {
		if (!this.isVisible()) {
			return;
		}

		// Apply height & Refresh
		this.setTreeHeightForInput(input).then(() => {
			this.tree.refresh().done(() => {

				// Indicate entries to tree
				this.tree.layout();

B
Benjamin Pasero 已提交
623 624 625 626 627
				let doAutoFocus = autoFocus && input && input.entries.some(e => this.isElementVisible(input, e));
				if (doAutoFocus && !autoFocus.autoFocusPrefixMatch) {
					doAutoFocus = !this.tree.getFocus(); // if auto focus is not for prefix matches, we do not want to change what the user has focussed already
				}

E
Erich Gamma 已提交
628
				// Handle auto focus
B
Benjamin Pasero 已提交
629
				if (doAutoFocus) {
E
Erich Gamma 已提交
630 631 632 633 634 635
					this.autoFocus(input, autoFocus);
				}
			}, errors.onUnexpectedError);
		});
	}

636
	private setTreeHeightForInput(input: IModel<any>): TPromise<void> {
E
Erich Gamma 已提交
637 638 639 640 641 642
		let newHeight = this.getHeight(input) + 'px';
		let oldHeight = this.treeContainer.style('height');

		// Apply
		this.treeContainer.style({ height: newHeight });

P
Pascal Borreli 已提交
643
		// Return instantly if we don't CSS transition or the height is the same as old
E
Erich Gamma 已提交
644
		if (!this.treeContainer.hasClass('transition') || oldHeight === newHeight) {
645
			return TPromise.as(null);
E
Erich Gamma 已提交
646 647
		}

P
Pascal Borreli 已提交
648
		// Otherwise return promise that only fulfills when the CSS transition has ended
649
		return new TPromise<void>((c, e) => {
650
			let unbind: IDisposable[] = [];
E
Erich Gamma 已提交
651 652 653 654 655
			let complete = false;
			let completeHandler = () => {
				if (!complete) {
					complete = true;

J
Joao Moreno 已提交
656
					unbind = dispose(unbind);
E
Erich Gamma 已提交
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700

					c(null);
				}
			};

			this.treeContainer.once('webkitTransitionEnd', completeHandler, unbind);
			this.treeContainer.once('transitionend', completeHandler, unbind);
		});
	}

	private getHeight(input: IModel<any>): number {
		const renderer = input.renderer;

		if (!input) {
			let itemHeight = renderer.getHeight(null);

			return this.options.minItemsToShow ? this.options.minItemsToShow * itemHeight : 0;
		}

		let height = 0;

		let preferredItemsHeight: number;
		if (this.layoutDimensions && this.layoutDimensions.height) {
			preferredItemsHeight = (this.layoutDimensions.height - 50 /* subtract height of input field (30px) and some spacing (drop shadow) to fit */) * 0.40 /* max 40% of screen */;
		}

		if (!preferredItemsHeight || preferredItemsHeight > QuickOpenWidget.MAX_ITEMS_HEIGHT) {
			preferredItemsHeight = QuickOpenWidget.MAX_ITEMS_HEIGHT;
		}

		let entries = input.entries.filter(e => this.isElementVisible(input, e));
		let maxEntries = this.options.maxItemsToShow || entries.length;
		for (let i = 0; i < maxEntries && i < entries.length; i++) {
			let entryHeight = renderer.getHeight(entries[i]);
			if (height + entryHeight <= preferredItemsHeight) {
				height += entryHeight;
			} else {
				break;
			}
		}

		return height;
	}

701
	public hide(reason?: HideReason): void {
E
Erich Gamma 已提交
702 703 704 705 706 707 708 709 710
		if (!this.isVisible()) {
			return;
		}

		this.visible = false;
		this.builder.hide();
		this.builder.domBlur();

		// report failure cases
711
		if (reason === HideReason.CANCELED) {
E
Erich Gamma 已提交
712 713 714 715 716 717 718 719 720 721 722 723
			if (this.model) {
				let entriesCount = this.model.entries.filter(e => this.isElementVisible(this.model, e)).length;
				if (this.usageLogger) {
					this.usageLogger.publicLog('quickOpenWidgetCancelled', { count: entriesCount, isQuickNavigate: this.quickNavigateConfiguration ? true : false });
				}
			}
		}

		// Clear input field and clear tree
		this.inputBox.value = '';
		this.tree.setInput(null);

724 725 726
		// ARIA
		this.inputElement.setAttribute('aria-haspopup', 'false');

E
Erich Gamma 已提交
727
		// Reset Tree Height
I
isidor 已提交
728
		this.treeContainer.style({ height: (this.options.minItemsToShow ? this.options.minItemsToShow * 22 : 0) + 'px' });
E
Erich Gamma 已提交
729 730 731 732 733 734 735 736 737 738 739 740

		// Clear any running Progress
		this.progressBar.stop().getContainer().hide();

		// Clear Focus
		if (this.tree.isDOMFocused()) {
			this.tree.DOMBlur();
		} else if (this.inputBox.hasFocus()) {
			this.inputBox.blur();
		}

		// Callbacks
741
		if (reason === HideReason.CANCELED) {
E
Erich Gamma 已提交
742 743 744 745 746 747
			this.callbacks.onCancel();
		} else {
			this.callbacks.onOk();
		}

		if (this.callbacks.onHide) {
748
			this.callbacks.onHide(reason === HideReason.FOCUS_LOST);
E
Erich Gamma 已提交
749 750 751
		}
	}

752 753
	public getQuickNavigateConfiguration(): IQuickNavigateConfiguration {
		return this.quickNavigateConfiguration;
754 755
	}

E
Erich Gamma 已提交
756 757 758 759 760 761
	public setPlaceHolder(placeHolder: string): void {
		if (this.inputBox) {
			this.inputBox.setPlaceHolder(placeHolder);
		}
	}

J
Johannes Rieken 已提交
762
	public setValue(value: string, select: boolean): void {
E
Erich Gamma 已提交
763 764
		if (this.inputBox) {
			this.inputBox.value = value;
J
Johannes Rieken 已提交
765 766 767
			if (select) {
				this.inputBox.select();
			}
E
Erich Gamma 已提交
768 769 770 771 772 773 774 775 776
		}
	}

	public setPassword(isPassword: boolean): void {
		if (this.inputBox) {
			this.inputBox.inputElement.type = isPassword ? 'password' : 'text';
		}
	}

777
	public setInput(input: IModel<any>, autoFocus: IAutoFocus, ariaLabel?: string): void {
E
Erich Gamma 已提交
778 779 780 781 782 783
		if (!this.isVisible()) {
			return;
		}

		// Adapt tree height to entries and apply input
		this.setInputAndLayout(input, autoFocus);
784 785 786 787 788

		// Apply ARIA
		if (this.inputBox) {
			this.inputBox.setAriaLabel(ariaLabel || DEFAULT_INPUT_ARIA_LABEL);
		}
E
Erich Gamma 已提交
789 790 791 792 793 794
	}

	public getInput(): IModel<any> {
		return this.tree.getInput();
	}

795 796 797 798 799 800 801 802 803 804 805 806
	public showInputDecoration(decoration: Severity): void {
		if (this.inputBox) {
			this.inputBox.showMessage({ type: decoration === Severity.Info ? MessageType.INFO : decoration === Severity.Warning ? MessageType.WARNING : MessageType.ERROR, content: '' });
		}
	}

	public clearInputDecoration(): void {
		if (this.inputBox) {
			this.inputBox.hideMessage();
		}
	}

E
Erich Gamma 已提交
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
	public runFocus(): boolean {
		let focus = this.tree.getFocus();
		if (focus) {
			this.elementSelected(focus);
			return true;
		}

		return false;
	}

	public getProgressBar(): ProgressBar {
		return this.progressBar;
	}

	public setExtraClass(clazz: string): void {
		let previousClass = this.builder.getProperty('extra-class');
		if (previousClass) {
			this.builder.removeClass(previousClass);
		}

		if (clazz) {
			this.builder.addClass(clazz);
			this.builder.setProperty('extra-class', clazz);
		} else if (previousClass) {
			this.builder.removeProperty('extra-class');
		}
	}

	public isVisible(): boolean {
		return this.visible;
	}

	public layout(dimension: Dimension): void {
		this.layoutDimensions = dimension;

		// Apply to quick open width (height is dynamic by number of items to show)
		let quickOpenWidth = Math.min(this.layoutDimensions.width * 0.62 /* golden cut */, QuickOpenWidget.MAX_WIDTH);
		if (this.builder) {

			// quick open
			this.builder.style({
				width: quickOpenWidth + 'px',
				marginLeft: '-' + (quickOpenWidth / 2) + 'px'
			});

			// input field
			this.inputContainer.style({
				width: (quickOpenWidth - 12) + 'px'
			});
		}
	}

	private gainingFocus(): void {
		this.isLoosingFocus = false;
	}

	private loosingFocus(e: Event): void {
		if (!this.isVisible()) {
			return;
		}

		const relatedTarget = (<any>e).relatedTarget;
		if (!this.quickNavigateConfiguration && DOM.isAncestor(relatedTarget, this.builder.getHTMLElement())) {
870
			return; // user clicked somewhere into quick open widget, do not close thereby
E
Erich Gamma 已提交
871 872 873
		}

		this.isLoosingFocus = true;
874
		TPromise.timeout(0).then(() => {
E
Erich Gamma 已提交
875 876 877 878 879 880
			if (!this.isLoosingFocus) {
				return;
			}

			const veto = this.callbacks.onFocusLost && this.callbacks.onFocusLost();
			if (!veto) {
881
				this.hide(HideReason.FOCUS_LOST);
E
Erich Gamma 已提交
882 883 884 885 886
			}
		});
	}

	public dispose(): void {
A
Alex Dima 已提交
887
		this.toUnbind = dispose(this.toUnbind);
E
Erich Gamma 已提交
888 889 890 891 892 893

		this.progressBar.dispose();
		this.inputBox.dispose();
		this.tree.dispose();
	}
}