Theia APIs——命令和快捷键

  • 时间:
  • 浏览:0
  • 来源:大发快3_快3豹子_大发快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);
});