Class CommandManager

Hierarchy (view full)

MultiHashHandler
- CommandManager

Constructors

constructor

new CommandManager(platform, commands): CommandManager
new CommandManager(platform, commands)
Parameters
- platform: string
  Identifier for the platform; must be either "mac" or "win"
- commands: any[]
  A list of commands
Returns CommandManager
Overrides MultiHashHandler.constructor
- Defined in src/commands/command_manager.js:16

Properties

$addCommandToMacro

$addCommandToMacro: any

$inReplay

$inReplay: boolean

$singleCommand

$singleCommand: boolean

byName

byName: Record<string, Command>

commandKeyBinding

commandKeyBinding: {}

Type declaration

commands

commands: Record<string, Command>

macro

macro: any

oldMacro

oldMacro: any

platform

platform: string

recording

recording: boolean

Methods

$init

$init(config, platform?, $singleCommand?): void
Parameters
- config: Command[] | Record<string, CommandLike>
- Optional platform: string
- Optional $singleCommand: boolean
Returns void
Inherited from MultiHashHandler.$init
- Defined in src/keyboard/hash_handler.js:26

_addCommandToBinding

_addCommandToBinding(keyId, command, position): void
Parameters
- keyId: string
- command: any
- position: number
Returns void
Inherited from MultiHashHandler._addCommandToBinding
- Defined in src/keyboard/hash_handler.js:116

_buildKeyHash

_buildKeyHash(command): void
Parameters
- command: any
Returns void
Inherited from MultiHashHandler._buildKeyHash
- Defined in src/keyboard/hash_handler.js:187

addCommand

addCommand(command): void
Parameters
- command: Command
Returns void
Inherited from MultiHashHandler.addCommand
- Defined in src/keyboard/hash_handler.js:38

addCommands

addCommands(commands?): void
Parameters
- Optional commands: Command[] | Record<string, CommandLike>
Returns void
Inherited from MultiHashHandler.addCommands
- Defined in src/keyboard/hash_handler.js:147

bindKey

bindKey(key, command, position?): void
Parameters
- key: string | {
      mac?: string;
      position?: number;
      win?: string;
  }
- command: string | CommandLike
- Optional position: number
Returns void
Inherited from MultiHashHandler.bindKey
- Defined in src/keyboard/hash_handler.js:81

bindKeys

bindKeys(keyList): void
Parameters
- keyList: Record<string, CommandLike>
Returns void
Inherited from MultiHashHandler.bindKeys
- Defined in src/keyboard/hash_handler.js:181

canExecute

canExecute(command, editor): boolean
Parameters
- command: string | Command
- editor: Editor
Returns boolean
- Defined in src/commands/command_manager.js:62

exec

exec(command, editor, args): boolean
Parameters
- command: string | string[] | Command
- editor: Editor
- args: any
Returns boolean
- Defined in src/commands/command_manager.js:34

findKeyCommand

findKeyCommand(hashId, keyString): Command
Parameters
- hashId: number
- keyString: string
Returns Command
Inherited from MultiHashHandler.findKeyCommand
- Defined in src/keyboard/hash_handler.js:227

getStatusText

getStatusText(editor?, data?): string
Parameters
- Optional editor: any
- Optional data: any
Returns string
Inherited from MultiHashHandler.getStatusText
- Defined in src/keyboard/hash_handler.js:269

handleKeyboard

handleKeyboard(data, hashId, keyString, keyCode): void | {
command: string;
}
Parameters
- data: {
  $keyChain: string | any[];
  }
  - $keyChain: string | any[]
- hashId: number
- keyString: string
- keyCode: number
Returns void | {
command: string;
}
Inherited from MultiHashHandler.handleKeyboard
- Defined in src/keyboard/hash_handler.js:239

parseKeys

parseKeys(keys): false | {
hashId: number;
key: string;
}
Accepts keys in the form ctrl+Enter or ctrl-Enter keys without modifiers or shift only
Parameters
- keys: string
Returns false | {
hashId: number;
key: string;
}
Inherited from MultiHashHandler.parseKeys
- Defined in src/keyboard/hash_handler.js:197

removeCommand

removeCommand(command, keepCommand?): void
Parameters
- command: string | Command
- Optional keepCommand: boolean
Returns void
Inherited from MultiHashHandler.removeCommand
- Defined in src/keyboard/hash_handler.js:52

removeCommands

removeCommands(commands): void
Parameters
- commands: Record<string, CommandLike>
Returns void
Inherited from MultiHashHandler.removeCommands
- Defined in src/keyboard/hash_handler.js:172

replay

replay(editor): boolean
Parameters
- editor: Editor
Returns boolean
- Defined in src/commands/command_manager.js:112

toggleRecording

toggleRecording(editor): boolean
Parameters
- editor: Editor
Returns boolean
- Defined in src/commands/command_manager.js:83

trimMacro

trimMacro(m): any
Parameters
- m: any
Returns any
- Defined in src/commands/command_manager.js:132

`Static` call

call(thisArg, config, platform): void
Parameters
- thisArg: any
- config: any
- platform: any
Returns void
Inherited from MultiHashHandler.call
- Defined in src/keyboard/hash_handler.js:295

Generated using TypeDoc