Observable History
Package: | Ext |
Defined In: | History.js |
Class: | History |
Extends: | Observable |
Config Options | Defined By | |
---|---|---|
listeners : Object (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
(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.
|
Observable |
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 object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
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 | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
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 element (shorthand for addListener)
Appends an event handler to this element (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 a listener
Removes a listener
Parameters:
|
Observable | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
suspendEvents() : 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 a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable |