Theia APIs——命令和快捷键

  • 时间:
  • 浏览:0

上一篇:使用Theia——创建语言支持

命令和快捷键

  Theia都须要通越多种不同的妙招进行扩展。命令允许packages提供都须要被其它包调用的唯一命令,还都须要向那些命令换成快捷键和上下文,使得它们非要在你你是什么 特定的条件下被调用(如窗口获取焦点、当前选项等)。

在Theia中换成命令

  要将命令换成到Theia,须要实现CommandContribution类,如:

java-commands.ts

@injectable()
export class JavaCommandContribution implements CommandContribution {
...
    registerCommands(commands: CommandRegistry): void {
        commands.registerCommand(SHOW_JAVA_REFERENCES, {
            execute: (uri: string, position: Position, locations: Location[]) =>
                commands.executeCommand(SHOW_REFERENCES.id, uri, position, locations)
        });
        commands.registerCommand(APPLY_WORKSPACE_EDIT, {
            execute: (changes: WorkspaceEdit) =>
                !!this.workspace.applyEdit && this.workspace.applyEdit(changes)
        });
    }
}

  每有一俩个 contribution须要提供有一俩个 唯一的命令id,以及有一俩个 命令出理 应用应用程序(由回调函数执行)。

  将contribution绑定到CommandContribution。

  怎么让将contribution的类注入到适当的模块中(确保类被标记为@injectable()),像另有一俩个 :

java-frontend-module.ts

export default new ContainerModule(bind => {
    bind(CommandContribution).to(JavaCommandContribution).inSingletonScope();
    ...
});

  负责注册和执行命令的类是CommandRegistry,通过get commandIds() api都须要获取命令列表。

换成快捷键

  默认清况 下不须要给命令换成快捷键,原因它都须要通过你你是什么 不同的妙招来调用(通过编程妙招原因用户点击)。不过,亲戚亲戚大伙仍然都须要将具有特定上下文的快捷键绑定到命令上以完成相同的命令功能。

  要换成快捷键,只须要注入有一俩个 KeybindingContribution的实现。

editor-keybinding.ts

@injectable()
export class EditorKeybindingContribution implements KeybindingContribution {

    constructor(
        @inject(EditorKeybindingContext) protected readonly editorKeybindingContext: EditorKeybindingContext
    ) { }

    registerKeybindings(registry: KeybindingRegistry): void {
        [
            {
                command: 'editor.close',
                context: this.editorKeybindingContext,
                keybinding: "alt+w"
            },
            {
                command: 'editor.close.all',
                context: this.editorKeybindingContext,
                keybinding: "alt+shift+w"
            }
        ].forEach(binding => {
            registry.registerKeybinding(binding);
        });
    }
}

  commandId须要是预先注册好的命令,怎么让须要唯一。context是有一俩个 简单的类,用于确保命令和快捷键的绑定组合在特定条件下是可用的。对于编辑器而言,它看起来是另有一俩个 的:

editor-keybinding.ts

@injectable()
export class EditorKeybindingContext implements KeybindingContext {
    constructor( @inject(EditorManager) protected readonly editorService: EditorManager) { }

    id = 'editor.keybinding.context';

    isEnabled(arg?: Keybinding) {
        return this.editorService && !!this.editorService.activeEditor;
    }
}

  context不是 有一俩个 唯一的id,用于在上下文中将快捷键注册到命令中。isEnabled()妙招会根据给定的条件返回true或false。请注意,context是有一俩个 可选参数,原因这麼提供,则默认为NOOP_CONTEXT。使用该context注册的快捷键将始终保持开启清况 ,都须要在应用应用应用程序的任何地方使用。

  对于id而言,参数keycode是须要的,它是有一俩个 所含实际快捷键绑定的形状。下面是有一俩个 正确的形状:

keys.ts

export declare type Keystroke = { first: Key, modifiers?: Modifier[] };

  Modifier是平台无关的,什么都有 Modifier.M1在OS X上是Command而在Windows/Linux上是CTRL。Key字符串常量定义在keys.ts中。

将contribution绑定到KeybindingContribution

  与绑定命令contribution一样,快捷键contribution也须要按模块进行绑定,像另有一俩个 :

editor-frontend-module.ts

export default new ContainerModule(bind => {
    ...
    bind(CommandContribution).to(EditorCommandHandlers);
    bind(EditorKeybindingContext).toSelf().inSingletonScope();
    bind(KeybindingContext).toDynamicValue(context => context.container.get(EditorKeybindingContext));
    bind(KeybindingContribution).to(EditorKeybindingContribution);
});