API Docs for: 1.8.0
Show:

photonui.SpriteSheet Class

Extends photonui.Base
Defined in: src/nonvisual/spritesheet.js:43
Module: NonVisual
Parent Module: PhotonUI

Sprite sheet (to use with SpriteIcon).

Constructor

photonui.SpriteSheet

()

Defined in src/nonvisual/spritesheet.js:43

Methods

_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.

addIcon

(
  • iconName
  • x
  • y
)

Defined in src/nonvisual/spritesheet.js:186

Add an icon (set its position).

Parameters:

destroy

()

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

Destroy the class.

getIconCss

(
  • iconName
)
String

Defined in src/nonvisual/spritesheet.js:171

Get the right CSS for the given icon.

Parameters:

Returns:

String:

the CSS.

getIconPosition

(
  • iconName
)
Object

Defined in src/nonvisual/spritesheet.js:160

Get icon position.

Parameters:

Returns:

Object:

{x: Number, y: Number}

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).

removeCallback

(
  • id
)

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

Remove a registered callback.

Parameters:

  • id String
    The id of the callback.

removeIcon

(
  • iconName
)

Defined in src/nonvisual/spritesheet.js:198

Remove an icon.

Parameters:

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).

data

Object

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

Arbitrary data

Default: {}

icons

Object

Defined in src/nonvisual/spritesheet.js:129

Icons.

{
     "iconName": [x, y],
     "icon2": [x2, y2],
     ...
}

Default: : {}

imageUrl

String

Defined in src/nonvisual/spritesheet.js:86

The spritesheet image URL.

Default: null

name

String

Defined in src/nonvisual/spritesheet.js:64

The spritesheet name.

Default: "default"

size

Number

Defined in src/nonvisual/spritesheet.js:112

Icon size (width = height).

Default: 16