Skip to content

@jtopo/core / Keyboard

Class: Keyboard

键盘抽象

示例:

js

// 所有快捷键只有当前画布的canvas成为页面焦点时才有效

// 绑定快捷键
let keyboard = stage.keyboard;

keyboard.bindKey('Shift+a', ()=> { 
   console.log('shift+a');  
});

// 解绑
keyboard.unbind('Shift+a');

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Keyboard(stage)

Parameters

NameType
stageStage

Overrides

EventTarget.constructor

Properties

disabled

Readonly disabled: boolean = false

是否禁用

Methods

addEventListener

addEventListener(type, callback): void

增加事件监听

Parameters

NameTypeDescription
typeKeyboardEventType事件类型
callback(e: KeyboardEvent) => void

Returns

void

Overrides

EventTarget.addEventListener


bindKey

bindKey(keyInfo, fn): void

绑定按键

Parameters

NameTypeDescription
keyInfostring例如"Control+a" 、"Meta+a"、 ”G" 、”Shift+1“
fnFunction-

Returns

void


disable

disable(): void

禁用jtopo的快捷键

Returns

void


dispatchEvent

dispatchEvent(event): void

分发事件

Parameters

NameType
eventEvent | EventBase

Returns

void

Inherited from

EventTarget.dispatchEvent


enable

enable(): void

启用jtopo默认的快捷键

Returns

void


getKeyBinding

getKeyBinding(keyInfo): Function

获取按键绑定的函数

Parameters

NameType
keyInfostring

Returns

Function


hasListener

hasListener(type): boolean

是否有该类型的监听

Parameters

NameType
typeKeyboardEventType

Returns

boolean

Overrides

EventTarget.hasListener


isAltDown

isAltDown(): boolean

Returns

boolean


isControlDown

isControlDown(): boolean

Returns

boolean


isKeyRegistered

isKeyRegistered(keyInfo): boolean

判断按键是否已经注册

Parameters

NameType
keyInfostring

Returns

boolean


isKeydown

isKeydown(keyInfo): boolean

指定的单个键是否按下

Parameters

NameType
keyInfostring

Returns

boolean


isMetaDown

isMetaDown(): boolean

Returns

boolean


isShiftDown

isShiftDown(): boolean

Returns

boolean


removeEventListener

removeEventListener(type, callback): any

移除一个事件监听

Parameters

NameType
typeKeyboardEventType
callback(e: KeyboardEvent) => void

Returns

any

Overrides

EventTarget.removeEventListener


unbind

unbind(keyInfo): void

解绑按键

Parameters

NameTypeDescription
keyInfostring例如"Control+a" 、"Meta+a"、 ”G" 、”Shift+1“

Returns

void