For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.util.History

####

    MixinsExt.util.Observable

History management component that allows you to register arbitrary tokens that signify application history state on navigation actions. You can then handle the history change event in order to reset your application UI to the appropriate state when the user navigates forward or backward through the browser history stack.

Defined By

### Config Options

#### Other Configs

Ext.util.Observable
view source
listeners : Object
(optional) A config object containing one or more event handlers to be added to this object during initialization. T...

(optional)

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.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'); }
            }
        }
    });

Defined By

### Properties

Ext.util.History
view source
fieldId : String

The id of the hidden field required for storing the current history token.

The id of the hidden field required for storing the current history token.

Ext.util.History
view source
iframeId : String

The id of the iframe required by IE to manage the history stack.

The id of the iframe required by IE to manage the history stack.

Defined By

### Methods

Ext.util.History
view source
add( String token, Boolean preventDuplicates) : void
Add a new token to the history stack. This can be any arbitrary value, although it would commonly be the concatenatio...

Add a new token to the history stack. This can be any arbitrary value, although it would commonly be the concatenation of a component id and another id marking the specifc history state of that component. Example usage:

    // Handle tab changes on a TabPanel
    tabPanel.on('tabchange', function(tabPanel, tab){
    Ext.History.add(tabPanel.id + ':' + tab.id);
    });

### Parameters

- token : String

  The value that defines a particular application-specific history state

- preventDuplicates : Boolean

  When true, if the passed token matches the current token it will not save a new history step. Set to false if the same state can be saved more than once at the same history stack location (defaults to true).

### Returns

- void

Ext.util.Observable
view source
addEvents( Object/String o, String ) : 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.

- : String

  [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

      this.addEvents('storeloaded', 'storecleared');

### Returns

- void

Ext.util.Observable
view source
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.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

Ext.util.Observable
view source
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

Ext.util.History
view source
back : void

Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).

Programmatically steps back one step in browser history (equivalent to the user pressing the Back button).

### Returns

- void

Ext.util.Observable
view source
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

Ext.util.Observable
view source
clearListeners : void

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

### Returns

- void

Ext.util.Observable
view source
clearManagedListeners : void

Removes all managed listeners for this object.

Removes all managed listeners for this object.

### Returns

- void

Ext.util.Observable
view source
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.Base, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.Function.createSequence(Ext.form.field.Base.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

Ext.util.Observable
view source
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 Ob...

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.

Ext.util.History
view source
forward : void

Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).

Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button).

### Returns

- void

Ext.util.History
view source
getToken : String

Retrieves the currently-active history token.

Retrieves the currently-active history token.

### Returns

- String

  The token

Ext.util.Observable
view source
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

Ext.util.History
view source
init( [Boolean onReady], [Object scope]) : void

Initialize the global History instance.

Initialize the global History instance.

### Parameters

- onReady : Boolean

  (optional) A callback function that will be called once the history component is fully initialized.

- scope : Object

  (optional) The scope (`this` reference) in which the callback is executed. Defaults to the browser window.

### Returns

- void

Ext.util.Observable
view source
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 a...

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

Ext.util.Observable
view source
on( 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

Ext.util.Observable
view source
relayEvents( Object origin, Array events, Object prefix) : 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.

- prefix : Object

### Returns

- void

Ext.util.Observable
view source
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

Ext.util.Observable
view source
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

Ext.util.Observable
view source
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

Ext.util.Observable
view source
resumeEvents : void
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.

### Returns

- void

Ext.util.Observable
view source
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

Ext.util.Observable
view source
un( 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

Defined By

### Events

Ext.util.History
view source
change( String token)

Fires when navigation back or forwards within the local page's history occurs.

Fires when navigation back or forwards within the local page's history occurs.

### Parameters

- token : String

  An identifier associated with the page state at that point in its history.

Ext.util.History
view source
ready( Ext.util.History The)

Fires when the Ext.util.History singleton has been initialized and is ready for use.

Fires when the Ext.util.History singleton has been initialized and is ready for use.

### Parameters

- The : Ext.util.History

  Ext.util.History singleton.