API Docs for: 1.8.0
Show:

photonui.AccelManager Class

Extends photonui.Base
Defined in: src/nonvisual/accelmanager.js:42
Module: NonVisual
Parent Module: PhotonUI

Manage keyboard accelerators.

Constructor

photonui.AccelManager

()

Defined in src/nonvisual/accelmanager.js:42

Methods

__onAccel

(
  • keys
  • event
)
private

Defined in src/nonvisual/accelmanager.js:160

Parameters:

_bindEvent

(
  • id
  • element
  • evName
  • callback
  • [options]
)
private

Inherited from photonui.Base: src/base.js:229

Javascript event binding (for internal use).

Parameters:

  • id String
    An unique id for the event.
  • element DOMElement
    The element on which the event will be bind.
  • evName String
    The event name (e.g. "mousemove", "click",...).
  • callback Function
    The function that will be called when the event occured.
  • [options] Object optional
    options for addEventListener

_callCallbacks

(
  • wEvent
  • params
)
private

Inherited from photonui.Base: src/base.js:292

Call all callbacks for the given wEvent. NOTE: the first argument passed to the callback is the current widget. NOTE²: if the thisArg of the callback is null, this will be binded to the current widget.

Parameters:

  • wEvent String
    The widget event.
  • params Array
    Parametters that will be sent to the callbacks.

_registerWEvents

(
  • wEvents
)
private

Inherited from photonui.Base: src/base.js:276

Register available wEvent.

Parameters:

_unbindEvent

(
  • id
)
private

Inherited from photonui.Base: src/base.js:257

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_updateProperties

(
  • properties
)
deprecated private

Inherited from photonui.Base: src/base.js:209

Force the update of the given properties. This method is deprecated. One should use '@photonui-update' abitbol's annotation on concerned properties.

Parameters:

  • properties Array
    The properties to update.

addAccel

(
  • id
  • keys
  • callback
  • safe
)

Defined in src/nonvisual/accelmanager.js:103

Add an accelerator.

Parameters:

destroy

()

Inherited from photonui.Base: src/base.js:157

Destroy the class.

registerCallback

(
  • id
  • wEvent
  • callback
  • thisArg
)

Inherited from photonui.Base: src/base.js:169

Register a callback for any PhotonUI/Widget event (called wEvent). Callback signature: function (Object(Base/Widget) [, arg1 [, arg2 [, ...]]])

Parameters:

  • id String
    An unique id for the callback.
  • wEvent String
    the PhotonUI/Widget event name.
  • callback Function
    The callback function.
  • thisArg Object
    The value of this (optionnal, default = current widget).

removeAccel

(
  • id
)

Defined in src/nonvisual/accelmanager.js:128

Remove an accelerator.

Parameters:

  • id String

    the accelerator id.

removeCallback

(
  • id
)

Inherited from photonui.Base: src/base.js:193

Remove a registered callback.

Parameters:

  • id String
    The id of the callback.

Properties

__callbacks

Object private

Inherited from photonui.Base: src/base.js:142

Object containing references to registered callbacks.

__events

Object private

Inherited from photonui.Base: src/base.js:132

Object containing references javascript events binding (for widget internal use).

__kbd

Object private

Defined in src/nonvisual/accelmanager.js:79

Keyboard bindings.

{
    "id": {
        safe: Boolean,
        callback: Function,
        binding: Object
    },
    ...
}

__keys

Object private

Defined in src/nonvisual/accelmanager.js:65

Registered keys.

{
    "key": [ "id", "id", ... ]
    ...
}

data

Object

Inherited from photonui.Base: src/base.js:113

Arbitrary data

Default: {}