@theia/property-view 1.45.0 → 1.46.0-next.72

package/src/browser/empty-property-view-widget-provider.tsx

@@ -1,83 +1,83 @@
-// *****************************************************************************
-// Copyright (C) 2020 EclipseSource 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 { nls } from '@theia/core/lib/common/nls';
-import { ReactWidget } from '@theia/core/lib/browser';
-import { injectable } from '@theia/core/shared/inversify';
-import * as React from '@theia/core/shared/react';
-import { PropertyViewContentWidget } from './property-view-content-widget';
-import { DefaultPropertyViewWidgetProvider } from './property-view-widget-provider';
-
-/**
- * Property view widget that is shown if no property data or selection is available.
- * This widget is provided by the {@link EmptyPropertyViewWidgetProvider}.
- */
-class EmptyPropertyViewWidget extends ReactWidget implements PropertyViewContentWidget {
-
-    static readonly ID = 'theia-empty-property-view';
-    static readonly LABEL = 'No Properties';
-
-    constructor() {
-        super();
-        this.id = EmptyPropertyViewWidget.ID;
-        this.title.label = EmptyPropertyViewWidget.LABEL;
-        this.title.caption = EmptyPropertyViewWidget.LABEL;
-        this.title.closable = false;
-        this.node.tabIndex = 0;
-    }
-
-    updatePropertyViewContent(): void {
-        this.update();
-    }
-
-    protected render(): React.ReactNode {
-        return this.emptyComponent;
-    }
-
-    protected emptyComponent: JSX.Element = <div className={'theia-widget-noInfo'}>{nls.localize('theia/property-view/noProperties', 'No properties available.')}</div>;
-
-}
-
-/**
- * `EmptyPropertyViewWidgetProvider` is implemented to provide the {@link EmptyPropertyViewWidget}
- *  if the given selection is undefined or no other provider can handle the given selection.
- */
-@injectable()
-export class EmptyPropertyViewWidgetProvider extends DefaultPropertyViewWidgetProvider {
-
-    static readonly ID = 'no-properties';
-    override readonly id = EmptyPropertyViewWidgetProvider.ID;
-    override readonly label = 'DefaultPropertyViewWidgetProvider';
-
-    private emptyWidget: EmptyPropertyViewWidget;
-
-    constructor() {
-        super();
-        this.emptyWidget = new EmptyPropertyViewWidget();
-    }
-
-    override canHandle(selection: Object | undefined): number {
-        return selection === undefined ? 1 : 0;
-    }
-
-    override provideWidget(selection: Object | undefined): Promise<EmptyPropertyViewWidget> {
-        return Promise.resolve(this.emptyWidget);
-    }
-
-    override updateContentWidget(selection: Object | undefined): void {
-        this.emptyWidget.updatePropertyViewContent();
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2020 EclipseSource 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 { nls } from '@theia/core/lib/common/nls';
+import { ReactWidget } from '@theia/core/lib/browser';
+import { injectable } from '@theia/core/shared/inversify';
+import * as React from '@theia/core/shared/react';
+import { PropertyViewContentWidget } from './property-view-content-widget';
+import { DefaultPropertyViewWidgetProvider } from './property-view-widget-provider';
+
+/**
+ * Property view widget that is shown if no property data or selection is available.
+ * This widget is provided by the {@link EmptyPropertyViewWidgetProvider}.
+ */
+class EmptyPropertyViewWidget extends ReactWidget implements PropertyViewContentWidget {
+
+    static readonly ID = 'theia-empty-property-view';
+    static readonly LABEL = 'No Properties';
+
+    constructor() {
+        super();
+        this.id = EmptyPropertyViewWidget.ID;
+        this.title.label = EmptyPropertyViewWidget.LABEL;
+        this.title.caption = EmptyPropertyViewWidget.LABEL;
+        this.title.closable = false;
+        this.node.tabIndex = 0;
+    }
+
+    updatePropertyViewContent(): void {
+        this.update();
+    }
+
+    protected render(): React.ReactNode {
+        return this.emptyComponent;
+    }
+
+    protected emptyComponent: JSX.Element = <div className={'theia-widget-noInfo'}>{nls.localize('theia/property-view/noProperties', 'No properties available.')}</div>;
+
+}
+
+/**
+ * `EmptyPropertyViewWidgetProvider` is implemented to provide the {@link EmptyPropertyViewWidget}
+ *  if the given selection is undefined or no other provider can handle the given selection.
+ */
+@injectable()
+export class EmptyPropertyViewWidgetProvider extends DefaultPropertyViewWidgetProvider {
+
+    static readonly ID = 'no-properties';
+    override readonly id = EmptyPropertyViewWidgetProvider.ID;
+    override readonly label = 'DefaultPropertyViewWidgetProvider';
+
+    private emptyWidget: EmptyPropertyViewWidget;
+
+    constructor() {
+        super();
+        this.emptyWidget = new EmptyPropertyViewWidget();
+    }
+
+    override canHandle(selection: Object | undefined): number {
+        return selection === undefined ? 1 : 0;
+    }
+
+    override provideWidget(selection: Object | undefined): Promise<EmptyPropertyViewWidget> {
+        return Promise.resolve(this.emptyWidget);
+    }
+
+    override updateContentWidget(selection: Object | undefined): void {
+        this.emptyWidget.updatePropertyViewContent();
+    }
+}

package/src/browser/property-data-service.ts

@@ -1,48 +1,48 @@
-// *****************************************************************************
-// Copyright (C) 2020 EclipseSource 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
-// *****************************************************************************
-
-export const PropertyDataService = Symbol('PropertyDataService');
-/**
- * `PropertyDataService` should be implemented to provide property data for the given selection.
- */
-export interface PropertyDataService {
-
-    /**
-     * A unique id for this provider.
-     */
-    readonly id: string;
-    /**
-     * A human-readable name for this provider.
-     */
-    readonly label?: string;
-
-    /**
-     * Test whether this provider can provide property data for the given selection.
-     * Return a nonzero number if this provider can provide; otherwise it cannot.
-     * Never reject.
-     *
-     * A returned value indicating a priority of this provider.
-     */
-    canHandleSelection(selection: Object | undefined): number;
-
-    /**
-     * Provide property data for the given selection.
-     * Resolve to a property view content widget.
-     * Never reject if `canHandle` returns a positive number; otherwise should reject.
-     */
-    providePropertyData(selection: Object | undefined): Promise<Object | undefined>;
-
-}
+// *****************************************************************************
+// Copyright (C) 2020 EclipseSource 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
+// *****************************************************************************
+
+export const PropertyDataService = Symbol('PropertyDataService');
+/**
+ * `PropertyDataService` should be implemented to provide property data for the given selection.
+ */
+export interface PropertyDataService {
+
+    /**
+     * A unique id for this provider.
+     */
+    readonly id: string;
+    /**
+     * A human-readable name for this provider.
+     */
+    readonly label?: string;
+
+    /**
+     * Test whether this provider can provide property data for the given selection.
+     * Return a nonzero number if this provider can provide; otherwise it cannot.
+     * Never reject.
+     *
+     * A returned value indicating a priority of this provider.
+     */
+    canHandleSelection(selection: Object | undefined): number;
+
+    /**
+     * Provide property data for the given selection.
+     * Resolve to a property view content widget.
+     * Never reject if `canHandle` returns a positive number; otherwise should reject.
+     */
+    providePropertyData(selection: Object | undefined): Promise<Object | undefined>;
+
+}

package/src/browser/property-view-content-widget.ts

@@ -1,27 +1,27 @@
-// *****************************************************************************
-// Copyright (C) 2020 EclipseSource 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 { Widget } from '@theia/core/lib/browser/widgets/widget';
-import { PropertyDataService } from './property-data-service';
-
-/**
- * A widget that fetches the property data via the given {@link PropertyDataService} and the given selection
- * and renders that property data.
- * This widget can be provided by a registered `PropertyViewWidgetProvider`.
- */
-export interface PropertyViewContentWidget extends Widget {
-    updatePropertyViewContent(propertyDataService?: PropertyDataService, selection?: Object): void;
-}
+// *****************************************************************************
+// Copyright (C) 2020 EclipseSource 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 { Widget } from '@theia/core/lib/browser/widgets/widget';
+import { PropertyDataService } from './property-data-service';
+
+/**
+ * A widget that fetches the property data via the given {@link PropertyDataService} and the given selection
+ * and renders that property data.
+ * This widget can be provided by a registered `PropertyViewWidgetProvider`.
+ */
+export interface PropertyViewContentWidget extends Widget {
+    updatePropertyViewContent(propertyDataService?: PropertyDataService, selection?: Object): void;
+}

package/src/browser/property-view-contribution.ts

@@ -1,36 +1,36 @@
-// *****************************************************************************
-// Copyright (C) 2020 EclipseSource 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 { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
-import { injectable } from '@theia/core/shared/inversify';
-import { PropertyViewWidget } from './property-view-widget';
-
-@injectable()
-export class PropertyViewContribution extends AbstractViewContribution<PropertyViewWidget> {
-
-    constructor() {
-        super({
-            widgetId: PropertyViewWidget.ID,
-            widgetName: PropertyViewWidget.LABEL,
-            defaultWidgetOptions: {
-                area: 'bottom'
-            },
-            toggleCommandId: 'property-view:toggle',
-            toggleKeybinding: 'shift+alt+p'
-        });
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2020 EclipseSource 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 { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
+import { injectable } from '@theia/core/shared/inversify';
+import { PropertyViewWidget } from './property-view-widget';
+
+@injectable()
+export class PropertyViewContribution extends AbstractViewContribution<PropertyViewWidget> {
+
+    constructor() {
+        super({
+            widgetId: PropertyViewWidget.ID,
+            widgetName: PropertyViewWidget.LABEL,
+            defaultWidgetOptions: {
+                area: 'bottom'
+            },
+            toggleCommandId: 'property-view:toggle',
+            toggleKeybinding: 'shift+alt+p'
+        });
+    }
+
+}

package/src/browser/property-view-frontend-module.ts

@@ -1,47 +1,47 @@
-// *****************************************************************************
-// Copyright (C) 2020 EclipseSource 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 { bindViewContribution, WidgetFactory } from '@theia/core/lib/browser';
-import { bindContributionProvider } from '@theia/core/lib/common/contribution-provider';
-import { ContainerModule } from '@theia/core/shared/inversify';
-import { EmptyPropertyViewWidgetProvider } from './empty-property-view-widget-provider';
-import { PropertyDataService } from './property-data-service';
-import { PropertyViewContribution } from './property-view-contribution';
-import { PropertyViewService } from './property-view-service';
-import { PropertyViewWidget } from './property-view-widget';
-import { PropertyViewWidgetProvider } from './property-view-widget-provider';
-import { bindResourcePropertyView } from './resource-property-view';
-import '../../src/browser/style/property-view.css';
-
-export default new ContainerModule(bind => {
-    bind(PropertyViewService).toSelf().inSingletonScope();
-
-    bindContributionProvider(bind, PropertyDataService);
-    bindContributionProvider(bind, PropertyViewWidgetProvider);
-
-    bind(EmptyPropertyViewWidgetProvider).toSelf().inSingletonScope();
-    bind(PropertyViewWidgetProvider).to(EmptyPropertyViewWidgetProvider);
-
-    bind(PropertyViewWidget).toSelf();
-    bind(WidgetFactory).toDynamicValue(({ container }) => ({
-        id: PropertyViewWidget.ID,
-        createWidget: () => container.get(PropertyViewWidget)
-    })).inSingletonScope();
-
-    bindViewContribution(bind, PropertyViewContribution);
-
-    bindResourcePropertyView(bind);
-});
+// *****************************************************************************
+// Copyright (C) 2020 EclipseSource 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 { bindViewContribution, WidgetFactory } from '@theia/core/lib/browser';
+import { bindContributionProvider } from '@theia/core/lib/common/contribution-provider';
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { EmptyPropertyViewWidgetProvider } from './empty-property-view-widget-provider';
+import { PropertyDataService } from './property-data-service';
+import { PropertyViewContribution } from './property-view-contribution';
+import { PropertyViewService } from './property-view-service';
+import { PropertyViewWidget } from './property-view-widget';
+import { PropertyViewWidgetProvider } from './property-view-widget-provider';
+import { bindResourcePropertyView } from './resource-property-view';
+import '../../src/browser/style/property-view.css';
+
+export default new ContainerModule(bind => {
+    bind(PropertyViewService).toSelf().inSingletonScope();
+
+    bindContributionProvider(bind, PropertyDataService);
+    bindContributionProvider(bind, PropertyViewWidgetProvider);
+
+    bind(EmptyPropertyViewWidgetProvider).toSelf().inSingletonScope();
+    bind(PropertyViewWidgetProvider).to(EmptyPropertyViewWidgetProvider);
+
+    bind(PropertyViewWidget).toSelf();
+    bind(WidgetFactory).toDynamicValue(({ container }) => ({
+        id: PropertyViewWidget.ID,
+        createWidget: () => container.get(PropertyViewWidget)
+    })).inSingletonScope();
+
+    bindViewContribution(bind, PropertyViewContribution);
+
+    bindResourcePropertyView(bind);
+});

package/src/browser/property-view-service.ts

@@ -1,62 +1,62 @@
-// *****************************************************************************
-// Copyright (C) 2020 EclipseSource 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 { ContributionProvider, Prioritizeable } from '@theia/core';
-import { inject, injectable, named, postConstruct } from '@theia/core/shared/inversify';
-import { EmptyPropertyViewWidgetProvider } from './empty-property-view-widget-provider';
-import { PropertyViewWidgetProvider } from './property-view-widget-provider';
-
-/**
- * `PropertyViewService` provides an access to existing property view widget providers.
- */
-@injectable()
-export class PropertyViewService {
-
-    @inject(ContributionProvider) @named(PropertyViewWidgetProvider)
-    private readonly contributions: ContributionProvider<PropertyViewWidgetProvider>;
-
-    @inject(EmptyPropertyViewWidgetProvider)
-    private readonly emptyWidgetProvider: EmptyPropertyViewWidgetProvider;
-
-    private providers: PropertyViewWidgetProvider[] = [];
-
-    @postConstruct()
-    init(): void {
-        this.providers = this.providers.concat(this.contributions.getContributions());
-    }
-
-    /**
-     * Return a property view widget provider with the highest priority for the given selection.
-     * Never reject, return the default provider ({@link EmptyPropertyViewWidgetProvider};
-     * displays `No properties available`) if there are no other matches.
-     */
-    async getProvider(selection: Object | undefined): Promise<PropertyViewWidgetProvider> {
-        const provider = await this.prioritize(selection);
-        return provider ?? this.emptyWidgetProvider;
-    }
-
-    protected async prioritize(selection: Object | undefined): Promise<PropertyViewWidgetProvider | undefined> {
-        const prioritized = await Prioritizeable.prioritizeAll(this.providers, async (provider: PropertyViewWidgetProvider) => {
-            try {
-                return await provider.canHandle(selection);
-            } catch {
-                return 0;
-            }
-        });
-        return prioritized.length !== 0 ? prioritized[0].value : undefined;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2020 EclipseSource 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 { ContributionProvider, Prioritizeable } from '@theia/core';
+import { inject, injectable, named, postConstruct } from '@theia/core/shared/inversify';
+import { EmptyPropertyViewWidgetProvider } from './empty-property-view-widget-provider';
+import { PropertyViewWidgetProvider } from './property-view-widget-provider';
+
+/**
+ * `PropertyViewService` provides an access to existing property view widget providers.
+ */
+@injectable()
+export class PropertyViewService {
+
+    @inject(ContributionProvider) @named(PropertyViewWidgetProvider)
+    private readonly contributions: ContributionProvider<PropertyViewWidgetProvider>;
+
+    @inject(EmptyPropertyViewWidgetProvider)
+    private readonly emptyWidgetProvider: EmptyPropertyViewWidgetProvider;
+
+    private providers: PropertyViewWidgetProvider[] = [];
+
+    @postConstruct()
+    init(): void {
+        this.providers = this.providers.concat(this.contributions.getContributions());
+    }
+
+    /**
+     * Return a property view widget provider with the highest priority for the given selection.
+     * Never reject, return the default provider ({@link EmptyPropertyViewWidgetProvider};
+     * displays `No properties available`) if there are no other matches.
+     */
+    async getProvider(selection: Object | undefined): Promise<PropertyViewWidgetProvider> {
+        const provider = await this.prioritize(selection);
+        return provider ?? this.emptyWidgetProvider;
+    }
+
+    protected async prioritize(selection: Object | undefined): Promise<PropertyViewWidgetProvider | undefined> {
+        const prioritized = await Prioritizeable.prioritizeAll(this.providers, async (provider: PropertyViewWidgetProvider) => {
+            try {
+                return await provider.canHandle(selection);
+            } catch {
+                return 0;
+            }
+        });
+        return prioritized.length !== 0 ? prioritized[0].value : undefined;
+    }
+
+}