Theia APIs——命令和快捷键

上一篇：使用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);
});