<!DOCTYPE html>
|
<html>
|
<head>
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<title>The source code</title>
|
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
|
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
|
<style type="text/css">
|
.highlight { display: block; background-color: #ddd; }
|
</style>
|
<script type="text/javascript">
|
function highlight() {
|
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
|
}
|
</script>
|
</head>
|
<body onload="prettyPrint(); highlight();">
|
<pre class="prettyprint lang-js"><span id='Ext-util-HashMap'>/**
|
</span> * Represents a collection of a set of key and value pairs. Each key in the HashMap
|
* must be unique, the same key cannot exist twice. Access to items is provided via
|
* the key only. Sample usage:
|
*
|
* var map = new Ext.util.HashMap();
|
* map.add('key1', 1);
|
* map.add('key2', 2);
|
* map.add('key3', 3);
|
*
|
* map.each(function(key, value, length){
|
* console.log(key, value, length);
|
* });
|
*
|
* The HashMap is an unordered class,
|
* there is no guarantee when iterating over the items that they will be in any particular
|
* order. If this is required, then use a {@link Ext.util.MixedCollection}.
|
*/
|
Ext.define('Ext.util.HashMap', {
|
mixins: {
|
observable: 'Ext.util.Observable'
|
},
|
|
<span id='Ext-util-HashMap-property-generation'> /**
|
</span> * @private Mutation counter which is incremented upon add and remove.
|
*/
|
generation: 0,
|
|
<span id='Ext-util-HashMap-cfg-keyFn'> /**
|
</span> * @cfg {Function} keyFn A function that is used to retrieve a default key for a passed object.
|
* A default is provided that returns the `id` property on the object. This function is only used
|
* if the `add` method is called with a single argument.
|
*/
|
|
<span id='Ext-util-HashMap-method-constructor'> /**
|
</span> * Creates new HashMap.
|
* @param {Object} config (optional) Config object.
|
*/
|
constructor: function(config) {
|
config = config || {};
|
|
var me = this,
|
keyFn = config.keyFn;
|
|
me.initialConfig = config;
|
me.addEvents(
|
<span id='Ext-util-HashMap-event-add'> /**
|
</span> * @event add
|
* Fires when a new item is added to the hash.
|
* @param {Ext.util.HashMap} this
|
* @param {String} key The key of the added item.
|
* @param {Object} value The value of the added item.
|
*/
|
'add',
|
<span id='Ext-util-HashMap-event-clear'> /**
|
</span> * @event clear
|
* Fires when the hash is cleared.
|
* @param {Ext.util.HashMap} this
|
*/
|
'clear',
|
<span id='Ext-util-HashMap-event-remove'> /**
|
</span> * @event remove
|
* Fires when an item is removed from the hash.
|
* @param {Ext.util.HashMap} this
|
* @param {String} key The key of the removed item.
|
* @param {Object} value The value of the removed item.
|
*/
|
'remove',
|
<span id='Ext-util-HashMap-event-replace'> /**
|
</span> * @event replace
|
* Fires when an item is replaced in the hash.
|
* @param {Ext.util.HashMap} this
|
* @param {String} key The key of the replaced item.
|
* @param {Object} value The new value for the item.
|
* @param {Object} old The old value for the item.
|
*/
|
'replace'
|
);
|
|
me.mixins.observable.constructor.call(me, config);
|
me.clear(true);
|
|
if (keyFn) {
|
me.getKey = keyFn;
|
}
|
},
|
|
<span id='Ext-util-HashMap-method-getCount'> /**
|
</span> * Gets the number of items in the hash.
|
* @return {Number} The number of items in the hash.
|
*/
|
getCount: function() {
|
return this.length;
|
},
|
|
<span id='Ext-util-HashMap-method-getData'> /**
|
</span> * Implementation for being able to extract the key from an object if only
|
* a single argument is passed.
|
* @private
|
* @param {String} key The key
|
* @param {Object} value The value
|
* @return {Array} [key, value]
|
*/
|
getData: function(key, value) {
|
// if we have no value, it means we need to get the key from the object
|
if (value === undefined) {
|
value = key;
|
key = this.getKey(value);
|
}
|
|
return [key, value];
|
},
|
|
<span id='Ext-util-HashMap-method-getKey'> /**
|
</span> * Extracts the key from an object. This is a default implementation, it may be overridden
|
* @param {Object} o The object to get the key from
|
* @return {String} The key to use.
|
*/
|
getKey: function(o) {
|
return o.id;
|
},
|
|
<span id='Ext-util-HashMap-method-add'> /**
|
</span> * Adds an item to the collection. Fires the {@link #event-add} event when complete.
|
*
|
* @param {String/Object} key The key to associate with the item, or the new item.
|
*
|
* If a {@link #getKey} implementation was specified for this HashMap,
|
* or if the key of the stored items is in a property called `id`,
|
* the HashMap will be able to *derive* the key for the new item.
|
* In this case just pass the new item in this parameter.
|
*
|
* @param {Object} [o] The item to add.
|
*
|
* @return {Object} The item added.
|
*/
|
add: function(key, value) {
|
var me = this;
|
|
// Need to check arguments length here, since we could have called:
|
// map.add('foo', undefined);
|
if (arguments.length === 1) {
|
value = key;
|
key = me.getKey(value);
|
}
|
|
if (me.containsKey(key)) {
|
return me.replace(key, value);
|
}
|
|
me.map[key] = value;
|
++me.length;
|
me.generation++;
|
if (me.hasListeners.add) {
|
me.fireEvent('add', me, key, value);
|
}
|
return value;
|
},
|
|
<span id='Ext-util-HashMap-method-replace'> /**
|
</span> * Replaces an item in the hash. If the key doesn't exist, the
|
* {@link #method-add} method will be used.
|
* @param {String} key The key of the item.
|
* @param {Object} value The new value for the item.
|
* @return {Object} The new value of the item.
|
*/
|
replace: function(key, value) {
|
var me = this,
|
map = me.map,
|
old;
|
|
// Need to check arguments length here, since we could have called:
|
// map.replace('foo', undefined);
|
if (arguments.length === 1) {
|
value = key;
|
key = me.getKey(value);
|
}
|
|
if (!me.containsKey(key)) {
|
me.add(key, value);
|
}
|
old = map[key];
|
map[key] = value;
|
me.generation++;
|
if (me.hasListeners.replace) {
|
me.fireEvent('replace', me, key, value, old);
|
}
|
return value;
|
},
|
|
<span id='Ext-util-HashMap-method-remove'> /**
|
</span> * Remove an item from the hash.
|
* @param {Object} o The value of the item to remove.
|
* @return {Boolean} True if the item was successfully removed.
|
*/
|
remove: function(o) {
|
var key = this.findKey(o);
|
if (key !== undefined) {
|
return this.removeAtKey(key);
|
}
|
return false;
|
},
|
|
<span id='Ext-util-HashMap-method-removeAtKey'> /**
|
</span> * Remove an item from the hash.
|
* @param {String} key The key to remove.
|
* @return {Boolean} True if the item was successfully removed.
|
*/
|
removeAtKey: function(key) {
|
var me = this,
|
value;
|
|
if (me.containsKey(key)) {
|
value = me.map[key];
|
delete me.map[key];
|
--me.length;
|
me.generation++;
|
if (me.hasListeners.remove) {
|
me.fireEvent('remove', me, key, value);
|
}
|
return true;
|
}
|
return false;
|
},
|
|
<span id='Ext-util-HashMap-method-get'> /**
|
</span> * Retrieves an item with a particular key.
|
* @param {String} key The key to lookup.
|
* @return {Object} The value at that key. If it doesn't exist, `undefined` is returned.
|
*/
|
get: function(key) {
|
var map = this.map;
|
return map.hasOwnProperty(key) ? map[key] : undefined;
|
},
|
|
<span id='Ext-util-HashMap-method-clear'> /**
|
</span> * Removes all items from the hash.
|
* @return {Ext.util.HashMap} this
|
*/
|
clear: function(/* private */ initial) {
|
var me = this;
|
|
// Only clear if it has ever had any content
|
if (initial || me.generation) {
|
me.map = {};
|
me.length = 0;
|
me.generation = initial ? 0 : me.generation + 1;
|
}
|
if (initial !== true && me.hasListeners.clear) {
|
me.fireEvent('clear', me);
|
}
|
return me;
|
},
|
|
<span id='Ext-util-HashMap-method-containsKey'> /**
|
</span> * Checks whether a key exists in the hash.
|
* @param {String} key The key to check for.
|
* @return {Boolean} True if they key exists in the hash.
|
*/
|
containsKey: function(key) {
|
var map = this.map;
|
return map.hasOwnProperty(key) && map[key] !== undefined;
|
},
|
|
<span id='Ext-util-HashMap-method-contains'> /**
|
</span> * Checks whether a value exists in the hash.
|
* @param {Object} value The value to check for.
|
* @return {Boolean} True if the value exists in the dictionary.
|
*/
|
contains: function(value) {
|
return this.containsKey(this.findKey(value));
|
},
|
|
<span id='Ext-util-HashMap-method-getKeys'> /**
|
</span> * Return all of the keys in the hash.
|
* @return {Array} An array of keys.
|
*/
|
getKeys: function() {
|
return this.getArray(true);
|
},
|
|
<span id='Ext-util-HashMap-method-getValues'> /**
|
</span> * Return all of the values in the hash.
|
* @return {Array} An array of values.
|
*/
|
getValues: function() {
|
return this.getArray(false);
|
},
|
|
<span id='Ext-util-HashMap-method-getArray'> /**
|
</span> * Gets either the keys/values in an array from the hash.
|
* @private
|
* @param {Boolean} isKey True to extract the keys, otherwise, the value
|
* @return {Array} An array of either keys/values from the hash.
|
*/
|
getArray: function(isKey) {
|
var arr = [],
|
key,
|
map = this.map;
|
for (key in map) {
|
if (map.hasOwnProperty(key)) {
|
arr.push(isKey ? key: map[key]);
|
}
|
}
|
return arr;
|
},
|
|
<span id='Ext-util-HashMap-method-each'> /**
|
</span> * Executes the specified function once for each item in the hash.
|
* Returning false from the function will cease iteration.
|
*
|
* @param {Function} fn The function to execute.
|
* @param {String} fn.key The key of the item.
|
* @param {Number} fn.value The value of the item.
|
* @param {Number} fn.length The total number of items in the hash.
|
* @param {Object} [scope] The scope to execute in. Defaults to <tt>this</tt>.
|
* @return {Ext.util.HashMap} this
|
*/
|
each: function(fn, scope) {
|
// copy items so they may be removed during iteration.
|
var items = Ext.apply({}, this.map),
|
key,
|
length = this.length;
|
|
scope = scope || this;
|
for (key in items) {
|
if (items.hasOwnProperty(key)) {
|
if (fn.call(scope, key, items[key], length) === false) {
|
break;
|
}
|
}
|
}
|
return this;
|
},
|
|
<span id='Ext-util-HashMap-method-clone'> /**
|
</span> * Performs a shallow copy on this hash.
|
* @return {Ext.util.HashMap} The new hash object.
|
*/
|
clone: function() {
|
var hash = new this.self(this.initialConfig),
|
map = this.map,
|
key;
|
|
hash.suspendEvents();
|
for (key in map) {
|
if (map.hasOwnProperty(key)) {
|
hash.add(key, map[key]);
|
}
|
}
|
hash.resumeEvents();
|
return hash;
|
},
|
|
<span id='Ext-util-HashMap-method-findKey'> /**
|
</span> * @private
|
* Find the key for a value.
|
* @param {Object} value The value to find.
|
* @return {Object} The value of the item. Returns <tt>undefined</tt> if not found.
|
*/
|
findKey: function(value) {
|
var key,
|
map = this.map;
|
|
for (key in map) {
|
if (map.hasOwnProperty(key) && map[key] === value) {
|
return key;
|
}
|
}
|
return undefined;
|
}
|
});
|
</pre>
|
</body>
|
</html>
|