Sencha Documentation

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 Ext.util.MixedCollection.

Config Options

 
keyFn : Function
A function that is used to retrieve a default key for a passed object. A default is provided that returns the id prop...
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.
 
listeners : Object
A config object containing one or more event handlers to be added to this object during initialization. This should ...

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.


DOM events from ExtJs Components


While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Methods

 
( String eventName, Function handler, [Object scope] ) : Void
Removes an event handler (shorthand for removeListener.)
Removes an event handler (shorthand for removeListener.)

Parameters

  • eventName : String
    The type of event the handler was associated with.
  • handler : Function
    The handler to remove. This must be a reference to the function passed into the addListener call.
  • scope : Object
    (optional) The scope originally specified for the handler.

Returns

  • Void
 
add( String key, Object value ) : Object
Add a new item to the hash. An exception will be thrown if the key already exists.
Add a new item to the hash. An exception will be thrown if the key already exists.

Parameters

  • key : String
    The key of the new item.
  • value : Object
    The value of the new item.

Returns

  • Object   The value of the new item added.
 
addEvents( Object|String o, string Optional. ) : Void
Adds the specified events to the list of events which this Observable may fire.
Adds the specified events to the list of events which this Observable may fire.

Parameters

  • o : Object|String
    Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.
  • Optional. : string
    Event name if multiple event names are being passed as separate parameters. Usage:
    this.addEvents('storeloaded', 'storecleared');

Returns

  • Void
 
addListener( String eventName, Function handler, [Object scope], [Object options] ) : Void
Appends an event handler to this object.
Appends an event handler to this object.

Parameters

  • eventName : String
    The name of the event to listen for. May also be an object who's property names are event names. See
  • handler : Function
    The method the event invokes.
  • scope : Object
    (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
  • options : Object
    (optional) An object containing handler configuration. properties. This may contain any of the following properties:
    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
    • element : String
      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener


    Combining Options
    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
    });

    Attaching multiple handlers in 1 call
    The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

    myGridPanel.on({
        cellClick: this.onCellClick,
        mouseover: this.onMouseOver,
        mouseout: this.onMouseOut,
        scope: this // Important. Ensure "this" is correct during handler execution
    });
    .

Returns

  • Void
 
addManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope, Object opt ) : Void
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed...

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

  • item : Observable|Element
    The item to which to add a listener/listeners.
  • ename : Object|String
    The event name, or an object containing event name properties.
  • fn : Function
    Optional. If the ename parameter was an event name, this is the handler function.
  • scope : Object
    Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.
  • opt : Object
    Optional. If the ename parameter was an event name, this is the addListener options.

Returns

  • Void
 
capture( Observable o, Function fn, [Object scope] ) : Void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

  • o : Observable
    The Observable to capture events from.
  • fn : Function
    The function to call when an event is fired.
  • scope : Object
    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

  • Void
 
clear : Ext.util.HashMap
Removes all items from the hash.
Removes all items from the hash.
 
Removes all listeners for this object including the managed listeners
Removes all listeners for this object including the managed listeners
 
Removes all managed listeners for this object.
Removes all managed listeners for this object.
 
clone : Ext.util.HashMap
Performs a shallow copy on this hash.
Performs a shallow copy on this hash.
 
contains( Object value ) : Boolean
Checks whether a value exists in the hash.
Checks whether a value exists in the hash.

Parameters

  • value : Object
    The value to check for.

Returns

  • Boolean   True if the value exists in the dictionary.
 
containsKey( String key ) : Boolean
Checks whether a key exists in the hash.
Checks whether a key exists in the hash.

Parameters

  • key : String
    The key to check for.

Returns

  • Boolean   True if they key exists in the hash.
 
createAlias( String eventName, Function handler, [Object scope], [Object options] ) : Void
Appends an event handler to this object (shorthand for addListener.)
Appends an event handler to this object (shorthand for addListener.)

Parameters

  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • scope : Object
    (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
  • options : Object
    (optional) An object containing handler configuration.

Returns

  • Void
 
each( Function fn, Object scope ) : Ext.util.HashMap
Executes the specified function once for each item in the hash. Returning false from the function will cease iteratio...
Executes the specified function once for each item in the hash. Returning false from the function will cease iteration. The paramaters passed to the function are:
  • key : String

    The key of the item

  • value : Number

    The value of the item

  • length : Number

    The total number of items in the hash

Parameters

  • fn : Function
    The function to execute.
  • scope : Object
    The scope to execute in. Defaults to this.

Returns

  • Ext.util.HashMap   this
 
enableBubble( String/Array events ) : Void
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.override(Ext.form.Field, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.Field.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
    ...
}],
listeners: {
    change: function() {
        // Title goes red if form has been modified.
        myForm.header.setStyle('color', 'red');
    }
}
});

