Class ShortCut

初始化快捷键模块

var shortcuts:Array = [ //
//在按下key1时触发命令command1
{key: "key1", command: "command1", when: ""}, //
//在按下key1时触发状态命令改变stateCommand1为激活状态
{key: "key1", stateCommand: "stateCommand1", when: "state1"}, //
//处于state1状态时按下key1触发命令command1
{key: "key1", command: "command1", when: "state1"}, //
//处于state1状态不处于state2时按下key1与没按下key2触发command1与command2，改变stateCommand1为激活状态，stateCommand2为非激活状态
{key: "key1+ ! key2", command: "command1,command2", stateCommand: "stateCommand1,!stateCommand2", when: "state1+!state2"}, //
];
//添加快捷键
shortCut.addShortCuts(shortcuts);
//监听命令
Event.on(shortCut,"run" as any, function(e:Event):void
{
trace("接受到命令：" + e.type);
});

Hierarchy

EventEmitter
- ShortCut

Constructors

constructor

new ShortCut(): ShortCut
初始化快捷键模块

Returns ShortCut
Overrides EventEmitter.constructor
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:56

Properties

captureDic

captureDic: {
[capture: string]: ShortCutCapture;
}

捕获字典

Type declaration

[capture: string]: ShortCutCapture

enable

enable: boolean

启动

`Private` getShortcutUniqueKey

getShortcutUniqueKey: any

获取快捷键唯一字符串

keyCapture

keyCapture: KeyCapture

按键捕获

keyState

keyState: KeyState

按键状态

stateDic

stateDic: {
[state: string]: boolean;
}

状态字典

Type declaration

[state: string]: boolean

Methods

activityState

activityState(state): void
激活状态
Parameters
- state: string
  
  状态名称
Returns void
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:85

addShortCuts

addShortCuts(shortcuts): void
添加快捷键
Parameters
- shortcuts: {
      command?: string;
      key: string;
      stateCommand?: string;
      when?: string;
  }[]
  
  快捷键列表
Returns void
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:61

broadcast

broadcast<K>(type, data?): IEvent<any>
将事件广播到下级对象中。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
返回广播后的事件。
Inherited from EventEmitter.broadcast
- Defined in packages/event/src/EventEmitter.ts:176

bubbles

bubbles<K>(type, data?): IEvent<any>
将事件冒泡到上级对象中。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
返回冒泡后的事件。
Inherited from EventEmitter.bubbles
- Defined in packages/event/src/EventEmitter.ts:189

deactivityState

deactivityState(state): void
取消激活状态
Parameters
- state: string
  
  状态名称
Returns void
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:90

dispose

dispose(): void
销毁

Returns void
Inherited from EventEmitter.dispose
- Defined in packages/event/src/EventEmitter.ts:535

emit

emit<K>(type, data?, bubbles?, broadcast?, share?): IEvent<any>
发射事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<any>
返回发射后的事件。
Inherited from EventEmitter.emit
- Defined in packages/event/src/EventEmitter.ts:145

emitEvent

emitEvent<K>(event): IEvent<any>
发射事件。

当事件重复流向一个对象时将不会被处理。
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件对象
Returns IEvent<any>
返回事件是否被处理
Inherited from EventEmitter.emitEvent
- Defined in packages/event/src/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends string
Returns K[]
Inherited from EventEmitter.eventNames
- Defined in packages/event/src/EventEmitter.ts:70

getState

getState(state): boolean
获取状态
Parameters
- state: string
  
  状态名称
Returns boolean
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:95

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event): void
向下级广播事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from EventEmitter.handelEventBroadcast
- Defined in packages/event/src/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event): void
向上级报告事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from EventEmitter.handelEventBubbles
- Defined in packages/event/src/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event): void
向平级分享事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from EventEmitter.handelEventShare
- Defined in packages/event/src/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e): void
处理事件
Type Parameters
- K extends string
Parameters
- e: IEvent<any>
  
  事件
