X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Function.html

diff --git a/docs/output/Function.html b/docs/output/Function.html
deleted file mode 100644
index 38f667f7..00000000
--- a/docs/output/Function.html
+++ /dev/null
@@ -1,100 +0,0 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Function-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Function-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Function-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Function"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Ext.html#cls-Function">Function</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Global</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Ext.js,&#13;Ext-more.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Ext.html#cls-Function">Function</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">These functions are available on every Function object (any JavaScript function).</div><div class="hr"></div><a id="Function-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Function-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Function-createCallback"></a><b><a href="source/Ext.html#method-Function-createCallback">createCallback</a></b>()
-    :
-                                        Function<div class="mdesc"><div class="short">Creates a callback that passes arguments[0], arguments[1], arguments[2], ...&#13;
-Call directly on any function. Example:...</div><div class="long">Creates a callback that passes arguments[0], arguments[1], arguments[2], ...
-Call directly on any function. Example: <code>myFunction.createCallback(arg1, arg2)</code>
-Will create a function that is bound to those 2 args. <b>If a specific scope is required in the
-callback, use <a href="output/Function.html#Function-createDelegate" ext:member="createDelegate" ext:cls="Function">createDelegate</a> instead.</b> The function returned by createCallback always
-executes in the window scope.
-<p>This method is required when you want to pass arguments to a callback function.  If no arguments
-are needed, you can simply pass a reference to the function as a callback (e.g., callback: myFn).
-However, if you tried to pass a function with arguments (e.g., callback: myFn(arg1, arg2)) the function
-would simply execute immediately when the code is parsed. Example usage:
-<pre><code><b>var</b> sayHi = <b>function</b>(name){
-    alert(<em>'Hi, '</em> + name);
-}
-
-<i>// clicking the button alerts <em>"Hi, Fred"</em></i>
-<b>new</b> Ext.Button({
-    text: <em>'Say Hi'</em>,
-    renderTo: Ext.getBody(),
-    handler: sayHi.createCallback(<em>'Fred'</em>)
-});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc">The new function</div></li></ul></div></div></div></td><td class="msource">Function</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Function-createDelegate"></a><b><a href="source/Ext.html#method-Function-createDelegate">createDelegate</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;obj</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Array&nbsp;args</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean/Number&nbsp;appendArgs</code>]</span>&nbsp;)
-    :
-                                        Function<div class="mdesc"><div class="short">Creates a delegate (callback) that sets the scope to obj.&#13;
-Call directly on any function. Example: this.myFunction.cr...</div><div class="long">Creates a delegate (callback) that sets the scope to obj.
-Call directly on any function. Example: <code>this.myFunction.createDelegate(this, [arg1, arg2])</code>
-Will create a function that is automatically scoped to obj so that the <tt>this</tt> variable inside the
-callback points to obj. Example usage:
-<pre><code><b>var</b> sayHi = <b>function</b>(name){
-    <i>// Note this use of <em>"this.text"</em> here.  This <b>function</b> expects to</i>
-    <i>// execute within a scope that contains a text property.  In this</i>
-    <i>// example, the <em>"this"</em> variable is pointing to the btn object that</i>
-    <i>// was passed <b>in</b> createDelegate below.</i>
-    alert(<em>'Hi, '</em> + name + <em>'. You clicked the <em>"'</em> + this.text + <em>'"</em> button.'</em>);
-}
-
-<b>var</b> btn = <b>new</b> Ext.Button({
-    text: <em>'Say Hi'</em>,
-    renderTo: Ext.getBody()
-});
-
-<i>// This callback will execute <b>in</b> the scope of the</i>
-<i>// button instance. Clicking the button alerts</i>
-<i>// <em>"Hi, Fred. You clicked the "</em>Say Hi<em>" button."</em></i>
-btn.on(<em>'click'</em>, sayHi.createDelegate(btn, [<em>'Fred'</em>]));</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>obj</code> : Object<div class="sub-desc">(optional) The object for which the scope is set</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)</div></li><li><code>appendArgs</code> : Boolean/Number<div class="sub-desc">(optional) if True args are appended to call args instead of overriding,
-if a number the args are inserted at the specified position</div></li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc">The new function</div></li></ul></div></div></div></td><td class="msource">Function</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Function-createInterceptor"></a><b><a href="source/Ext.html#method-Function-createInterceptor">createInterceptor</a></b>(&nbsp;<code>Function&nbsp;fcn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
-    :
-                                        Function<div class="mdesc"><div class="short">Creates an interceptor function. The passed fcn is called before the original one. If it returns false,&#13;
-the original...</div><div class="long">Creates an interceptor function. The passed fcn is called before the original one. If it returns false,
-the original one is not called. The resulting function returns the results of the original function.
-The passed fcn is called with the parameters of the original function. Example usage:
-<pre><code><b>var</b> sayHi = <b>function</b>(name){
-    alert(<em>'Hi, '</em> + name);
-}
-
-sayHi(<em>'Fred'</em>); <i>// alerts <em>"Hi, Fred"</em></i>
-
-<i>// create a <b>new</b> <b>function</b> that validates input without</i>
-<i>// directly modifying the original <b>function</b>:</i>
-<b>var</b> sayHiToFriend = sayHi.createInterceptor(<b>function</b>(name){
-    <b>return</b> name == <em>'Brian'</em>;
-});
-
-sayHiToFriend(<em>'Fred'</em>);  <i>// no alert</i>
-sayHiToFriend(<em>'Brian'</em>); <i>// alerts <em>"Hi, Brian"</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fcn</code> : Function<div class="sub-desc">The function to call before the original</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the passed fcn (Defaults to scope of original function or window)</div></li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc">The new function</div></li></ul></div></div></div></td><td class="msource">Function</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Function-createSequence"></a><b><a href="source/Ext-more.html#method-Function-createSequence">createSequence</a></b>(&nbsp;<code>Function&nbsp;fcn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
-    :
-                                        Function<div class="mdesc"><div class="short">Create a combined function call sequence of the original function + the passed function.
-The resulting function retur...</div><div class="long">Create a combined function call sequence of the original function + the passed function.
-The resulting function returns the results of the original function.
-The passed fcn is called with the parameters of the original function. Example usage:
-<pre><code><b>var</b> sayHi = <b>function</b>(name){
-    alert(<em>'Hi, '</em> + name);
-}
-
-sayHi(<em>'Fred'</em>); <i>// alerts <em>"Hi, Fred"</em></i>
-
-<b>var</b> sayGoodbye = sayHi.createSequence(<b>function</b>(name){
-    alert(<em>'Bye, '</em> + name);
-});
-
-sayGoodbye(<em>'Fred'</em>); <i>// both alerts show</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fcn</code> : Function<div class="sub-desc">The function to sequence</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the passed fcn (Defaults to scope of original function or window)</div></li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc">The new function</div></li></ul></div></div></div></td><td class="msource">Function</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Function-defer"></a><b><a href="source/Ext.html#method-Function-defer">defer</a></b>(&nbsp;<code>Number&nbsp;millis</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;obj</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Array&nbsp;args</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean/Number&nbsp;appendArgs</code>]</span>&nbsp;)
-    :
-                                        Number<div class="mdesc"><div class="short">Calls this function after the number of millseconds specified, optionally in a specific scope. Example usage:&#13;
-var sa...</div><div class="long">Calls this function after the number of millseconds specified, optionally in a specific scope. Example usage:
-<pre><code><b>var</b> sayHi = <b>function</b>(name){
-    alert(<em>'Hi, '</em> + name);
-}
-
-<i>// executes immediately:</i>
-sayHi(<em>'Fred'</em>);
-
-<i>// executes after 2 seconds:</i>
-sayHi.defer(2000, this, [<em>'Fred'</em>]);
-
-<i>// this syntax is sometimes useful <b>for</b> deferring</i>
-<i>// execution of an anonymous <b>function</b>:</i>
-(<b>function</b>(){
-    alert(<em>'Anonymous'</em>);
-}).defer(100);</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>millis</code> : Number<div class="sub-desc">The number of milliseconds for the setTimeout call (if less than or equal to 0 the function is executed immediately)</div></li><li><code>obj</code> : Object<div class="sub-desc">(optional) The object for which the scope is set</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)</div></li><li><code>appendArgs</code> : Boolean/Number<div class="sub-desc">(optional) if True args are appended to call args instead of overriding,
-if a number the args are inserted at the specified position</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The timeout id that can be used with clearTimeout</div></li></ul></div></div></div></td><td class="msource">Function</td></tr></tbody></table><a id="Function-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file

