Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class EventObj

    Object
       |
       +--EventObj

class EventObj

Defined in obj-events.js
Version: 1.0
Author: mpollack

Field Summary
`array` | `comactiveEventObj` Array of events to fire on comactive
`array` | `coursereadyEventObj` Array of events to fire on courseready
`boolean` | `eventprop` event variable that is as a watchpoint
`array` | `globaltoolsreadyEventObj` Array of events to fire on globaltools
`array` | `glossaryreadyEventObj` Array of events to fire on glossary
`array` | `pagereadyEventObj` Array of events to fire on pageready
`array` | `themereadyEventObj` Array of events to fire on themeready
`array` | `toggleEventObj` Array of events to fire on toggle

Constructor Summary
`EventObj()` Holds all event object references and controllers

Method Summary
`void` | `addEvent(<string> t,<method> e,<string> i)` Adds event to an event array based on type.
`boolean` | `eventWatcher(<string> prop, <string> oldval, <string> newval)` Watches eventprop for change.
`void` | `ieCheck()` Processes watch hack for IE and if change is found calls eventWatcher.
`void` | `ieWatch()` Starts watch hack for IE
`void` | `removeEvent(<string> t,<string> i)` Removes an event from an event array based on type and ID.

Field Detail

### comactiveEventObj

    array comactiveEventObj

Array of events to fire on comactive

### coursereadyEventObj

    array coursereadyEventObj

Array of events to fire on courseready

### eventprop

    boolean eventprop

event variable that is as a watchpoint

### globaltoolsreadyEventObj

    array globaltoolsreadyEventObj

Array of events to fire on globaltools

### glossaryreadyEventObj

    array glossaryreadyEventObj

Array of events to fire on glossary

### pagereadyEventObj

    array pagereadyEventObj

Array of events to fire on pageready

### themereadyEventObj

    array themereadyEventObj

Array of events to fire on themeready

### toggleEventObj

    array toggleEventObj

Array of events to fire on toggle

Constructor Detail

### EventObj

    EventObj()

Holds all event object references and controllers

Version: 1.0
Author: mpollack

Method Detail

### addEvent

    void addEvent(<string> t,<method> e,<string> i)

Adds event to an event array based on type. If not enough data is provided an error is thrown.

Parameters:

`t` - Event type

`e` - Event to execute

`i` - Event identifier

### eventWatcher

    boolean eventWatcher(<string> prop, <string> oldval, <string> newval)

Watches eventprop for change. When eventprop registers a change in value an event array is selected based on the newval property. This event array is then looped through and executed. The eventprop is then reset.

Parameters:

`prop` - Event type

`oldval` - Event identifier

`newval` - Event identifier

Returns:

Always returns false

### ieCheck

    void ieCheck()

Processes watch hack for IE and if change is found calls eventWatcher.

### ieWatch

    void ieWatch()

Starts watch hack for IE

### removeEvent

    void removeEvent(<string> t,<string> i)

Removes an event from an event array based on type and ID. If not enough data is provided an error is thrown.

Parameters:

`t` - Event type

`i` - Event identifier

Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Tue Mar 4 12:01:48 2008