Interface CommandManager

interface CommandManager {
    byName: CommandMap;
    commands: CommandMap;
    addCommand(command): void;
    addCommands(command): void;
    addEventListener(name, callback, capturing?): void;
    bindKey(key, command, position?): void;
    bindKeys(keys): void;
    canExecute(command, editor): boolean;
    exec(command, editor, args): boolean;
    findKeyCommand(hashId, keyString): string;
    getStatusText(editor, data): string;
    handleKeyboard(data, hashId, keyString, keyCode): void | {
        command: string;
    };
    off(name, callback): void;
    on(name, callback): Function;
    on(name, callback): Function;
    on(name, callback, capturing?): void;
    once(name, callback): void;
    parseKeys(keyPart): {
        hashId: number;
        key: string;
    };
    removeAllListeners(name?): void;
    removeCommand(command, keepCommand?): void;
    removeCommands(command): void;
    removeDefaultHandler(name, callback): void;
    removeEventListener(name, callback): void;
    removeListener(name, callback): void;
    replay(editor): void;
    setDefaultHandler(name, callback): void;
    toggleRecording(editor): void;
}

Hierarchy (view full)

Properties

byName commands

Methods

addCommand addCommands addEventListener bindKey bindKeys canExecute exec findKeyCommand getStatusText handleKeyboard off on once parseKeys removeAllListeners removeCommand removeCommands removeDefaultHandler removeEventListener removeListener replay setDefaultHandler toggleRecording

Properties

byName

byName: CommandMap

commands

commands: CommandMap

Methods

addCommand

addCommands

addEventListener

bindKey

  • bindKey(key, command, position?): void

  • Parameters

    • key: string | {
          mac?: string;
          win?: string;
      }
    • command: Ace.CommandLike
    • Optional position: number

    Returns void

bindKeys

  • bindKeys(keys): void

  • Parameters

    • keys: {
          [s: string]: Function;
      }
      • [s: string]: Function

    Returns void

canExecute

exec

findKeyCommand

  • findKeyCommand(hashId, keyString): string

  • Parameters

    • hashId: number
    • keyString: string

    Returns string

getStatusText

  • getStatusText(editor, data): string

  • Parameters

    Returns string

handleKeyboard

  • handleKeyboard(data, hashId, keyString, keyCode): void | {
        command: string;
    }

  • Parameters

    • data: {}
      • hashId: number
      • keyString: string
      • keyCode: string | number

      Returns void | {
          command: string;
      }

    off

    on

    • on(name, callback): Function

    • Parameters

      Returns Function

    • on(name, callback): Function

    • Parameters

      Returns Function

    • on(name, callback, capturing?): void

    • Parameters

      • name: string
      • callback: Function
      • Optional capturing: boolean

      Returns void

    once

    parseKeys

    • parseKeys(keyPart): {
          hashId: number;
          key: string;
      }

    • Parameters

      • keyPart: string

      Returns {
          hashId: number;
          key: string;
      }

      • hashId: number
      • key: string

    removeAllListeners

    removeCommand

    • removeCommand(command, keepCommand?): void

    • Parameters

      • command: string | Ace.Command
      • Optional keepCommand: boolean

      Returns void

    removeCommands

    removeDefaultHandler

    removeEventListener

    removeListener

    replay

    setDefaultHandler

    toggleRecording

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc