Theia APIs——命令和快捷键

  • 时间:
  • 浏览:1
  • 来源:大发pk10_pk10平台app_大发pk10平台app

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