Theia APIs——命令和快捷键

  • 时间:
  • 浏览:3
  • 来源:极速快3_快3IOS下载_极速快3IOS下载

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