Properties

Methods

Events

Config Options

Direct Link

HistoryButton

Class CQ.HistoryButton

Package:	CQ
Class:	HistoryButton
Extends:	CQ.Ext.Toolbar.Button
Clientlib:	cq.widgets
xtype:	historybutton

The HistoryButton is a small helper class to easily provide back and forward buttons. Usually two related instances are required: The forward button instance is a simple button linked to the back button instance which handles the histroy and the back and forward handlers.

Config Options

Config Options		Defined By
	backHandler : Function The function called when the back button is hit (back button only). The handler is passed the current object from the... The function called when the back button is hit (back button only). The handler is passed the current object from the history stack. addHistory will be	HistoryButton
	forwardHandler : Function The function called when the forward button is hit (back button only). The handler is passed the current object from ... The function called when the forward button is hit (back button only). The handler is passed the current object from the history stack.	HistoryButton
	forwardId : String The back button must be linked to the id of the foward button (back button only). The back button must be linked to the id of the foward button (back button only).	HistoryButton
	historyId : String The forward button must be linked to the id of the back button (forward button only). The forward button must be linked to the id of the back button (forward button only).	HistoryButton
	id : String The ID of the button	HistoryButton

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	HistoryButton( `Object config` ) Creates a new HistoryButton. Creates a new HistoryButton. Parameters: `config` : Object The config object Example usage: `var backButton = new CQ.Ext.Panel({ "tbar": [ new CQ.HistoryButton({ // the back button including the handlers "id": "myHistory", "forwardId": "myHistory-Forward", "backHandler": function(obj) { // handle back }, "forwardHandler": function(obj) { // handle forward } }), new CQ.HistoryButton({ // the forward button "id": "myHistory-Forward", "historyId": "myHistory" }) ] };` Returns:	HistoryButton
	addHistory( `Mixed obj` ) : void Adds the specified object to the stack of the history. This method has to be called on the back button instance. Adds the specified object to the stack of the history. This method has to be called on the back button instance. Parameters: `obj` : Mixed Returns: `void`	HistoryButton

Public Events

This class has no public events.