FocusManagerPlugin

Defined in: plugins/focus/FocusManagerPlugin.ts:276

Extends

• Plugin<Application, FocusManagerPluginOptions>

Implements

• IFocusManagerPlugin

Constructors

new FocusManagerPlugin()

new FocusManagerPlugin(id): FocusManagerPlugin

Defined in: plugins/Plugin.ts:48

Parameters

id

string = 'Plugin'

Returns

FocusManagerPlugin

Inherited from

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:39

Inherited from

Plugin.__dill_pixel_method_binding_root

---

id

readonly id: string = 'focus'

Defined in: plugins/focus/FocusManagerPlugin.ts:277

Implementation of

IFocusManagerPlugin.id

Overrides

Plugin.id

---

onFocusChange

onFocusChange: Signal<(detail) => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:285

Implementation of

IFocusManagerPlugin.onFocusChange

---

onFocusLayerChange

onFocusLayerChange: Signal<(currentLayerId) => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:282

Implementation of

IFocusManagerPlugin.onFocusLayerChange

---

onFocusManagerActivated

onFocusManagerActivated: Signal<() => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:280

Implementation of

IFocusManagerPlugin.onFocusManagerActivated

---

onFocusManagerDeactivated

onFocusManagerDeactivated: Signal<() => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:281

Implementation of

IFocusManagerPlugin.onFocusManagerDeactivated

---

view

readonly view: Container<ContainerChild>

Defined in: plugins/focus/FocusManagerPlugin.ts:278

Implementation of

IFocusManagerPlugin.view

Accessors

active

Get Signature

get active(): boolean

Defined in: plugins/focus/FocusManagerPlugin.ts:311

Returns

boolean

Implementation of

IFocusManagerPlugin.active

---

app

Get Signature

get app(): A

Defined in: plugins/Plugin.ts:53

Returns

A

Implementation of

IFocusManagerPlugin.app

Inherited from

Plugin.app

---

currentLayer

Get Signature

get currentLayer(): undefined | IFocusLayer

Defined in: plugins/focus/FocusManagerPlugin.ts:302

Returns

undefined | IFocusLayer

Implementation of

IFocusManagerPlugin.currentLayer

---

currentLayerId

Get Signature

get currentLayerId(): null | string | number

Defined in: plugins/focus/FocusManagerPlugin.ts:298

Returns

null | string | number

Implementation of

IFocusManagerPlugin.currentLayerId

---

enabled

Get Signature

get enabled(): boolean

Defined in: plugins/focus/FocusManagerPlugin.ts:317

Returns

boolean

Set Signature

set enabled(value): void

Defined in: plugins/focus/FocusManagerPlugin.ts:321

Parameters

value

boolean

Returns

void

Implementation of

IFocusManagerPlugin.enabled

---

layerCount

Get Signature

get layerCount(): number

Defined in: plugins/focus/FocusManagerPlugin.ts:325

Returns

number

Implementation of

IFocusManagerPlugin.layerCount

---

layers

Get Signature

get layers(): Map<string | number, IFocusLayer>

Defined in: plugins/focus/FocusManagerPlugin.ts:292

Returns

Map<string | number, IFocusLayer>

Implementation of

IFocusManagerPlugin.layers

---

options

Get Signature

get options(): O

Defined in: plugins/Plugin.ts:44

Returns

O

Implementation of

IFocusManagerPlugin.options

Inherited from

Plugin.options

Methods

_onKeyDown()

_onKeyDown(e): void

Defined in: plugins/focus/FocusManagerPlugin.ts:512

Parameters

e

KeyboardEvent

Returns

void

---

_onKeyUp()

_onKeyUp(e): void

Defined in: plugins/focus/FocusManagerPlugin.ts:545

Parameters

e

any

Returns

void

---

_onMouseMove()

_onMouseMove(e): void

Defined in: plugins/focus/FocusManagerPlugin.ts:560

Parameters

e

MouseEvent

Returns

void

---

add()

add(focusable, layerId?, isDefault?): void

Defined in: plugins/focus/FocusManagerPlugin.ts:366

Parameters

focusable

IFocusable | IFocusable[]

layerId?

string | number

isDefault?

boolean = false

Returns

void

Implementation of

IFocusManagerPlugin.add

---

addFocusable()

addFocusable(focusable, layerId?, isDefault?): void

