next-core-object

Augmented.js Next Core - Object and Events

API

Table of Contents

• AugmentedObject
  • Parameters
  • initialize
    • Parameters
  • options
  • events
  • trigger
    • Parameters
  • once
    • Parameters
  • off
    • Parameters
  • stopListening
    • Parameters
  • on
    • Parameters
  • listenTo
    • Parameters
  • listenToOnce
    • Parameters
• Configuration
  • Properties
• EVENT_SPLITTER
• eventsApi
  • Parameters
• internalOn
  • Parameters
• onApi
  • Parameters
• offApi
  • Parameters
• triggerApi
  • Parameters
• triggerEvents
  • Parameters

AugmentedObject

Augmented Object Base class for other classes to extend from
Supported options:

• events - Event object

Parameters

• options object Object options

initialize

Initialize the object

Parameters

• args ...any

Returns object Returns this context

Meta

• deprecated: Use the Constructor

options

The passed options

events

The Events

trigger

Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

Parameters

• name string The name of the event
• args any any number of additional arguments

Returns object Returns this context

once

Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

Parameters

• name string The name of the event
• callback function The callback to evoke
• context object The context of the callback

Returns object Returns this context

off

Remove one or many callbacks. If context is null, removes all callbacks with that function. If callback is null, removes all callbacks for the event. If name is null, removes all bound callbacks for all events.

Parameters

• name string The name of the event
• callback function The callback to evoke
• context object The context of the callback

Returns object Returns this context

stopListening

Tell this object to stop listening to either specific events ... or to every object it's currently listening to.

Parameters

• obj object The object to stop listening to
• name string The name of the event
• callback function The callback to evoke

Returns object Returns this context

on

Bind an event to a callback function. Passing "all" will bind the callback to all events fired.

Parameters

• name string The name of the event
• callback function The callback to evoke
• context object The context of the callback

Returns object Returns this context

listenTo

Inversion-of-control versions of on. Tell this object to listen to an event in another object... keeping track of what it's listening to for easier unbinding later.

Parameters

• obj object The object to listening to
• name string The name of the event
• callback function The callback to evoke

Returns object Returns this context

listenToOnce

Inversion-of-control versions of once.

Parameters

• obj object The object to stop listening to
• name string The name of the event
• callback function The callback to evoke

Returns object Returns this context

Configuration

A set of configuration properties for the framework

Properties

• LoggerLevel string The level of the framework internal logger
• MessageBundle string the base name for messages in the framework (default: Messages)
• AsynchronousQueueTimeout number the default milisecond timeout (default: 2000)
• ApplicationInitProcessTimeout number the application init even timeout (default: 1000)

EVENT_SPLITTER

Regular expression used to split event strings.

eventsApi

Iterates over the standard event, callback (as well as the fancy multiple space-separated events "change blur", callback and jQuery-style event maps {event: callback}).

Parameters

• iteratee function Function to iterate
• events object Event object
• name (string | object) Name of event or events
• callback function The function to call
• opts any Any other params

internalOn

Guard the listening argument from the public API.

Parameters

• obj object Object with events
• name (string | object) Name of event or events
• callback function The function to call
• context object The context of 'this'
• listening array Array of listeners

onApi

The reducing API that adds a callback to the events object.

Parameters

• events object Event object
• name (string | object) Name of event or events
• callback function The function to call
• options object Any options

offApi

The reducing API that removes a callback from the events object.

Parameters

• events object Event object
• name (string | object) Name of event or events
• callback function The function to call
• options object Any options

triggerApi

Handles triggering the appropriate event callbacks.

Parameters

• objEvents object Event object
• name (string | object) Name of event or events
• callback function The function to call
• args any Any other arguments

triggerEvents

Internal dispatch function for triggering events.

Parameters

• events array The events
• args any Any otehr arguments