规范了文件结构

新增Editor的Demo
2024-11-21 16:39:15 +08:00 · 2024-11-21 02:12:20 +08:00
9 changed files with 421 additions and 70 deletions
--- a/src/vs/workbench/common/editor.ts
+++ b/src/vs/workbench/common/editor.ts
@ -421,6 +421,7 @@ export interface IFileEditorFactory {
 }

 export interface IEditorFactoryRegistry {
+	[x: string]: any;

 	/**
 	 * Registers the file editor factory to use for file editors.
--- a/src/vs/workbench/common/views.ts
+++ b/src/vs/workbench/common/views.ts
@ -34,6 +34,14 @@ export const defaultViewIcon = registerIcon('default-view-icon', Codicon.window,
 export namespace Extensions {
 	export const ViewContainersRegistry = 'workbench.registry.view.containers';
 	export const ViewsRegistry = 'workbench.registry.view';
+
+	export function InstantiationService<T>(InstantiationService: any) {
+		throw new Error('Function not implemented.');
+	}
+
+	export function EditorService<T>(EditorService: any) {
+		throw new Error('Function not implemented.');
+	}
 }

 export const enum ViewContainerLocation {
--- a/src/vs/workbench/contrib/example/browser/editors/StockDetailsEditor.ts
+++ b/src/vs/workbench/contrib/example/browser/editors/StockDetailsEditor.ts
@ -0,0 +1,149 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { EditorPane } from '../../../../browser/parts/editor/editorPane.js';
+import { Dimension } from '../../../../../base/browser/dom.js';
+import { StockDetailsInput } from './StockDetailsInput.js';
+import { ITelemetryService } from '../../../../../platform/telemetry/common/telemetry.js';
+import { IThemeService } from '../../../../../platform/theme/common/themeService.js';
+import { IStorageService } from '../../../../../platform/storage/common/storage.js';
+
+import { CancellationToken } from '../../../../../base/common/cancellation.js';
+import { IEditorOptions } from '../../../../../platform/editor/common/editor.js';
+import { IEditorOpenContext } from '../../../../common/editor.js';
+import { IEditorGroup } from '../../../../services/editor/common/editorGroupsService.js';
+
+export class StockDetailsEditor extends EditorPane {
+	static readonly ID = 'workbench.editor.stockDetails';
+
+	private container: HTMLElement | null = null;
+
+	constructor(
+		group: IEditorGroup,
+		@ITelemetryService telemetryService: ITelemetryService,
+		@IThemeService themeService: IThemeService,
+		@IStorageService storageService: IStorageService
+	) {
+		super(StockDetailsEditor.ID, group, telemetryService, themeService, storageService);
+	}
+
+	/**
+	 * 创建编辑器容器并初始化界面。
+	 */
+	protected createEditor(parent: HTMLElement): void {
+		this.container = document.createElement('div');
+		this.container.className = 'stock-details-editor';
+
+		// 添加占位符
+		const placeholder = document.createElement('div');
+		placeholder.className = 'stock-placeholder';
+		placeholder.textContent = '请选择一只股票查看详情';
+		this.container.appendChild(placeholder);
+
+		parent.appendChild(this.container);
+	}
+
+	/**
+	 * 设置编辑器输入。
+	 */
+	override async setInput(
+		input: StockDetailsInput,
+		options: IEditorOptions | undefined,
+		context: IEditorOpenContext,
+		token: CancellationToken
+	): Promise<void> {
+		await super.setInput(input, options, context, token);
+
+		if (input.resource) {
+			console.log(`setInput 接收到股票代码: ${input.getCode()}`);
+			const stockCode = input.getCode();
+
+			if (!stockCode || stockCode.trim() === '') {
+				this.renderErrorMessage('股票代码为空，请选择有效的股票。');
+				return;
+			}
+
+			this.renderStockDetails(stockCode);
+		} else {
+			this.renderErrorMessage('未提供有效的股票代码');
+		}
+
+	}
+
+	/**
+	 * 根据股票代码加载详情。
+	 */
+	private renderStockDetails(stockCode: string): void {
+		if (!this.container) {
+			return;
+		}
+
+		// 清空容器内容
+		this.container.textContent = ''; // 不使用 innerHTML
+
+		// 创建标题
+		const title = document.createElement('h3');
+		title.textContent = '股票详情';
+		// 使用内联样式修改标题样式
+		title.style.fontSize = '24px'; // 修改字体大小为 24 像素
+		title.style.fontWeight = 'bold'; // 设置字体加粗
+		title.style.margin = '10px 0'; // 设置上下外边距
+
+		// 创建股票代码段
+		const codeInfo = document.createElement('p');
+		codeInfo.textContent = `代码: ${stockCode}`;
+
+		// 模拟价格信息
+		const priceInfo = document.createElement('p');
+		priceInfo.textContent = '价格: ¥123.45';
+
+		// 模拟涨跌幅信息
+		const changeInfo = document.createElement('p');
+		changeInfo.textContent = '涨跌幅: +3.21%';
+
+		// 添加到容器
+		this.container.appendChild(title);
+		this.container.appendChild(codeInfo);
+		this.container.appendChild(priceInfo);
+		this.container.appendChild(changeInfo);
+	}
+
+
+	/**
+	 * 渲染错误消息。
+	 */
+	private renderErrorMessage(message: string): void {
+		if (!this.container) {
+			return;
+		}
+
+		this.container.textContent = ''; // 清空之前的内容
+
+		const errorDiv = document.createElement('div');
+		errorDiv.className = 'stock-error';
+		errorDiv.textContent = message;
+
+		this.container.appendChild(errorDiv);
+	}
+
+	/**
+	 * 布局调整。
+	 */
+	override layout(dimension: Dimension): void {
+		if (this.container) {
+			this.container.style.width = `${dimension.width}px`;
+			this.container.style.height = `${dimension.height}px`;
+		}
+	}
+
+	/**
+	 * 清空输入内容。
+	 */
+	override clearInput(): void {
+		if (this.container) {
+			this.container.textContent = ''; // 不使用 innerHTML
+		}
+		super.clearInput();
+	}
+}
--- a/src/vs/workbench/contrib/example/browser/editors/StockDetailsInput.ts
+++ b/src/vs/workbench/contrib/example/browser/editors/StockDetailsInput.ts
@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { URI } from '../../../../../base/common/uri.js';
+import { EditorInput } from '../../../../common/editor/editorInput.js';
+
+
+export class StockDetailsInput extends EditorInput {
+	static readonly ID = 'workbench.stockDetails.input';
+
+	// 修改为 public
+	public readonly resource: URI;
+
+	constructor(resource: URI) {
+		super();
+
+		// 打印传入的 URI，无论是否有效
+		console.log(`StockDetailsInput 创建: ${resource ? resource.toString() : 'undefined'}`);
+
+		this.resource = resource;
+	}
+
+	override get typeId(): string {
+		return StockDetailsInput.ID;
+	}
+
+	override getName(): string {
+		// 获取股票代码部分
+		const stockCode = this.resource.toString().replace(/^stock-details:\/\/+/, ''); // 移除前缀 'stock-details://'
+		return `${stockCode}`; // 自定义标题
+	}
+
+	public getCode(): string {
+		// 从 URI 中提取股票代码，移除前缀 'stock-details://'
+		return this.resource.toString().replace(/^stock-details:\/\/+/, '');
+	}
+
+	override matches(other: EditorInput): boolean {
+		return other instanceof StockDetailsInput && this.resource.toString() === other.resource.toString();
+	}
+}
--- a/src/vs/workbench/contrib/example/browser/example.contribution.ts
+++ b/src/vs/workbench/contrib/example/browser/example.contribution.ts
@ -14,9 +14,15 @@ import { ILocalizedString, localize } from '../../../../nls.js';
 import { SyncDescriptor } from '../../../../platform/instantiation/common/descriptors.js';
 import { registerIcon } from '../../../../platform/theme/common/iconRegistry.js';
 import { Codicon } from '../../../../base/common/codicons.js';
