Observable History
Package: | Ext |
Defined In: | History.js |
Class: | History |
Extends: | Observable |
Config Options | Defined By | |
---|---|---|
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
| Observable |
Property | Defined By | |
---|---|---|
fieldId : String The id of the hidden field required for storing the current history token. | History | |
iframeId : String The id of the iframe required by IE to manage the history stack. | History |
Method | Defined By | |
---|---|---|
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:
Parameters:
| History | |
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:
| Observable | |
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:
| Observable | |
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). Parameters:
| History | |
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 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:
Parameters:
| Observable | |
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:
| Observable | |
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). Parameters:
| History | |
getToken() : String Retrieves the currently-active history token. Retrieves the currently-active history token. Parameters:
| History | |
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:
| Observable | |
init( [Boolean onReady], [Object scope] ) : void Initialize the global History instance. Initialize the global History instance. Parameters:
| History | |
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:
| Observable | |
purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o, 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:
| Observable | |
removeListener( String eventName, Function handler, [Object scope] ) : void Removes an event handler. Removes an event handler. Parameters:
| Observable | |
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. Parameters:
| Observable | |
suspendEvents( Boolean queueSuspended ) : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName, Function handler, [Object scope] ) : void Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
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. Listeners will be called with the following arguments:
| History | |
ready : ( Ext.History The ) Fires when the Ext.History singleton has been initialized and is ready for use. Fires when the Ext.History singleton has been initialized and is ready for use. Listeners will be called with the following arguments:
| History |