Skip to content

IFocusManagerPlugin

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

Extends

Properties

active

readonly active: boolean

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


app

app: IApplication

Defined in: plugins/Plugin.ts:10

Inherited from

IPlugin.app


currentLayer

readonly currentLayer: undefined | IFocusLayer

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


currentLayerId

readonly currentLayerId: null | string | number

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


enabled

enabled: boolean

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


id

id: string

Defined in: plugins/Plugin.ts:8

Inherited from

IPlugin.id


layerCount

readonly layerCount: number

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


layers

readonly layers: Map<string | number, IFocusLayer>

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


onFocusChange

onFocusChange: Signal<(detail) => void>

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


onFocusLayerChange

onFocusLayerChange: Signal<(currentLayerId) => void>

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


onFocusManagerActivated

onFocusManagerActivated: Signal<() => void>

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


onFocusManagerDeactivated

onFocusManagerDeactivated: Signal<() => void>

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


options

readonly options: Partial<any>

Defined in: plugins/Plugin.ts:12

Inherited from

IPlugin.options


view

readonly view: Container

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

Methods

add()

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

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

Parameters

focusable

IFocusable | IFocusable[]

layerId?

string | number

isDefault?

boolean

Returns

void


addFocusable()

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

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

Parameters

focusable

IFocusable | IFocusable[]

layerId?

string | number

isDefault?

boolean

Returns

void


addFocusLayer()

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

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

Parameters

layerId?

string | number

setAsCurrent?

boolean

focusables?

IFocusable | IFocusable[]

Returns

IFocusLayer


addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:20

Parameters

args

SignalConnection[]

Returns

void

Inherited from

IPlugin.addSignalConnection


clearFocus()

clearFocus(): void

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

Returns

void


clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:22

Returns

void

Inherited from

IPlugin.clearSignalConnections


deactivate()

deactivate(): void

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

Returns

void


destroy()

destroy(): void

Defined in: plugins/Plugin.ts:18

Returns

void

Inherited from

IPlugin.destroy


focus()

focus(focusable): void

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

Parameters

focusable

IFocusable

Returns

void


forceFocus()

forceFocus(focusable): void

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

Parameters

focusable

IFocusable

Returns

void


initialize()

initialize(options, app): void | Promise<void>

Defined in: plugins/Plugin.ts:14

Parameters

options

Partial<any>

app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.initialize


postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:16

Parameters

_app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.postInitialize


registerCoreFunctions()

registerCoreFunctions(): void

Defined in: plugins/Plugin.ts:24

Returns

void

Inherited from

IPlugin.registerCoreFunctions


registerCoreSignals()

registerCoreSignals(): void

Defined in: plugins/Plugin.ts:26

Returns

void

Inherited from

IPlugin.registerCoreSignals


remove()

remove(focusable): void

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

Parameters

focusable

IFocusable | IFocusable[]

Returns

void


removeAllFocusLayers()

removeAllFocusLayers(): void

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

Returns

void


removeFocusable()

removeFocusable(focusable): void

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

Parameters

focusable

IFocusable | IFocusable[]

Returns

void


removeFocusLayer()

removeFocusLayer(layerId?): void

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

Parameters

layerId?

string | number

Returns

void


restart()

restart(): void

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

Returns

void


setFocus()

setFocus(focusable): void

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

Parameters

focusable

IFocusable

Returns

void


setFocusLayer()

setFocusLayer(layerId): void

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

Parameters

layerId

string | number

Returns

void


setLayerOrder()

setLayerOrder(layerIds): void

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

Parameters

layerIds

(string | number)[]

Returns

void


sortFocusablesByPosition()

sortFocusablesByPosition(): void

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

Returns

void