Stable object methods and events

This commit is contained in:
Tim Schaub
2015-04-02 12:12:36 +02:00
parent 11ac778b29
commit 89dc3a254b
+10 -9
View File
@@ -47,7 +47,7 @@ ol.ObjectEvent = function(type, key, oldValue) {
/** /**
* The name of the property whose value is changing. * The name of the property whose value is changing.
* @type {string} * @type {string}
* @api * @api stable
*/ */
this.key = key; this.key = key;
@@ -55,7 +55,7 @@ ol.ObjectEvent = function(type, key, oldValue) {
* The old value. To get the new value use `e.target.get(e.key)` where * The old value. To get the new value use `e.target.get(e.key)` where
* `e` is the event object. * `e` is the event object.
* @type {*} * @type {*}
* @api * @api stable
*/ */
this.oldValue = oldValue; this.oldValue = oldValue;
@@ -352,7 +352,7 @@ ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
* Gets a value. * Gets a value.
* @param {string} key Key name. * @param {string} key Key name.
* @return {*} Value. * @return {*} Value.
* @api * @api stable
*/ */
ol.Object.prototype.get = function(key) { ol.Object.prototype.get = function(key) {
var value; var value;
@@ -371,7 +371,7 @@ ol.Object.prototype.get = function(key) {
/** /**
* Get a list of object property names. * Get a list of object property names.
* @return {Array.<string>} List of property names. * @return {Array.<string>} List of property names.
* @api * @api stable
*/ */
ol.Object.prototype.getKeys = function() { ol.Object.prototype.getKeys = function() {
var accessors = this.accessors_; var accessors = this.accessors_;
@@ -403,7 +403,7 @@ ol.Object.prototype.getKeys = function() {
/** /**
* Get an object of all property names and values. * Get an object of all property names and values.
* @return {Object.<string, *>} Object. * @return {Object.<string, *>} Object.
* @api * @api stable
*/ */
ol.Object.prototype.getProperties = function() { ol.Object.prototype.getProperties = function() {
var properties = {}; var properties = {};
@@ -435,7 +435,7 @@ ol.Object.prototype.notify = function(key, oldValue) {
* Sets a value. * Sets a value.
* @param {string} key Key name. * @param {string} key Key name.
* @param {*} value Value. * @param {*} value Value.
* @api * @api stable
*/ */
ol.Object.prototype.set = function(key, value) { ol.Object.prototype.set = function(key, value) {
var accessors = this.accessors_; var accessors = this.accessors_;
@@ -452,9 +452,10 @@ ol.Object.prototype.set = function(key, value) {
/** /**
* Sets a collection of key-value pairs. * Sets a collection of key-value pairs. Note that this changes any existing
* properties and adds new ones (it does not remove any existing properties).
* @param {Object.<string, *>} values Values. * @param {Object.<string, *>} values Values.
* @api * @api stable
*/ */
ol.Object.prototype.setProperties = function(values) { ol.Object.prototype.setProperties = function(values) {
var key; var key;
@@ -497,7 +498,7 @@ ol.Object.prototype.unbindAll = function() {
/** /**
* Unsets a property. * Unsets a property.
* @param {string} key Key name. * @param {string} key Key name.
* @api * @api stable
*/ */
ol.Object.prototype.unset = function(key) { ol.Object.prototype.unset = function(key) {
if (key in this.values_) { if (key in this.values_) {