Commit Graph

139 Commits

Author SHA1 Message Date
Tim Schaub
f10c90bdba Simpler type for ol.events.Key
Instead of having `ol.events.Key` be a listener object or an array of listener objects, it should be less error prone to have it just be a single listener object.

To avoid using too many functions with multiple return types, the `ol.events.*` functions for registering and unregistering listeners no longer accept an array of event types (and only a single key is returned when registering).

To make it convenient for users to register multiple listeners at once, the `observable.on()` method accepts an array of event types.  Internally in the library, we should use the less risky `ol.events.listen()`.
2016-02-03 11:19:38 +01:00
Tim Schaub
e48ab95735 Use originalEvent instead of browserEvent 2016-02-03 11:19:38 +01:00
Tim Schaub
80df1f5ae8 Move opt_useCapture arg to the end of the list 2016-02-03 11:19:38 +01:00
Andreas Hocevar
7e27ba1d42 Remove goog.fx.Dragger 2016-02-03 11:19:38 +01:00
Andreas Hocevar
3f2d79b7fe Replace goog.events.Event/EventTarget system with our own
This also removes goog.events.listen, goog.events.unlisten,
goog.events.unlistenByKey and goog.events.BrowserEvent.
2016-02-03 11:19:38 +01:00
Nicholas L
db3ad70a3d Remove use of goog.bind and use ES5 .bind 2016-01-15 22:10:55 +13:00
Tim Schaub
13a981c94b Fewer blank lines 2016-01-11 22:03:23 -08:00
Tim Schaub
3cf8618fc7 Prefer single line assignment to 80 character limit 2016-01-11 18:56:08 -08:00
Tim Schaub
59a66c7aaa Remaining valid-jsdoc corrections 2016-01-11 18:56:08 -08:00
Marc Jansen
5502083af9 Remove goog.isNull in mapbrowserevent class 2015-10-01 09:18:53 +02:00
Frederic Junod
496cece074 Remove use of goog.array.forEach 2015-09-29 10:55:17 +02:00
Frederic Junod
e877a21b8e Remove legacy IE support 2015-09-28 15:36:49 +02:00
Tim Schaub
e3951fa3c6 Inline simple goog.isDef() calls 2015-09-27 10:34:44 -06:00
Marc Jansen
96f0374b2f Add basic docs for mapbrowserevent 2015-04-23 20:49:36 +02:00
Tim Schaub
56a942e9cf Stable map browser events 2015-04-02 11:57:43 +02:00
Bart van den Eijnden
47ce127a10 Add assert messages for all assertions up until ol.renderer.vector. 2015-03-30 22:55:23 +02:00
Frederic Junod
e2f8c01c42 Fix jsdoc type for arrays of listening keys 2015-02-26 11:45:15 +01:00
tsauerwein
9a841583db Remove getter for down_ 2015-01-30 09:38:47 +01:00
tsauerwein
f2518e4c08 Add dragging flag to MapBrowserEvent 2015-01-30 09:15:35 +01:00
Frederic Junod
f440de2446 Move touchstart preventDefault to ol.renderer.dom.Map
`preventDefault` is called to prevent the img context menu on mobile devices.
2014-10-23 08:48:22 +02:00
Éric Lemoine
db452759c9 Add @api stable to ol.MapBrowserEvent 2014-08-25 17:36:10 +02:00
Peter Robins
7a5a5d75e7 Improve and standardise event docs 2014-08-18 15:17:02 +00:00
Frederic Junod
b2e345c407 Reuse event pixel to compute the coordinate 2014-07-23 16:53:56 +02:00
Tim Schaub
4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Peter Robins
b4596732e1 Document that panning triggers pointermove on touch 2014-06-30 12:29:36 -04:00
Andreas Hocevar
547334e211 Move oli.* stability notes to the corresponding ol.* symbol 2014-05-22 16:01:35 +02:00
Andreas Hocevar
eb6a938062 Do not document object literals as interfaces
Instead, object literals with properties that should not be
renamed can go in externs/olx.js.
2014-05-22 15:48:47 +02:00
Tim Schaub
cec41c4b0a Add missing requires
Without explicit requires, it is possible that a build would exclude ol.js.
2014-04-30 08:37:52 -06:00
Andreas Hocevar
fbdbbfb7a7 Get rid of stability annotations and document stability with api
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
2014-04-29 09:53:07 -06:00
Andreas Hocevar
c17ac0cae3 Greatly simplify and document the usage of JSDoc
This commit simplifies the exports.js plugin so it only relies
on the stability notes to generate the documentation, which
completely decouples it from the exportable API.

As a rule of thumb, whenever something has an 'api' annotation,
it should also have a 'stability' annotation. A more verbose
documentation of ol3 specific annotation usage is available in
the new 'apidoc/readme.md' file.

This commit also modifies all source files to implement these
usage suggestions.
2014-04-29 09:53:06 -06:00
Tim Schaub
fb497f5288 Annotations for exports 2014-04-29 09:53:05 -06:00
ahocevar
7bfa15c0fd Add click event as responsive alternative to singleclick
The singleclick event makes the application feel slow because
of the 250 ms delay that is used to rule out a dblclick.
2014-03-27 18:33:17 +01:00
Andreas Hocevar
b59fa4e8af Merge pull request #1898 from ahocevar/events
Document events
2014-03-26 14:13:59 +01:00
ahocevar
932cab12af Document stability of MapBrowserEvent properties and events 2014-03-25 22:07:14 +01:00
ahocevar
7e850ca33d Use JSDoc's stock event documentation 2014-03-25 18:21:08 +01:00
ahocevar
fcd737e62b Document MapBrowserEvent events 2014-03-24 21:53:32 +01:00
Tom Payne
35dea5e3a6 Always use === to compare with 0 2014-03-23 18:29:47 +01:00
tsauerwein
155b9b3f86 Add comment about pointercancel listener 2014-03-14 10:16:27 +01:00
tsauerwein
77aa29e6ee Remove blank lines 2014-03-14 10:16:27 +01:00
tsauerwein
52839533e6 Fix typo in POINTERDRAG constant 2014-03-14 10:16:27 +01:00
tsauerwein
6742e6a03a Fix type annotation 2014-03-14 10:16:27 +01:00
tsauerwein
51d7cb2820 Make goog.events.listen return proper listener key
When goog.events.listen receives an array of event types,
it only return null as listener key. So that calling
goog.events.unlistenByKey does not work.
2014-03-14 10:16:26 +01:00
tsauerwein
b17957b543 Fix support for legacy IE 2014-03-14 10:16:26 +01:00
tsauerwein
42f0dfa75a Use goog.dispose 2014-03-14 10:16:26 +01:00
tsauerwein
0d72f4542e Remove old event types
Pointer events for the win.
2014-03-14 10:16:26 +01:00
ahocevar
32ffb1ecae Relay pointermove events again
This will be needed for hover actions.
2014-03-14 10:16:26 +01:00
tsauerwein
fca9c50a3f PointerInteraction uses MapBrowserPointerEvent not MapBrowserEvent 2014-03-14 10:16:26 +01:00
tsauerwein
e0b345b7db add assertion 2014-03-14 10:16:26 +01:00
tsauerwein
692a68644f introduce type POINTERDRAG to make a distinction between pointer move and drag 2014-03-14 10:16:26 +01:00
tsauerwein
b52f79340d use separate pointer event handler for document when dragging 2014-03-14 10:16:26 +01:00