Returns void
Inherited from EventEmitter.handleEvent
- Defined in packages/event/src/EventEmitter.ts:389

has

has<K>(type): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns boolean
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
Inherited from EventEmitter.has
- Defined in packages/event/src/EventEmitter.ts:200

listenerCount

listenerCount<K>(type): number
返回指定事件类型的监听数量。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns number
Inherited from EventEmitter.listenerCount
- Defined in packages/event/src/EventEmitter.ts:82

off

off<K>(type?, listener?, thisObject?): ShortCut
移除监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns ShortCut
Inherited from EventEmitter.off
- Defined in packages/event/src/EventEmitter.ts:253

offAll

offAll<K>(type?): ShortCut
移除所有监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns ShortCut
Inherited from EventEmitter.offAll
- Defined in packages/event/src/EventEmitter.ts:303

offAny

offAny<K>(listener?, thisObject?): ShortCut
移除监听对象的任意事件。
Type Parameters
- K extends string
Parameters
- Optional listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns ShortCut
Inherited from EventEmitter.offAny
- Defined in packages/event/src/EventEmitter.ts:353

on

on<K>(type, listener, thisObject?, priority?, once?): ShortCut
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns ShortCut
Inherited from EventEmitter.on
- Defined in packages/event/src/EventEmitter.ts:214

onAny

onAny<K>(listener, thisObject?, priority?, once?): ShortCut
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends string
Parameters
- listener: ((event) => void)
  
  处理事件的监听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns ShortCut
Inherited from EventEmitter.onAny
- Defined in packages/event/src/EventEmitter.ts:318

once

once<K>(type, listener, thisObject?, priority?): ShortCut
监听一次事件后将会被移除
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event) => void)
  
  处理事件的侦听器函数。
  - - (event): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns ShortCut
Inherited from EventEmitter.once
- Defined in packages/event/src/EventEmitter.ts:95

removeAllShortCuts

removeAllShortCuts(): void
移除所有快捷键

Returns void
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:80

removeShortCuts

removeShortCuts(shortcuts): void
删除快捷键
Parameters
- shortcuts: {
      command?: string;
      key: string;
      stateCommand?: string;
      when?: string;
  }[]
  
  快捷键列表
Returns void
- Defined in node_modules/@feng3d/shortcut/lib/ShortCut.d.ts:71

`Static` getEventEmitter

getEventEmitter(target): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
Inherited from EventEmitter.getEventEmitter
- Defined in packages/event/src/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
Inherited from EventEmitter.getOrCreateEventEmitter
- Defined in packages/event/src/EventEmitter.ts:44

Class ShortCut

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ShortCut

Properties

captureDic

Type declaration

[capture: string]: ShortCutCapture

enable

Private getShortcutUniqueKey

keyCapture

keyState

stateDic

Type declaration

[state: string]: boolean

Methods

activityState

Parameters

state: string

Returns void

addShortCuts

Parameters

shortcuts: { command?: string; key: string; stateCommand?: string; when?: string; }[]

Returns void

broadcast

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

bubbles

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

deactivityState

Parameters

state: string

Returns void

dispose

Returns void

emit

Type Parameters

K extends string

Parameters

type: K

Optional data: any

bubbles: boolean = false

broadcast: boolean = false

share: boolean = true

Returns IEvent<any>

emitEvent

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns IEvent<any>

eventNames

Type Parameters

K extends string

Returns K[]

getState

Parameters

state: string

Returns boolean

Protected handelEventBroadcast

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

Protected handelEventBubbles

`Private` getShortcutUniqueKey

shortcuts: {
command?: string;
key: string;
stateCommand?: string;
when?: string;
}[]

`Optional` data: any

`Optional` data: any

`Optional` data: any

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent

`Optional` type: K

`Optional` listener: ((event) => void)

`Optional` thisObject: any

`Optional` type: K

`Optional` listener: ((event) => void)

`Optional` thisObject: any

`Optional` thisObject: any