-import { ExampleViewContainer } from './exampleViewContainer.js';
-import { ExampleView } from './exampleView.js';
+import { ExampleViewContainer } from './views/exampleViewContainer.js';
+import { ExampleView } from './views/exampleView.js';
 import { IViewPaneOptions } from '../../../browser/parts/views/viewPane.js';
+import { EditorPaneDescriptor, IEditorPaneRegistry } from '../../../browser/editor.js';
+import { EditorExtensions } from '../../../common/editor.js';
+import { StockDetailsEditor } from './editors/StockDetailsEditor.js';
+import { StockDetailsInput } from './editors/StockDetailsInput.js';
+
+


 // 如果需要为 Extensions 使用别名，可以在此处赋值
@ -34,7 +40,7 @@ const exampleIcon = registerIcon(
 const viewContainer = Registry.as<IViewContainersRegistry>(ViewContainerExtensions.ViewContainersRegistry).registerViewContainer(
 	{
 		id: 'workbench.view.example',
-		title: { value: localize('example', '示例'), original: 'Example' },
+		title: { value: localize('example', '侧边栏'), original: 'Example' },
 		ctorDescriptor: new SyncDescriptor(ExampleViewContainer),
 		icon: exampleIcon,
 		order: 6,
@ -66,5 +72,17 @@ Registry.as<IViewsRegistry>(ViewExtensions.ViewsRegistry).registerViews(
 	viewContainer
 );

+// 注册 EditorPane
+Registry.as<IEditorPaneRegistry>(EditorExtensions.EditorPane).registerEditorPane(
+	EditorPaneDescriptor.create(
+		StockDetailsEditor, // 编辑器的类
+		StockDetailsEditor.ID, // 编辑器唯一标识符
+		localize('stockDetails', 'Stock Details') // 编辑器的本地化名称
+	),
+	[new SyncDescriptor(StockDetailsInput)] // 绑定的 EditorInput 类型
+);
+
+
+console.log('StockDetailsEditor 注册完成');
 console.log('初始化完成');

--- a/src/vs/workbench/contrib/example/browser/exampleView.ts
+++ b/src/vs/workbench/contrib/example/browser/exampleView.ts
@ -1,55 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-import { IViewPaneOptions, ViewPane } from '../../../browser/parts/views/viewPane.js';
-
-import { IKeybindingService } from '../../../../platform/keybinding/common/keybinding.js';
-import { IContextMenuService } from '../../../../platform/contextview/browser/contextView.js';
-import { IConfigurationService } from '../../../../platform/configuration/common/configuration.js';
-import { IContextKeyService } from '../../../../platform/contextkey/common/contextkey.js';
-import { IViewDescriptorService } from '../../../common/views.js';
-import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
-import { IOpenerService } from '../../../../platform/opener/common/opener.js';
-import { IThemeService } from '../../../../platform/theme/common/themeService.js';
-import { ITelemetryService } from '../../../../platform/telemetry/common/telemetry.js';
-import { IAccessibleViewService } from '../../../../platform/accessibility/browser/accessibleView.js';
-import { IHoverService } from '../../../../platform/hover/browser/hover.js';
-
-
-
-export class ExampleView extends ViewPane {
-	constructor(
-		options: IViewPaneOptions,
-		@IKeybindingService keybindingService: IKeybindingService,
-		@IContextMenuService contextMenuService: IContextMenuService,
-		@IConfigurationService configurationService: IConfigurationService,
-		@IContextKeyService contextKeyService: IContextKeyService,
-		@IViewDescriptorService viewDescriptorService: IViewDescriptorService,
-		@IInstantiationService instantiationService: IInstantiationService,
-		@IOpenerService openerService: IOpenerService,
-		@IThemeService themeService: IThemeService,
-		@ITelemetryService telemetryService: ITelemetryService,
-		@IHoverService hoverService: IHoverService,
-		@IAccessibleViewService accessibleViewService: IAccessibleViewService
-	) {
-		super(
-			options,
-			keybindingService,
-			contextMenuService,
-			configurationService,
-			contextKeyService,
-			viewDescriptorService,
-			instantiationService,
-			openerService,
-			themeService,
-			telemetryService,
-			hoverService,
-
-		);
-	}
-
-	// 您可以在这里添加自定义的视图逻辑
-}
-
--- a/src/vs/workbench/contrib/example/browser/views/exampleView.ts
+++ b/src/vs/workbench/contrib/example/browser/views/exampleView.ts
@ -0,0 +1,166 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { IViewPaneOptions, ViewPane } from '../../../../browser/parts/views/viewPane.js';
+
+import { IKeybindingService } from '../../../../../platform/keybinding/common/keybinding.js';
+import { IContextMenuService } from '../../../../../platform/contextview/browser/contextView.js';
+import { IConfigurationService } from '../../../../../platform/configuration/common/configuration.js';
+import { IContextKeyService } from '../../../../../platform/contextkey/common/contextkey.js';
+import { IViewDescriptorService } from '../../../../common/views.js';
+import { IInstantiationService } from '../../../../../platform/instantiation/common/instantiation.js';
+import { IOpenerService } from '../../../../../platform/opener/common/opener.js';
+import { IThemeService } from '../../../../../platform/theme/common/themeService.js';
+import { ITelemetryService } from '../../../../../platform/telemetry/common/telemetry.js';
+import { IAccessibleViewService } from '../../../../../platform/accessibility/browser/accessibleView.js';
+import { IHoverService } from '../../../../../platform/hover/browser/hover.js';
+import * as DOM from '../../../../../base/browser/dom.js';
+import { URI } from '../../../../../base/common/uri.js';
+
+import './media/exampleViewContainer.css';
+import { IEditorService } from '../../../../services/editor/common/editorService.js';
+import { StockDetailsInput } from '../editors/StockDetailsInput.js';
+
+export class ExampleView extends ViewPane {
+	constructor(
+		options: IViewPaneOptions,
+		@IKeybindingService keybindingService: IKeybindingService,
+		@IContextMenuService contextMenuService: IContextMenuService,
+		@IConfigurationService configurationService: IConfigurationService,
+		@IContextKeyService contextKeyService: IContextKeyService,
+		@IViewDescriptorService viewDescriptorService: IViewDescriptorService,
+		@IInstantiationService instantiationService: IInstantiationService,
+		@IOpenerService openerService: IOpenerService,
+		@IThemeService themeService: IThemeService,
+		@ITelemetryService telemetryService: ITelemetryService,
+		@IHoverService hoverService: IHoverService,
+		@IAccessibleViewService accessibleViewService: IAccessibleViewService
+	) {
+		super(
+			options,
+			keybindingService,
+			contextMenuService,
+			configurationService,
+			contextKeyService,
+			viewDescriptorService,
+			instantiationService,
+			openerService,
+			themeService,
+			telemetryService,
+			hoverService,
+
+		);
+	}
+
+	// 您可以在这里添加自定义的视图逻辑
+
+	// override renderBody(container: HTMLElement): void {
+	// 	super.renderBody(container);
+
+	// 	// 创建一个用于股票列表的容器
+	// 	const stockListContainer = DOM.$('.stock-list-container');
+	// 	stockListContainer.style.padding = '10px';
+	// 	stockListContainer.style.overflowY = 'auto';
+	// 	stockListContainer.style.maxHeight = '100%';
+
+	// 	// 模拟股票列表
+	// 	const mockStockData = [
+	// 		{ name: 'Stock A', code: '000001', price: '100.00' },
+	// 		{ name: 'Stock B', code: '000002', price: '200.00' },
+	// 		{ name: 'Stock C', code: '000003', price: '300.00' },
+	// 		{ name: 'Stock D', code: '000004', price: '400.00' },
+	// 		{ name: 'Stock E', code: '000005', price: '500.00' },
+	// 	];
+
+	// 	// 创建列表元素
+	// 	const ul = DOM.$('ul');
+	// 	ul.style.listStyleType = 'none';
+	// 	ul.style.margin = '0';
+	// 	ul.style.padding = '0';
+
+	// 	// 遍历伪数据并创建每个列表项
+	// 	mockStockData.forEach(stock => {
+	// 		const li = DOM.$('li');
+	// 		li.style.display = 'flex';
+	// 		li.style.justifyContent = 'space-between';
+	// 		li.style.padding = '8px';
+	// 		li.style.borderBottom = '1px solid #ccc';
+
+	// 		const name = DOM.$('span');
+	// 		name.textContent = `${stock.name} (${stock.code})`;
+
+	// 		const price = DOM.$('span');
+	// 		price.textContent = `￥${stock.price}`;
+
+	// 		li.appendChild(name);
+	// 		li.appendChild(price);
+	// 		ul.appendChild(li);
+	// 	});
+
+	// 	// 将列表添加到容器中
+	// 	stockListContainer.appendChild(ul);
+	// 	container.appendChild(stockListContainer);
+	// }
+
+	override renderBody(container: HTMLElement): void {
+		super.renderBody(container);
+
+		const ul = DOM.$('ul'); // 创建一个无序列表
+		ul.classList.add('stock-list'); // 为列表添加样式类
+		const data = [
+			{ name: 'Stock A', code: '000001', price: 100 },
+			{ name: 'Stock B', code: '000002', price: 200 },
+			{ name: 'Stock C', code: '000003', price: 300 },
+			{ name: 'Stock D', code: '000004', price: 400 },
+			{ name: 'Stock E', code: '000005', price: 500 },
+		]; // 假数据
+
+		for (const stock of data) {
+			const li = DOM.$('li');
+			li.textContent = `${stock.name} (${stock.code}) ¥${stock.price.toFixed(2)}`;
+			li.classList.add('stock-item');
+			li.addEventListener('click', () => {
+				this.openStockDetails(stock); // 点击时打开股票详情
+			});
+			ul.appendChild(li);
+		}
+
+		container.appendChild(ul); // 将列表附加到容器中
+	}
+
+	// private openStockDetails(stock: { name: string; code: string; price: number }): void {
+	// 	const uri = URI.parse(`stock-details://${stock.code}`); // 自定义 URI
+	// 	const editorInput = new StockDetailsInput(uri); // 创建新的输入实例
+
+	// 	const editorService = this.instantiationService.invokeFunction(accessor => accessor.get(IEditorService)); // 获取编辑器服务
+	// 	editorService.openEditor(editorInput, { pinned: true }).then(() => { // 打开编辑器
+	// 		console.log(`Opened details for ${stock.name}`);
+	// 	});
+	// }
+
+	private openStockDetails(stock: { name: string; code: string; price: number }): void {
+		if (!stock.code || stock.code.trim() === '') {
+			console.error('无法打开股票详情：股票代码为空');
+			return;
+		}
+
+		console.log(`准备打开股票详情: ${stock.name} (${stock.code})`);
+
+		const uri = URI.parse(`stock-details://${stock.code}`); // 自定义 URI
+		const editorInput = new StockDetailsInput(uri); // 创建新的输入实例
+
+		const editorService = this.instantiationService.invokeFunction(accessor => accessor.get(IEditorService)); // 获取编辑器服务
+		editorService.openEditor(editorInput, { pinned: true }).then(() => {
+			console.log(`成功打开股票详情: ${stock.name} (${stock.code})`);
+		}).catch(err => {
+			console.error(`打开股票详情失败: ${err.message}`);
+		});
+	}
+
+	override layoutBody(height: number, width: number): void {
+		// 布局逻辑，如果需要调整高度和宽度
+	}
+}
+
--- a/src/vs/workbench/contrib/example/browser/views/exampleViewContainer.ts
+++ b/src/vs/workbench/contrib/example/browser/views/exampleViewContainer.ts
@ -3,17 +3,17 @@
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

-import { ViewPaneContainer } from '../../../browser/parts/views/viewPaneContainer.js';
-import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
-import { IConfigurationService } from '../../../../platform/configuration/common/configuration.js';
-import { IExtensionService } from '../../../services/extensions/common/extensions.js';
-import { ITelemetryService } from '../../../../platform/telemetry/common/telemetry.js';
-import { IThemeService } from '../../../../platform/theme/common/themeService.js';
-import { IStorageService } from '../../../../platform/storage/common/storage.js';
-import { IWorkbenchLayoutService } from '../../../services/layout/browser/layoutService.js';
-import { IContextMenuService } from '../../../../platform/contextview/browser/contextView.js';
-import { IViewDescriptorService } from '../../../common/views.js';
-import { IWorkspaceContextService } from '../../../../platform/workspace/common/workspace.js';
+import { ViewPaneContainer } from '../../../../browser/parts/views/viewPaneContainer.js';
+import { IInstantiationService } from '../../../../../platform/instantiation/common/instantiation.js';
+import { IConfigurationService } from '../../../../../platform/configuration/common/configuration.js';
+import { IExtensionService } from '../../../../services/extensions/common/extensions.js';
+import { ITelemetryService } from '../../../../../platform/telemetry/common/telemetry.js';
+import { IThemeService } from '../../../../../platform/theme/common/themeService.js';
+import { IStorageService } from '../../../../../platform/storage/common/storage.js';
+import { IWorkbenchLayoutService } from '../../../../services/layout/browser/layoutService.js';
+import { IContextMenuService } from '../../../../../platform/contextview/browser/contextView.js';
+import { IViewDescriptorService } from '../../../../common/views.js';
+import { IWorkspaceContextService } from '../../../../../platform/workspace/common/workspace.js';


 export class ExampleViewContainer extends ViewPaneContainer {
@ -30,7 +30,7 @@ export class ExampleViewContainer extends ViewPaneContainer {
 		@IWorkspaceContextService contextService: IWorkspaceContextService
 	) {
 		super(
-			'exampleViewContainer',
+			'workbench.view.example',
 			{ mergeViewWithContainerWhenSingleView: true },
 			instantiationService,
 			configurationService,
@ -44,4 +44,9 @@ export class ExampleViewContainer extends ViewPaneContainer {
 			viewDescriptorService
 		);
 	}
+
+	override getTitle(): string {
+		return ''; // 返回空字符串，确保没有容器标题和冒号
+	}
+
 }
--- a/src/vs/workbench/contrib/example/browser/views/media/exampleViewContainer.css
+++ b/src/vs/workbench/contrib/example/browser/views/media/exampleViewContainer.css
@ -0,0 +1,16 @@
+.stock-list {
+    list-style: none;
+    padding: 0;
+    margin: 0;
+}
+
+.stock-item {
+    padding: 10px;
+    border-bottom: 1px solid #ddd;
+    cursor: pointer;
+    transition: background 0.2s;
+}
+
+.stock-item:hover {
+    background: #f0f0f0;
+}
Author	SHA1	Message	Date
mxwj	11b799fa14	规范了文件结构 Some checks failed Monaco Editor checks / Monaco Editor checks (push) Failing after 39s Details	2024-11-21 16:39:15 +08:00
mxwj	42f411fc64	新增Editor的Demo Some checks failed Monaco Editor checks / Monaco Editor checks (push) Failing after 19m8s Details	2024-11-21 02:12:20 +08:00