Namespace SS.events
SS.events
Defined in: SS.events.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Provides a uniformed cross browser way to implement event triggered functions.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
SS.events.add(y, f)
Attaches a function to a browser based event.
|
| <static> |
SS.events.called(r, e, y)
Function to fire the appropriate listening functions in the event context.
|
| <static> |
SS.events.dze(dz)
Drop Zone Event.
|
| <static> |
SS.events.dzr(dz)
Drop Zone Register.
|
| <static> |
SS.events.remove(y, f)
Remove function from listener.
|
| <static> |
SS.events.removeById(id)
Remove function by Id from listener
|
Namespace Detail
SS.events
Provides a uniformed cross browser way to implement event triggered functions.
Method Detail
<static>
{function}
SS.events.add(y, f)
Attaches a function to a browser based event. e.g. window, document, document.body ...
- Parameters:
- {String} y
- Event Type. Name of the event to attach to e.g. onresize, onscroll, onmousemove...
- f
- Returns:
- {function} Reference to the added event. See SS.events.removeById to use this reference to remove the event.
<static>
SS.events.called(r, e, y)
Function to fire the appropriate listening functions in the event context.
- Parameters:
- {Object} r
- Control reference. Object that triggered the event.
- {Event} e
- Event
- {String} y
- Event Type Name
- Returns:
- null
<static>
SS.events.dze(dz)
Drop Zone Event. Called when there is an event that the drop zone
control may be interested in
- Parameters:
- {Event} dz
- Event that has been triggered.
- Returns:
- null
<static>
SS.events.dzr(dz)
Drop Zone Register. Registers a drop zone control into the events model to receive alerts when an object is
drag over the specified element
- Parameters:
- {SS.control.dropzone} dz
- Control reference. Object that triggered the event.
- Returns:
- null
<static>
SS.events.remove(y, f)
Remove function from listener.
- Parameters:
- {String} y
- Event Type. Name of the event which the function is currently attached to. e.g. onresize, onscroll, onmousemove...
- {Function} f
- Function to be removed. If this function hasn't been assigned to the event lister then it cannot be removed.
- Returns:
- null
<static>
SS.events.removeById(id)
Remove function by Id from listener
- Parameters:
- {String} id
- Id of the event function that is to be removed, as returned by SS.events.add
- Returns:
- null