X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..2e847cf21b8ab9d15fa167b315ca5b2fa92638fc:/docs/source/History.html diff --git a/docs/source/History.html b/docs/source/History.html index 8a42ef18..48d103e3 100644 --- a/docs/source/History.html +++ b/docs/source/History.html @@ -1,5 +1,6 @@ + The source code @@ -34,7 +35,7 @@ Ext.History = (function () { } function updateIFrame (token) { - var html = ['
',token,'
'].join(''); + var html = ['
',Ext.util.Format.htmlEncode(token),'
'].join(''); try { var doc = iframe.contentWindow.document; doc.open(); @@ -118,14 +119,14 @@ Ext.History = (function () { * @property */ iframeId: 'x-history-frame', - + events:{},
/** * Initialize the global History instance. * @param {Boolean} onReady (optional) A callback function that will be called once the history * component is fully initialized. - * @param {Object} scope (optional) The callback scope + * @param {Object} scope (optional) The scope (this reference) in which the callback is executed. Defaults to the browser window. */ init: function (onReady, scope) { if(ready) { @@ -142,7 +143,20 @@ Ext.History = (function () { if (Ext.isIE) { iframe = Ext.getDom(Ext.History.iframeId); } - this.addEvents('ready', 'change'); + this.addEvents( +
/** + * @event ready + * Fires when the Ext.History singleton has been initialized and is ready for use. + * @param {Ext.History} The Ext.History singleton. + */ + 'ready', +
/** + * @event change + * Fires when navigation back or forwards within the local page's history occurs. + * @param {String} token An identifier associated with the page state at that point in its history. + */ + 'change' + ); if(onReady){ this.on('ready', onReady, scope, {single:true}); }