A collection of useful static methods to deal with function callbacks
-Create an alias to the provided method property with name methodName of object.
-Note that the execution scope will still be bound to the provided object itself.
aliasFn
-Create a new function from the provided fn, change this to the provided scope, optionally
-overrides arguments for the call. (Defaults to the arguments passed by the caller)
The function to delegate.
-(optional) The scope (this reference) in which the function is executed.
-If omitted, defaults to the browser window.
(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)
-(optional) if True args are appended to call args instead of overriding, -if a number the args are inserted at the specified position
-The new function
-Creates a delegate function, optionally with a bound scope which, when called, buffers -the execution of the passed function for the configured number of milliseconds. -If called again within that period, the impending invocation will be canceled, and the -timeout period will begin again.
- -The function to invoke on a buffered timer.
-The number of milliseconds by which to buffer the invocation of the -function.
-(optional) The scope (this reference) in which
-the passed function is executed. If omitted, defaults to the scope specified by the caller.
(optional) Override arguments for the call. Defaults to the arguments -passed by the caller.
-A function which invokes the passed function after buffering for the specified time.
-Creates a delegate (callback) which, when called, executes after a specific delay.
-Creates a delegate (callback) which, when called, executes after a specific delay.
-The function which will be called on a delay when the returned function is called. -Optionally, a replacement (or additional) argument list may be specified.
-The number of milliseconds to defer execution by whenever called.
-(optional) The scope (this reference) used by the function at execution time.
(optional) Override arguments for the call. (Defaults to the arguments passed by the caller)
-(optional) if True args are appended to call args instead of overriding, -if a number the args are inserted at the specified position.
-A function which, when called, executes the original function after the specified delay.
-Creates an interceptor function. The passed function 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 function 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 = Ext.Function.createInterceptor(sayHi, function(name){
- return name == 'Brian';
-});
-
-sayHiToFriend('Fred'); // no alert
-sayHiToFriend('Brian'); // alerts "Hi, Brian"
- The original function.
-The function to call before the original
-(optional) The scope (this reference) in which the passed function is executed.
-If omitted, defaults to the scope in which the original function is called or the browser window.
(optional) The value to return if the passed function return false (defaults to null).
-The new function
-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 function 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 = Ext.Function.createSequence(sayHi, function(name){
- alert('Bye, ' + name);
-});
-
-sayGoodbye('Fred'); // both alerts show
-The original function.
-The function to sequence
-(optional) The scope (this reference) in which the passed function is executed. -If omitted, defaults to the scope in which the original function is called or the browser window.
-The new function
-Creates a throttled version of the passed function which, when called repeatedly and -rapidly, invokes the passed function only after a certain interval has elapsed since the -previous invocation.
- - - - -This is useful for wrapping functions which may be called repeatedly, such as -a handler of a mouse move event when the processing is expensive.
- -{Function} The function to execute at a regular time interval.
-{Number} The interval in milliseconds on which the passed function is executed.
-(optional) The scope (this reference) in which
-the passed function is executed. If omitted, defaults to the scope specified by the caller.
A function which invokes the passed function at the specified interval.
-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:
-Ext.Function.defer(sayHi, 2000, this, ['Fred']);
-
-// this syntax is sometimes useful for deferring
-// execution of an anonymous function:
-Ext.Function.defer(function(){
- alert('Anonymous');
-}, 100);
- The function to defer.
-The number of milliseconds for the setTimeout call (if less than or equal to 0 the function is executed immediately)
-(optional) The scope (this reference) in which the function is executed.
-If omitted, defaults to the browser window.
(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)
-(optional) if True args are appended to call args instead of overriding, -if a number the args are inserted at the specified position
-The timeout id that can be used with clearTimeout
-A very commonly used method throughout the framework. It acts as a wrapper around another method
-which originally accepts 2 arguments for name and value.
-The wrapped function then allows "flexible" value setting of either:
name and value as 2 argumentsFor example:
- -var setValue = Ext.Function.flexSetter(function(name, value) {
- this[name] = value;
-});
-
-// Afterwards
-// Setting a single name - value
-setValue('name1', 'value1');
-
-// Settings multiple name - value pairs
-setValue({
- name1: 'value1',
- name2: 'value2',
- name3: 'value3'
-});
-flexSetter
-Create a new function from the provided fn, the arguments of which are pre-set to args.
-New arguments passed to the newly created callback when it's invoked are appended after the pre-set ones.
-This is especially useful when creating callbacks.
-For example:
var originalFunction = function(){
- alert(Ext.Array.from(arguments).join(' '));
-};
-
-var callback = Ext.Function.pass(originalFunction, ['Hello', 'World']);
-
-callback(); // alerts 'Hello World'
-callback('by Me'); // alerts 'Hello World by Me'
-The original function
-The arguments to pass to new callback
-(optional) The scope (this reference) in which the function is executed.
The new callback function
-