Package:	Global
Defined In:	Ext.js, Ext-more.js
Class:	Function
Extends:	Object
Method		Defined By
	createCallback() - : - Function Creates a callback that passes arguments[0], arguments[1], arguments[2], ... -Call directly on any function. Example:... Creates a callback that passes arguments[0], arguments[1], arguments[2], ... -Call directly on any function. Example: `myFunction.createCallback(arg1, arg2)` -Will create a function that is bound to those 2 args. If a specific scope is required in the -callback, use createDelegate instead. The function returned by createCallback always -executes in the window scope. - This method is required when you want to pass arguments to a callback function. If no arguments -are needed, you can simply pass a reference to the function as a callback (e.g., callback: myFn). -However, if you tried to pass a function with arguments (e.g., callback: myFn(arg1, arg2)) the function -would simply execute immediately when the code is parsed. Example usage: - `var sayHi = function(name){ - alert('Hi, ' + name); -} - -// clicking the button alerts "Hi, Fred" -new Ext.Button({ - text: 'Say Hi', - renderTo: Ext.getBody(), - handler: sayHi.createCallback('Fred') -});` Parameters: None. Returns: `Function` The new function	Function
	createDelegate( [`Object obj`], [`Array args`], [`Boolean/Number appendArgs`] ) - : - Function Creates a delegate (callback) that sets the scope to obj. -Call directly on any function. Example: this.myFunction.cr... Creates a delegate (callback) that sets the scope to obj. -Call directly on any function. Example: `this.myFunction.createDelegate(this, [arg1, arg2])` -Will create a function that is automatically scoped to obj so that the `this` variable inside the -callback points to obj. Example usage: - var sayHi = function(name){ - // Note this use of "this.text" here. This function expects to - // execute within a scope that contains a text property. In this - // example, the "this" variable is pointing to the btn object that - // was passed in createDelegate below. - alert('Hi, ' + name + '. You clicked the "' + this.text + '" button.'); -} - -var btn = new Ext.Button({ - text: 'Say Hi', - renderTo: Ext.getBody() -}); - -// This callback will execute in the scope of the -// button instance. Clicking the button alerts -// "Hi, Fred. You clicked the "Say Hi" button." -btn.on('click', sayHi.createDelegate(btn, ['Fred'])); Parameters: `obj` : Object (optional) The object for which the scope is set `args` : Array (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller) `appendArgs` : Boolean/Number (optional) if True args are appended to call args instead of overriding, -if a number the args are inserted at the specified position Returns: `Function` The new function	Function
	createInterceptor( `Function fcn`, [`Object scope`] ) - : - Function Creates an interceptor function. The passed fcn is called before the original one. If it returns false, -the original... Creates an interceptor function. The passed fcn is called before the original one. If it returns false, -the original one is not called. The resulting function returns the results of the original function. -The passed fcn is called with the parameters of the original function. Example usage: - `var sayHi = function(name){ - alert('Hi, ' + name); -} - -sayHi('Fred'); // alerts "Hi, Fred" - -// create a new function that validates input without -// directly modifying the original function: -var sayHiToFriend = sayHi.createInterceptor(function(name){ - return name == 'Brian'; -}); - -sayHiToFriend('Fred'); // no alert -sayHiToFriend('Brian'); // alerts "Hi, Brian"` Parameters: `fcn` : Function The function to call before the original `scope` : Object (optional) The scope of the passed fcn (Defaults to scope of original function or window) Returns: `Function` The new function	Function
	createSequence( `Function fcn`, [`Object scope`] ) - : - Function Create a combined function call sequence of the original function + the passed function. -The resulting function retur... Create a combined function call sequence of the original function + the passed function. -The resulting function returns the results of the original function. -The passed fcn is called with the parameters of the original function. Example usage: - `var sayHi = function(name){ - alert('Hi, ' + name); -} - -sayHi('Fred'); // alerts "Hi, Fred" - -var sayGoodbye = sayHi.createSequence(function(name){ - alert('Bye, ' + name); -}); - -sayGoodbye('Fred'); // both alerts show` Parameters: `fcn` : Function The function to sequence `scope` : Object (optional) The scope of the passed fcn (Defaults to scope of original function or window) Returns: `Function` The new function	Function
	defer( `Number millis`, [`Object obj`], [`Array args`], [`Boolean/Number appendArgs`] ) - : - Number Calls this function after the number of millseconds specified, optionally in a specific scope. Example usage: -var sa... Calls this function after the number of millseconds specified, optionally in a specific scope. Example usage: - `var sayHi = function(name){ - alert('Hi, ' + name); -} - -// executes immediately: -sayHi('Fred'); - -// executes after 2 seconds: -sayHi.defer(2000, this, ['Fred']); - -// this syntax is sometimes useful for deferring -// execution of an anonymous function: -(function(){ - alert('Anonymous'); -}).defer(100);` Parameters: `millis` : Number The number of milliseconds for the setTimeout call (if less than or equal to 0 the function is executed immediately) `obj` : Object (optional) The object for which the scope is set `args` : Array (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller) `appendArgs` : Boolean/Number (optional) if True args are appended to call args instead of overriding, -if a number the args are inserted at the specified position Returns: `Number` The timeout id that can be used with clearTimeout	Function