Defined in: plugins/focus/FocusManagerPlugin.ts:370

Parameters

focusable

IFocusable | IFocusable[]

layerId?

null | string | number

isDefault?

boolean = false

Returns

void

Implementation of

IFocusManagerPlugin.addFocusable

---

addFocusLayer()

addFocusLayer(layerId?, setAsCurrent?, focusables?): IFocusLayer

Defined in: plugins/focus/FocusManagerPlugin.ts:424

Parameters

layerId?

string | number

setAsCurrent?

boolean = true

focusables?

IFocusable | IFocusable[]

Returns

IFocusLayer

Implementation of

IFocusManagerPlugin.addFocusLayer

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:79

Add signal connections to the container.

Parameters

args

…SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

IFocusManagerPlugin.addSignalConnection

Inherited from

Plugin.addSignalConnection

---

clearFocus()

clearFocus(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:503

Returns

void

Implementation of

IFocusManagerPlugin.clearFocus

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:85

Returns

void

Implementation of

IFocusManagerPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections

---

deactivate()

deactivate(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:360

Returns

void

Implementation of

IFocusManagerPlugin.deactivate

---

destroy()

destroy(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:352

Returns

void

Implementation of

IFocusManagerPlugin.destroy

Overrides

Plugin.destroy

---

focus()

focus(focusable): void

Defined in: plugins/focus/FocusManagerPlugin.ts:479

Parameters

focusable

IFocusable

Returns

void

Implementation of

IFocusManagerPlugin.focus

---

forceFocus()

forceFocus(focusable): void

Defined in: plugins/focus/FocusManagerPlugin.ts:471

Parameters

focusable

IFocusable

Returns

void

Implementation of

IFocusManagerPlugin.forceFocus

---

initialize()

initialize(_options, app): void

Defined in: plugins/focus/FocusManagerPlugin.ts:333

Parameters

_options

Partial<FocusManagerPluginOptions>

app

IApplication

Returns

void

Implementation of

IFocusManagerPlugin.initialize

Overrides

Plugin.initialize

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/focus/FocusManagerPlugin.ts:501

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IFocusManagerPlugin.postInitialize

Overrides

Plugin.postInitialize

---

remove()

remove(focusable): void

Defined in: plugins/focus/FocusManagerPlugin.ts:395

Parameters

focusable

IFocusable | IFocusable[]

Returns

void

Implementation of

IFocusManagerPlugin.remove

---

removeAllFocusLayers()

removeAllFocusLayers(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:507

Returns

void

Implementation of

IFocusManagerPlugin.removeAllFocusLayers

---

removeFocusable()

removeFocusable(focusable): void

Defined in: plugins/focus/FocusManagerPlugin.ts:399

Parameters

focusable

IFocusable | IFocusable[]

Returns

void

Implementation of

IFocusManagerPlugin.removeFocusable

---

removeFocusLayer()

removeFocusLayer(layerId?, removeTopLayerIfUndefined?): void

Defined in: plugins/focus/FocusManagerPlugin.ts:450

Parameters

layerId?

string | number

removeTopLayerIfUndefined?

boolean = true

Returns

void

Implementation of

IFocusManagerPlugin.removeFocusLayer

---

restart()

restart(reverse): void

Defined in: plugins/focus/FocusManagerPlugin.ts:462

Parameters

reverse

boolean = false

Returns

void

Implementation of

IFocusManagerPlugin.restart

---

setFocus()

setFocus(focusable): void

Defined in: plugins/focus/FocusManagerPlugin.ts:475

Parameters

focusable

IFocusable

Returns

void

Implementation of

IFocusManagerPlugin.setFocus

---

setFocusLayer()

setFocusLayer(layerId): void

Defined in: plugins/focus/FocusManagerPlugin.ts:483

Parameters

layerId

string | number

Returns

void

Implementation of

IFocusManagerPlugin.setFocusLayer

---

setLayerOrder()

setLayerOrder(layerIds): void

Defined in: plugins/focus/FocusManagerPlugin.ts:413

Parameters

layerIds

(string | number)[]

Returns

void

Implementation of

IFocusManagerPlugin.setLayerOrder

---

sortFocusablesByPosition()

sortFocusablesByPosition(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:329

Returns

void

Implementation of

IFocusManagerPlugin.sortFocusablesByPosition