FocusManagerPlugin
Defined in: plugins/focus/FocusManagerPlugin.ts:275
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FocusManagerPlugin(
id):FocusManagerPlugin
Defined in: plugins/Plugin.ts:48
Parameters
Section titled “Parameters”string = 'Plugin'
Returns
Section titled “Returns”FocusManagerPlugin
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”__dill_pixel_method_binding_root
Section titled “__dill_pixel_method_binding_root”__dill_pixel_method_binding_root:
boolean
Defined in: plugins/Plugin.ts:39
Inherited from
Section titled “Inherited from”Plugin.__dill_pixel_method_binding_root
readonlyid:string='focus'
Defined in: plugins/focus/FocusManagerPlugin.ts:276
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”onFocusChange
Section titled “onFocusChange”onFocusChange:
Signal<(detail) =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:284
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.onFocusChange
onFocusLayerChange
Section titled “onFocusLayerChange”onFocusLayerChange:
Signal<(currentLayerId) =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:281
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.onFocusLayerChange
onFocusManagerActivated
Section titled “onFocusManagerActivated”onFocusManagerActivated:
Signal<() =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:279
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.onFocusManagerActivated
onFocusManagerDeactivated
Section titled “onFocusManagerDeactivated”onFocusManagerDeactivated:
Signal<() =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:280
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.onFocusManagerDeactivated
readonlyview:Container<ContainerChild>
Defined in: plugins/focus/FocusManagerPlugin.ts:277
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”active
Section titled “active”Get Signature
Section titled “Get Signature”get active():
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:310
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get app():
A
Defined in: plugins/Plugin.ts:53
Returns
Section titled “Returns”A
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”currentLayer
Section titled “currentLayer”Get Signature
Section titled “Get Signature”get currentLayer():
undefined|IFocusLayer
Defined in: plugins/focus/FocusManagerPlugin.ts:301
Returns
Section titled “Returns”undefined | IFocusLayer
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.currentLayer
currentLayerId
Section titled “currentLayerId”Get Signature
Section titled “Get Signature”get currentLayerId():
null|string|number
Defined in: plugins/focus/FocusManagerPlugin.ts:297
Returns
Section titled “Returns”null | string | number
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.currentLayerId
enabled
Section titled “enabled”Get Signature
Section titled “Get Signature”get enabled():
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:316
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set enabled(
value):void
Defined in: plugins/focus/FocusManagerPlugin.ts:320
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”layerCount
Section titled “layerCount”Get Signature
Section titled “Get Signature”get layerCount():
number
Defined in: plugins/focus/FocusManagerPlugin.ts:324
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.layerCount
layers
Section titled “layers”Get Signature
Section titled “Get Signature”get layers():
Map<string|number,IFocusLayer>
Defined in: plugins/focus/FocusManagerPlugin.ts:291
Returns
Section titled “Returns”Map<string | number, IFocusLayer>
Implementation of
Section titled “Implementation of”options
Section titled “options”Get Signature
Section titled “Get Signature”get options():
O
Defined in: plugins/Plugin.ts:44
Returns
Section titled “Returns”O
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”_onKeyDown()
Section titled “_onKeyDown()”_onKeyDown(
e):void
Defined in: plugins/focus/FocusManagerPlugin.ts:511
Parameters
Section titled “Parameters”KeyboardEvent
Returns
Section titled “Returns”void
_onKeyUp()
Section titled “_onKeyUp()”_onKeyUp(
e):void
Defined in: plugins/focus/FocusManagerPlugin.ts:544
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
_onMouseMove()
Section titled “_onMouseMove()”_onMouseMove(
e):void
Defined in: plugins/focus/FocusManagerPlugin.ts:559
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
add(
focusable,layerId?,isDefault?):void
Defined in: plugins/focus/FocusManagerPlugin.ts:365
Parameters
Section titled “Parameters”focusable
Section titled “focusable”IFocusable | IFocusable[]
layerId?
Section titled “layerId?”string | number
isDefault?
Section titled “isDefault?”boolean = false
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”addFocusable()
Section titled “addFocusable()”addFocusable(
focusable,layerId?,isDefault?):void
Defined in: plugins/focus/FocusManagerPlugin.ts:369
Parameters
Section titled “Parameters”focusable
Section titled “focusable”IFocusable | IFocusable[]
layerId?
Section titled “layerId?”null | string | number
isDefault?
Section titled “isDefault?”boolean = false
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.addFocusable
addFocusLayer()
Section titled “addFocusLayer()”addFocusLayer(
layerId?,setAsCurrent?,focusables?):IFocusLayer
Defined in: plugins/focus/FocusManagerPlugin.ts:423
Parameters
Section titled “Parameters”layerId?
Section titled “layerId?”string | number
setAsCurrent?
Section titled “setAsCurrent?”boolean = true
focusables?
Section titled “focusables?”IFocusable | IFocusable[]
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”IFocusManagerPlugin.addFocusLayer
addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:79
Add signal connections to the container.
Parameters
Section titled “Parameters”…SignalConnection[]
The signal connections to add.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.addSignalConnection
Inherited from
Section titled “Inherited from”clearFocus()
Section titled “clearFocus()”clearFocus():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:502
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.clearFocus
clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:85
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.clearSignalConnections
Inherited from
Section titled “Inherited from”deactivate()
Section titled “deactivate()”deactivate():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:359
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.deactivate
destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:351
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”focus()
Section titled “focus()”focus(
focusable):void
Defined in: plugins/focus/FocusManagerPlugin.ts:478
Parameters
Section titled “Parameters”focusable
Section titled “focusable”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”forceFocus()
Section titled “forceFocus()”forceFocus(
focusable):void
Defined in: plugins/focus/FocusManagerPlugin.ts:470
Parameters
Section titled “Parameters”focusable
Section titled “focusable”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.forceFocus
initialize()
Section titled “initialize()”initialize(
_options,app):void
Defined in: plugins/focus/FocusManagerPlugin.ts:332
Parameters
Section titled “Parameters”_options
Section titled “_options”Partial<FocusManagerPluginOptions>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.initialize
Overrides
Section titled “Overrides”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/focus/FocusManagerPlugin.ts:500
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.postInitialize
Overrides
Section titled “Overrides”remove()
Section titled “remove()”remove(
focusable):void
Defined in: plugins/focus/FocusManagerPlugin.ts:394
Parameters
Section titled “Parameters”focusable
Section titled “focusable”IFocusable | IFocusable[]
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”removeAllFocusLayers()
Section titled “removeAllFocusLayers()”removeAllFocusLayers():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:506
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.removeAllFocusLayers
removeFocusable()
Section titled “removeFocusable()”removeFocusable(
focusable):void
Defined in: plugins/focus/FocusManagerPlugin.ts:398
Parameters
Section titled “Parameters”focusable
Section titled “focusable”IFocusable | IFocusable[]
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.removeFocusable
removeFocusLayer()
Section titled “removeFocusLayer()”removeFocusLayer(
layerId?,removeTopLayerIfUndefined?):void
Defined in: plugins/focus/FocusManagerPlugin.ts:449
Parameters
Section titled “Parameters”layerId?
Section titled “layerId?”string | number
removeTopLayerIfUndefined?
Section titled “removeTopLayerIfUndefined?”boolean = true
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.removeFocusLayer
restart()
Section titled “restart()”restart(
reverse):void
Defined in: plugins/focus/FocusManagerPlugin.ts:461
Parameters
Section titled “Parameters”reverse
Section titled “reverse”boolean = false
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”setFocus()
Section titled “setFocus()”setFocus(
focusable):void
Defined in: plugins/focus/FocusManagerPlugin.ts:474
Parameters
Section titled “Parameters”focusable
Section titled “focusable”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”setFocusLayer()
Section titled “setFocusLayer()”setFocusLayer(
layerId):void
Defined in: plugins/focus/FocusManagerPlugin.ts:482
Parameters
Section titled “Parameters”layerId
Section titled “layerId”string | number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.setFocusLayer
setLayerOrder()
Section titled “setLayerOrder()”setLayerOrder(
layerIds):void
Defined in: plugins/focus/FocusManagerPlugin.ts:412
Parameters
Section titled “Parameters”layerIds
Section titled “layerIds”(string | number)[]
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IFocusManagerPlugin.setLayerOrder
sortFocusablesByPosition()
Section titled “sortFocusablesByPosition()”sortFocusablesByPosition():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:328
Returns
Section titled “Returns”void