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);
});