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
Tim Schaub
fb497f5288
Annotations for exports
2014-04-29 09:53:05 -06:00
Tom Payne
7db06b61de
Fix location of call to goog.getUid, thanks @elemoine
2014-03-27 22:22:54 +01:00
Tom Payne
4e93fe2fbd
Call goog.getUid in ol.Object constructor
2014-03-27 19:01:29 +01:00
ahocevar
a3b5376520
Add missing event documentation and stability tags
2014-03-26 14:04:58 +01:00
ahocevar
3227ce4a06
Document ol.ObjectEvent events
2014-03-25 18:24:57 +01:00
Tom Payne
271487c1bc
Remove leading whitespace
2014-03-12 19:52:13 +01:00
Tim Schaub
6344b8e06c
Make setValues consistent with repeated calls to set
2014-02-19 10:17:39 -07:00
Tom Payne
2b42e89580
Add stability annotation to ol.Object#getProperties
2014-02-03 14:44:59 +01:00
Tom Payne
ce3209a439
Improve type checking in ol.Object#bindTo
2014-01-30 11:20:59 +01:00
Tom Payne
37351c530c
Convert ol.ObjectEvent#getKey method into key property
2014-01-27 15:53:58 +01:00
Tom Payne
d63fec80d1
Use goog.object.get to suppress compiler warning about use of [] with struct
2013-12-13 20:36:32 +01:00
Tom Payne
6e3bcc7478
Make ol.Object#listeners_ a private renameable property
2013-12-13 20:35:27 +01:00
Tom Payne
b48fd51561
Make ol.Object#accessors_ a private renameable property
2013-12-13 20:34:56 +01:00
Tim Schaub
20d74810ab
Export a getKey method on ol.ObjectEvent
2013-12-12 16:59:34 -07:00
Tim Schaub
69385f4ff0
More consistent event types
2013-12-11 16:54:01 -07:00
Tim Schaub
625007f364
Make enum property name like its value
...
Where an enum value is used as an event type, it should be alllowercase (to follow DOM events). Property names should be ALLUPPERCASE in this case (just as camelCase and PascalCase are converted to CONSTANT_CASE).
2013-12-11 16:54:01 -07:00
Tim Schaub
c8985b9906
Using unique event type values for distinct events
...
Any event target can be used to dispatch generic goog.events.Event instances with an arbitrary type. In cases where we dispatch custom events, we should not use type values that collide with those used for generic events (at least internally). This allows listeners a better chance of knowing what kind of argument they will receive.
As subsequent change will clean up the enumeration and add a bit more consistency.
2013-12-11 16:53:52 -07:00
Tim Schaub
153cb307e0
Handle beforechange events for bound properties
2013-12-11 11:25:51 -07:00
Tim Schaub
9d3a4e3c6c
Add beforechange event type and provide key with change events
...
If you know ahead of time that you only want to listen for changes for a specific property, the foo:change type events can be useful. If you want to listen for changes on all properties, the change event becomes more useful if it provides information on what changed. And the beforechange event allows listeners to access values before they change.
2013-12-11 11:25:50 -07:00
Tim Schaub
162b245d7c
ol.Object extends ol.Observable
2013-12-05 12:28:33 -07:00
Tom Payne
f795adcd56
Add ol.Object#getProperties
2013-12-04 19:19:51 +01:00
Frederic Junod
6e88d3ba3c
Minor apidoc updates
2013-11-21 10:52:00 +01:00
Frederic Junod
c18b2706fb
Notify target object after transform functions change
2013-11-13 16:13:08 +01:00
Frederic Junod
03cc533cb3
Getter and setter support for bindTo
2013-11-13 16:13:08 +01:00
Frederic Junod
01cc19af80
More precise {function} jsdoc definition
2013-11-07 16:03:19 +01:00
Tom Payne
60245a57d8
Make ol.Object#getKeys about 10x faster
2013-11-04 18:18:31 +01:00
Paul Spencer
bada596b45
Add default stability level to docs of exported things.
2013-10-24 18:20:24 -04:00
Éric Lemoine
8301b01395
Remove ol.Object#bindTo noNotify option
2013-09-13 16:46:49 +02:00
Tom Payne
b6319c9a68
Use goog.events.Key
2013-07-22 17:42:47 +02:00
Frederic Junod
a965d9ee9f
Remove unused ol.Object#setOptions function
2013-07-17 13:50:43 +02:00
Bart van den Eijnden
8dc97790bc
Add more content for the API doc
...
Involves additions to (there will be subsequent pull requests for other
classes):
- ol.Attribution
- ol.Collection
- ol.Expression
- ol.Feature
- ol.Geolocation
- ol.Map
- ol.Object
- ol.Overlay
- ol.Projection
- ol.View2D
- ol.control.Attribution
- ol.control.Control
- ol.control.FullScreen
- ol.control.Logo
- ol.control.MousePosition
- ol.control.ScaleLine
- ol.control.Zoom
- ol.control.ZoomSlider
- ol.dom.Input
- ol.filter.Filter
- ol.filter.Geometry
- ol.filter.Logical
2013-06-11 20:56:04 +02:00
Frederic Junod
984002a7ec
Change ol.Object event name syntax
...
'changed' to 'change' and '<attribute>_changed' to 'change:<attribute>'.
2013-05-31 12:38:37 +02:00
Tim Schaub
ffe9105891
Rename onOnce to once (see #678 )
2013-04-30 14:58:39 -06:00
Frederic Junod
6366bd05b3
ol.Object.{on|onOnce|un} type can also be an array of string
2013-04-30 15:03:52 +02:00
Tom Payne
e8109919e9
Add ol.Object#onOnce
2013-04-25 19:41:03 +02:00
Tom Payne
09fe09e42b
Add ol.Object#unByKey
2013-04-25 19:41:03 +02:00
Tom Payne
fa2582a2f1
Return listener key from ol.Object#on
2013-04-25 19:41:02 +02:00
Frederic Junod
e3bec11d2e
Remove unused ol.Object.prototype.changed
2013-04-23 11:06:42 +02:00
Éric Lemoine
ce0836e403
Add on and un methods to ol.Object
2013-03-31 14:14:19 +02:00
Tim Schaub
2919906ba6
Add method for getting keys
2013-02-19 14:47:49 -07:00
Tim Schaub
d6ff58305d
Using a dedicated object for value storage
...
Without this, we are limited in the key names that we can accept from users. And because of compiler renaming, we don't know ahead of time what the limitations are (e.g. the key 'a' may clobber the 'set' method).
2013-02-19 14:35:11 -07:00
Tim Schaub
052e995f2e
Key in obj check not appropriate for user supplied keys
2013-02-19 14:19:40 -07:00
Tim Schaub
6cfc36d8cc
Using hasOwnProperty is better for user keys on objects we control
2013-02-19 14:17:58 -07:00
Tim Schaub
b9507de3ea
Removing unnecessary overhead
2013-02-19 14:14:36 -07:00
Tom Payne
21331d1065
Dispatch generic changed events when any ol.Object property changes
2013-01-08 17:26:22 +01:00
Tim Schaub
c3a41c967e
Removing file overviews for now.
2012-09-24 16:58:55 +02:00
Tom Payne
f8c31ba45c
s/ol3/ol/
2012-09-24 14:21:41 +02:00
