@theia/core 1.53.0-next.4 → 1.53.0-next.55

package/src/browser/breadcrumbs/breadcrumb-popup-container.ts

@@ -1,101 +1,101 @@
-// *****************************************************************************
-// Copyright (C) 2019 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { inject, injectable, postConstruct } from '../../../shared/inversify';
-import { Emitter, Event } from '../../common';
-import { Disposable, DisposableCollection } from '../../common/disposable';
-import { Coordinate } from '../context-menu-renderer';
-import { RendererHost } from '../widgets/react-renderer';
-import { Styles } from './breadcrumbs-constants';
-
-export interface BreadcrumbPopupContainerFactory {
-    (parent: HTMLElement, breadcrumbId: string, position: Coordinate): BreadcrumbPopupContainer;
-}
-export const BreadcrumbPopupContainerFactory = Symbol('BreadcrumbPopupContainerFactory');
-
-export type BreadcrumbID = string;
-export const BreadcrumbID = Symbol('BreadcrumbID');
-
-/**
- * This class creates a popup container at the given position
- * so that contributions can attach their HTML elements
- * as children of `BreadcrumbPopupContainer#container`.
- *
- * - `dispose()` is called on blur or on hit on escape
- */
-@injectable()
-export class BreadcrumbPopupContainer implements Disposable {
-    @inject(RendererHost) protected readonly parent: RendererHost;
-    @inject(BreadcrumbID) public readonly breadcrumbId: BreadcrumbID;
-    @inject(Coordinate) protected readonly position: Coordinate;
-
-    protected onDidDisposeEmitter = new Emitter<void>();
-    protected toDispose: DisposableCollection = new DisposableCollection(this.onDidDisposeEmitter);
-    get onDidDispose(): Event<void> {
-        return this.onDidDisposeEmitter.event;
-    }
-
-    protected _container: HTMLElement;
-    get container(): HTMLElement {
-        return this._container;
-    }
-
-    protected _isOpen: boolean;
-    get isOpen(): boolean {
-        return this._isOpen;
-    }
-
-    @postConstruct()
-    protected init(): void {
-        this._container = this.createPopupDiv(this.position);
-        document.addEventListener('keyup', this.escFunction);
-        this._container.focus();
-        this._isOpen = true;
-    }
-
-    protected createPopupDiv(position: Coordinate): HTMLDivElement {
-        const result = window.document.createElement('div');
-        result.className = Styles.BREADCRUMB_POPUP;
-        result.style.left = `${position.x}px`;
-        result.style.top = `${position.y}px`;
-        result.tabIndex = 0;
-        result.addEventListener('focusout', this.onFocusOut);
-        this.parent.appendChild(result);
-        return result;
-    }
-
-    protected onFocusOut = (event: FocusEvent) => {
-        if (!(event.relatedTarget instanceof Element) || !this._container.contains(event.relatedTarget)) {
-            this.dispose();
-        }
-    };
-
-    protected escFunction = (event: KeyboardEvent) => {
-        if (event.key === 'Escape' || event.key === 'Esc') {
-            this.dispose();
-        }
-    };
-
-    dispose(): void {
-        if (!this.toDispose.disposed) {
-            this.onDidDisposeEmitter.fire();
-            this.toDispose.dispose();
-            this._container.remove();
-            this._isOpen = false;
-            document.removeEventListener('keyup', this.escFunction);
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { inject, injectable, postConstruct } from '../../../shared/inversify';
+import { Emitter, Event } from '../../common';
+import { Disposable, DisposableCollection } from '../../common/disposable';
+import { Coordinate } from '../context-menu-renderer';
+import { RendererHost } from '../widgets/react-renderer';
+import { Styles } from './breadcrumbs-constants';
+
+export interface BreadcrumbPopupContainerFactory {
+    (parent: HTMLElement, breadcrumbId: string, position: Coordinate): BreadcrumbPopupContainer;
+}
+export const BreadcrumbPopupContainerFactory = Symbol('BreadcrumbPopupContainerFactory');
+
+export type BreadcrumbID = string;
+export const BreadcrumbID = Symbol('BreadcrumbID');
+
+/**
+ * This class creates a popup container at the given position
+ * so that contributions can attach their HTML elements
+ * as children of `BreadcrumbPopupContainer#container`.
+ *
+ * - `dispose()` is called on blur or on hit on escape
+ */
+@injectable()
+export class BreadcrumbPopupContainer implements Disposable {
+    @inject(RendererHost) protected readonly parent: RendererHost;
+    @inject(BreadcrumbID) public readonly breadcrumbId: BreadcrumbID;
+    @inject(Coordinate) protected readonly position: Coordinate;
+
+    protected onDidDisposeEmitter = new Emitter<void>();
+    protected toDispose: DisposableCollection = new DisposableCollection(this.onDidDisposeEmitter);
+    get onDidDispose(): Event<void> {
+        return this.onDidDisposeEmitter.event;
+    }
+
+    protected _container: HTMLElement;
+    get container(): HTMLElement {
+        return this._container;
+    }
+
+    protected _isOpen: boolean;
+    get isOpen(): boolean {
+        return this._isOpen;
+    }
+
+    @postConstruct()
+    protected init(): void {
+        this._container = this.createPopupDiv(this.position);
+        document.addEventListener('keyup', this.escFunction);
+        this._container.focus();
+        this._isOpen = true;
+    }
+
+    protected createPopupDiv(position: Coordinate): HTMLDivElement {
+        const result = window.document.createElement('div');
+        result.className = Styles.BREADCRUMB_POPUP;
+        result.style.left = `${position.x}px`;
+        result.style.top = `${position.y}px`;
+        result.tabIndex = 0;
+        result.addEventListener('focusout', this.onFocusOut);
+        this.parent.appendChild(result);
+        return result;
+    }
+
+    protected onFocusOut = (event: FocusEvent) => {
+        if (!(event.relatedTarget instanceof Element) || !this._container.contains(event.relatedTarget)) {
+            this.dispose();
+        }
+    };
+
+    protected escFunction = (event: KeyboardEvent) => {
+        if (event.key === 'Escape' || event.key === 'Esc') {
+            this.dispose();
+        }
+    };
+
+    dispose(): void {
+        if (!this.toDispose.disposed) {
+            this.onDidDisposeEmitter.fire();
+            this.toDispose.dispose();
+            this._container.remove();
+            this._isOpen = false;
+            document.removeEventListener('keyup', this.escFunction);
+        }
+    }
+}

package/src/browser/breadcrumbs/breadcrumb-renderer.tsx

@@ -1,41 +1,41 @@
-// *****************************************************************************
-// Copyright (C) 2019 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import * as React from 'react';
-import { injectable } from 'inversify';
-import { Breadcrumb, Styles } from './breadcrumbs-constants';
-
-export const BreadcrumbRenderer = Symbol('BreadcrumbRenderer');
-export interface BreadcrumbRenderer {
-    /**
-     * Renders the given breadcrumb. If `onClick` is given, it is called on breadcrumb click.
-     */
-    render(breadcrumb: Breadcrumb, onMouseDown?: (breadcrumb: Breadcrumb, event: React.MouseEvent) => void): React.ReactNode;
-}
-
-@injectable()
-export class DefaultBreadcrumbRenderer implements BreadcrumbRenderer {
-    render(breadcrumb: Breadcrumb, onMouseDown?: (breadcrumb: Breadcrumb, event: React.MouseEvent) => void): React.ReactNode {
-        return <li key={breadcrumb.id} title={breadcrumb.longLabel}
-            className={Styles.BREADCRUMB_ITEM + (!onMouseDown ? '' : ' ' + Styles.BREADCRUMB_ITEM_HAS_POPUP)}
-            onMouseDown={event => onMouseDown && onMouseDown(breadcrumb, event)}
-            tabIndex={0}
-            data-breadcrumb-id={breadcrumb.id}
-        >
-            {breadcrumb.iconClass && <span className={breadcrumb.iconClass}></span>} <span> {breadcrumb.label}</span>
-        </li >;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import * as React from 'react';
+import { injectable } from 'inversify';
+import { Breadcrumb, Styles } from './breadcrumbs-constants';
+
+export const BreadcrumbRenderer = Symbol('BreadcrumbRenderer');
+export interface BreadcrumbRenderer {
+    /**
+     * Renders the given breadcrumb. If `onClick` is given, it is called on breadcrumb click.
+     */
+    render(breadcrumb: Breadcrumb, onMouseDown?: (breadcrumb: Breadcrumb, event: React.MouseEvent) => void): React.ReactNode;
+}
+
+@injectable()
+export class DefaultBreadcrumbRenderer implements BreadcrumbRenderer {
+    render(breadcrumb: Breadcrumb, onMouseDown?: (breadcrumb: Breadcrumb, event: React.MouseEvent) => void): React.ReactNode {
+        return <li key={breadcrumb.id} title={breadcrumb.longLabel}
+            className={Styles.BREADCRUMB_ITEM + (!onMouseDown ? '' : ' ' + Styles.BREADCRUMB_ITEM_HAS_POPUP)}
+            onMouseDown={event => onMouseDown && onMouseDown(breadcrumb, event)}
+            tabIndex={0}
+            data-breadcrumb-id={breadcrumb.id}
+        >
+            {breadcrumb.iconClass && <span className={breadcrumb.iconClass}></span>} <span> {breadcrumb.label}</span>
+        </li >;
+    }
+}

package/src/browser/breadcrumbs/breadcrumbs-constants.ts

@@ -1,79 +1,79 @@
-// *****************************************************************************
-// Copyright (C) 2019 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { MaybePromise, Event } from '../../common';
-import { Disposable } from '../../../shared/vscode-languageserver-protocol';
-import URI from '../../common/uri';
-
-export namespace Styles {
-    export const BREADCRUMBS = 'theia-breadcrumbs';
-    export const BREADCRUMB_ITEM = 'theia-breadcrumb-item';
-    export const BREADCRUMB_POPUP_OVERLAY_CONTAINER = 'theia-breadcrumbs-popups-overlay';
-    export const BREADCRUMB_POPUP = 'theia-breadcrumbs-popup';
-    export const BREADCRUMB_ITEM_HAS_POPUP = 'theia-breadcrumb-item-haspopup';
-}
-
-/** A single breadcrumb in the breadcrumbs bar. */
-export interface Breadcrumb {
-
-    /** An ID of this breadcrumb that should be unique in the breadcrumbs bar. */
-    readonly id: string;
-
-    /** The breadcrumb type. Should be the same as the contribution type `BreadcrumbsContribution#type`. */
-    readonly type: symbol;
-
-    /** The text that will be rendered as label. */
-    readonly label: string;
-
-    /** A longer text that will be used as tooltip text. */
-    readonly longLabel: string;
-
-    /** A CSS class for the icon. */
-    readonly iconClass?: string;
-
-    /** CSS classes for the container. */
-    readonly containerClass?: string;
-}
-
-export const BreadcrumbsContribution = Symbol('BreadcrumbsContribution');
-export interface BreadcrumbsContribution {
-
-    /**
-     * The breadcrumb type. Breadcrumbs returned by `#computeBreadcrumbs(uri)` should have this as `Breadcrumb#type`.
-     */
-    readonly type: symbol;
-
-    /**
-     * The priority of this breadcrumbs contribution. Contributions are rendered left to right in order of ascending priority.
-     */
-    readonly priority: number;
-
-    /**
-     * An event emitter that should fire when breadcrumbs change for a given URI.
-     */
-    readonly onDidChangeBreadcrumbs: Event<URI>;
-
-    /**
-     * Computes breadcrumbs for a given URI.
-     */
-    computeBreadcrumbs(uri: URI): MaybePromise<Breadcrumb[]>;
-
-    /**
-     * Attaches the breadcrumb popup content for the given breadcrumb as child to the given parent.
-     * If it returns a Disposable, it is called when the popup closes.
-     */
-    attachPopupContent(breadcrumb: Breadcrumb, parent: HTMLElement): Promise<Disposable | undefined>;
-}
+// *****************************************************************************
+// Copyright (C) 2019 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { MaybePromise, Event } from '../../common';
+import { Disposable } from '../../../shared/vscode-languageserver-protocol';
+import URI from '../../common/uri';
+
+export namespace Styles {
+    export const BREADCRUMBS = 'theia-breadcrumbs';
+    export const BREADCRUMB_ITEM = 'theia-breadcrumb-item';
+    export const BREADCRUMB_POPUP_OVERLAY_CONTAINER = 'theia-breadcrumbs-popups-overlay';
+    export const BREADCRUMB_POPUP = 'theia-breadcrumbs-popup';
+    export const BREADCRUMB_ITEM_HAS_POPUP = 'theia-breadcrumb-item-haspopup';
+}
+
+/** A single breadcrumb in the breadcrumbs bar. */
+export interface Breadcrumb {
+
+    /** An ID of this breadcrumb that should be unique in the breadcrumbs bar. */
+    readonly id: string;
+
+    /** The breadcrumb type. Should be the same as the contribution type `BreadcrumbsContribution#type`. */
+    readonly type: symbol;
+
+    /** The text that will be rendered as label. */
+    readonly label: string;
+
+    /** A longer text that will be used as tooltip text. */
+    readonly longLabel: string;
+
+    /** A CSS class for the icon. */
+    readonly iconClass?: string;
+
+    /** CSS classes for the container. */
+    readonly containerClass?: string;
+}
+
+export const BreadcrumbsContribution = Symbol('BreadcrumbsContribution');
+export interface BreadcrumbsContribution {
+
+    /**
+     * The breadcrumb type. Breadcrumbs returned by `#computeBreadcrumbs(uri)` should have this as `Breadcrumb#type`.
+     */
+    readonly type: symbol;
+
+    /**
+     * The priority of this breadcrumbs contribution. Contributions are rendered left to right in order of ascending priority.
+     */
+    readonly priority: number;
+
+    /**
+     * An event emitter that should fire when breadcrumbs change for a given URI.
+     */
+    readonly onDidChangeBreadcrumbs: Event<URI>;
+
+    /**
+     * Computes breadcrumbs for a given URI.
+     */
+    computeBreadcrumbs(uri: URI): MaybePromise<Breadcrumb[]>;
+
+    /**
+     * Attaches the breadcrumb popup content for the given breadcrumb as child to the given parent.
+     * If it returns a Disposable, it is called when the popup closes.
+     */
+    attachPopupContent(breadcrumb: Breadcrumb, parent: HTMLElement): Promise<Disposable | undefined>;
+}