Options
All
  • Public
  • Public/Protected
  • All
Menu

ResourceManager manages async loading and caching of resources.

ResourceManager Basically, it maintains a map of fileNames to URI for the resource. When a request for resource fileName is received, the uri is looked up and the file is either async loaded or served from cache. This also manages a ready state with callbacks that tells when one or more resources are being loaded and when all resources are ready.

Hierarchy

Index

Constructors

constructor

Properties

Private images

images: object

Type declaration

  • [key: string]: HTMLImageElement

Private packs

packs: IPack[]

ready

ready: boolean = true

Private uris

uris: object

Type declaration

  • [key: string]: string

Private waitCount

waitCount: number = 0

Private waitImages

waitImages: object

Type declaration

  • [key: string]: HTMLImageElement

Static prefixed

prefixed: string | boolean

Methods

Private _getUri

  • _getUri(fileName: string): string

Private _loadEnd

  • _loadEnd(): void

Private _loadStart

  • _loadStart(): void

addListener

  • addListener(event: string | symbol, fn: ListenerFn, context?: any): this
  • Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns this

clear

  • clear(keys?: string[]): void
  • Clears state, uri mappings and caches. Browser caches still apply.

    Parameters

    • Default value keys: string[] = null

      the keys which should be cleared. Default clears everything.

    Returns void

emit

  • emit(event: string | symbol, ...args: Array<any>): boolean
  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol
    • Rest ...args: Array<any>

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<string | symbol>

get

  • get(key: string): object
  • Returns the attributes for this ResourceManager

    Parameters

    • key: string

      the name of the attribute. Only "uris" is acceptable.

    Returns object

    • [key: string]: string

getImage

  • getImage(fileName: string, success: function, error?: function): void
  • Loads an Image resource.

    Parameters

    • fileName: string

      fileName of the image to be returned

    • success: function

      handler that'll be called on success

        • (image: HTMLImageElement): void
        • Parameters

          • image: HTMLImageElement

          Returns void

    • Optional error: function

      handler that'll be called on error

        • (): void
        • Returns void

    Returns void

Protected listenTo

  • listenTo(emitter: EventEmitter, event: string, callback: function): void
  • Add a listener to another EventEmitter.

    This provides an event subscription list facility. Allowing subclasses to listen to other emitters and remove all or some listeners with a single call to Model.stopListening, later.

    Parameters

    • emitter: EventEmitter

      the event emitter to listen to

    • event: string

      the name of the event to listen to

    • callback: function

      the callback for the event handler

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

listenerCount

  • listenerCount(event: string | symbol): number
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Array<ListenerFn>
  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

    Returns Array<ListenerFn>

off

  • off(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): this
  • Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on(event: string | symbol, fn: ListenerFn, context?: any): this
  • Add a listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns this

once

  • once(event: string | symbol, fn: ListenerFn, context?: any): this
  • Add a one-time listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns this

registerUri

  • registerUri(fileName: string | any, uri?: string): void
  • Register a filename and a URI in the resource manager.

    Parameters

    • fileName: string | any

      name of the file or map of filename: uri.

    • Optional uri: string

      uri when string fileName is specified

    Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): this
  • Remove the listeners of a given event.

    Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns this

set

  • set(key: string | any, value: any, options?: any): boolean
  • Safely set an attribute(s).

    If the attribute set succeeds, a change:[attribute name] event is fired. change:[attribute name] event handler receives this object, the new value and options as arguments.

    Additionally a change event is also fired when all changes succeed. The change event receives this object and the options as arguments.

    Parameters

    • key: string | any

      the name of the attribute or map of values

    • value: any

      the new value of the attribute

    • Optional options: any

      this object is sent down to the event handlers, useful to things down to your handler. if options.silent is true then events are not fired.

    Returns boolean

Protected setAttribute

  • setAttribute(key: string, value: any, options: any): boolean

Protected stopListening

  • stopListening(emitter?: EventEmitter, event?: string, callback?: function): void
  • Removes to one or more listeners that were set earlier with calls to Model.listenTo.

    Use the arguments to filter subscriptions. eg: model.stopListening(em) will remove all listeners on emitter em. model.stopListening(em, 'change') will remove all listeners for change event on emitter em.

    Parameters

    • Optional emitter: EventEmitter

      the event emitter on which the listener was set

    • Optional event: string

      the event to be removed

    • Optional callback: function

      the callback to be removed

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

toJSON

  • toJSON(): object