File: EventDispatcher.html

package info (click to toggle)
three.js 111%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,184 kB
  • sloc: javascript: 133,174; makefile: 24; sh: 1
file content (102 lines) | stat: -rw-r--r-- 2,161 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="list.js"></script>
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		<h1>[name]</h1>

		<p class="desc">
			JavaScript events for custom objects.<br />
			[link:https://github.com/mrdoob/eventdispatcher.js Eventdispatcher on GitHub]
		</p>

		<h2>Example</h2>

		<code>
// Adding events to a custom object

var Car = function () {

    this.start = function () {

        this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );

    };

};

// Mixing the EventDispatcher.prototype with the custom object prototype

Object.assign( Car.prototype, EventDispatcher.prototype );

// Using events with the custom object

var car = new Car();

car.addEventListener( 'start', function ( event ) {

    alert( event.message );

} );

car.start();
		</code>

		<h2>Constructor</h2>

		<h3>[name]()</h3>
		<p>
		Creates EventDispatcher object.
		</p>


		<h2>Methods</h2>

		<h3>[method:null addEventListener]( [param:String type], [param:Function listener] )</h3>
		<p>
		type - The type of event to listen to.<br />
		listener - The function that gets called when the event is fired.
		</p>
		<p>
		Adds a listener to an event type.
		</p>

		<h3>[method:Boolean hasEventListener]( [param:String type], [param:Function listener] )</h3>
		<p>
		type - The type of event to listen to.<br />
		listener - The function that gets called when the event is fired.
		</p>
		<p>
		Checks if listener is added to an event type.
		</p>

		<h3>[method:null removeEventListener]( [param:String type], [param:Function listener] )</h3>
		<p>
		type - The type of the listener that gets removed.<br />
		listener - The listener function that gets removed.
		</p>
		<p>
		Removes a listener from an event type.
		</p>

		<h3>[method:null dispatchEvent]( [param:object event] )</h3>
		<p>
		event - The event that gets fired.
		</p>
		<p>
		Fire an event type.
		</p>


		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>