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