Keyboard | Anywhere Teacher Activity Project Documentation

The Keyboard class creates a functional on-screen keyboard

Hierarchy

Keyboard

Index

Accessors

Methods

Accessors

allowSpaceCharacters

set allowSpaceCharacters(enable: boolean): void

- Defined in src/Keyboard.ts:132
Parameters
- enable: boolean
Returns void

alwaysForceAutoCapitalization

get alwaysForceAutoCapitalization(): boolean

- Defined in src/Keyboard.ts:119
Returns boolean

autoCapitalizeAllWords

get autoCapitalizeAllWords(): boolean

- Defined in src/Keyboard.ts:115
Returns boolean

config

get config(): KeyboardConfig

- Defined in src/Keyboard.ts:37
Returns KeyboardConfig

enableHardKeys

get enableHardKeys(): boolean
set enableHardKeys(enable: boolean): void

- Defined in src/Keyboard.ts:123
Returns boolean
- Defined in src/Keyboard.ts:136
Parameters
- enable: boolean
Returns void

isAutoCapitalizationEnabled

get isAutoCapitalizationEnabled(): boolean

- Defined in src/Keyboard.ts:111
Returns boolean

isKeyboardVisible

get isKeyboardVisible(): boolean

- Defined in src/Keyboard.ts:128
Returns boolean

Static instance

get instance(): Keyboard

- Defined in src/Keyboard.ts:30
Get the one and only keyboard instance. Creates on first access.

Returns Keyboard

Keyboard instance

Methods

add

add(config?: KeyboardConfig): void

- Defined in src/Keyboard.ts:68
Add/set the keyboard configuration/layout

Parameters
- Default value config: KeyboardConfig = KeyboardConfig.Alphabet
  
  Keyboard configuration to use.
Returns void

enableAutoCapitalization

enableAutoCapitalization(enable: boolean, allWords: boolean, alwaysForce: boolean): void

- Defined in src/Keyboard.ts:107
Parameters
- enable: boolean
- allWords: boolean
- alwaysForce: boolean
Returns void

forceHide

forceHide(animate?: boolean, onComplete?: Function): void

- Defined in src/Keyboard.ts:140
Parameters
- Default value animate: boolean = true
- Default value onComplete: Function = null
Returns void

giveFocus

giveFocus(text: Text, maxChars: number, onEnter?: Function, onTab?: Function, onKey?: Function): void

- Defined in src/Keyboard.ts:148
Parameters
- text: Text
- maxChars: number
- Default value onEnter: Function = null
- Default value onTab: Function = null
- Default value onKey: Function = null
Returns void

hasFocus

hasFocus(): boolean

- Defined in src/Keyboard.ts:156
Returns boolean

remove

remove(): void

- Defined in src/Keyboard.ts:100
Returns void

removeFocus

removeFocus(): void

- Defined in src/Keyboard.ts:152
Returns void

setFocusOnText

setFocusOnText(text: Text, maxChars: number, onEnter?: Function, onTab?: Function, onKey?: Function): void

- Defined in src/Keyboard.ts:144
Parameters
- text: Text
- maxChars: number
- Default value onEnter: Function = null
- Default value onTab: Function = null
- Default value onKey: Function = null
Returns void