Parameters

  • events : String/Array
    The event name to bubble, or an Array of event names.

Returns

  • Void
 
fireEvent( String eventName, Object... args ) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse...

Fires the specified event with the passed parameters (minus the event name).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

Parameters

  • eventName : String
    The name of the event to fire.
  • args : Object...
    Variable number of parameters are passed to handlers.

Returns

  • Boolean   returns false if any of the handlers return false otherwise it returns true.
 
get( String key ) : Object
Retrieves an item with a particular key.
Retrieves an item with a particular key.

Parameters

  • key : String
    The key to lookup.

Returns

  • Object   The value at that key. If it doesn't exist, undefined is returned.
 
getCount : Number
Gets the number of items in the hash.
Gets the number of items in the hash.
 
getKeys : Array
Return all of the keys in the hash.
Return all of the keys in the hash.
 
getValues : Array
Return all of the values in the hash.
Return all of the values in the hash.
 
hasListener( String eventName ) : Boolean
Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event

Parameters

  • eventName : String
    The name of the event to check for

Returns

  • Boolean   True if the event is being listened for, else false
 
observe( Function c, Object listeners ) : Void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class al...
Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
        Ext.data.Connection.on('beforerequest', function(con, options) {
            console.log('Ajax request made to ' + options.url);
        });

Parameters

  • c : Function
    The class constructor to make observable.
  • listeners : Object
    An object containing a series of listeners to add. See addListener.

Returns

  • Void
 
relayEvents( Object origin, Array events ) : Void
Relays selected events from the specified Observable as if the events were fired by this.
Relays selected events from the specified Observable as if the events were fired by this.

Parameters

  • origin : Object
    The Observable whose events this object is to relay.
  • events : Array
    Array of event names to relay.

Returns

  • Void
 
releaseCapture( Observable o ) : Void
Removes all added captures from the Observable.
Removes all added captures from the Observable.

Parameters

  • o : Observable
    The Observable to release

Returns

  • Void
 
remove( Object o ) : Boolean
Remove an item from the hash.
Remove an item from the hash.

Parameters

  • o : Object
    The value of the item to remove.

Returns

  • Boolean   True if the item was successfully removed.
 
removeByKey( String key ) : Boolean
Remove an item from the hash.
Remove an item from the hash.

Parameters

  • key : String
    The key to remove.

Returns

  • Boolean   True if the item was successfully removed.
 
removeListener( String eventName, Function handler, [Object scope] ) : Void
Removes an event handler.
Removes an event handler.

Parameters

  • eventName : String
    The type of event the handler was associated with.
  • handler : Function
    The handler to remove. This must be a reference to the function passed into the addListener call.
  • scope : Object
    (optional) The scope originally specified for the handler.

Returns

  • Void
 
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope ) : Void
Removes listeners that were added by the mon method.
Removes listeners that were added by the mon method.

Parameters

  • item : Observable|Element
    The item from which to remove a listener/listeners.
  • ename : Object|String
    The event name, or an object containing event name properties.
  • fn : Function
    Optional. If the ename parameter was an event name, this is the handler function.
  • scope : Object
    Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns

  • Void
 
replace( String key, Object value ) : Object
Replaces an item in the hash. If the key doesn't exist, the add method will be used.
Replaces an item in the hash. If the key doesn't exist, the add method will be used.

Parameters

  • key : String
    The key of the item.
  • value : Object
    The new value for the item.

Returns

  • Object   The new value of the item.
 
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.
 
suspendEvents( Boolean queueSuspended ) : Void
Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean
    Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Returns

  • Void

Events

 
add( Ext.util.HashMap this., String key, Object value )
Fires when a new item is added to the hash
Fires when a new item is added to the hash

Parameters

  • this. : Ext.util.HashMap
  • key : String
    The key of the added item.
  • value : Object
    The value of the added item.

Returns

  • Void
 
clear( Ext.util.HashMap this. )
Fires when the hash is cleared.
Fires when the hash is cleared.

Parameters

  • this. : Ext.util.HashMap

Returns

  • Void
 
remove( Ext.util.HashMap this., String key, Object value )
Fires when an item is removed from the hash.
Fires when an item is removed from the hash.

Parameters

  • this. : Ext.util.HashMap
  • key : String
    The key of the removed item.
  • value : Object
    The value of the removed item.

Returns

  • Void
 
replace( Ext.util.HashMap this., String key, Object value, Object old )
Fires when an item is replaced in the hash.
Fires when an item is replaced in the hash.

Parameters

  • this. : Ext.util.HashMap
  • key : String
    The key of the replaced item.
  • value : Object
    The new value for the item.
  • old : Object
    The old value for the item.

Returns

  • Void