Theia APIs——命令和快捷键

  • 时间:
  • 浏览:0
  • 来源:大发uu快3_uu快3回血_大发uu快3回血

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