Class CommandManager

命令管理器

Export

Date

2022.6.6

Author

lyx

Hierarchy

EngineObject
- CommandManager

Index

Constructors

Properties

Accessors

Methods

addEventListener clear dispatchEvent dispose do redo removeAllEventListeners removeEventListener removeEventListenerByEventId undo

Constructors

constructor

new CommandManager(engine): CommandManager
Parameters
- engine: Engine
Returns CommandManager

Overrides EngineObject.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from EngineObject.engine

Methods

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from EngineObject.addEventListener

clear

clear(): void
清空命令

Returns void

Memberof
CommandManager

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
CommandManager

Overrides EngineObject.dispose

do

do(cmd): void
执行命令
Parameters
- cmd: Command | CommandGroup
Returns void

Memberof
CommandManager

redo

redo(): void
重做一个命令

Returns void

Memberof
CommandManager

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListenerByEventId

undo

undo(): void
撤销一个命令

Returns void

Memberof
CommandManager