/* This file is part of Ext JS 4.2 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-05-16 14:36:50 (f9be68accb407158ba2b1be2c226a6ce1f649314) */ // @tag foundation,core // @define Ext /** * @class Ext * @singleton */ var Ext = Ext || {}; Ext._startTime = new Date().getTime(); (function() { var global = this, objectPrototype = Object.prototype, toString = objectPrototype.toString, enumerables = true, enumerablesTest = {toString: 1}, emptyFn = function () {}, // This is the "$previous" method of a hook function on an instance. When called, it // calls through the class prototype by the name of the called method. callOverrideParent = function () { var method = callOverrideParent.caller.caller; // skip callParent (our caller) return method.$owner.prototype[method.$name].apply(this, arguments); }, i, nonWhitespaceRe = /\S/, ExtApp, iterableRe = /\[object\s*(?:Array|Arguments|\w*Collection|\w*List|HTML\s+document\.all\s+class)\]/; Function.prototype.$extIsFunction = true; Ext.global = global; for (i in enumerablesTest) { enumerables = null; } if (enumerables) { enumerables = ['hasOwnProperty', 'valueOf', 'isPrototypeOf', 'propertyIsEnumerable', 'toLocaleString', 'toString', 'constructor']; } /** * An array containing extra enumerables for old browsers * @property {String[]} */ Ext.enumerables = enumerables; /** * Copies all the properties of config to the specified object. * Note that if recursive merging and cloning without referencing the original objects / arrays is needed, use * {@link Ext.Object#merge} instead. * @param {Object} object The receiver of the properties * @param {Object} config The source of the properties * @param {Object} [defaults] A different object that will also be applied for default values * @return {Object} returns obj */ Ext.apply = function(object, config, defaults) { if (defaults) { Ext.apply(object, defaults); } if (object && config && typeof config === 'object') { var i, j, k; for (i in config) { object[i] = config[i]; } if (enumerables) { for (j = enumerables.length; j--;) { k = enumerables[j]; if (config.hasOwnProperty(k)) { object[k] = config[k]; } } } } return object; }; Ext.buildSettings = Ext.apply({ baseCSSPrefix: 'x-' }, Ext.buildSettings || {}); Ext.apply(Ext, { /** * @property {String} [name='Ext'] *

The name of the property in the global namespace (The window in browser environments) which refers to the current instance of Ext.

*

This is usually "Ext", but if a sandboxed build of ExtJS is being used, this will be an alternative name.

*

If code is being generated for use by eval or to create a new Function, and the global instance * of Ext must be referenced, this is the name that should be built into the code.

*/ name: Ext.sandboxName || 'Ext', /** * @property {Function} * A reusable empty function */ emptyFn: emptyFn, /** * A reusable identity function. The function will always return the first argument, unchanged. */ identityFn: function(o) { return o; }, /** * A zero length string which will pass a truth test. Useful for passing to methods * which use a truth test to reject falsy values where a string value must be cleared. */ emptyString: new String(), baseCSSPrefix: Ext.buildSettings.baseCSSPrefix, /** * Copies all the properties of config to object if they don't already exist. * @param {Object} object The receiver of the properties * @param {Object} config The source of the properties * @return {Object} returns obj */ applyIf: function(object, config) { var property; if (object) { for (property in config) { if (object[property] === undefined) { object[property] = config[property]; } } } return object; }, /** * Iterates either an array or an object. This method delegates to * {@link Ext.Array#each Ext.Array.each} if the given value is iterable, and {@link Ext.Object#each Ext.Object.each} otherwise. * * @param {Object/Array} object The object or array to be iterated. * @param {Function} fn The function to be called for each iteration. See and {@link Ext.Array#each Ext.Array.each} and * {@link Ext.Object#each Ext.Object.each} for detailed lists of arguments passed to this function depending on the given object * type that is being iterated. * @param {Object} scope (Optional) The scope (`this` reference) in which the specified function is executed. * Defaults to the object being iterated itself. * @markdown */ iterate: function(object, fn, scope) { if (Ext.isEmpty(object)) { return; } if (scope === undefined) { scope = object; } if (Ext.isIterable(object)) { Ext.Array.each.call(Ext.Array, object, fn, scope); } else { Ext.Object.each.call(Ext.Object, object, fn, scope); } } }); Ext.apply(Ext, { /** * This method deprecated. Use {@link Ext#define Ext.define} instead. * @method * @param {Function} superclass * @param {Object} overrides * @return {Function} The subclass constructor from the overrides parameter, or a generated one if not provided. * @deprecated 4.0.0 Use {@link Ext#define Ext.define} instead */ extend: (function() { // inline overrides var objectConstructor = objectPrototype.constructor, inlineOverrides = function(o) { for (var m in o) { if (!o.hasOwnProperty(m)) { continue; } this[m] = o[m]; } }; return function(subclass, superclass, overrides) { // First we check if the user passed in just the superClass with overrides if (Ext.isObject(superclass)) { overrides = superclass; superclass = subclass; subclass = overrides.constructor !== objectConstructor ? overrides.constructor : function() { superclass.apply(this, arguments); }; } if (!superclass) { Ext.Error.raise({ sourceClass: 'Ext', sourceMethod: 'extend', msg: 'Attempting to extend from a class which has not been loaded on the page.' }); } // We create a new temporary class var F = function() {}, subclassProto, superclassProto = superclass.prototype; F.prototype = superclassProto; subclassProto = subclass.prototype = new F(); subclassProto.constructor = subclass; subclass.superclass = superclassProto; if (superclassProto.constructor === objectConstructor) { superclassProto.constructor = superclass; } subclass.override = function(overrides) { Ext.override(subclass, overrides); }; subclassProto.override = inlineOverrides; subclassProto.proto = subclassProto; subclass.override(overrides); subclass.extend = function(o) { return Ext.extend(subclass, o); }; return subclass; }; }()), /** * Overrides members of the specified `target` with the given values. * * If the `target` is a class declared using {@link Ext#define Ext.define}, the * `override` method of that class is called (see {@link Ext.Base#override}) given * the `overrides`. * * If the `target` is a function, it is assumed to be a constructor and the contents * of `overrides` are applied to its `prototype` using {@link Ext#apply Ext.apply}. * * If the `target` is an instance of a class declared using {@link Ext#define Ext.define}, * the `overrides` are applied to only that instance. In this case, methods are * specially processed to allow them to use {@link Ext.Base#callParent}. * * var panel = new Ext.Panel({ ... }); * * Ext.override(panel, { * initComponent: function () { * // extra processing... * * this.callParent(); * } * }); * * If the `target` is none of these, the `overrides` are applied to the `target` * using {@link Ext#apply Ext.apply}. * * Please refer to {@link Ext#define Ext.define} and {@link Ext.Base#override} for * further details. * * @param {Object} target The target to override. * @param {Object} overrides The properties to add or replace on `target`. * @method override */ override: function (target, overrides) { if (target.$isClass) { target.override(overrides); } else if (typeof target == 'function') { Ext.apply(target.prototype, overrides); } else { var owner = target.self, name, value; if (owner && owner.$isClass) { // if (instance of Ext.define'd class) for (name in overrides) { if (overrides.hasOwnProperty(name)) { value = overrides[name]; if (typeof value == 'function') { if (owner.$className) { value.displayName = owner.$className + '#' + name; } value.$name = name; value.$owner = owner; value.$previous = target.hasOwnProperty(name) ? target[name] // already hooked, so call previous hook : callOverrideParent; // calls by name on prototype } target[name] = value; } } } else { Ext.apply(target, overrides); } } return target; } }); // A full set of static methods to do type checking Ext.apply(Ext, { /** * Returns the given value itself if it's not empty, as described in {@link Ext#isEmpty}; returns the default * value (second argument) otherwise. * * @param {Object} value The value to test * @param {Object} defaultValue The value to return if the original value is empty * @param {Boolean} allowBlank (optional) true to allow zero length strings to qualify as non-empty (defaults to false) * @return {Object} value, if non-empty, else defaultValue */ valueFrom: function(value, defaultValue, allowBlank){ return Ext.isEmpty(value, allowBlank) ? defaultValue : value; }, /** * Returns the type of the given variable in string format. List of possible values are: * * - `undefined`: If the given value is `undefined` * - `null`: If the given value is `null` * - `string`: If the given value is a string * - `number`: If the given value is a number * - `boolean`: If the given value is a boolean value * - `date`: If the given value is a `Date` object * - `function`: If the given value is a function reference * - `object`: If the given value is an object * - `array`: If the given value is an array * - `regexp`: If the given value is a regular expression * - `element`: If the given value is a DOM Element * - `textnode`: If the given value is a DOM text node and contains something other than whitespace * - `whitespace`: If the given value is a DOM text node and contains only whitespace * * @param {Object} value * @return {String} * @markdown */ typeOf: function(value) { var type, typeToString; if (value === null) { return 'null'; } type = typeof value; if (type === 'undefined' || type === 'string' || type === 'number' || type === 'boolean') { return type; } typeToString = toString.call(value); switch(typeToString) { case '[object Array]': return 'array'; case '[object Date]': return 'date'; case '[object Boolean]': return 'boolean'; case '[object Number]': return 'number'; case '[object RegExp]': return 'regexp'; } if (type === 'function') { return 'function'; } if (type === 'object') { if (value.nodeType !== undefined) { if (value.nodeType === 3) { return (nonWhitespaceRe).test(value.nodeValue) ? 'textnode' : 'whitespace'; } else { return 'element'; } } return 'object'; } Ext.Error.raise({ sourceClass: 'Ext', sourceMethod: 'typeOf', msg: 'Failed to determine the type of the specified value "' + value + '". This is most likely a bug.' }); }, /** * Coerces the first value if possible so that it is comparable to the second value. * * Coercion only works between the basic atomic data types String, Boolean, Number, Date, null and undefined. * * Numbers and numeric strings are coerced to Dates using the value as the millisecond era value. * * Strings are coerced to Dates by parsing using the {@link Ext.Date#defaultFormat defaultFormat}. * * For example * * Ext.coerce('false', true); * * returns the boolean value `false` because the second parameter is of type `Boolean`. * * @param {Mixed} from The value to coerce * @param {Mixed} to The value it must be compared against * @return The coerced value. */ coerce: function(from, to) { var fromType = Ext.typeOf(from), toType = Ext.typeOf(to), isString = typeof from === 'string'; if (fromType !== toType) { switch (toType) { case 'string': return String(from); case 'number': return Number(from); case 'boolean': return isString && (!from || from === 'false') ? false : Boolean(from); case 'null': return isString && (!from || from === 'null') ? null : from; case 'undefined': return isString && (!from || from === 'undefined') ? undefined : from; case 'date': return isString && isNaN(from) ? Ext.Date.parse(from, Ext.Date.defaultFormat) : Date(Number(from)); } } return from; }, /** * Returns true if the passed value is empty, false otherwise. The value is deemed to be empty if it is either: * * - `null` * - `undefined` * - a zero-length array * - a zero-length string (Unless the `allowEmptyString` parameter is set to `true`) * * @param {Object} value The value to test * @param {Boolean} allowEmptyString (optional) true to allow empty strings (defaults to false) * @return {Boolean} * @markdown */ isEmpty: function(value, allowEmptyString) { return (value === null) || (value === undefined) || (!allowEmptyString ? value === '' : false) || (Ext.isArray(value) && value.length === 0); }, /** * Returns true if the passed value is a JavaScript Array, false otherwise. * * @param {Object} target The target to test * @return {Boolean} * @method */ isArray: ('isArray' in Array) ? Array.isArray : function(value) { return toString.call(value) === '[object Array]'; }, /** * Returns true if the passed value is a JavaScript Date object, false otherwise. * @param {Object} object The object to test * @return {Boolean} */ isDate: function(value) { return toString.call(value) === '[object Date]'; }, /** * Returns true if the passed value is a JavaScript Object, false otherwise. * @param {Object} value The value to test * @return {Boolean} * @method */ isObject: (toString.call(null) === '[object Object]') ? function(value) { // check ownerDocument here as well to exclude DOM nodes return value !== null && value !== undefined && toString.call(value) === '[object Object]' && value.ownerDocument === undefined; } : function(value) { return toString.call(value) === '[object Object]'; }, /** * @private */ isSimpleObject: function(value) { return value instanceof Object && value.constructor === Object; }, /** * Returns true if the passed value is a JavaScript 'primitive', a string, number or boolean. * @param {Object} value The value to test * @return {Boolean} */ isPrimitive: function(value) { var type = typeof value; return type === 'string' || type === 'number' || type === 'boolean'; }, /** * Returns true if the passed value is a JavaScript Function, false otherwise. * @param {Object} value The value to test * @return {Boolean} * @method */ isFunction: function(value) { return !!(value && value.$extIsFunction); }, /** * Returns true if the passed value is a number. Returns false for non-finite numbers. * @param {Object} value The value to test * @return {Boolean} */ isNumber: function(value) { return typeof value === 'number' && isFinite(value); }, /** * Validates that a value is numeric. * @param {Object} value Examples: 1, '1', '2.34' * @return {Boolean} True if numeric, false otherwise */ isNumeric: function(value) { return !isNaN(parseFloat(value)) && isFinite(value); }, /** * Returns true if the passed value is a string. * @param {Object} value The value to test * @return {Boolean} */ isString: function(value) { return typeof value === 'string'; }, /** * Returns true if the passed value is a boolean. * * @param {Object} value The value to test * @return {Boolean} */ isBoolean: function(value) { return typeof value === 'boolean'; }, /** * Returns true if the passed value is an HTMLElement * @param {Object} value The value to test * @return {Boolean} */ isElement: function(value) { return value ? value.nodeType === 1 : false; }, /** * Returns true if the passed value is a TextNode * @param {Object} value The value to test * @return {Boolean} */ isTextNode: function(value) { return value ? value.nodeName === "#text" : false; }, /** * Returns true if the passed value is defined. * @param {Object} value The value to test * @return {Boolean} */ isDefined: function(value) { return typeof value !== 'undefined'; }, /** * Returns `true` if the passed value is iterable, that is, if elements of it are addressable using array * notation with numeric indices, `false` otherwise. * * Arrays and function `arguments` objects are iterable. Also HTML collections such as `NodeList` and `HTMLCollection' * are iterable. * * @param {Object} value The value to test * @return {Boolean} */ isIterable: function(value) { // To be iterable, the object must have a numeric length property and must not be a string or function. if (!value || typeof value.length !== 'number' || typeof value === 'string' || value.$extIsFunction) { return false; } // Certain "standard" collections in IE (such as document.images) do not offer the correct // Javascript Object interface; specifically, they lack the propertyIsEnumerable method. // And the item property while it does exist is not typeof "function" if (!value.propertyIsEnumerable) { return !!value.item; } // If it is a regular, interrogatable JS object (not an IE ActiveX object), then... // If it has its own property called "length", but not enumerable, it's iterable if (value.hasOwnProperty('length') && !value.propertyIsEnumerable('length')) { return true; } // Test against whitelist which includes known iterable collection types return iterableRe.test(toString.call(value)); } }); Ext.apply(Ext, { /** * Clone simple variables including array, {}-like objects, DOM nodes and Date without keeping the old reference. * A reference for the object itself is returned if it's not a direct decendant of Object. For model cloning, * see {@link Ext.data.Model#copy Model.copy}. * * @param {Object} item The variable to clone * @return {Object} clone */ clone: function(item) { var type, i, j, k, clone, key; if (item === null || item === undefined) { return item; } // DOM nodes // TODO proxy this to Ext.Element.clone to handle automatic id attribute changing // recursively if (item.nodeType && item.cloneNode) { return item.cloneNode(true); } type = toString.call(item); // Date if (type === '[object Date]') { return new Date(item.getTime()); } // Array if (type === '[object Array]') { i = item.length; clone = []; while (i--) { clone[i] = Ext.clone(item[i]); } } // Object else if (type === '[object Object]' && item.constructor === Object) { clone = {}; for (key in item) { clone[key] = Ext.clone(item[key]); } if (enumerables) { for (j = enumerables.length; j--;) { k = enumerables[j]; if (item.hasOwnProperty(k)) { clone[k] = item[k]; } } } } return clone || item; }, /** * @private * Generate a unique reference of Ext in the global scope, useful for sandboxing */ getUniqueGlobalNamespace: function() { var uniqueGlobalNamespace = this.uniqueGlobalNamespace, i; if (uniqueGlobalNamespace === undefined) { i = 0; do { uniqueGlobalNamespace = 'ExtBox' + (++i); } while (Ext.global[uniqueGlobalNamespace] !== undefined); Ext.global[uniqueGlobalNamespace] = Ext; this.uniqueGlobalNamespace = uniqueGlobalNamespace; } return uniqueGlobalNamespace; }, /** * @private */ functionFactoryCache: {}, cacheableFunctionFactory: function() { var me = this, args = Array.prototype.slice.call(arguments), cache = me.functionFactoryCache, idx, fn, ln; if (Ext.isSandboxed) { ln = args.length; if (ln > 0) { ln--; args[ln] = 'var Ext=window.' + Ext.name + ';' + args[ln]; } } idx = args.join(''); fn = cache[idx]; if (!fn) { fn = Function.prototype.constructor.apply(Function.prototype, args); cache[idx] = fn; } return fn; }, functionFactory: function() { var me = this, args = Array.prototype.slice.call(arguments), ln; if (Ext.isSandboxed) { ln = args.length; if (ln > 0) { ln--; args[ln] = 'var Ext=window.' + Ext.name + ';' + args[ln]; } } return Function.prototype.constructor.apply(Function.prototype, args); }, /** * @private * @property */ Logger: { verbose: emptyFn, log: emptyFn, info: emptyFn, warn: emptyFn, error: function(message) { throw new Error(message); }, deprecate: emptyFn } }); /** * Old alias to {@link Ext#typeOf} * @deprecated 4.0.0 Use {@link Ext#typeOf} instead * @method * @inheritdoc Ext#typeOf */ Ext.type = Ext.typeOf; // When using Cmd optimizations, the namespace Ext.app may already be defined // by this point since it's done up front by the tool. Check if app already // exists before overwriting it. ExtApp = Ext.app; if (!ExtApp) { ExtApp = Ext.app = {}; } Ext.apply(ExtApp, { namespaces: {}, /** * @private */ collectNamespaces: function(paths) { var namespaces = Ext.app.namespaces, path; for (path in paths) { if (paths.hasOwnProperty(path)) { namespaces[path] = true; } } }, /** * Adds namespace(s) to known list. * * @param {String/String[]} namespace */ addNamespaces: function(ns) { var namespaces = Ext.app.namespaces, i, l; if (!Ext.isArray(ns)) { ns = [ns]; } for (i = 0, l = ns.length; i < l; i++) { namespaces[ns[i]] = true; } }, /** * @private Clear all namespaces from known list. */ clearNamespaces: function() { Ext.app.namespaces = {}; }, /** * Get namespace prefix for a class name. * * @param {String} className * * @return {String} Namespace prefix if it's known, otherwise undefined */ getNamespace: function(className) { var namespaces = Ext.app.namespaces, deepestPrefix = '', prefix; for (prefix in namespaces) { if (namespaces.hasOwnProperty(prefix) && prefix.length > deepestPrefix.length && (prefix + '.' === className.substring(0, prefix.length + 1))) { deepestPrefix = prefix; } } return deepestPrefix === '' ? undefined : deepestPrefix; } }); }()); /* * This method evaluates the given code free of any local variable. In some browsers this * will be at global scope, in others it will be in a function. * @parma {String} code The code to evaluate. * @private * @method */ Ext.globalEval = Ext.global.execScript ? function(code) { execScript(code); } : function($$code) { // IMPORTANT: because we use eval we cannot place this in the above function or it // will break the compressor's ability to rename local variables... (function(){ // This var should not be replaced by the compressor. We need to do this so // that Ext refers to the global Ext, if we're sandboxing it may // refer to the local instance inside the closure var Ext = this.Ext; eval($$code); }()); }; // @tag foundation,core // @require ../Ext.js // @define Ext.Version /** * @author Jacky Nguyen * @docauthor Jacky Nguyen * @class Ext.Version * * A utility class that wrap around a string version number and provide convenient * method to perform comparison. See also: {@link Ext.Version#compare compare}. Example: * * var version = new Ext.Version('1.0.2beta'); * console.log("Version is " + version); // Version is 1.0.2beta * * console.log(version.getMajor()); // 1 * console.log(version.getMinor()); // 0 * console.log(version.getPatch()); // 2 * console.log(version.getBuild()); // 0 * console.log(version.getRelease()); // beta * * console.log(version.isGreaterThan('1.0.1')); // True * console.log(version.isGreaterThan('1.0.2alpha')); // True * console.log(version.isGreaterThan('1.0.2RC')); // False * console.log(version.isGreaterThan('1.0.2')); // False * console.log(version.isLessThan('1.0.2')); // True * * console.log(version.match(1.0)); // True * console.log(version.match('1.0.2')); // True * */ (function() { // Current core version // also fix Ext-more.js var version = '4.2.1.883', Version; Ext.Version = Version = Ext.extend(Object, { /** * @param {String/Number} version The version number in the following standard format: * * major[.minor[.patch[.build[release]]]] * * Examples: * * 1.0 * 1.2.3beta * 1.2.3.4RC * * @return {Ext.Version} this */ constructor: function(version) { var parts, releaseStartIndex; if (version instanceof Version) { return version; } this.version = this.shortVersion = String(version).toLowerCase().replace(/_/g, '.').replace(/[\-+]/g, ''); releaseStartIndex = this.version.search(/([^\d\.])/); if (releaseStartIndex !== -1) { this.release = this.version.substr(releaseStartIndex, version.length); this.shortVersion = this.version.substr(0, releaseStartIndex); } this.shortVersion = this.shortVersion.replace(/[^\d]/g, ''); parts = this.version.split('.'); this.major = parseInt(parts.shift() || 0, 10); this.minor = parseInt(parts.shift() || 0, 10); this.patch = parseInt(parts.shift() || 0, 10); this.build = parseInt(parts.shift() || 0, 10); return this; }, /** * Override the native toString method * @private * @return {String} version */ toString: function() { return this.version; }, /** * Override the native valueOf method * @private * @return {String} version */ valueOf: function() { return this.version; }, /** * Returns the major component value * @return {Number} major */ getMajor: function() { return this.major || 0; }, /** * Returns the minor component value * @return {Number} minor */ getMinor: function() { return this.minor || 0; }, /** * Returns the patch component value * @return {Number} patch */ getPatch: function() { return this.patch || 0; }, /** * Returns the build component value * @return {Number} build */ getBuild: function() { return this.build || 0; }, /** * Returns the release component value * @return {Number} release */ getRelease: function() { return this.release || ''; }, /** * Returns whether this version if greater than the supplied argument * @param {String/Number} target The version to compare with * @return {Boolean} True if this version if greater than the target, false otherwise */ isGreaterThan: function(target) { return Version.compare(this.version, target) === 1; }, /** * Returns whether this version if greater than or equal to the supplied argument * @param {String/Number} target The version to compare with * @return {Boolean} True if this version if greater than or equal to the target, false otherwise */ isGreaterThanOrEqual: function(target) { return Version.compare(this.version, target) >= 0; }, /** * Returns whether this version if smaller than the supplied argument * @param {String/Number} target The version to compare with * @return {Boolean} True if this version if smaller than the target, false otherwise */ isLessThan: function(target) { return Version.compare(this.version, target) === -1; }, /** * Returns whether this version if less than or equal to the supplied argument * @param {String/Number} target The version to compare with * @return {Boolean} True if this version if less than or equal to the target, false otherwise */ isLessThanOrEqual: function(target) { return Version.compare(this.version, target) <= 0; }, /** * Returns whether this version equals to the supplied argument * @param {String/Number} target The version to compare with * @return {Boolean} True if this version equals to the target, false otherwise */ equals: function(target) { return Version.compare(this.version, target) === 0; }, /** * Returns whether this version matches the supplied argument. Example: * * var version = new Ext.Version('1.0.2beta'); * console.log(version.match(1)); // True * console.log(version.match(1.0)); // True * console.log(version.match('1.0.2')); // True * console.log(version.match('1.0.2RC')); // False * * @param {String/Number} target The version to compare with * @return {Boolean} True if this version matches the target, false otherwise */ match: function(target) { target = String(target); return this.version.substr(0, target.length) === target; }, /** * Returns this format: [major, minor, patch, build, release]. Useful for comparison * @return {Number[]} */ toArray: function() { return [this.getMajor(), this.getMinor(), this.getPatch(), this.getBuild(), this.getRelease()]; }, /** * Returns shortVersion version without dots and release * @return {String} */ getShortVersion: function() { return this.shortVersion; }, /** * Convenient alias to {@link Ext.Version#isGreaterThan isGreaterThan} * @param {String/Number} target * @return {Boolean} */ gt: function() { return this.isGreaterThan.apply(this, arguments); }, /** * Convenient alias to {@link Ext.Version#isLessThan isLessThan} * @param {String/Number} target * @return {Boolean} */ lt: function() { return this.isLessThan.apply(this, arguments); }, /** * Convenient alias to {@link Ext.Version#isGreaterThanOrEqual isGreaterThanOrEqual} * @param {String/Number} target * @return {Boolean} */ gtEq: function() { return this.isGreaterThanOrEqual.apply(this, arguments); }, /** * Convenient alias to {@link Ext.Version#isLessThanOrEqual isLessThanOrEqual} * @param {String/Number} target * @return {Boolean} */ ltEq: function() { return this.isLessThanOrEqual.apply(this, arguments); } }); Ext.apply(Version, { // @private releaseValueMap: { 'dev': -6, 'alpha': -5, 'a': -5, 'beta': -4, 'b': -4, 'rc': -3, '#': -2, 'p': -1, 'pl': -1 }, /** * Converts a version component to a comparable value * * @static * @param {Object} value The value to convert * @return {Object} */ getComponentValue: function(value) { return !value ? 0 : (isNaN(value) ? this.releaseValueMap[value] || value : parseInt(value, 10)); }, /** * Compare 2 specified versions, starting from left to right. If a part contains special version strings, * they are handled in the following order: * 'dev' < 'alpha' = 'a' < 'beta' = 'b' < 'RC' = 'rc' < '#' < 'pl' = 'p' < 'anything else' * * @static * @param {String} current The current version to compare to * @param {String} target The target version to compare to * @return {Number} Returns -1 if the current version is smaller than the target version, 1 if greater, and 0 if they're equivalent */ compare: function(current, target) { var currentValue, targetValue, i; current = new Version(current).toArray(); target = new Version(target).toArray(); for (i = 0; i < Math.max(current.length, target.length); i++) { currentValue = this.getComponentValue(current[i]); targetValue = this.getComponentValue(target[i]); if (currentValue < targetValue) { return -1; } else if (currentValue > targetValue) { return 1; } } return 0; } }); /** * @class Ext */ Ext.apply(Ext, { /** * @private */ versions: {}, /** * @private */ lastRegisteredVersion: null, /** * Set version number for the given package name. * * @param {String} packageName The package name, for example: 'core', 'touch', 'extjs' * @param {String/Ext.Version} version The version, for example: '1.2.3alpha', '2.4.0-dev' * @return {Ext} */ setVersion: function(packageName, version) { Ext.versions[packageName] = new Version(version); Ext.lastRegisteredVersion = Ext.versions[packageName]; return this; }, /** * Get the version number of the supplied package name; will return the last registered version * (last Ext.setVersion call) if there's no package name given. * * @param {String} packageName (Optional) The package name, for example: 'core', 'touch', 'extjs' * @return {Ext.Version} The version */ getVersion: function(packageName) { if (packageName === undefined) { return Ext.lastRegisteredVersion; } return Ext.versions[packageName]; }, /** * Create a closure for deprecated code. * * // This means Ext.oldMethod is only supported in 4.0.0beta and older. * // If Ext.getVersion('extjs') returns a version that is later than '4.0.0beta', for example '4.0.0RC', * // the closure will not be invoked * Ext.deprecate('extjs', '4.0.0beta', function() { * Ext.oldMethod = Ext.newMethod; * * ... * }); * * @param {String} packageName The package name * @param {String} since The last version before it's deprecated * @param {Function} closure The callback function to be executed with the specified version is less than the current version * @param {Object} scope The execution scope (`this`) if the closure */ deprecate: function(packageName, since, closure, scope) { if (Version.compare(Ext.getVersion(packageName), since) < 1) { closure.call(scope); } } }); // End Versioning Ext.setVersion('core', version); }()); // @tag foundation,core // @require ../version/Version.js // @define Ext.String /** * @class Ext.String * * A collection of useful static methods to deal with strings. * @singleton */ Ext.String = (function() { var trimRegex = /^[\x09\x0a\x0b\x0c\x0d\x20\xa0\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000]+|[\x09\x0a\x0b\x0c\x0d\x20\xa0\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000]+$/g, escapeRe = /('|\\)/g, formatRe = /\{(\d+)\}/g, escapeRegexRe = /([-.*+?\^${}()|\[\]\/\\])/g, basicTrimRe = /^\s+|\s+$/g, whitespaceRe = /\s+/, varReplace = /(^[^a-z]*|[^\w])/gi, charToEntity, entityToChar, charToEntityRegex, entityToCharRegex, htmlEncodeReplaceFn = function(match, capture) { return charToEntity[capture]; }, htmlDecodeReplaceFn = function(match, capture) { return (capture in entityToChar) ? entityToChar[capture] : String.fromCharCode(parseInt(capture.substr(2), 10)); }, boundsCheck = function(s, other){ if (s === null || s === undefined || other === null || other === undefined) { return false; } return other.length <= s.length; }; return { /** * Inserts a substring into a string. * @param {String} s The original string. * @param {String} value The substring to insert. * @param {Number} index The index to insert the substring. Negative indexes will insert from the end of * the string. Example: * * Ext.String.insert("abcdefg", "h", -1); // abcdefhg * * @return {String} The value with the inserted substring */ insert: function(s, value, index) { if (!s) { return value; } if (!value) { return s; } var len = s.length; if (!index && index !== 0) { index = len; } if (index < 0) { index *= -1; if (index >= len) { // negative overflow, insert at start index = 0; } else { index = len - index; } } if (index === 0) { s = value + s; } else if (index >= s.length) { s += value; } else { s = s.substr(0, index) + value + s.substr(index); } return s; }, /** * Checks if a string starts with a substring * @param {String} s The original string * @param {String} start The substring to check * @param {Boolean} [ignoreCase=false] True to ignore the case in the comparison */ startsWith: function(s, start, ignoreCase){ var result = boundsCheck(s, start); if (result) { if (ignoreCase) { s = s.toLowerCase(); start = start.toLowerCase(); } result = s.lastIndexOf(start, 0) === 0; } return result; }, /** * Checks if a string ends with a substring * @param {String} s The original string * @param {String} start The substring to check * @param {Boolean} [ignoreCase=false] True to ignore the case in the comparison */ endsWith: function(s, end, ignoreCase){ var result = boundsCheck(s, end); if (result) { if (ignoreCase) { s = s.toLowerCase(); end = end.toLowerCase(); } result = s.indexOf(end, s.length - end.length) !== -1; } return result; }, /** * Converts a string of characters into a legal, parse-able JavaScript `var` name as long as the passed * string contains at least one alphabetic character. Non alphanumeric characters, and *leading* non alphabetic * characters will be removed. * @param {String} s A string to be converted into a `var` name. * @return {String} A legal JavaScript `var` name. */ createVarName: function(s) { return s.replace(varReplace, ''); }, /** * Convert certain characters (&, <, >, ', and ") to their HTML character equivalents for literal display in web pages. * @param {String} value The string to encode. * @return {String} The encoded text. * @method */ htmlEncode: function(value) { return (!value) ? value : String(value).replace(charToEntityRegex, htmlEncodeReplaceFn); }, /** * Convert certain characters (&, <, >, ', and ") from their HTML character equivalents. * @param {String} value The string to decode. * @return {String} The decoded text. * @method */ htmlDecode: function(value) { return (!value) ? value : String(value).replace(entityToCharRegex, htmlDecodeReplaceFn); }, /** * Adds a set of character entity definitions to the set used by * {@link Ext.String#htmlEncode} and {@link Ext.String#htmlDecode}. * * This object should be keyed by the entity name sequence, * with the value being the textual representation of the entity. * * Ext.String.addCharacterEntities({ * '&Uuml;':'Ü', * '&ccedil;':'ç', * '&ntilde;':'ñ', * '&egrave;':'è' * }); * var s = Ext.String.htmlEncode("A string with entities: èÜçñ"); * * __Note:__ the values of the character entities defined on this object are expected * to be single character values. As such, the actual values represented by the * characters are sensitive to the character encoding of the JavaScript source * file when defined in string literal form. Script tags referencing server * resources with character entities must ensure that the 'charset' attribute * of the script node is consistent with the actual character encoding of the * server resource. * * The set of character entities may be reset back to the default state by using * the {@link Ext.String#resetCharacterEntities} method * * @param {Object} entities The set of character entities to add to the current * definitions. */ addCharacterEntities: function(newEntities) { var charKeys = [], entityKeys = [], key, echar; for (key in newEntities) { echar = newEntities[key]; entityToChar[key] = echar; charToEntity[echar] = key; charKeys.push(echar); entityKeys.push(key); } charToEntityRegex = new RegExp('(' + charKeys.join('|') + ')', 'g'); entityToCharRegex = new RegExp('(' + entityKeys.join('|') + '|&#[0-9]{1,5};' + ')', 'g'); }, /** * Resets the set of character entity definitions used by * {@link Ext.String#htmlEncode} and {@link Ext.String#htmlDecode} back to the * default state. */ resetCharacterEntities: function() { charToEntity = {}; entityToChar = {}; // add the default set this.addCharacterEntities({ '&' : '&', '>' : '>', '<' : '<', '"' : '"', ''' : "'" }); }, /** * Appends content to the query string of a URL, handling logic for whether to place * a question mark or ampersand. * @param {String} url The URL to append to. * @param {String} string The content to append to the URL. * @return {String} The resulting URL */ urlAppend : function(url, string) { if (!Ext.isEmpty(string)) { return url + (url.indexOf('?') === -1 ? '?' : '&') + string; } return url; }, /** * Trims whitespace from either end of a string, leaving spaces within the string intact. Example: * * var s = ' foo bar '; * alert('-' + s + '-'); //alerts "- foo bar -" * alert('-' + Ext.String.trim(s) + '-'); //alerts "-foo bar-" * * @param {String} string The string to trim. * @return {String} The trimmed string. */ trim: function(string) { return string.replace(trimRegex, ""); }, /** * Capitalize the given string * @param {String} string * @return {String} */ capitalize: function(string) { return string.charAt(0).toUpperCase() + string.substr(1); }, /** * Uncapitalize the given string. * @param {String} string * @return {String} */ uncapitalize: function(string) { return string.charAt(0).toLowerCase() + string.substr(1); }, /** * Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length. * @param {String} value The string to truncate. * @param {Number} length The maximum length to allow before truncating. * @param {Boolean} [word=false] `true` to try to find a common word break. * @return {String} The converted text. */ ellipsis: function(value, len, word) { if (value && value.length > len) { if (word) { var vs = value.substr(0, len - 2), index = Math.max(vs.lastIndexOf(' '), vs.lastIndexOf('.'), vs.lastIndexOf('!'), vs.lastIndexOf('?')); if (index !== -1 && index >= (len - 15)) { return vs.substr(0, index) + "..."; } } return value.substr(0, len - 3) + "..."; } return value; }, /** * Escapes the passed string for use in a regular expression. * @param {String} string * @return {String} */ escapeRegex: function(string) { return string.replace(escapeRegexRe, "\\$1"); }, /** * Escapes the passed string for ' and \ * @param {String} string The string to escape * @return {String} The escaped string */ escape: function(string) { return string.replace(escapeRe, "\\$1"); }, /** * Utility function that allows you to easily switch a string between two alternating values. The passed value * is compared to the current string, and if they are equal, the other value that was passed in is returned. If * they are already different, the first value passed in is returned. Note that this method returns the new value * but does not change the current string. * * // alternate sort directions * sort = Ext.String.toggle(sort, 'ASC', 'DESC'); * * // instead of conditional logic: * sort = (sort === 'ASC' ? 'DESC' : 'ASC'); * * @param {String} string The current string. * @param {String} value The value to compare to the current string. * @param {String} other The new value to use if the string already equals the first value passed in. * @return {String} The new value. */ toggle: function(string, value, other) { return string === value ? other : value; }, /** * Pads the left side of a string with a specified character. This is especially useful * for normalizing number and date strings. Example usage: * * var s = Ext.String.leftPad('123', 5, '0'); * // s now contains the string: '00123' * * @param {String} string The original string. * @param {Number} size The total length of the output string. * @param {String} [character=' '] (optional) The character with which to pad the original string. * @return {String} The padded string. */ leftPad: function(string, size, character) { var result = String(string); character = character || " "; while (result.length < size) { result = character + result; } return result; }, /** * Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each * token must be unique, and must increment in the format {0}, {1}, etc. Example usage: * * var cls = 'my-class', * text = 'Some text'; * var s = Ext.String.format('
{1}
', cls, text); * // s now contains the string: '
Some text
' * * @param {String} string The tokenized string to be formatted. * @param {Mixed...} values The values to replace tokens `{0}`, `{1}`, etc in order. * @return {String} The formatted string. */ format: function(format) { var args = Ext.Array.toArray(arguments, 1); return format.replace(formatRe, function(m, i) { return args[i]; }); }, /** * Returns a string with a specified number of repetitions a given string pattern. * The pattern be separated by a different string. * * var s = Ext.String.repeat('---', 4); // = '------------' * var t = Ext.String.repeat('--', 3, '/'); // = '--/--/--' * * @param {String} pattern The pattern to repeat. * @param {Number} count The number of times to repeat the pattern (may be 0). * @param {String} sep An option string to separate each pattern. */ repeat: function(pattern, count, sep) { if (count < 1) { count = 0; } for (var buf = [], i = count; i--; ) { buf.push(pattern); } return buf.join(sep || ''); }, /** * Splits a string of space separated words into an array, trimming as needed. If the * words are already an array, it is returned. * * @param {String/Array} words */ splitWords: function (words) { if (words && typeof words == 'string') { return words.replace(basicTrimRe, '').split(whitespaceRe); } return words || []; } }; }()); // initialize the default encode / decode entities Ext.String.resetCharacterEntities(); /** * Old alias to {@link Ext.String#htmlEncode} * @deprecated Use {@link Ext.String#htmlEncode} instead * @method * @member Ext * @inheritdoc Ext.String#htmlEncode */ Ext.htmlEncode = Ext.String.htmlEncode; /** * Old alias to {@link Ext.String#htmlDecode} * @deprecated Use {@link Ext.String#htmlDecode} instead * @method * @member Ext * @inheritdoc Ext.String#htmlDecode */ Ext.htmlDecode = Ext.String.htmlDecode; /** * Old alias to {@link Ext.String#urlAppend} * @deprecated Use {@link Ext.String#urlAppend} instead * @method * @member Ext * @inheritdoc Ext.String#urlAppend */ Ext.urlAppend = Ext.String.urlAppend; // @tag foundation,core // @require String.js // @define Ext.Number /** * @class Ext.Number * * A collection of useful static methods to deal with numbers * @singleton */ Ext.Number = new function() { var me = this, isToFixedBroken = (0.9).toFixed() !== '1', math = Math; Ext.apply(this, { /** * Checks whether or not the passed number is within a desired range. If the number is already within the * range it is returned, otherwise the min or max value is returned depending on which side of the range is * exceeded. Note that this method returns the constrained value but does not change the current number. * @param {Number} number The number to check * @param {Number} min The minimum number in the range * @param {Number} max The maximum number in the range * @return {Number} The constrained value if outside the range, otherwise the current value */ constrain: function(number, min, max) { var x = parseFloat(number); // Watch out for NaN in Chrome 18 // V8bug: http://code.google.com/p/v8/issues/detail?id=2056 // Operators are faster than Math.min/max. See http://jsperf.com/number-constrain // ... and (x < Nan) || (x < undefined) == false // ... same for (x > NaN) || (x > undefined) // so if min or max are undefined or NaN, we never return them... sadly, this // is not true of null (but even Math.max(-1,null)==0 and isNaN(null)==false) return (x < min) ? min : ((x > max) ? max : x); }, /** * Snaps the passed number between stopping points based upon a passed increment value. * * The difference between this and {@link #snapInRange} is that {@link #snapInRange} uses the minValue * when calculating snap points: * * r = Ext.Number.snap(56, 2, 55, 65); // Returns 56 - snap points are zero based * * r = Ext.Number.snapInRange(56, 2, 55, 65); // Returns 57 - snap points are based from minValue * * @param {Number} value The unsnapped value. * @param {Number} increment The increment by which the value must move. * @param {Number} minValue The minimum value to which the returned value must be constrained. Overrides the increment. * @param {Number} maxValue The maximum value to which the returned value must be constrained. Overrides the increment. * @return {Number} The value of the nearest snap target. */ snap : function(value, increment, minValue, maxValue) { var m; // If no value passed, or minValue was passed and value is less than minValue (anything < undefined is false) // Then use the minValue (or zero if the value was undefined) if (value === undefined || value < minValue) { return minValue || 0; } if (increment) { m = value % increment; if (m !== 0) { value -= m; if (m * 2 >= increment) { value += increment; } else if (m * 2 < -increment) { value -= increment; } } } return me.constrain(value, minValue, maxValue); }, /** * Snaps the passed number between stopping points based upon a passed increment value. * * The difference between this and {@link #snap} is that {@link #snap} does not use the minValue * when calculating snap points: * * r = Ext.Number.snap(56, 2, 55, 65); // Returns 56 - snap points are zero based * * r = Ext.Number.snapInRange(56, 2, 55, 65); // Returns 57 - snap points are based from minValue * * @param {Number} value The unsnapped value. * @param {Number} increment The increment by which the value must move. * @param {Number} [minValue=0] The minimum value to which the returned value must be constrained. * @param {Number} [maxValue=Infinity] The maximum value to which the returned value must be constrained. * @return {Number} The value of the nearest snap target. */ snapInRange : function(value, increment, minValue, maxValue) { var tween; // default minValue to zero minValue = (minValue || 0); // If value is undefined, or less than minValue, use minValue if (value === undefined || value < minValue) { return minValue; } // Calculate how many snap points from the minValue the passed value is. if (increment && (tween = ((value - minValue) % increment))) { value -= tween; tween *= 2; if (tween >= increment) { value += increment; } } // If constraining within a maximum, ensure the maximum is on a snap point if (maxValue !== undefined) { if (value > (maxValue = me.snapInRange(maxValue, increment, minValue))) { value = maxValue; } } return value; }, /** * Formats a number using fixed-point notation * @param {Number} value The number to format * @param {Number} precision The number of digits to show after the decimal point */ toFixed: isToFixedBroken ? function(value, precision) { precision = precision || 0; var pow = math.pow(10, precision); return (math.round(value * pow) / pow).toFixed(precision); } : function(value, precision) { return value.toFixed(precision); }, /** * Validate that a value is numeric and convert it to a number if necessary. Returns the specified default value if * it is not. Ext.Number.from('1.23', 1); // returns 1.23 Ext.Number.from('abc', 1); // returns 1 * @param {Object} value * @param {Number} defaultValue The value to return if the original value is non-numeric * @return {Number} value, if numeric, defaultValue otherwise */ from: function(value, defaultValue) { if (isFinite(value)) { value = parseFloat(value); } return !isNaN(value) ? value : defaultValue; }, /** * Returns a random integer between the specified range (inclusive) * @param {Number} from Lowest value to return. * @param {Number} to Highst value to return. * @return {Number} A random integer within the specified range. */ randomInt: function (from, to) { return math.floor(math.random() * (to - from + 1) + from); }, /** * Corrects floating point numbers that overflow to a non-precise * value because of their floating nature, for example `0.1 + 0.2` * @param {Number} The number * @return {Number} The correctly rounded number */ correctFloat: function(n) { // This is to correct the type of errors where 2 floats end with // a long string of decimals, eg 0.1 + 0.2. When they overflow in this // manner, they usually go to 15-16 decimals, so we cut it off at 14. return parseFloat(n.toPrecision(14)); } }); /** * @deprecated 4.0.0 Please use {@link Ext.Number#from} instead. * @member Ext * @method num * @inheritdoc Ext.Number#from */ Ext.num = function() { return me.from.apply(this, arguments); }; }; // @tag foundation,core // @require Number.js // @define Ext.Array /** * @class Ext.Array * @singleton * @author Jacky Nguyen * @docauthor Jacky Nguyen * * A set of useful static methods to deal with arrays; provide missing methods for older browsers. */ (function() { var arrayPrototype = Array.prototype, slice = arrayPrototype.slice, supportsSplice = (function () { var array = [], lengthBefore, j = 20; if (!array.splice) { return false; } // This detects a bug in IE8 splice method: // see http://social.msdn.microsoft.com/Forums/en-US/iewebdevelopment/thread/6e946d03-e09f-4b22-a4dd-cd5e276bf05a/ while (j--) { array.push("A"); } array.splice(15, 0, "F", "F", "F", "F", "F","F","F","F","F","F","F","F","F","F","F","F","F","F","F","F","F"); lengthBefore = array.length; //41 array.splice(13, 0, "XXX"); // add one element if (lengthBefore+1 != array.length) { return false; } // end IE8 bug return true; }()), supportsForEach = 'forEach' in arrayPrototype, supportsMap = 'map' in arrayPrototype, supportsIndexOf = 'indexOf' in arrayPrototype, supportsEvery = 'every' in arrayPrototype, supportsSome = 'some' in arrayPrototype, supportsFilter = 'filter' in arrayPrototype, supportsSort = (function() { var a = [1,2,3,4,5].sort(function(){ return 0; }); return a[0] === 1 && a[1] === 2 && a[2] === 3 && a[3] === 4 && a[4] === 5; }()), supportsSliceOnNodeList = true, ExtArray, erase, replace, splice; try { // IE 6 - 8 will throw an error when using Array.prototype.slice on NodeList if (typeof document !== 'undefined') { slice.call(document.getElementsByTagName('body')); } } catch (e) { supportsSliceOnNodeList = false; } function fixArrayIndex (array, index) { return (index < 0) ? Math.max(0, array.length + index) : Math.min(array.length, index); } /* Does the same work as splice, but with a slightly more convenient signature. The splice method has bugs in IE8, so this is the implementation we use on that platform. The rippling of items in the array can be tricky. Consider two use cases: index=2 removeCount=2 /=====\ +---+---+---+---+---+---+---+---+ | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | +---+---+---+---+---+---+---+---+ / \/ \/ \/ \ / /\ /\ /\ \ / / \/ \/ \ +--------------------------+ / / /\ /\ +--------------------------+ \ / / / \/ +--------------------------+ \ \ / / / /+--------------------------+ \ \ \ / / / / \ \ \ \ v v v v v v v v +---+---+---+---+---+---+ +---+---+---+---+---+---+---+---+---+ | 0 | 1 | 4 | 5 | 6 | 7 | | 0 | 1 | a | b | c | 4 | 5 | 6 | 7 | +---+---+---+---+---+---+ +---+---+---+---+---+---+---+---+---+ A B \=========/ insert=[a,b,c] In case A, it is obvious that copying of [4,5,6,7] must be left-to-right so that we don't end up with [0,1,6,7,6,7]. In case B, we have the opposite; we must go right-to-left or else we would end up with [0,1,a,b,c,4,4,4,4]. */ function replaceSim (array, index, removeCount, insert) { var add = insert ? insert.length : 0, length = array.length, pos = fixArrayIndex(array, index), remove, tailOldPos, tailNewPos, tailCount, lengthAfterRemove, i; // we try to use Array.push when we can for efficiency... if (pos === length) { if (add) { array.push.apply(array, insert); } } else { remove = Math.min(removeCount, length - pos); tailOldPos = pos + remove; tailNewPos = tailOldPos + add - remove; tailCount = length - tailOldPos; lengthAfterRemove = length - remove; if (tailNewPos < tailOldPos) { // case A for (i = 0; i < tailCount; ++i) { array[tailNewPos+i] = array[tailOldPos+i]; } } else if (tailNewPos > tailOldPos) { // case B for (i = tailCount; i--; ) { array[tailNewPos+i] = array[tailOldPos+i]; } } // else, add == remove (nothing to do) if (add && pos === lengthAfterRemove) { array.length = lengthAfterRemove; // truncate array array.push.apply(array, insert); } else { array.length = lengthAfterRemove + add; // reserves space for (i = 0; i < add; ++i) { array[pos+i] = insert[i]; } } } return array; } function replaceNative (array, index, removeCount, insert) { if (insert && insert.length) { // Inserting at index zero with no removing: use unshift if (index === 0 && !removeCount) { array.unshift.apply(array, insert); } // Inserting/replacing in middle of array else if (index < array.length) { array.splice.apply(array, [index, removeCount].concat(insert)); } // Appending to array else { array.push.apply(array, insert); } } else { array.splice(index, removeCount); } return array; } function eraseSim (array, index, removeCount) { return replaceSim(array, index, removeCount); } function eraseNative (array, index, removeCount) { array.splice(index, removeCount); return array; } function spliceSim (array, index, removeCount) { var pos = fixArrayIndex(array, index), removed = array.slice(index, fixArrayIndex(array, pos+removeCount)); if (arguments.length < 4) { replaceSim(array, pos, removeCount); } else { replaceSim(array, pos, removeCount, slice.call(arguments, 3)); } return removed; } function spliceNative (array) { return array.splice.apply(array, slice.call(arguments, 1)); } erase = supportsSplice ? eraseNative : eraseSim; replace = supportsSplice ? replaceNative : replaceSim; splice = supportsSplice ? spliceNative : spliceSim; // NOTE: from here on, use erase, replace or splice (not native methods)... ExtArray = Ext.Array = { /** * Iterates an array or an iterable value and invoke the given callback function for each item. * * var countries = ['Vietnam', 'Singapore', 'United States', 'Russia']; * * Ext.Array.each(countries, function(name, index, countriesItSelf) { * console.log(name); * }); * * var sum = function() { * var sum = 0; * * Ext.Array.each(arguments, function(value) { * sum += value; * }); * * return sum; * }; * * sum(1, 2, 3); // returns 6 * * The iteration can be stopped by returning false in the function callback. * * Ext.Array.each(countries, function(name, index, countriesItSelf) { * if (name === 'Singapore') { * return false; // break here * } * }); * * {@link Ext#each Ext.each} is alias for {@link Ext.Array#each Ext.Array.each} * * @param {Array/NodeList/Object} iterable The value to be iterated. If this * argument is not iterable, the callback function is called once. * @param {Function} fn The callback function. If it returns false, the iteration stops and this method returns * the current `index`. * @param {Object} fn.item The item at the current `index` in the passed `array` * @param {Number} fn.index The current `index` within the `array` * @param {Array} fn.allItems The `array` itself which was passed as the first argument * @param {Boolean} fn.return Return false to stop iteration. * @param {Object} scope (Optional) The scope (`this` reference) in which the specified function is executed. * @param {Boolean} reverse (Optional) Reverse the iteration order (loop from the end to the beginning) * Defaults false * @return {Boolean} See description for the `fn` parameter. */ each: function(array, fn, scope, reverse) { array = ExtArray.from(array); var i, ln = array.length; if (reverse !== true) { for (i = 0; i < ln; i++) { if (fn.call(scope || array[i], array[i], i, array) === false) { return i; } } } else { for (i = ln - 1; i > -1; i--) { if (fn.call(scope || array[i], array[i], i, array) === false) { return i; } } } return true; }, /** * Iterates an array and invoke the given callback function for each item. Note that this will simply * delegate to the native Array.prototype.forEach method if supported. It doesn't support stopping the * iteration by returning false in the callback function like {@link Ext.Array#each}. However, performance * could be much better in modern browsers comparing with {@link Ext.Array#each} * * @param {Array} array The array to iterate * @param {Function} fn The callback function. * @param {Object} fn.item The item at the current `index` in the passed `array` * @param {Number} fn.index The current `index` within the `array` * @param {Array} fn.allItems The `array` itself which was passed as the first argument * @param {Object} scope (Optional) The execution scope (`this`) in which the specified function is executed. */ forEach: supportsForEach ? function(array, fn, scope) { array.forEach(fn, scope); } : function(array, fn, scope) { var i = 0, ln = array.length; for (; i < ln; i++) { fn.call(scope, array[i], i, array); } }, /** * Get the index of the provided `item` in the given `array`, a supplement for the * missing arrayPrototype.indexOf in Internet Explorer. * * @param {Array} array The array to check * @param {Object} item The item to look for * @param {Number} from (Optional) The index at which to begin the search * @return {Number} The index of item in the array (or -1 if it is not found) */ indexOf: supportsIndexOf ? function(array, item, from) { return arrayPrototype.indexOf.call(array, item, from); } : function(array, item, from) { var i, length = array.length; for (i = (from < 0) ? Math.max(0, length + from) : from || 0; i < length; i++) { if (array[i] === item) { return i; } } return -1; }, /** * Checks whether or not the given `array` contains the specified `item` * * @param {Array} array The array to check * @param {Object} item The item to look for * @return {Boolean} True if the array contains the item, false otherwise */ contains: supportsIndexOf ? function(array, item) { return arrayPrototype.indexOf.call(array, item) !== -1; } : function(array, item) { var i, ln; for (i = 0, ln = array.length; i < ln; i++) { if (array[i] === item) { return true; } } return false; }, /** * Converts any iterable (numeric indices and a length property) into a true array. * * function test() { * var args = Ext.Array.toArray(arguments), * fromSecondToLastArgs = Ext.Array.toArray(arguments, 1); * * alert(args.join(' ')); * alert(fromSecondToLastArgs.join(' ')); * } * * test('just', 'testing', 'here'); // alerts 'just testing here'; * // alerts 'testing here'; * * Ext.Array.toArray(document.getElementsByTagName('div')); // will convert the NodeList into an array * Ext.Array.toArray('splitted'); // returns ['s', 'p', 'l', 'i', 't', 't', 'e', 'd'] * Ext.Array.toArray('splitted', 0, 3); // returns ['s', 'p', 'l'] * * {@link Ext#toArray Ext.toArray} is alias for {@link Ext.Array#toArray Ext.Array.toArray} * * @param {Object} iterable the iterable object to be turned into a true Array. * @param {Number} start (Optional) a zero-based index that specifies the start of extraction. Defaults to 0 * @param {Number} end (Optional) a 1-based index that specifies the end of extraction. Defaults to the last * index of the iterable value * @return {Array} array */ toArray: function(iterable, start, end){ if (!iterable || !iterable.length) { return []; } if (typeof iterable === 'string') { iterable = iterable.split(''); } if (supportsSliceOnNodeList) { return slice.call(iterable, start || 0, end || iterable.length); } var array = [], i; start = start || 0; end = end ? ((end < 0) ? iterable.length + end : end) : iterable.length; for (i = start; i < end; i++) { array.push(iterable[i]); } return array; }, /** * Plucks the value of a property from each item in the Array. Example: * * Ext.Array.pluck(Ext.query("p"), "className"); // [el1.className, el2.className, ..., elN.className] * * @param {Array/NodeList} array The Array of items to pluck the value from. * @param {String} propertyName The property name to pluck from each element. * @return {Array} The value from each item in the Array. */ pluck: function(array, propertyName) { var ret = [], i, ln, item; for (i = 0, ln = array.length; i < ln; i++) { item = array[i]; ret.push(item[propertyName]); } return ret; }, /** * Creates a new array with the results of calling a provided function on every element in this array. * * @param {Array} array * @param {Function} fn Callback function for each item * @param {Mixed} fn.item Current item. * @param {Number} fn.index Index of the item. * @param {Array} fn.array The whole array that's being iterated. * @param {Object} [scope] Callback function scope * @return {Array} results */ map: supportsMap ? function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.map must have a callback function passed as second argument.'); } return array.map(fn, scope); } : function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.map must have a callback function passed as second argument.'); } var results = [], i = 0, len = array.length; for (; i < len; i++) { results[i] = fn.call(scope, array[i], i, array); } return results; }, /** * Executes the specified function for each array element until the function returns a falsy value. * If such an item is found, the function will return false immediately. * Otherwise, it will return true. * * @param {Array} array * @param {Function} fn Callback function for each item * @param {Mixed} fn.item Current item. * @param {Number} fn.index Index of the item. * @param {Array} fn.array The whole array that's being iterated. * @param {Object} scope Callback function scope * @return {Boolean} True if no false value is returned by the callback function. */ every: supportsEvery ? function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.every must have a callback function passed as second argument.'); } return array.every(fn, scope); } : function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.every must have a callback function passed as second argument.'); } var i = 0, ln = array.length; for (; i < ln; ++i) { if (!fn.call(scope, array[i], i, array)) { return false; } } return true; }, /** * Executes the specified function for each array element until the function returns a truthy value. * If such an item is found, the function will return true immediately. Otherwise, it will return false. * * @param {Array} array * @param {Function} fn Callback function for each item * @param {Mixed} fn.item Current item. * @param {Number} fn.index Index of the item. * @param {Array} fn.array The whole array that's being iterated. * @param {Object} scope Callback function scope * @return {Boolean} True if the callback function returns a truthy value. */ some: supportsSome ? function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.some must have a callback function passed as second argument.'); } return array.some(fn, scope); } : function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.some must have a callback function passed as second argument.'); } var i = 0, ln = array.length; for (; i < ln; ++i) { if (fn.call(scope, array[i], i, array)) { return true; } } return false; }, /** * Shallow compares the contents of 2 arrays using strict equality. * @param {Array} array1 * @param {Array} array2 * @return {Boolean} `true` if the arrays are equal. */ equals: function(array1, array2) { var len1 = array1.length, len2 = array2.length, i; // Short circuit if the same array is passed twice if (array1 === array2) { return true; } if (len1 !== len2) { return false; } for (i = 0; i < len1; ++i) { if (array1[i] !== array2[i]) { return false; } } return true; }, /** * Filter through an array and remove empty item as defined in {@link Ext#isEmpty Ext.isEmpty} * * See {@link Ext.Array#filter} * * @param {Array} array * @return {Array} results */ clean: function(array) { var results = [], i = 0, ln = array.length, item; for (; i < ln; i++) { item = array[i]; if (!Ext.isEmpty(item)) { results.push(item); } } return results; }, /** * Returns a new array with unique items * * @param {Array} array * @return {Array} results */ unique: function(array) { var clone = [], i = 0, ln = array.length, item; for (; i < ln; i++) { item = array[i]; if (ExtArray.indexOf(clone, item) === -1) { clone.push(item); } } return clone; }, /** * Creates a new array with all of the elements of this array for which * the provided filtering function returns true. * * @param {Array} array * @param {Function} fn Callback function for each item * @param {Mixed} fn.item Current item. * @param {Number} fn.index Index of the item. * @param {Array} fn.array The whole array that's being iterated. * @param {Object} scope Callback function scope * @return {Array} results */ filter: supportsFilter ? function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.filter must have a filter function passed as second argument.'); } return array.filter(fn, scope); } : function(array, fn, scope) { if (!fn) { Ext.Error.raise('Ext.Array.filter must have a filter function passed as second argument.'); } var results = [], i = 0, ln = array.length; for (; i < ln; i++) { if (fn.call(scope, array[i], i, array)) { results.push(array[i]); } } return results; }, /** * Returns the first item in the array which elicits a true return value from the * passed selection function. * @param {Array} array The array to search * @param {Function} fn The selection function to execute for each item. * @param {Mixed} fn.item The array item. * @param {String} fn.index The index of the array item. * @param {Object} scope (optional) The scope (this reference) in which the * function is executed. Defaults to the array * @return {Object} The first item in the array which returned true from the selection * function, or null if none was found. */ findBy : function(array, fn, scope) { var i = 0, len = array.length; for (; i < len; i++) { if (fn.call(scope || array, array[i], i)) { return array[i]; } } return null; }, /** * Converts a value to an array if it's not already an array; returns: * * - An empty array if given value is `undefined` or `null` * - Itself if given value is already an array * - An array copy if given value is {@link Ext#isIterable iterable} (arguments, NodeList and alike) * - An array with one item which is the given value, otherwise * * @param {Object} value The value to convert to an array if it's not already is an array * @param {Boolean} newReference (Optional) True to clone the given array and return a new reference if necessary, * defaults to false * @return {Array} array */ from: function(value, newReference) { if (value === undefined || value === null) { return []; } if (Ext.isArray(value)) { return (newReference) ? slice.call(value) : value; } var type = typeof value; // Both strings and functions will have a length property. In phantomJS, NodeList // instances report typeof=='function' but don't have an apply method... if (value && value.length !== undefined && type !== 'string' && (type !== 'function' || !value.apply)) { return ExtArray.toArray(value); } return [value]; }, /** * Removes the specified item from the array if it exists * * @param {Array} array The array * @param {Object} item The item to remove * @return {Array} The passed array itself */ remove: function(array, item) { var index = ExtArray.indexOf(array, item); if (index !== -1) { erase(array, index, 1); } return array; }, /** * Push an item into the array only if the array doesn't contain it yet * * @param {Array} array The array * @param {Object} item The item to include */ include: function(array, item) { if (!ExtArray.contains(array, item)) { array.push(item); } }, /** * Clone a flat array without referencing the previous one. Note that this is different * from Ext.clone since it doesn't handle recursive cloning. It's simply a convenient, easy-to-remember method * for Array.prototype.slice.call(array) * * @param {Array} array The array * @return {Array} The clone array */ clone: function(array) { return slice.call(array); }, /** * Merge multiple arrays into one with unique items. * * {@link Ext.Array#union} is alias for {@link Ext.Array#merge} * * @param {Array} array1 * @param {Array} array2 * @param {Array} etc * @return {Array} merged */ merge: function() { var args = slice.call(arguments), array = [], i, ln; for (i = 0, ln = args.length; i < ln; i++) { array = array.concat(args[i]); } return ExtArray.unique(array); }, /** * Merge multiple arrays into one with unique items that exist in all of the arrays. * * @param {Array} array1 * @param {Array} array2 * @param {Array} etc * @return {Array} intersect */ intersect: function() { var intersection = [], arrays = slice.call(arguments), arraysLength, array, arrayLength, minArray, minArrayIndex, minArrayCandidate, minArrayLength, element, elementCandidate, elementCount, i, j, k; if (!arrays.length) { return intersection; } // Find the smallest array arraysLength = arrays.length; for (i = minArrayIndex = 0; i < arraysLength; i++) { minArrayCandidate = arrays[i]; if (!minArray || minArrayCandidate.length < minArray.length) { minArray = minArrayCandidate; minArrayIndex = i; } } minArray = ExtArray.unique(minArray); erase(arrays, minArrayIndex, 1); // Use the smallest unique'd array as the anchor loop. If the other array(s) do contain // an item in the small array, we're likely to find it before reaching the end // of the inner loop and can terminate the search early. minArrayLength = minArray.length; arraysLength = arrays.length; for (i = 0; i < minArrayLength; i++) { element = minArray[i]; elementCount = 0; for (j = 0; j < arraysLength; j++) { array = arrays[j]; arrayLength = array.length; for (k = 0; k < arrayLength; k++) { elementCandidate = array[k]; if (element === elementCandidate) { elementCount++; break; } } } if (elementCount === arraysLength) { intersection.push(element); } } return intersection; }, /** * Perform a set difference A-B by subtracting all items in array B from array A. * * @param {Array} arrayA * @param {Array} arrayB * @return {Array} difference */ difference: function(arrayA, arrayB) { var clone = slice.call(arrayA), ln = clone.length, i, j, lnB; for (i = 0,lnB = arrayB.length; i < lnB; i++) { for (j = 0; j < ln; j++) { if (clone[j] === arrayB[i]) { erase(clone, j, 1); j--; ln--; } } } return clone; }, /** * Returns a shallow copy of a part of an array. This is equivalent to the native * call "Array.prototype.slice.call(array, begin, end)". This is often used when "array" * is "arguments" since the arguments object does not supply a slice method but can * be the context object to Array.prototype.slice. * * @param {Array} array The array (or arguments object). * @param {Number} begin The index at which to begin. Negative values are offsets from * the end of the array. * @param {Number} end The index at which to end. The copied items do not include * end. Negative values are offsets from the end of the array. If end is omitted, * all items up to the end of the array are copied. * @return {Array} The copied piece of the array. * @method slice */ // Note: IE6 will return [] on slice.call(x, undefined). slice: ([1,2].slice(1, undefined).length ? function (array, begin, end) { return slice.call(array, begin, end); } : // at least IE6 uses arguments.length for variadic signature function (array, begin, end) { // After tested for IE 6, the one below is of the best performance // see http://jsperf.com/slice-fix if (typeof begin === 'undefined') { return slice.call(array); } if (typeof end === 'undefined') { return slice.call(array, begin); } return slice.call(array, begin, end); } ), /** * Sorts the elements of an Array. * By default, this method sorts the elements alphabetically and ascending. * * @param {Array} array The array to sort. * @param {Function} sortFn (optional) The comparison function. * @param {Mixed} sortFn.a An item to compare. * @param {Mixed} sortFn.b Another item to compare. * @return {Array} The sorted array. */ sort: supportsSort ? function(array, sortFn) { if (sortFn) { return array.sort(sortFn); } else { return array.sort(); } } : function(array, sortFn) { var length = array.length, i = 0, comparison, j, min, tmp; for (; i < length; i++) { min = i; for (j = i + 1; j < length; j++) { if (sortFn) { comparison = sortFn(array[j], array[min]); if (comparison < 0) { min = j; } } else if (array[j] < array[min]) { min = j; } } if (min !== i) { tmp = array[i]; array[i] = array[min]; array[min] = tmp; } } return array; }, /** * Recursively flattens into 1-d Array. Injects Arrays inline. * * @param {Array} array The array to flatten * @return {Array} The 1-d array. */ flatten: function(array) { var worker = []; function rFlatten(a) { var i, ln, v; for (i = 0, ln = a.length; i < ln; i++) { v = a[i]; if (Ext.isArray(v)) { rFlatten(v); } else { worker.push(v); } } return worker; } return rFlatten(array); }, /** * Returns the minimum value in the Array. * * @param {Array/NodeList} array The Array from which to select the minimum value. * @param {Function} comparisonFn (optional) a function to perform the comparision which determines minimization. * If omitted the "<" operator will be used. Note: gt = 1; eq = 0; lt = -1 * @param {Mixed} comparisonFn.min Current minimum value. * @param {Mixed} comparisonFn.item The value to compare with the current minimum. * @return {Object} minValue The minimum value */ min: function(array, comparisonFn) { var min = array[0], i, ln, item; for (i = 0, ln = array.length; i < ln; i++) { item = array[i]; if (comparisonFn) { if (comparisonFn(min, item) === 1) { min = item; } } else { if (item < min) { min = item; } } } return min; }, /** * Returns the maximum value in the Array. * * @param {Array/NodeList} array The Array from which to select the maximum value. * @param {Function} comparisonFn (optional) a function to perform the comparision which determines maximization. * If omitted the ">" operator will be used. Note: gt = 1; eq = 0; lt = -1 * @param {Mixed} comparisonFn.max Current maximum value. * @param {Mixed} comparisonFn.item The value to compare with the current maximum. * @return {Object} maxValue The maximum value */ max: function(array, comparisonFn) { var max = array[0], i, ln, item; for (i = 0, ln = array.length; i < ln; i++) { item = array[i]; if (comparisonFn) { if (comparisonFn(max, item) === -1) { max = item; } } else { if (item > max) { max = item; } } } return max; }, /** * Calculates the mean of all items in the array. * * @param {Array} array The Array to calculate the mean value of. * @return {Number} The mean. */ mean: function(array) { return array.length > 0 ? ExtArray.sum(array) / array.length : undefined; }, /** * Calculates the sum of all items in the given array. * * @param {Array} array The Array to calculate the sum value of. * @return {Number} The sum. */ sum: function(array) { var sum = 0, i, ln, item; for (i = 0,ln = array.length; i < ln; i++) { item = array[i]; sum += item; } return sum; }, /** * Creates a map (object) keyed by the elements of the given array. The values in * the map are the index+1 of the array element. For example: * * var map = Ext.Array.toMap(['a','b','c']); * * // map = { a: 1, b: 2, c: 3 }; * * Or a key property can be specified: * * var map = Ext.Array.toMap([ * { name: 'a' }, * { name: 'b' }, * { name: 'c' } * ], 'name'); * * // map = { a: 1, b: 2, c: 3 }; * * Lastly, a key extractor can be provided: * * var map = Ext.Array.toMap([ * { name: 'a' }, * { name: 'b' }, * { name: 'c' } * ], function (obj) { return obj.name.toUpperCase(); }); * * // map = { A: 1, B: 2, C: 3 }; * * @param {Array} array The Array to create the map from. * @param {String/Function} [getKey] Name of the object property to use * as a key or a function to extract the key. * @param {Object} [scope] Value of this inside callback. * @return {Object} The resulting map. */ toMap: function(array, getKey, scope) { var map = {}, i = array.length; if (!getKey) { while (i--) { map[array[i]] = i+1; } } else if (typeof getKey == 'string') { while (i--) { map[array[i][getKey]] = i+1; } } else { while (i--) { map[getKey.call(scope, array[i])] = i+1; } } return map; }, /** * Creates a map (object) keyed by a property of elements of the given array. The values in * the map are the array element. For example: * * var map = Ext.Array.toMap(['a','b','c']); * * // map = { a: 'a', b: 'b', c: 'c' }; * * Or a key property can be specified: * * var map = Ext.Array.toMap([ * { name: 'a' }, * { name: 'b' }, * { name: 'c' } * ], 'name'); * * // map = { a: {name: 'a'}, b: {name: 'b'}, c: {name: 'c'} }; * * Lastly, a key extractor can be provided: * * var map = Ext.Array.toMap([ * { name: 'a' }, * { name: 'b' }, * { name: 'c' } * ], function (obj) { return obj.name.toUpperCase(); }); * * // map = { A: {name: 'a'}, B: {name: 'b'}, C: {name: 'c'} }; * * @param {Array} array The Array to create the map from. * @param {String/Function} [getKey] Name of the object property to use * as a key or a function to extract the key. * @param {Object} [scope] Value of this inside callback. * @return {Object} The resulting map. */ toValueMap: function(array, getKey, scope) { var map = {}, i = array.length; if (!getKey) { while (i--) { map[array[i]] = array[i]; } } else if (typeof getKey == 'string') { while (i--) { map[array[i][getKey]] = array[i]; } } else { while (i--) { map[getKey.call(scope, array[i])] = array[i]; } } return map; }, _replaceSim: replaceSim, // for unit testing _spliceSim: spliceSim, /** * Removes items from an array. This is functionally equivalent to the splice method * of Array, but works around bugs in IE8's splice method and does not copy the * removed elements in order to return them (because very often they are ignored). * * @param {Array} array The Array on which to replace. * @param {Number} index The index in the array at which to operate. * @param {Number} removeCount The number of items to remove at index. * @return {Array} The array passed. * @method */ erase: erase, /** * Inserts items in to an array. * * @param {Array} array The Array in which to insert. * @param {Number} index The index in the array at which to operate. * @param {Array} items The array of items to insert at index. * @return {Array} The array passed. */ insert: function (array, index, items) { return replace(array, index, 0, items); }, /** * Replaces items in an array. This is functionally equivalent to the splice method * of Array, but works around bugs in IE8's splice method and is often more convenient * to call because it accepts an array of items to insert rather than use a variadic * argument list. * * @param {Array} array The Array on which to replace. * @param {Number} index The index in the array at which to operate. * @param {Number} removeCount The number of items to remove at index (can be 0). * @param {Array} insert (optional) An array of items to insert at index. * @return {Array} The array passed. * @method */ replace: replace, /** * Replaces items in an array. This is equivalent to the splice method of Array, but * works around bugs in IE8's splice method. The signature is exactly the same as the * splice method except that the array is the first argument. All arguments following * removeCount are inserted in the array at index. * * @param {Array} array The Array on which to replace. * @param {Number} index The index in the array at which to operate. * @param {Number} removeCount The number of items to remove at index (can be 0). * @param {Object...} elements The elements to add to the array. If you don't specify * any elements, splice simply removes elements from the array. * @return {Array} An array containing the removed items. * @method */ splice: splice, /** * Pushes new items onto the end of an Array. * * Passed parameters may be single items, or arrays of items. If an Array is found in the argument list, all its * elements are pushed into the end of the target Array. * * @param {Array} target The Array onto which to push new items * @param {Object...} elements The elements to add to the array. Each parameter may * be an Array, in which case all the elements of that Array will be pushed into the end of the * destination Array. * @return {Array} An array containing all the new items push onto the end. * */ push: function(array) { var len = arguments.length, i = 1, newItem; if (array === undefined) { array = []; } else if (!Ext.isArray(array)) { array = [array]; } for (; i < len; i++) { newItem = arguments[i]; Array.prototype.push[Ext.isIterable(newItem) ? 'apply' : 'call'](array, newItem); } return array; } }; /** * @method * @member Ext * @inheritdoc Ext.Array#each */ Ext.each = ExtArray.each; /** * @method * @member Ext.Array * @inheritdoc Ext.Array#merge */ ExtArray.union = ExtArray.merge; /** * Old alias to {@link Ext.Array#min} * @deprecated 4.0.0 Use {@link Ext.Array#min} instead * @method * @member Ext * @inheritdoc Ext.Array#min */ Ext.min = ExtArray.min; /** * Old alias to {@link Ext.Array#max} * @deprecated 4.0.0 Use {@link Ext.Array#max} instead * @method * @member Ext * @inheritdoc Ext.Array#max */ Ext.max = ExtArray.max; /** * Old alias to {@link Ext.Array#sum} * @deprecated 4.0.0 Use {@link Ext.Array#sum} instead * @method * @member Ext * @inheritdoc Ext.Array#sum */ Ext.sum = ExtArray.sum; /** * Old alias to {@link Ext.Array#mean} * @deprecated 4.0.0 Use {@link Ext.Array#mean} instead * @method * @member Ext * @inheritdoc Ext.Array#mean */ Ext.mean = ExtArray.mean; /** * Old alias to {@link Ext.Array#flatten} * @deprecated 4.0.0 Use {@link Ext.Array#flatten} instead * @method * @member Ext * @inheritdoc Ext.Array#flatten */ Ext.flatten = ExtArray.flatten; /** * Old alias to {@link Ext.Array#clean} * @deprecated 4.0.0 Use {@link Ext.Array#clean} instead * @method * @member Ext * @inheritdoc Ext.Array#clean */ Ext.clean = ExtArray.clean; /** * Old alias to {@link Ext.Array#unique} * @deprecated 4.0.0 Use {@link Ext.Array#unique} instead * @method * @member Ext * @inheritdoc Ext.Array#unique */ Ext.unique = ExtArray.unique; /** * Old alias to {@link Ext.Array#pluck Ext.Array.pluck} * @deprecated 4.0.0 Use {@link Ext.Array#pluck Ext.Array.pluck} instead * @method * @member Ext * @inheritdoc Ext.Array#pluck */ Ext.pluck = ExtArray.pluck; /** * @method * @member Ext * @inheritdoc Ext.Array#toArray */ Ext.toArray = function() { return ExtArray.toArray.apply(ExtArray, arguments); }; }()); // @tag foundation,core // @require Array.js // @define Ext.Function /** * @class Ext.Function * * A collection of useful static methods to deal with function callbacks * @singleton * @alternateClassName Ext.util.Functions */ Ext.Function = { /** * 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 arguments * - one single object argument with multiple key - value pairs * * For 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' * }); * * @param {Function} setter * @returns {Function} flexSetter */ flexSetter: function(fn) { return function(a, b) { var k, i; if (a === null) { return this; } if (typeof a !== 'string') { for (k in a) { if (a.hasOwnProperty(k)) { fn.call(this, k, a[k]); } } if (Ext.enumerables) { for (i = Ext.enumerables.length; i--;) { k = Ext.enumerables[i]; if (a.hasOwnProperty(k)) { fn.call(this, k, a[k]); } } } } else { fn.call(this, a, b); } return this; }; }, /** * 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) * * {@link Ext#bind Ext.bind} is alias for {@link Ext.Function#bind Ext.Function.bind} * * @param {Function} fn The function to delegate. * @param {Object} scope (optional) The scope (`this` reference) in which the function is executed. * **If omitted, defaults to the default global environment object (usually the browser window).** * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding, * if a number the args are inserted at the specified position * @return {Function} The new function */ bind: function(fn, scope, args, appendArgs) { if (arguments.length === 2) { return function() { return fn.apply(scope, arguments); }; } var method = fn, slice = Array.prototype.slice; return function() { var callArgs = args || arguments; if (appendArgs === true) { callArgs = slice.call(arguments, 0); callArgs = callArgs.concat(args); } else if (typeof appendArgs == 'number') { callArgs = slice.call(arguments, 0); // copy arguments first Ext.Array.insert(callArgs, appendArgs, args); } return method.apply(scope || Ext.global, callArgs); }; }, /** * 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' * * {@link Ext#pass Ext.pass} is alias for {@link Ext.Function#pass Ext.Function.pass} * * @param {Function} fn The original function * @param {Array} args The arguments to pass to new callback * @param {Object} scope (optional) The scope (`this` reference) in which the function is executed. * @return {Function} The new callback function */ pass: function(fn, args, scope) { if (!Ext.isArray(args)) { if (Ext.isIterable(args)) { args = Ext.Array.clone(args); } else { args = args !== undefined ? [args] : []; } } return function() { var fnArgs = [].concat(args); fnArgs.push.apply(fnArgs, arguments); return fn.apply(scope || this, fnArgs); }; }, /** * 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. * * @param {Object/Function} object * @param {String} methodName * @return {Function} aliasFn */ alias: function(object, methodName) { return function() { return object[methodName].apply(object, arguments); }; }, /** * Create a "clone" of the provided method. The returned method will call the given * method passing along all arguments and the "this" pointer and return its result. * * @param {Function} method * @return {Function} cloneFn */ clone: function(method) { return function() { return method.apply(this, arguments); }; }, /** * 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" * * @param {Function} origFn The original function. * @param {Function} newFn The function to call before the original * @param {Object} [scope] 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.** * @param {Object} [returnValue=null] The value to return if the passed function return false. * @return {Function} The new function */ createInterceptor: function(origFn, newFn, scope, returnValue) { var method = origFn; if (!Ext.isFunction(newFn)) { return origFn; } else { returnValue = Ext.isDefined(returnValue) ? returnValue : null; return function() { var me = this, args = arguments; newFn.target = me; newFn.method = origFn; return (newFn.apply(scope || me || Ext.global, args) !== false) ? origFn.apply(me || Ext.global, args) : returnValue; }; } }, /** * Creates a delegate (callback) which, when called, executes after a specific delay. * * @param {Function} fn 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. * @param {Number} delay The number of milliseconds to defer execution by whenever called. * @param {Object} scope (optional) The scope (`this` reference) used by the function at execution time. * @param {Array} args (optional) Override arguments for the call. (Defaults to the arguments passed by the caller) * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding, * if a number the args are inserted at the specified position. * @return {Function} A function which, when called, executes the original function after the specified delay. */ createDelayed: function(fn, delay, scope, args, appendArgs) { if (scope || args) { fn = Ext.Function.bind(fn, scope, args, appendArgs); } return function() { var me = this, args = Array.prototype.slice.call(arguments); setTimeout(function() { fn.apply(me, args); }, delay); }; }, /** * 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); * * {@link Ext#defer Ext.defer} is alias for {@link Ext.Function#defer Ext.Function.defer} * * @param {Function} fn The function to defer. * @param {Number} millis The number of milliseconds for the setTimeout call * (if less than or equal to 0 the function is executed immediately) * @param {Object} scope (optional) The scope (`this` reference) in which the function is executed. * **If omitted, defaults to the browser window.** * @param {Array} args (optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller) * @param {Boolean/Number} appendArgs (optional) if True args are appended to call args instead of overriding, * if a number the args are inserted at the specified position * @return {Number} The timeout id that can be used with clearTimeout */ defer: function(fn, millis, scope, args, appendArgs) { fn = Ext.Function.bind(fn, scope, args, appendArgs); if (millis > 0) { return setTimeout(Ext.supports.TimeoutActualLateness ? function () { fn(); } : fn, millis); } fn(); return 0; }, /** * 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 * * @param {Function} originalFn The original function. * @param {Function} newFn The function to sequence * @param {Object} scope (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 default global environment object (usually the browser window). * @return {Function} The new function */ createSequence: function(originalFn, newFn, scope) { if (!newFn) { return originalFn; } else { return function() { var result = originalFn.apply(this, arguments); newFn.apply(scope || this, arguments); return result; }; } }, /** * 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. * * @param {Function} fn The function to invoke on a buffered timer. * @param {Number} buffer The number of milliseconds by which to buffer the invocation of the * function. * @param {Object} scope (optional) The scope (`this` reference) in which * the passed function is executed. If omitted, defaults to the scope specified by the caller. * @param {Array} args (optional) Override arguments for the call. Defaults to the arguments * passed by the caller. * @return {Function} A function which invokes the passed function after buffering for the specified time. */ createBuffered: function(fn, buffer, scope, args) { var timerId; return function() { var callArgs = args || Array.prototype.slice.call(arguments, 0), me = scope || this; if (timerId) { clearTimeout(timerId); } timerId = setTimeout(function(){ fn.apply(me, callArgs); }, buffer); }; }, /** * 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. * * @param {Function} fn The function to execute at a regular time interval. * @param {Number} interval The interval **in milliseconds** on which the passed function is executed. * @param {Object} scope (optional) The scope (`this` reference) in which * the passed function is executed. If omitted, defaults to the scope specified by the caller. * @returns {Function} A function which invokes the passed function at the specified interval. */ createThrottled: function(fn, interval, scope) { var lastCallTime, elapsed, lastArgs, timer, execute = function() { fn.apply(scope || this, lastArgs); lastCallTime = Ext.Date.now(); }; return function() { elapsed = Ext.Date.now() - lastCallTime; lastArgs = arguments; clearTimeout(timer); if (!lastCallTime || (elapsed >= interval)) { execute(); } else { timer = setTimeout(execute, interval - elapsed); } }; }, /** * Adds behavior to an existing method that is executed before the * original behavior of the function. For example: * * var soup = { * contents: [], * add: function(ingredient) { * this.contents.push(ingredient); * } * }; * Ext.Function.interceptBefore(soup, "add", function(ingredient){ * if (!this.contents.length && ingredient !== "water") { * // Always add water to start with * this.contents.push("water"); * } * }); * soup.add("onions"); * soup.add("salt"); * soup.contents; // will contain: water, onions, salt * * @param {Object} object The target object * @param {String} methodName Name of the method to override * @param {Function} fn Function with the new behavior. It will * be called with the same arguments as the original method. The * return value of this function will be the return value of the * new method. * @param {Object} [scope] The scope to execute the interceptor function. Defaults to the object. * @return {Function} The new function just created. */ interceptBefore: function(object, methodName, fn, scope) { var method = object[methodName] || Ext.emptyFn; return (object[methodName] = function() { var ret = fn.apply(scope || this, arguments); method.apply(this, arguments); return ret; }); }, /** * Adds behavior to an existing method that is executed after the * original behavior of the function. For example: * * var soup = { * contents: [], * add: function(ingredient) { * this.contents.push(ingredient); * } * }; * Ext.Function.interceptAfter(soup, "add", function(ingredient){ * // Always add a bit of extra salt * this.contents.push("salt"); * }); * soup.add("water"); * soup.add("onions"); * soup.contents; // will contain: water, salt, onions, salt * * @param {Object} object The target object * @param {String} methodName Name of the method to override * @param {Function} fn Function with the new behavior. It will * be called with the same arguments as the original method. The * return value of this function will be the return value of the * new method. * @param {Object} [scope] The scope to execute the interceptor function. Defaults to the object. * @return {Function} The new function just created. */ interceptAfter: function(object, methodName, fn, scope) { var method = object[methodName] || Ext.emptyFn; return (object[methodName] = function() { method.apply(this, arguments); return fn.apply(scope || this, arguments); }); } }; /** * @method * @member Ext * @inheritdoc Ext.Function#defer */ Ext.defer = Ext.Function.alias(Ext.Function, 'defer'); /** * @method * @member Ext * @inheritdoc Ext.Function#pass */ Ext.pass = Ext.Function.alias(Ext.Function, 'pass'); /** * @method * @member Ext * @inheritdoc Ext.Function#bind */ Ext.bind = Ext.Function.alias(Ext.Function, 'bind'); // @tag foundation,core // @require Function.js // @define Ext.Object /** * @class Ext.Object * * A collection of useful static methods to deal with objects. * * @singleton */ (function() { // The "constructor" for chain: var TemplateClass = function(){}, ExtObject = Ext.Object = { /** * Returns a new object with the given object as the prototype chain. This method is * designed to mimic the ECMA standard `Object.create` method and is assigned to that * function when it is available. * * **NOTE** This method does not support the property definitions capability of the * `Object.create` method. Only the first argument is supported. * * @param {Object} object The prototype chain for the new object. */ chain: Object.create || function (object) { TemplateClass.prototype = object; var result = new TemplateClass(); TemplateClass.prototype = null; return result; }, /** * Converts a `name` - `value` pair to an array of objects with support for nested structures. Useful to construct * query strings. For example: * * var objects = Ext.Object.toQueryObjects('hobbies', ['reading', 'cooking', 'swimming']); * * // objects then equals: * [ * { name: 'hobbies', value: 'reading' }, * { name: 'hobbies', value: 'cooking' }, * { name: 'hobbies', value: 'swimming' }, * ]; * * var objects = Ext.Object.toQueryObjects('dateOfBirth', { * day: 3, * month: 8, * year: 1987, * extra: { * hour: 4 * minute: 30 * } * }, true); // Recursive * * // objects then equals: * [ * { name: 'dateOfBirth[day]', value: 3 }, * { name: 'dateOfBirth[month]', value: 8 }, * { name: 'dateOfBirth[year]', value: 1987 }, * { name: 'dateOfBirth[extra][hour]', value: 4 }, * { name: 'dateOfBirth[extra][minute]', value: 30 }, * ]; * * @param {String} name * @param {Object/Array} value * @param {Boolean} [recursive=false] True to traverse object recursively * @return {Array} */ toQueryObjects: function(name, value, recursive) { var self = ExtObject.toQueryObjects, objects = [], i, ln; if (Ext.isArray(value)) { for (i = 0, ln = value.length; i < ln; i++) { if (recursive) { objects = objects.concat(self(name + '[' + i + ']', value[i], true)); } else { objects.push({ name: name, value: value[i] }); } } } else if (Ext.isObject(value)) { for (i in value) { if (value.hasOwnProperty(i)) { if (recursive) { objects = objects.concat(self(name + '[' + i + ']', value[i], true)); } else { objects.push({ name: name, value: value[i] }); } } } } else { objects.push({ name: name, value: value }); } return objects; }, /** * Takes an object and converts it to an encoded query string. * * Non-recursive: * * Ext.Object.toQueryString({foo: 1, bar: 2}); // returns "foo=1&bar=2" * Ext.Object.toQueryString({foo: null, bar: 2}); // returns "foo=&bar=2" * Ext.Object.toQueryString({'some price': '$300'}); // returns "some%20price=%24300" * Ext.Object.toQueryString({date: new Date(2011, 0, 1)}); // returns "date=%222011-01-01T00%3A00%3A00%22" * Ext.Object.toQueryString({colors: ['red', 'green', 'blue']}); // returns "colors=red&colors=green&colors=blue" * * Recursive: * * Ext.Object.toQueryString({ * username: 'Jacky', * dateOfBirth: { * day: 1, * month: 2, * year: 1911 * }, * hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']] * }, true); // returns the following string (broken down and url-decoded for ease of reading purpose): * // username=Jacky * // &dateOfBirth[day]=1&dateOfBirth[month]=2&dateOfBirth[year]=1911 * // &hobbies[0]=coding&hobbies[1]=eating&hobbies[2]=sleeping&hobbies[3][0]=nested&hobbies[3][1]=stuff * * @param {Object} object The object to encode * @param {Boolean} [recursive=false] Whether or not to interpret the object in recursive format. * (PHP / Ruby on Rails servers and similar). * @return {String} queryString */ toQueryString: function(object, recursive) { var paramObjects = [], params = [], i, j, ln, paramObject, value; for (i in object) { if (object.hasOwnProperty(i)) { paramObjects = paramObjects.concat(ExtObject.toQueryObjects(i, object[i], recursive)); } } for (j = 0, ln = paramObjects.length; j < ln; j++) { paramObject = paramObjects[j]; value = paramObject.value; if (Ext.isEmpty(value)) { value = ''; } else if (Ext.isDate(value)) { value = Ext.Date.toString(value); } params.push(encodeURIComponent(paramObject.name) + '=' + encodeURIComponent(String(value))); } return params.join('&'); }, /** * Converts a query string back into an object. * * Non-recursive: * * Ext.Object.fromQueryString("foo=1&bar=2"); // returns {foo: '1', bar: '2'} * Ext.Object.fromQueryString("foo=&bar=2"); // returns {foo: null, bar: '2'} * Ext.Object.fromQueryString("some%20price=%24300"); // returns {'some price': '$300'} * Ext.Object.fromQueryString("colors=red&colors=green&colors=blue"); // returns {colors: ['red', 'green', 'blue']} * * Recursive: * * Ext.Object.fromQueryString( * "username=Jacky&"+ * "dateOfBirth[day]=1&dateOfBirth[month]=2&dateOfBirth[year]=1911&"+ * "hobbies[0]=coding&hobbies[1]=eating&hobbies[2]=sleeping&"+ * "hobbies[3][0]=nested&hobbies[3][1]=stuff", true); * * // returns * { * username: 'Jacky', * dateOfBirth: { * day: '1', * month: '2', * year: '1911' * }, * hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']] * } * * @param {String} queryString The query string to decode * @param {Boolean} [recursive=false] Whether or not to recursively decode the string. This format is supported by * PHP / Ruby on Rails servers and similar. * @return {Object} */ fromQueryString: function(queryString, recursive) { var parts = queryString.replace(/^\?/, '').split('&'), object = {}, temp, components, name, value, i, ln, part, j, subLn, matchedKeys, matchedName, keys, key, nextKey; for (i = 0, ln = parts.length; i < ln; i++) { part = parts[i]; if (part.length > 0) { components = part.split('='); name = decodeURIComponent(components[0]); value = (components[1] !== undefined) ? decodeURIComponent(components[1]) : ''; if (!recursive) { if (object.hasOwnProperty(name)) { if (!Ext.isArray(object[name])) { object[name] = [object[name]]; } object[name].push(value); } else { object[name] = value; } } else { matchedKeys = name.match(/(\[):?([^\]]*)\]/g); matchedName = name.match(/^([^\[]+)/); if (!matchedName) { throw new Error('[Ext.Object.fromQueryString] Malformed query string given, failed parsing name from "' + part + '"'); } name = matchedName[0]; keys = []; if (matchedKeys === null) { object[name] = value; continue; } for (j = 0, subLn = matchedKeys.length; j < subLn; j++) { key = matchedKeys[j]; key = (key.length === 2) ? '' : key.substring(1, key.length - 1); keys.push(key); } keys.unshift(name); temp = object; for (j = 0, subLn = keys.length; j < subLn; j++) { key = keys[j]; if (j === subLn - 1) { if (Ext.isArray(temp) && key === '') { temp.push(value); } else { temp[key] = value; } } else { if (temp[key] === undefined || typeof temp[key] === 'string') { nextKey = keys[j+1]; temp[key] = (Ext.isNumeric(nextKey) || nextKey === '') ? [] : {}; } temp = temp[key]; } } } } } return object; }, /** * Iterates through an object and invokes the given callback function for each iteration. * The iteration can be stopped by returning `false` in the callback function. For example: * * var person = { * name: 'Jacky' * hairColor: 'black' * loves: ['food', 'sleeping', 'wife'] * }; * * Ext.Object.each(person, function(key, value, myself) { * console.log(key + ":" + value); * * if (key === 'hairColor') { * return false; // stop the iteration * } * }); * * @param {Object} object The object to iterate * @param {Function} fn The callback function. * @param {String} fn.key * @param {Object} fn.value * @param {Object} fn.object The object itself * @param {Object} [scope] The execution scope (`this`) of the callback function */ each: function(object, fn, scope) { for (var property in object) { if (object.hasOwnProperty(property)) { if (fn.call(scope || object, property, object[property], object) === false) { return; } } } }, /** * Merges any number of objects recursively without referencing them or their children. * * var extjs = { * companyName: 'Ext JS', * products: ['Ext JS', 'Ext GWT', 'Ext Designer'], * isSuperCool: true, * office: { * size: 2000, * location: 'Palo Alto', * isFun: true * } * }; * * var newStuff = { * companyName: 'Sencha Inc.', * products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'], * office: { * size: 40000, * location: 'Redwood City' * } * }; * * var sencha = Ext.Object.merge(extjs, newStuff); * * // extjs and sencha then equals to * { * companyName: 'Sencha Inc.', * products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'], * isSuperCool: true, * office: { * size: 40000, * location: 'Redwood City', * isFun: true * } * } * * @param {Object} destination The object into which all subsequent objects are merged. * @param {Object...} object Any number of objects to merge into the destination. * @return {Object} merged The destination object with all passed objects merged in. */ merge: function(destination) { var i = 1, ln = arguments.length, mergeFn = ExtObject.merge, cloneFn = Ext.clone, object, key, value, sourceKey; for (; i < ln; i++) { object = arguments[i]; for (key in object) { value = object[key]; if (value && value.constructor === Object) { sourceKey = destination[key]; if (sourceKey && sourceKey.constructor === Object) { mergeFn(sourceKey, value); } else { destination[key] = cloneFn(value); } } else { destination[key] = value; } } } return destination; }, /** * @private * @param destination */ mergeIf: function(destination) { var i = 1, ln = arguments.length, cloneFn = Ext.clone, object, key, value; for (; i < ln; i++) { object = arguments[i]; for (key in object) { if (!(key in destination)) { value = object[key]; if (value && value.constructor === Object) { destination[key] = cloneFn(value); } else { destination[key] = value; } } } } return destination; }, /** * Returns the first matching key corresponding to the given value. * If no matching value is found, null is returned. * * var person = { * name: 'Jacky', * loves: 'food' * }; * * alert(Ext.Object.getKey(person, 'food')); // alerts 'loves' * * @param {Object} object * @param {Object} value The value to find */ getKey: function(object, value) { for (var property in object) { if (object.hasOwnProperty(property) && object[property] === value) { return property; } } return null; }, /** * Gets all values of the given object as an array. * * var values = Ext.Object.getValues({ * name: 'Jacky', * loves: 'food' * }); // ['Jacky', 'food'] * * @param {Object} object * @return {Array} An array of values from the object */ getValues: function(object) { var values = [], property; for (property in object) { if (object.hasOwnProperty(property)) { values.push(object[property]); } } return values; }, /** * Gets all keys of the given object as an array. * * var values = Ext.Object.getKeys({ * name: 'Jacky', * loves: 'food' * }); // ['name', 'loves'] * * @param {Object} object * @return {String[]} An array of keys from the object * @method */ getKeys: (typeof Object.keys == 'function') ? function(object){ if (!object) { return []; } return Object.keys(object); } : function(object) { var keys = [], property; for (property in object) { if (object.hasOwnProperty(property)) { keys.push(property); } } return keys; }, /** * Gets the total number of this object's own properties * * var size = Ext.Object.getSize({ * name: 'Jacky', * loves: 'food' * }); // size equals 2 * * @param {Object} object * @return {Number} size */ getSize: function(object) { var size = 0, property; for (property in object) { if (object.hasOwnProperty(property)) { size++; } } return size; }, /** * Checks if there are any properties on this object. * @param {Object} object * @return {Boolean} `true` if there no properties on the object. */ isEmpty: function(object){ for (var key in object) { if (object.hasOwnProperty(key)) { return false; } } return true; }, /** * Shallow compares the contents of 2 objects using strict equality. Objects are * considered equal if they both have the same set of properties and the * value for those properties equals the other in the corresponding object. * * // Returns true * Ext.Object.equals({ * foo: 1, * bar: 2 * }, { * foo: 1, * bar: 2 * }); * * @param {Object} object1 * @param {Object} object2 * @return {Boolean} `true` if the objects are equal. */ equals: (function() { var check = function(o1, o2) { var key; for (key in o1) { if (o1.hasOwnProperty(key)) { if (o1[key] !== o2[key]) { return false; } } } return true; }; return function(object1, object2) { // Short circuit if the same object is passed twice if (object1 === object2) { return true; } if (object1 && object2) { // Do the second check because we could have extra keys in // object2 that don't exist in object1. return check(object1, object2) && check(object2, object1); } else if (!object1 && !object2) { return object1 === object2; } else { return false; } }; })(), /** * @private */ classify: function(object) { var prototype = object, objectProperties = [], propertyClassesMap = {}, objectClass = function() { var i = 0, ln = objectProperties.length, property; for (; i < ln; i++) { property = objectProperties[i]; this[property] = new propertyClassesMap[property](); } }, key, value; for (key in object) { if (object.hasOwnProperty(key)) { value = object[key]; if (value && value.constructor === Object) { objectProperties.push(key); propertyClassesMap[key] = ExtObject.classify(value); } } } objectClass.prototype = prototype; return objectClass; } }; /** * A convenient alias method for {@link Ext.Object#merge}. * * @member Ext * @method merge * @inheritdoc Ext.Object#merge */ Ext.merge = Ext.Object.merge; /** * @private * @member Ext */ Ext.mergeIf = Ext.Object.mergeIf; /** * * @member Ext * @method urlEncode * @inheritdoc Ext.Object#toQueryString * @deprecated 4.0.0 Use {@link Ext.Object#toQueryString} instead */ Ext.urlEncode = function() { var args = Ext.Array.from(arguments), prefix = ''; // Support for the old `pre` argument if ((typeof args[1] === 'string')) { prefix = args[1] + '&'; args[1] = false; } return prefix + ExtObject.toQueryString.apply(ExtObject, args); }; /** * Alias for {@link Ext.Object#fromQueryString}. * * @member Ext * @method urlDecode * @inheritdoc Ext.Object#fromQueryString * @deprecated 4.0.0 Use {@link Ext.Object#fromQueryString} instead */ Ext.urlDecode = function() { return ExtObject.fromQueryString.apply(ExtObject, arguments); }; }()); // @tag foundation,core // @require Object.js // @define Ext.Date /** * @class Ext.Date * A set of useful static methods to deal with date * Note that if Ext.Date is required and loaded, it will copy all methods / properties to * this object for convenience * * The date parsing and formatting syntax contains a subset of * [PHP's `date()` function](http://www.php.net/date), and the formats that are * supported will provide results equivalent to their PHP versions. * * The following is a list of all currently supported formats: *
Format      Description                                                               Example returned values
------      -----------------------------------------------------------------------   -----------------------
  d         Day of the month, 2 digits with leading zeros                             01 to 31
  D         A short textual representation of the day of the week                     Mon to Sun
  j         Day of the month without leading zeros                                    1 to 31
  l         A full textual representation of the day of the week                      Sunday to Saturday
  N         ISO-8601 numeric representation of the day of the week                    1 (for Monday) through 7 (for Sunday)
  S         English ordinal suffix for the day of the month, 2 characters             st, nd, rd or th. Works well with j
  w         Numeric representation of the day of the week                             0 (for Sunday) to 6 (for Saturday)
  z         The day of the year (starting from 0)                                     0 to 364 (365 in leap years)
  W         ISO-8601 week number of year, weeks starting on Monday                    01 to 53
  F         A full textual representation of a month, such as January or March        January to December
  m         Numeric representation of a month, with leading zeros                     01 to 12
  M         A short textual representation of a month                                 Jan to Dec
  n         Numeric representation of a month, without leading zeros                  1 to 12
  t         Number of days in the given month                                         28 to 31
  L         Whether it's a leap year                                                  1 if it is a leap year, 0 otherwise.
  o         ISO-8601 year number (identical to (Y), but if the ISO week number (W)    Examples: 1998 or 2004
            belongs to the previous or next year, that year is used instead)
  Y         A full numeric representation of a year, 4 digits                         Examples: 1999 or 2003
  y         A two digit representation of a year                                      Examples: 99 or 03
  a         Lowercase Ante meridiem and Post meridiem                                 am or pm
  A         Uppercase Ante meridiem and Post meridiem                                 AM or PM
  g         12-hour format of an hour without leading zeros                           1 to 12
  G         24-hour format of an hour without leading zeros                           0 to 23
  h         12-hour format of an hour with leading zeros                              01 to 12
  H         24-hour format of an hour with leading zeros                              00 to 23
  i         Minutes, with leading zeros                                               00 to 59
  s         Seconds, with leading zeros                                               00 to 59
  u         Decimal fraction of a second                                              Examples:
            (minimum 1 digit, arbitrary number of digits allowed)                     001 (i.e. 0.001s) or
                                                                                      100 (i.e. 0.100s) or
                                                                                      999 (i.e. 0.999s) or
                                                                                      999876543210 (i.e. 0.999876543210s)
  O         Difference to Greenwich time (GMT) in hours and minutes                   Example: +1030
  P         Difference to Greenwich time (GMT) with colon between hours and minutes   Example: -08:00
  T         Timezone abbreviation of the machine running the code                     Examples: EST, MDT, PDT ...
  Z         Timezone offset in seconds (negative if west of UTC, positive if east)    -43200 to 50400
  c         ISO 8601 date
            Notes:                                                                    Examples:
            1) If unspecified, the month / day defaults to the current month / day,   1991 or
               the time defaults to midnight, while the timezone defaults to the      1992-10 or
               browser's timezone. If a time is specified, it must include both hours 1993-09-20 or
               and minutes. The "T" delimiter, seconds, milliseconds and timezone     1994-08-19T16:20+01:00 or
               are optional.                                                          1995-07-18T17:21:28-02:00 or
            2) The decimal fraction of a second, if specified, must contain at        1996-06-17T18:22:29.98765+03:00 or
               least 1 digit (there is no limit to the maximum number                 1997-05-16T19:23:30,12345-0400 or
               of digits allowed), and may be delimited by either a '.' or a ','      1998-04-15T20:24:31.2468Z or
            Refer to the examples on the right for the various levels of              1999-03-14T20:24:32Z or
            date-time granularity which are supported, or see                         2000-02-13T21:25:33
            http://www.w3.org/TR/NOTE-datetime for more info.                         2001-01-12 22:26:34
  U         Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)                1193432466 or -2138434463
  MS        Microsoft AJAX serialized dates                                           \/Date(1238606590509)\/ (i.e. UTC milliseconds since epoch) or
                                                                                      \/Date(1238606590509+0800)\/
  time      A javascript millisecond timestamp                                        1350024476440
  timestamp A UNIX timestamp (same as U)                                              1350024866            
* * Example usage (note that you must escape format specifiers with '\\' to render them as character literals): * * // Sample date: * // 'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)' * * var dt = new Date('1/10/2007 03:05:01 PM GMT-0600'); * console.log(Ext.Date.format(dt, 'Y-m-d')); // 2007-01-10 * console.log(Ext.Date.format(dt, 'F j, Y, g:i a')); // January 10, 2007, 3:05 pm * console.log(Ext.Date.format(dt, 'l, \\t\\he jS \\of F Y h:i:s A')); // Wednesday, the 10th of January 2007 03:05:01 PM * * Here are some standard date/time patterns that you might find helpful. They * are not part of the source of Ext.Date, but to use them you can simply copy this * block of code into any script that is included after Ext.Date and they will also become * globally available on the Date object. Feel free to add or remove patterns as needed in your code. * * Ext.Date.patterns = { * ISO8601Long:"Y-m-d H:i:s", * ISO8601Short:"Y-m-d", * ShortDate: "n/j/Y", * LongDate: "l, F d, Y", * FullDateTime: "l, F d, Y g:i:s A", * MonthDay: "F d", * ShortTime: "g:i A", * LongTime: "g:i:s A", * SortableDateTime: "Y-m-d\\TH:i:s", * UniversalSortableDateTime: "Y-m-d H:i:sO", * YearMonth: "F, Y" * }; * * Example usage: * * var dt = new Date(); * console.log(Ext.Date.format(dt, Ext.Date.patterns.ShortDate)); * * Developer-written, custom formats may be used by supplying both a formatting and a parsing function * which perform to specialized requirements. The functions are stored in {@link #parseFunctions} and {@link #formatFunctions}. * @singleton */ /* * Most of the date-formatting functions below are the excellent work of Baron Schwartz. * (see http://www.xaprb.com/blog/2005/12/12/javascript-closures-for-runtime-efficiency/) * They generate precompiled functions from format patterns instead of parsing and * processing each pattern every time a date is formatted. These functions are available * on every Date object. */ Ext.Date = new function() { var utilDate = this, stripEscapeRe = /(\\.)/g, hourInfoRe = /([gGhHisucUOPZ]|MS)/, dateInfoRe = /([djzmnYycU]|MS)/, slashRe = /\\/gi, numberTokenRe = /\{(\d+)\}/g, MSFormatRe = new RegExp('\\/Date\\(([-+])?(\\d+)(?:[+-]\\d{4})?\\)\\/'), code = [ // date calculations (note: the code below creates a dependency on Ext.Number.from()) "var me = this, dt, y, m, d, h, i, s, ms, o, O, z, zz, u, v, W, year, jan4, week1monday, daysInMonth, dayMatched,", "def = me.defaults,", "from = Ext.Number.from,", "results = String(input).match(me.parseRegexes[{0}]);", // either null, or an array of matched strings "if(results){", "{1}", "if(u != null){", // i.e. unix time is defined "v = new Date(u * 1000);", // give top priority to UNIX time "}else{", // create Date object representing midnight of the current day; // this will provide us with our date defaults // (note: clearTime() handles Daylight Saving Time automatically) "dt = me.clearTime(new Date);", "y = from(y, from(def.y, dt.getFullYear()));", "m = from(m, from(def.m - 1, dt.getMonth()));", "dayMatched = d !== undefined;", "d = from(d, from(def.d, dt.getDate()));", // Attempt to validate the day. Since it defaults to today, it may go out // of range, for example parsing m/Y where the value is 02/2000 on the 31st of May. // It will attempt to parse 2000/02/31, which will overflow to March and end up // returning 03/2000. We only do this when we default the day. If an invalid day value // was set to be parsed by the user, continue on and either let it overflow or return null // depending on the strict value. This will be in line with the normal Date behaviour. "if (!dayMatched) {", "dt.setDate(1);", "dt.setMonth(m);", "dt.setFullYear(y);", "daysInMonth = me.getDaysInMonth(dt);", "if (d > daysInMonth) {", "d = daysInMonth;", "}", "}", "h = from(h, from(def.h, dt.getHours()));", "i = from(i, from(def.i, dt.getMinutes()));", "s = from(s, from(def.s, dt.getSeconds()));", "ms = from(ms, from(def.ms, dt.getMilliseconds()));", "if(z >= 0 && y >= 0){", // both the year and zero-based day of year are defined and >= 0. // these 2 values alone provide sufficient info to create a full date object // create Date object representing January 1st for the given year // handle years < 100 appropriately "v = me.add(new Date(y < 100 ? 100 : y, 0, 1, h, i, s, ms), me.YEAR, y < 100 ? y - 100 : 0);", // then add day of year, checking for Date "rollover" if necessary "v = !strict? v : (strict === true && (z <= 364 || (me.isLeapYear(v) && z <= 365))? me.add(v, me.DAY, z) : null);", "}else if(strict === true && !me.isValid(y, m + 1, d, h, i, s, ms)){", // check for Date "rollover" "v = null;", // invalid date, so return null "}else{", "if (W) {", // support ISO-8601 // http://en.wikipedia.org/wiki/ISO_week_date // // Mutually equivalent definitions for week 01 are: // a. the week starting with the Monday which is nearest in time to 1 January // b. the week with 4 January in it // ... there are many others ... // // We'll use letter b above to determine the first week of the year. // // So, first get a Date object for January 4th of whatever calendar year is desired. // // Then, the first Monday of the year can easily be determined by (operating on this Date): // 1. Getting the day of the week. // 2. Subtracting that by one. // 3. Multiplying that by 86400000 (one day in ms). // 4. Subtracting this number of days (in ms) from the January 4 date (represented in ms). // // Example #1 ... // // January 2012 // Su Mo Tu We Th Fr Sa // 1 2 3 4 5 6 7 // 8 9 10 11 12 13 14 // 15 16 17 18 19 20 21 // 22 23 24 25 26 27 28 // 29 30 31 // // 1. January 4th is a Wednesday. // 2. Its day number is 3. // 3. Simply substract 2 days from Wednesday. // 4. The first week of the year begins on Monday, January 2. Simple! // // Example #2 ... // January 1992 // Su Mo Tu We Th Fr Sa // 1 2 3 4 // 5 6 7 8 9 10 11 // 12 13 14 15 16 17 18 // 19 20 21 22 23 24 25 // 26 27 28 29 30 31 // // 1. January 4th is a Saturday. // 2. Its day number is 6. // 3. Simply subtract 5 days from Saturday. // 4. The first week of the year begins on Monday, December 30. Simple! // // v = Ext.Date.clearTime(new Date(week1monday.getTime() + ((W - 1) * 604800000))); // (This is essentially doing the same thing as above but for the week rather than the day) "year = y || (new Date()).getFullYear(),", "jan4 = new Date(year, 0, 4, 0, 0, 0),", "week1monday = new Date(jan4.getTime() - ((jan4.getDay() - 1) * 86400000));", "v = Ext.Date.clearTime(new Date(week1monday.getTime() + ((W - 1) * 604800000)));", "} else {", // plain old Date object // handle years < 100 properly "v = me.add(new Date(y < 100 ? 100 : y, m, d, h, i, s, ms), me.YEAR, y < 100 ? y - 100 : 0);", "}", "}", "}", "}", "if(v){", // favor UTC offset over GMT offset "if(zz != null){", // reset to UTC, then add offset "v = me.add(v, me.SECOND, -v.getTimezoneOffset() * 60 - zz);", "}else if(o){", // reset to GMT, then add offset "v = me.add(v, me.MINUTE, -v.getTimezoneOffset() + (sn == '+'? -1 : 1) * (hr * 60 + mn));", "}", "}", "return v;" ].join('\n'); // create private copy of Ext JS's `Ext.util.Format.format()` method // - to remove unnecessary dependency // - to resolve namespace conflict with MS-Ajax's implementation function xf(format) { var args = Array.prototype.slice.call(arguments, 1); return format.replace(numberTokenRe, function(m, i) { return args[i]; }); } Ext.apply(utilDate, { /** * Returns the current timestamp. * @return {Number} Milliseconds since UNIX epoch. * @method */ now: Date.now || function() { return +new Date(); }, /** * @private * Private for now */ toString: function(date) { var pad = Ext.String.leftPad; return date.getFullYear() + "-" + pad(date.getMonth() + 1, 2, '0') + "-" + pad(date.getDate(), 2, '0') + "T" + pad(date.getHours(), 2, '0') + ":" + pad(date.getMinutes(), 2, '0') + ":" + pad(date.getSeconds(), 2, '0'); }, /** * Returns the number of milliseconds between two dates. * @param {Date} dateA The first date. * @param {Date} [dateB=new Date()] (optional) The second date. * @return {Number} The difference in milliseconds */ getElapsed: function(dateA, dateB) { return Math.abs(dateA - (dateB || utilDate.now())); }, /** * Global flag which determines if strict date parsing should be used. * Strict date parsing will not roll-over invalid dates, which is the * default behavior of JavaScript Date objects. * (see {@link #parse} for more information) * @type Boolean */ useStrict: false, // private formatCodeToRegex: function(character, currentGroup) { // Note: currentGroup - position in regex result array (see notes for Ext.Date.parseCodes below) var p = utilDate.parseCodes[character]; if (p) { p = typeof p == 'function'? p() : p; utilDate.parseCodes[character] = p; // reassign function result to prevent repeated execution } return p ? Ext.applyIf({ c: p.c ? xf(p.c, currentGroup || "{0}") : p.c }, p) : { g: 0, c: null, s: Ext.String.escapeRegex(character) // treat unrecognized characters as literals }; }, /** * An object hash in which each property is a date parsing function. The property name is the * format string which that function parses. * * This object is automatically populated with date parsing functions as * date formats are requested for Ext standard formatting strings. * * Custom parsing functions may be inserted into this object, keyed by a name which from then on * may be used as a format string to {@link #parse}. * * Example: * * Ext.Date.parseFunctions['x-date-format'] = myDateParser; * * A parsing function should return a Date object, and is passed the following parameters:
    *
  • date : String
    The date string to parse.
  • *
  • strict : Boolean
    True to validate date strings while parsing * (i.e. prevent JavaScript Date "rollover") (The default must be `false`). * Invalid date strings should return `null` when parsed.
  • *
* * To enable Dates to also be _formatted_ according to that format, a corresponding * formatting function must be placed into the {@link #formatFunctions} property. * @property parseFunctions * @type Object */ parseFunctions: { "MS": function(input, strict) { // note: the timezone offset is ignored since the MS Ajax server sends // a UTC milliseconds-since-Unix-epoch value (negative values are allowed) var r = (input || '').match(MSFormatRe); return r ? new Date(((r[1] || '') + r[2]) * 1) : null; }, "time": function(input, strict) { var num = parseInt(input, 10); if (num || num === 0) { return new Date(num); } return null; }, "timestamp": function(input, strict) { var num = parseInt(input, 10); if (num || num === 0) { return new Date(num * 1000); } return null; } }, parseRegexes: [], /** * An object hash in which each property is a date formatting function. The property name is the * format string which corresponds to the produced formatted date string. * * This object is automatically populated with date formatting functions as * date formats are requested for Ext standard formatting strings. * * Custom formatting functions may be inserted into this object, keyed by a name which from then on * may be used as a format string to {@link #format}. * * Example: * * Ext.Date.formatFunctions['x-date-format'] = myDateFormatter; * * A formatting function should return a string representation of the passed Date object, and is passed the following parameters:
    *
  • date : Date
    The Date to format.
  • *
* * To enable date strings to also be _parsed_ according to that format, a corresponding * parsing function must be placed into the {@link #parseFunctions} property. * @property formatFunctions * @type Object */ formatFunctions: { "MS": function() { // UTC milliseconds since Unix epoch (MS-AJAX serialized date format (MRSF)) return '\\/Date(' + this.getTime() + ')\\/'; }, "time": function(){ return this.getTime().toString(); }, "timestamp": function(){ return utilDate.format(this, 'U'); } }, y2kYear : 50, /** * Date interval constant * @type String */ MILLI : "ms", /** * Date interval constant * @type String */ SECOND : "s", /** * Date interval constant * @type String */ MINUTE : "mi", /** Date interval constant * @type String */ HOUR : "h", /** * Date interval constant * @type String */ DAY : "d", /** * Date interval constant * @type String */ MONTH : "mo", /** * Date interval constant * @type String */ YEAR : "y", /** * An object hash containing default date values used during date parsing. * * The following properties are available:
    *
  • y : Number
    The default year value. (defaults to undefined)
  • *
  • m : Number
    The default 1-based month value. (defaults to undefined)
  • *
  • d : Number
    The default day value. (defaults to undefined)
  • *
  • h : Number
    The default hour value. (defaults to undefined)
  • *
  • i : Number
    The default minute value. (defaults to undefined)
  • *
  • s : Number
    The default second value. (defaults to undefined)
  • *
  • ms : Number
    The default millisecond value. (defaults to undefined)
  • *
* * Override these properties to customize the default date values used by the {@link #parse} method. * * __Note:__ In countries which experience Daylight Saving Time (i.e. DST), the `h`, `i`, `s` * and `ms` properties may coincide with the exact time in which DST takes effect. * It is the responsibility of the developer to account for this. * * Example Usage: * * // set default day value to the first day of the month * Ext.Date.defaults.d = 1; * * // parse a February date string containing only year and month values. * // setting the default day value to 1 prevents weird date rollover issues * // when attempting to parse the following date string on, for example, March 31st 2009. * Ext.Date.parse('2009-02', 'Y-m'); // returns a Date object representing February 1st 2009 * * @property defaults * @type Object */ defaults: {}, // /** * @property {String[]} dayNames * An array of textual day names. * Override these values for international dates. * * Example: * * Ext.Date.dayNames = [ * 'SundayInYourLang', * 'MondayInYourLang' * // ... * ]; */ dayNames : [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], // // /** * @property {String[]} monthNames * An array of textual month names. * Override these values for international dates. * * Example: * * Ext.Date.monthNames = [ * 'JanInYourLang', * 'FebInYourLang' * // ... * ]; */ monthNames : [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ], // // /** * @property {Object} monthNumbers * An object hash of zero-based JavaScript month numbers (with short month names as keys. **Note:** keys are case-sensitive). * Override these values for international dates. * * Example: * * Ext.Date.monthNumbers = { * 'LongJanNameInYourLang': 0, * 'ShortJanNameInYourLang':0, * 'LongFebNameInYourLang':1, * 'ShortFebNameInYourLang':1 * // ... * }; */ monthNumbers : { January: 0, Jan: 0, February: 1, Feb: 1, March: 2, Mar: 2, April: 3, Apr: 3, May: 4, June: 5, Jun: 5, July: 6, Jul: 6, August: 7, Aug: 7, September: 8, Sep: 8, October: 9, Oct: 9, November: 10, Nov: 10, December: 11, Dec: 11 }, // // /** * @property {String} defaultFormat * The date format string that the {@link Ext.util.Format#dateRenderer} * and {@link Ext.util.Format#date} functions use. See {@link Ext.Date} for details. * * This may be overridden in a locale file. */ defaultFormat : "m/d/Y", // // /** * Get the short month name for the given month number. * Override this function for international dates. * @param {Number} month A zero-based JavaScript month number. * @return {String} The short month name. */ getShortMonthName : function(month) { return Ext.Date.monthNames[month].substring(0, 3); }, // // /** * Get the short day name for the given day number. * Override this function for international dates. * @param {Number} day A zero-based JavaScript day number. * @return {String} The short day name. */ getShortDayName : function(day) { return Ext.Date.dayNames[day].substring(0, 3); }, // // /** * Get the zero-based JavaScript month number for the given short/full month name. * Override this function for international dates. * @param {String} name The short/full month name. * @return {Number} The zero-based JavaScript month number. */ getMonthNumber : function(name) { // handle camel casing for English month names (since the keys for the Ext.Date.monthNumbers hash are case sensitive) return Ext.Date.monthNumbers[name.substring(0, 1).toUpperCase() + name.substring(1, 3).toLowerCase()]; }, // /** * Checks if the specified format contains hour information * @param {String} format The format to check * @return {Boolean} True if the format contains hour information * @method */ formatContainsHourInfo : function(format){ return hourInfoRe.test(format.replace(stripEscapeRe, '')); }, /** * Checks if the specified format contains information about * anything other than the time. * @param {String} format The format to check * @return {Boolean} True if the format contains information about * date/day information. * @method */ formatContainsDateInfo : function(format){ return dateInfoRe.test(format.replace(stripEscapeRe, '')); }, /** * Removes all escaping for a date format string. In date formats, * using a '\' can be used to escape special characters. * @param {String} format The format to unescape * @return {String} The unescaped format * @method */ unescapeFormat: function(format) { // Escape the format, since \ can be used to escape special // characters in a date format. For example, in a Spanish // locale the format may be: 'd \\de F \\de Y' return format.replace(slashRe, ''); }, /** * The base format-code to formatting-function hashmap used by the {@link #format} method. * Formatting functions are strings (or functions which return strings) which * will return the appropriate value when evaluated in the context of the Date object * from which the {@link #format} method is called. * Add to / override these mappings for custom date formatting. * * __Note:__ Ext.Date.format() treats characters as literals if an appropriate mapping cannot be found. * * Example: * * Ext.Date.formatCodes.x = "Ext.util.Format.leftPad(this.getDate(), 2, '0')"; * console.log(Ext.Date.format(new Date(), 'X'); // returns the current day of the month * @type Object */ formatCodes : { d: "Ext.String.leftPad(this.getDate(), 2, '0')", D: "Ext.Date.getShortDayName(this.getDay())", // get localized short day name j: "this.getDate()", l: "Ext.Date.dayNames[this.getDay()]", N: "(this.getDay() ? this.getDay() : 7)", S: "Ext.Date.getSuffix(this)", w: "this.getDay()", z: "Ext.Date.getDayOfYear(this)", W: "Ext.String.leftPad(Ext.Date.getWeekOfYear(this), 2, '0')", F: "Ext.Date.monthNames[this.getMonth()]", m: "Ext.String.leftPad(this.getMonth() + 1, 2, '0')", M: "Ext.Date.getShortMonthName(this.getMonth())", // get localized short month name n: "(this.getMonth() + 1)", t: "Ext.Date.getDaysInMonth(this)", L: "(Ext.Date.isLeapYear(this) ? 1 : 0)", o: "(this.getFullYear() + (Ext.Date.getWeekOfYear(this) == 1 && this.getMonth() > 0 ? +1 : (Ext.Date.getWeekOfYear(this) >= 52 && this.getMonth() < 11 ? -1 : 0)))", Y: "Ext.String.leftPad(this.getFullYear(), 4, '0')", y: "('' + this.getFullYear()).substring(2, 4)", a: "(this.getHours() < 12 ? 'am' : 'pm')", A: "(this.getHours() < 12 ? 'AM' : 'PM')", g: "((this.getHours() % 12) ? this.getHours() % 12 : 12)", G: "this.getHours()", h: "Ext.String.leftPad((this.getHours() % 12) ? this.getHours() % 12 : 12, 2, '0')", H: "Ext.String.leftPad(this.getHours(), 2, '0')", i: "Ext.String.leftPad(this.getMinutes(), 2, '0')", s: "Ext.String.leftPad(this.getSeconds(), 2, '0')", u: "Ext.String.leftPad(this.getMilliseconds(), 3, '0')", O: "Ext.Date.getGMTOffset(this)", P: "Ext.Date.getGMTOffset(this, true)", T: "Ext.Date.getTimezone(this)", Z: "(this.getTimezoneOffset() * -60)", c: function() { // ISO-8601 -- GMT format var c, code, i, l, e; for (c = "Y-m-dTH:i:sP", code = [], i = 0, l = c.length; i < l; ++i) { e = c.charAt(i); code.push(e == "T" ? "'T'" : utilDate.getFormatCode(e)); // treat T as a character literal } return code.join(" + "); }, /* c: function() { // ISO-8601 -- UTC format return [ "this.getUTCFullYear()", "'-'", "Ext.util.Format.leftPad(this.getUTCMonth() + 1, 2, '0')", "'-'", "Ext.util.Format.leftPad(this.getUTCDate(), 2, '0')", "'T'", "Ext.util.Format.leftPad(this.getUTCHours(), 2, '0')", "':'", "Ext.util.Format.leftPad(this.getUTCMinutes(), 2, '0')", "':'", "Ext.util.Format.leftPad(this.getUTCSeconds(), 2, '0')", "'Z'" ].join(" + "); }, */ U: "Math.round(this.getTime() / 1000)" }, /** * Checks if the passed Date parameters will cause a JavaScript Date "rollover". * @param {Number} year 4-digit year * @param {Number} month 1-based month-of-year * @param {Number} day Day of month * @param {Number} hour (optional) Hour * @param {Number} minute (optional) Minute * @param {Number} second (optional) Second * @param {Number} millisecond (optional) Millisecond * @return {Boolean} `true` if the passed parameters do not cause a Date "rollover", `false` otherwise. */ isValid : function(y, m, d, h, i, s, ms) { // setup defaults h = h || 0; i = i || 0; s = s || 0; ms = ms || 0; // Special handling for year < 100 var dt = utilDate.add(new Date(y < 100 ? 100 : y, m - 1, d, h, i, s, ms), utilDate.YEAR, y < 100 ? y - 100 : 0); return y == dt.getFullYear() && m == dt.getMonth() + 1 && d == dt.getDate() && h == dt.getHours() && i == dt.getMinutes() && s == dt.getSeconds() && ms == dt.getMilliseconds(); }, /** * Parses the passed string using the specified date format. * Note that this function expects normal calendar dates, meaning that months are 1-based (i.e. 1 = January). * The {@link #defaults} hash will be used for any date value (i.e. year, month, day, hour, minute, second or millisecond) * which cannot be found in the passed string. If a corresponding default date value has not been specified in the {@link #defaults} hash, * the current date's year, month, day or DST-adjusted zero-hour time value will be used instead. * Keep in mind that the input date string must precisely match the specified format string * in order for the parse operation to be successful (failed parse operations return a null value). * * Example: * * //dt = Fri May 25 2007 (current date) * var dt = new Date(); * * //dt = Thu May 25 2006 (today's month/day in 2006) * dt = Ext.Date.parse("2006", "Y"); * * //dt = Sun Jan 15 2006 (all date parts specified) * dt = Ext.Date.parse("2006-01-15", "Y-m-d"); * * //dt = Sun Jan 15 2006 15:20:01 * dt = Ext.Date.parse("2006-01-15 3:20:01 PM", "Y-m-d g:i:s A"); * * // attempt to parse Sun Feb 29 2006 03:20:01 in strict mode * dt = Ext.Date.parse("2006-02-29 03:20:01", "Y-m-d H:i:s", true); // returns null * * @param {String} input The raw date string. * @param {String} format The expected date string format. * @param {Boolean} [strict=false] (optional) `true` to validate date strings while parsing (i.e. prevents JavaScript Date "rollover"). * Invalid date strings will return `null` when parsed. * @return {Date} The parsed Date. */ parse : function(input, format, strict) { var p = utilDate.parseFunctions; if (p[format] == null) { utilDate.createParser(format); } return p[format].call(utilDate, input, Ext.isDefined(strict) ? strict : utilDate.useStrict); }, // Backwards compat parseDate: function(input, format, strict){ return utilDate.parse(input, format, strict); }, // private getFormatCode : function(character) { var f = utilDate.formatCodes[character]; if (f) { f = typeof f == 'function'? f() : f; utilDate.formatCodes[character] = f; // reassign function result to prevent repeated execution } // note: unknown characters are treated as literals return f || ("'" + Ext.String.escape(character) + "'"); }, // private createFormat : function(format) { var code = [], special = false, ch = '', i; for (i = 0; i < format.length; ++i) { ch = format.charAt(i); if (!special && ch == "\\") { special = true; } else if (special) { special = false; code.push("'" + Ext.String.escape(ch) + "'"); } else { code.push(utilDate.getFormatCode(ch)); } } utilDate.formatFunctions[format] = Ext.functionFactory("return " + code.join('+')); }, // private createParser : function(format) { var regexNum = utilDate.parseRegexes.length, currentGroup = 1, calc = [], regex = [], special = false, ch = "", i = 0, len = format.length, atEnd = [], obj; for (; i < len; ++i) { ch = format.charAt(i); if (!special && ch == "\\") { special = true; } else if (special) { special = false; regex.push(Ext.String.escape(ch)); } else { obj = utilDate.formatCodeToRegex(ch, currentGroup); currentGroup += obj.g; regex.push(obj.s); if (obj.g && obj.c) { if (obj.calcAtEnd) { atEnd.push(obj.c); } else { calc.push(obj.c); } } } } calc = calc.concat(atEnd); utilDate.parseRegexes[regexNum] = new RegExp("^" + regex.join('') + "$", 'i'); utilDate.parseFunctions[format] = Ext.functionFactory("input", "strict", xf(code, regexNum, calc.join(''))); }, // private parseCodes : { /* * Notes: * g = {Number} calculation group (0 or 1. only group 1 contributes to date calculations.) * c = {String} calculation method (required for group 1. null for group 0. {0} = currentGroup - position in regex result array) * s = {String} regex pattern. all matches are stored in results[], and are accessible by the calculation mapped to 'c' */ d: { g:1, c:"d = parseInt(results[{0}], 10);\n", s:"(3[0-1]|[1-2][0-9]|0[1-9])" // day of month with leading zeroes (01 - 31) }, j: { g:1, c:"d = parseInt(results[{0}], 10);\n", s:"(3[0-1]|[1-2][0-9]|[1-9])" // day of month without leading zeroes (1 - 31) }, D: function() { for (var a = [], i = 0; i < 7; a.push(utilDate.getShortDayName(i)), ++i); // get localised short day names return { g:0, c:null, s:"(?:" + a.join("|") +")" }; }, l: function() { return { g:0, c:null, s:"(?:" + utilDate.dayNames.join("|") + ")" }; }, N: { g:0, c:null, s:"[1-7]" // ISO-8601 day number (1 (monday) - 7 (sunday)) }, // S: { g:0, c:null, s:"(?:st|nd|rd|th)" }, // w: { g:0, c:null, s:"[0-6]" // JavaScript day number (0 (sunday) - 6 (saturday)) }, z: { g:1, c:"z = parseInt(results[{0}], 10);\n", s:"(\\d{1,3})" // day of the year (0 - 364 (365 in leap years)) }, W: { g:1, c:"W = parseInt(results[{0}], 10);\n", s:"(\\d{2})" // ISO-8601 week number (with leading zero) }, F: function() { return { g:1, c:"m = parseInt(me.getMonthNumber(results[{0}]), 10);\n", // get localised month number s:"(" + utilDate.monthNames.join("|") + ")" }; }, M: function() { for (var a = [], i = 0; i < 12; a.push(utilDate.getShortMonthName(i)), ++i); // get localised short month names return Ext.applyIf({ s:"(" + a.join("|") + ")" }, utilDate.formatCodeToRegex("F")); }, m: { g:1, c:"m = parseInt(results[{0}], 10) - 1;\n", s:"(1[0-2]|0[1-9])" // month number with leading zeros (01 - 12) }, n: { g:1, c:"m = parseInt(results[{0}], 10) - 1;\n", s:"(1[0-2]|[1-9])" // month number without leading zeros (1 - 12) }, t: { g:0, c:null, s:"(?:\\d{2})" // no. of days in the month (28 - 31) }, L: { g:0, c:null, s:"(?:1|0)" }, o: { g: 1, c: "y = parseInt(results[{0}], 10);\n", s: "(\\d{4})" // ISO-8601 year number (with leading zero) }, Y: { g:1, c:"y = parseInt(results[{0}], 10);\n", s:"(\\d{4})" // 4-digit year }, y: { g:1, c:"var ty = parseInt(results[{0}], 10);\n" + "y = ty > me.y2kYear ? 1900 + ty : 2000 + ty;\n", // 2-digit year s:"(\\d{1,2})" }, /* * In the am/pm parsing routines, we allow both upper and lower case * even though it doesn't exactly match the spec. It gives much more flexibility * in being able to specify case insensitive regexes. */ // a: { g:1, c:"if (/(am)/i.test(results[{0}])) {\n" + "if (!h || h == 12) { h = 0; }\n" + "} else { if (!h || h < 12) { h = (h || 0) + 12; }}", s:"(am|pm|AM|PM)", calcAtEnd: true }, // // A: { g:1, c:"if (/(am)/i.test(results[{0}])) {\n" + "if (!h || h == 12) { h = 0; }\n" + "} else { if (!h || h < 12) { h = (h || 0) + 12; }}", s:"(AM|PM|am|pm)", calcAtEnd: true }, // g: { g:1, c:"h = parseInt(results[{0}], 10);\n", s:"(1[0-2]|[0-9])" // 12-hr format of an hour without leading zeroes (1 - 12) }, G: { g:1, c:"h = parseInt(results[{0}], 10);\n", s:"(2[0-3]|1[0-9]|[0-9])" // 24-hr format of an hour without leading zeroes (0 - 23) }, h: { g:1, c:"h = parseInt(results[{0}], 10);\n", s:"(1[0-2]|0[1-9])" // 12-hr format of an hour with leading zeroes (01 - 12) }, H: { g:1, c:"h = parseInt(results[{0}], 10);\n", s:"(2[0-3]|[0-1][0-9])" // 24-hr format of an hour with leading zeroes (00 - 23) }, i: { g:1, c:"i = parseInt(results[{0}], 10);\n", s:"([0-5][0-9])" // minutes with leading zeros (00 - 59) }, s: { g:1, c:"s = parseInt(results[{0}], 10);\n", s:"([0-5][0-9])" // seconds with leading zeros (00 - 59) }, u: { g:1, c:"ms = results[{0}]; ms = parseInt(ms, 10)/Math.pow(10, ms.length - 3);\n", s:"(\\d+)" // decimal fraction of a second (minimum = 1 digit, maximum = unlimited) }, O: { g:1, c:[ "o = results[{0}];", "var sn = o.substring(0,1),", // get + / - sign "hr = o.substring(1,3)*1 + Math.floor(o.substring(3,5) / 60),", // get hours (performs minutes-to-hour conversion also, just in case) "mn = o.substring(3,5) % 60;", // get minutes "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))? (sn + Ext.String.leftPad(hr, 2, '0') + Ext.String.leftPad(mn, 2, '0')) : null;\n" // -12hrs <= GMT offset <= 14hrs ].join("\n"), s: "([+-]\\d{4})" // GMT offset in hrs and mins }, P: { g:1, c:[ "o = results[{0}];", "var sn = o.substring(0,1),", // get + / - sign "hr = o.substring(1,3)*1 + Math.floor(o.substring(4,6) / 60),", // get hours (performs minutes-to-hour conversion also, just in case) "mn = o.substring(4,6) % 60;", // get minutes "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))? (sn + Ext.String.leftPad(hr, 2, '0') + Ext.String.leftPad(mn, 2, '0')) : null;\n" // -12hrs <= GMT offset <= 14hrs ].join("\n"), s: "([+-]\\d{2}:\\d{2})" // GMT offset in hrs and mins (with colon separator) }, T: { g:0, c:null, s:"[A-Z]{1,5}" // timezone abbrev. may be between 1 - 5 chars }, Z: { g:1, c:"zz = results[{0}] * 1;\n" // -43200 <= UTC offset <= 50400 + "zz = (-43200 <= zz && zz <= 50400)? zz : null;\n", s:"([+-]?\\d{1,5})" // leading '+' sign is optional for UTC offset }, c: function() { var calc = [], arr = [ utilDate.formatCodeToRegex("Y", 1), // year utilDate.formatCodeToRegex("m", 2), // month utilDate.formatCodeToRegex("d", 3), // day utilDate.formatCodeToRegex("H", 4), // hour utilDate.formatCodeToRegex("i", 5), // minute utilDate.formatCodeToRegex("s", 6), // second {c:"ms = results[7] || '0'; ms = parseInt(ms, 10)/Math.pow(10, ms.length - 3);\n"}, // decimal fraction of a second (minimum = 1 digit, maximum = unlimited) {c:[ // allow either "Z" (i.e. UTC) or "-0530" or "+08:00" (i.e. UTC offset) timezone delimiters. assumes local timezone if no timezone is specified "if(results[8]) {", // timezone specified "if(results[8] == 'Z'){", "zz = 0;", // UTC "}else if (results[8].indexOf(':') > -1){", utilDate.formatCodeToRegex("P", 8).c, // timezone offset with colon separator "}else{", utilDate.formatCodeToRegex("O", 8).c, // timezone offset without colon separator "}", "}" ].join('\n')} ], i, l; for (i = 0, l = arr.length; i < l; ++i) { calc.push(arr[i].c); } return { g:1, c:calc.join(""), s:[ arr[0].s, // year (required) "(?:", "-", arr[1].s, // month (optional) "(?:", "-", arr[2].s, // day (optional) "(?:", "(?:T| )?", // time delimiter -- either a "T" or a single blank space arr[3].s, ":", arr[4].s, // hour AND minute, delimited by a single colon (optional). MUST be preceded by either a "T" or a single blank space "(?::", arr[5].s, ")?", // seconds (optional) "(?:(?:\\.|,)(\\d+))?", // decimal fraction of a second (e.g. ",12345" or ".98765") (optional) "(Z|(?:[-+]\\d{2}(?::)?\\d{2}))?", // "Z" (UTC) or "-0530" (UTC offset without colon delimiter) or "+08:00" (UTC offset with colon delimiter) (optional) ")?", ")?", ")?" ].join("") }; }, U: { g:1, c:"u = parseInt(results[{0}], 10);\n", s:"(-?\\d+)" // leading minus sign indicates seconds before UNIX epoch } }, //Old Ext.Date prototype methods. // private dateFormat: function(date, format) { return utilDate.format(date, format); }, /** * Compares if two dates are equal by comparing their values. * @param {Date} date1 * @param {Date} date2 * @return {Boolean} `true` if the date values are equal */ isEqual: function(date1, date2) { // check we have 2 date objects if (date1 && date2) { return (date1.getTime() === date2.getTime()); } // one or both isn't a date, only equal if both are falsey return !(date1 || date2); }, /** * Formats a date given the supplied format string. * @param {Date} date The date to format * @param {String} format The format string * @return {String} The formatted date or an empty string if date parameter is not a JavaScript Date object */ format: function(date, format) { var formatFunctions = utilDate.formatFunctions; if (!Ext.isDate(date)) { return ''; } if (formatFunctions[format] == null) { utilDate.createFormat(format); } return formatFunctions[format].call(date) + ''; }, /** * Get the timezone abbreviation of the current date (equivalent to the format specifier 'T'). * * __Note:__ The date string returned by the JavaScript Date object's `toString()` method varies * between browsers (e.g. FF vs IE) and system region settings (e.g. IE in Asia vs IE in America). * For a given date string e.g. "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)", * getTimezone() first tries to get the timezone abbreviation from between a pair of parentheses * (which may or may not be present), failing which it proceeds to get the timezone abbreviation * from the GMT offset portion of the date string. * @param {Date} date The date * @return {String} The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...). */ getTimezone : function(date) { // the following list shows the differences between date strings from different browsers on a WinXP SP2 machine from an Asian locale: // // Opera : "Thu, 25 Oct 2007 22:53:45 GMT+0800" -- shortest (weirdest) date string of the lot // Safari : "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)" -- value in parentheses always gives the correct timezone (same as FF) // FF : "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)" -- value in parentheses always gives the correct timezone // IE : "Thu Oct 25 22:54:35 UTC+0800 2007" -- (Asian system setting) look for 3-4 letter timezone abbrev // IE : "Thu Oct 25 17:06:37 PDT 2007" -- (American system setting) look for 3-4 letter timezone abbrev // // this crazy regex attempts to guess the correct timezone abbreviation despite these differences. // step 1: (?:\((.*)\) -- find timezone in parentheses // step 2: ([A-Z]{1,4})(?:[\-+][0-9]{4})?(?: -?\d+)?) -- if nothing was found in step 1, find timezone from timezone offset portion of date string // step 3: remove all non uppercase characters found in step 1 and 2 return date.toString().replace(/^.* (?:\((.*)\)|([A-Z]{1,5})(?:[\-+][0-9]{4})?(?: -?\d+)?)$/, "$1$2").replace(/[^A-Z]/g, ""); }, /** * Get the offset from GMT of the current date (equivalent to the format specifier 'O'). * @param {Date} date The date * @param {Boolean} [colon=false] (optional) true to separate the hours and minutes with a colon. * @return {String} The 4-character offset string prefixed with + or - (e.g. '-0600'). */ getGMTOffset : function(date, colon) { var offset = date.getTimezoneOffset(); return (offset > 0 ? "-" : "+") + Ext.String.leftPad(Math.floor(Math.abs(offset) / 60), 2, "0") + (colon ? ":" : "") + Ext.String.leftPad(Math.abs(offset % 60), 2, "0"); }, /** * Get the numeric day number of the year, adjusted for leap year. * @param {Date} date The date * @return {Number} 0 to 364 (365 in leap years). */ getDayOfYear: function(date) { var num = 0, d = Ext.Date.clone(date), m = date.getMonth(), i; for (i = 0, d.setDate(1), d.setMonth(0); i < m; d.setMonth(++i)) { num += utilDate.getDaysInMonth(d); } return num + date.getDate() - 1; }, /** * Get the numeric ISO-8601 week number of the year. * (equivalent to the format specifier 'W', but without a leading zero). * @param {Date} date The date * @return {Number} 1 to 53 * @method */ getWeekOfYear : (function() { // adapted from http://www.merlyn.demon.co.uk/weekcalc.htm var ms1d = 864e5, // milliseconds in a day ms7d = 7 * ms1d; // milliseconds in a week return function(date) { // return a closure so constants get calculated only once var DC3 = Date.UTC(date.getFullYear(), date.getMonth(), date.getDate() + 3) / ms1d, // an Absolute Day Number AWN = Math.floor(DC3 / 7), // an Absolute Week Number Wyr = new Date(AWN * ms7d).getUTCFullYear(); return AWN - Math.floor(Date.UTC(Wyr, 0, 7) / ms7d) + 1; }; }()), /** * Checks if the current date falls within a leap year. * @param {Date} date The date * @return {Boolean} True if the current date falls within a leap year, false otherwise. */ isLeapYear : function(date) { var year = date.getFullYear(); return !!((year & 3) == 0 && (year % 100 || (year % 400 == 0 && year))); }, /** * Get the first day of the current month, adjusted for leap year. The returned value * is the numeric day index within the week (0-6) which can be used in conjunction with * the {@link #monthNames} array to retrieve the textual day name. * * Example: * * var dt = new Date('1/10/2007'), * firstDay = Ext.Date.getFirstDayOfMonth(dt); * console.log(Ext.Date.dayNames[firstDay]); // output: 'Monday' * * @param {Date} date The date * @return {Number} The day number (0-6). */ getFirstDayOfMonth : function(date) { var day = (date.getDay() - (date.getDate() - 1)) % 7; return (day < 0) ? (day + 7) : day; }, /** * Get the last day of the current month, adjusted for leap year. The returned value * is the numeric day index within the week (0-6) which can be used in conjunction with * the {@link #monthNames} array to retrieve the textual day name. * * Example: * * var dt = new Date('1/10/2007'), * lastDay = Ext.Date.getLastDayOfMonth(dt); * console.log(Ext.Date.dayNames[lastDay]); // output: 'Wednesday' * * @param {Date} date The date * @return {Number} The day number (0-6). */ getLastDayOfMonth : function(date) { return utilDate.getLastDateOfMonth(date).getDay(); }, /** * Get the date of the first day of the month in which this date resides. * @param {Date} date The date * @return {Date} */ getFirstDateOfMonth : function(date) { return new Date(date.getFullYear(), date.getMonth(), 1); }, /** * Get the date of the last day of the month in which this date resides. * @param {Date} date The date * @return {Date} */ getLastDateOfMonth : function(date) { return new Date(date.getFullYear(), date.getMonth(), utilDate.getDaysInMonth(date)); }, /** * Get the number of days in the current month, adjusted for leap year. * @param {Date} date The date * @return {Number} The number of days in the month. * @method */ getDaysInMonth: (function() { var daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]; return function(date) { // return a closure for efficiency var m = date.getMonth(); return m == 1 && utilDate.isLeapYear(date) ? 29 : daysInMonth[m]; }; }()), // /** * Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). * @param {Date} date The date * @return {String} 'st, 'nd', 'rd' or 'th'. */ getSuffix : function(date) { switch (date.getDate()) { case 1: case 21: case 31: return "st"; case 2: case 22: return "nd"; case 3: case 23: return "rd"; default: return "th"; } }, // /** * Creates and returns a new Date instance with the exact same date value as the called instance. * Dates are copied and passed by reference, so if a copied date variable is modified later, the original * variable will also be changed. When the intention is to create a new variable that will not * modify the original instance, you should create a clone. * * Example of correctly cloning a date: * * //wrong way: * var orig = new Date('10/1/2006'); * var copy = orig; * copy.setDate(5); * console.log(orig); // returns 'Thu Oct 05 2006'! * * //correct way: * var orig = new Date('10/1/2006'), * copy = Ext.Date.clone(orig); * copy.setDate(5); * console.log(orig); // returns 'Thu Oct 01 2006' * * @param {Date} date The date. * @return {Date} The new Date instance. */ clone : function(date) { return new Date(date.getTime()); }, /** * Checks if the current date is affected by Daylight Saving Time (DST). * @param {Date} date The date * @return {Boolean} `true` if the current date is affected by DST. */ isDST : function(date) { // adapted from http://sencha.com/forum/showthread.php?p=247172#post247172 // courtesy of @geoffrey.mcgill return new Date(date.getFullYear(), 0, 1).getTimezoneOffset() != date.getTimezoneOffset(); }, /** * Attempts to clear all time information from this Date by setting the time to midnight of the same day, * automatically adjusting for Daylight Saving Time (DST) where applicable. * * __Note:__ DST timezone information for the browser's host operating system is assumed to be up-to-date. * @param {Date} date The date * @param {Boolean} [clone=false] `true` to create a clone of this date, clear the time and return it. * @return {Date} this or the clone. */ clearTime : function(date, clone) { if (clone) { return Ext.Date.clearTime(Ext.Date.clone(date)); } // get current date before clearing time var d = date.getDate(), hr, c; // clear time date.setHours(0); date.setMinutes(0); date.setSeconds(0); date.setMilliseconds(0); if (date.getDate() != d) { // account for DST (i.e. day of month changed when setting hour = 0) // note: DST adjustments are assumed to occur in multiples of 1 hour (this is almost always the case) // refer to http://www.timeanddate.com/time/aboutdst.html for the (rare) exceptions to this rule // increment hour until cloned date == current date for (hr = 1, c = utilDate.add(date, Ext.Date.HOUR, hr); c.getDate() != d; hr++, c = utilDate.add(date, Ext.Date.HOUR, hr)); date.setDate(d); date.setHours(c.getHours()); } return date; }, /** * Provides a convenient method for performing basic date arithmetic. This method * does not modify the Date instance being called - it creates and returns * a new Date instance containing the resulting date value. * * Examples: * * // Basic usage: * var dt = Ext.Date.add(new Date('10/29/2006'), Ext.Date.DAY, 5); * console.log(dt); // returns 'Fri Nov 03 2006 00:00:00' * * // Negative values will be subtracted: * var dt2 = Ext.Date.add(new Date('10/1/2006'), Ext.Date.DAY, -5); * console.log(dt2); // returns 'Tue Sep 26 2006 00:00:00' * * // Decimal values can be used: * var dt3 = Ext.Date.add(new Date('10/1/2006'), Ext.Date.DAY, 1.25); * console.log(dt3); // returns 'Mon Oct 02 2006 06:00:00' * * @param {Date} date The date to modify * @param {String} interval A valid date interval enum value. * @param {Number} value The amount to add to the current date. * @return {Date} The new Date instance. */ add : function(date, interval, value) { var d = Ext.Date.clone(date), Date = Ext.Date, day, decimalValue, base = 0; if (!interval || value === 0) { return d; } decimalValue = value - parseInt(value, 10); value = parseInt(value, 10); if (value) { switch(interval.toLowerCase()) { // See EXTJSIV-7418. We use setTime() here to deal with issues related to // the switchover that occurs when changing to daylight savings and vice // versa. setTime() handles this correctly where setHour/Minute/Second/Millisecond // do not. Let's assume the DST change occurs at 2am and we're incrementing using add // for 15 minutes at time. When entering DST, we should see: // 01:30am // 01:45am // 03:00am // skip 2am because the hour does not exist // ... // Similarly, leaving DST, we should see: // 01:30am // 01:45am // 01:00am // repeat 1am because that's the change over // 01:30am // 01:45am // 02:00am // .... // case Ext.Date.MILLI: d.setTime(d.getTime() + value); break; case Ext.Date.SECOND: d.setTime(d.getTime() + value * 1000); break; case Ext.Date.MINUTE: d.setTime(d.getTime() + value * 60 * 1000); break; case Ext.Date.HOUR: d.setTime(d.getTime() + value * 60 * 60 * 1000); break; case Ext.Date.DAY: d.setDate(d.getDate() + value); break; case Ext.Date.MONTH: day = date.getDate(); if (day > 28) { day = Math.min(day, Ext.Date.getLastDateOfMonth(Ext.Date.add(Ext.Date.getFirstDateOfMonth(date), Ext.Date.MONTH, value)).getDate()); } d.setDate(day); d.setMonth(date.getMonth() + value); break; case Ext.Date.YEAR: day = date.getDate(); if (day > 28) { day = Math.min(day, Ext.Date.getLastDateOfMonth(Ext.Date.add(Ext.Date.getFirstDateOfMonth(date), Ext.Date.YEAR, value)).getDate()); } d.setDate(day); d.setFullYear(date.getFullYear() + value); break; } } if (decimalValue) { switch (interval.toLowerCase()) { case Ext.Date.MILLI: base = 1; break; case Ext.Date.SECOND: base = 1000; break; case Ext.Date.MINUTE: base = 1000*60; break; case Ext.Date.HOUR: base = 1000*60*60; break; case Ext.Date.DAY: base = 1000*60*60*24; break; case Ext.Date.MONTH: day = utilDate.getDaysInMonth(d); base = 1000*60*60*24*day; break; case Ext.Date.YEAR: day = (utilDate.isLeapYear(d) ? 366 : 365); base = 1000*60*60*24*day; break; } if (base) { d.setTime(d.getTime() + base * decimalValue); } } return d; }, /** * Provides a convenient method for performing basic date arithmetic. This method * does not modify the Date instance being called - it creates and returns * a new Date instance containing the resulting date value. * * Examples: * * // Basic usage: * var dt = Ext.Date.subtract(new Date('10/29/2006'), Ext.Date.DAY, 5); * console.log(dt); // returns 'Tue Oct 24 2006 00:00:00' * * // Negative values will be added: * var dt2 = Ext.Date.subtract(new Date('10/1/2006'), Ext.Date.DAY, -5); * console.log(dt2); // returns 'Fri Oct 6 2006 00:00:00' * * // Decimal values can be used: * var dt3 = Ext.Date.subtract(new Date('10/1/2006'), Ext.Date.DAY, 1.25); * console.log(dt3); // returns 'Fri Sep 29 2006 06:00:00' * * @param {Date} date The date to modify * @param {String} interval A valid date interval enum value. * @param {Number} value The amount to subtract from the current date. * @return {Date} The new Date instance. */ subtract: function(date, interval, value){ return utilDate.add(date, interval, -value); }, /** * Checks if a date falls on or between the given start and end dates. * @param {Date} date The date to check * @param {Date} start Start date * @param {Date} end End date * @return {Boolean} `true` if this date falls on or between the given start and end dates. */ between : function(date, start, end) { var t = date.getTime(); return start.getTime() <= t && t <= end.getTime(); }, //Maintains compatibility with old static and prototype window.Date methods. compat: function() { var nativeDate = window.Date, p, statics = ['useStrict', 'formatCodeToRegex', 'parseFunctions', 'parseRegexes', 'formatFunctions', 'y2kYear', 'MILLI', 'SECOND', 'MINUTE', 'HOUR', 'DAY', 'MONTH', 'YEAR', 'defaults', 'dayNames', 'monthNames', 'monthNumbers', 'getShortMonthName', 'getShortDayName', 'getMonthNumber', 'formatCodes', 'isValid', 'parseDate', 'getFormatCode', 'createFormat', 'createParser', 'parseCodes'], proto = ['dateFormat', 'format', 'getTimezone', 'getGMTOffset', 'getDayOfYear', 'getWeekOfYear', 'isLeapYear', 'getFirstDayOfMonth', 'getLastDayOfMonth', 'getDaysInMonth', 'getSuffix', 'clone', 'isDST', 'clearTime', 'add', 'between'], sLen = statics.length, pLen = proto.length, stat, prot, s; //Append statics for (s = 0; s < sLen; s++) { stat = statics[s]; nativeDate[stat] = utilDate[stat]; } //Append to prototype for (p = 0; p < pLen; p++) { prot = proto[p]; nativeDate.prototype[prot] = function() { var args = Array.prototype.slice.call(arguments); args.unshift(this); return utilDate[prot].apply(utilDate, args); }; } } }); }; // @tag foundation,core // @require ../lang/Date.js // @define Ext.Base /** * @author Jacky Nguyen * @docauthor Jacky Nguyen * @class Ext.Base * * The root of all classes created with {@link Ext#define}. * * Ext.Base is the building block of all Ext classes. All classes in Ext inherit from Ext.Base. * All prototype and static members of this class are inherited by all other classes. */ (function(flexSetter) { var noArgs = [], Base = function(){}, hookFunctionFactory = function(hookFunction, underriddenFunction, methodName, owningClass) { var result = function() { var result = this.callParent(arguments); hookFunction.apply(this, arguments); return result; }; result.$name = methodName; result.$owner = owningClass; if (underriddenFunction) { result.$previous = underriddenFunction.$previous; underriddenFunction.$previous = result; } return result; }; // These static properties will be copied to every newly created class with {@link Ext#define} Ext.apply(Base, { $className: 'Ext.Base', $isClass: true, /** * Create a new instance of this Class. * * Ext.define('My.cool.Class', { * ... * }); * * My.cool.Class.create({ * someConfig: true * }); * * All parameters are passed to the constructor of the class. * * @return {Object} the created instance. * @static * @inheritable */ create: function() { return Ext.create.apply(Ext, [this].concat(Array.prototype.slice.call(arguments, 0))); }, /** * @private * @static * @inheritable * @param config */ extend: function(parent) { var parentPrototype = parent.prototype, basePrototype, prototype, i, ln, name, statics; prototype = this.prototype = Ext.Object.chain(parentPrototype); prototype.self = this; this.superclass = prototype.superclass = parentPrototype; if (!parent.$isClass) { basePrototype = Ext.Base.prototype; for (i in basePrototype) { if (i in prototype) { prototype[i] = basePrototype[i]; } } } // Statics inheritance statics = parentPrototype.$inheritableStatics; if (statics) { for (i = 0,ln = statics.length; i < ln; i++) { name = statics[i]; if (!this.hasOwnProperty(name)) { this[name] = parent[name]; } } } if (parent.$onExtended) { this.$onExtended = parent.$onExtended.slice(); } prototype.config = new prototype.configClass(); prototype.initConfigList = prototype.initConfigList.slice(); prototype.initConfigMap = Ext.clone(prototype.initConfigMap); prototype.configMap = Ext.Object.chain(prototype.configMap); }, /** * @private * @static * @inheritable */ $onExtended: [], /** * @private * @static * @inheritable */ triggerExtended: function() { Ext.classSystemMonitor && Ext.classSystemMonitor(this, 'Ext.Base#triggerExtended', arguments); var callbacks = this.$onExtended, ln = callbacks.length, i, callback; if (ln > 0) { for (i = 0; i < ln; i++) { callback = callbacks[i]; callback.fn.apply(callback.scope || this, arguments); } } }, /** * @private * @static * @inheritable */ onExtended: function(fn, scope) { this.$onExtended.push({ fn: fn, scope: scope }); return this; }, /** * @private * @static * @inheritable * @param config */ addConfig: function(config, fullMerge) { var prototype = this.prototype, configNameCache = Ext.Class.configNameCache, hasConfig = prototype.configMap, initConfigList = prototype.initConfigList, initConfigMap = prototype.initConfigMap, defaultConfig = prototype.config, initializedName, name, value; for (name in config) { if (config.hasOwnProperty(name)) { if (!hasConfig[name]) { hasConfig[name] = true; } value = config[name]; initializedName = configNameCache[name].initialized; if (!initConfigMap[name] && value !== null && !prototype[initializedName]) { initConfigMap[name] = true; initConfigList.push(name); } } } if (fullMerge) { Ext.merge(defaultConfig, config); } else { Ext.mergeIf(defaultConfig, config); } prototype.configClass = Ext.Object.classify(defaultConfig); }, /** * Add / override static properties of this class. * * Ext.define('My.cool.Class', { * ... * }); * * My.cool.Class.addStatics({ * someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue' * method1: function() { ... }, // My.cool.Class.method1 = function() { ... }; * method2: function() { ... } // My.cool.Class.method2 = function() { ... }; * }); * * @param {Object} members * @return {Ext.Base} this * @static * @inheritable */ addStatics: function(members) { var member, name; for (name in members) { if (members.hasOwnProperty(name)) { member = members[name]; if (typeof member == 'function' && !member.$isClass && member !== Ext.emptyFn && member !== Ext.identityFn) { member.$owner = this; member.$name = name; member.displayName = Ext.getClassName(this) + '.' + name; } this[name] = member; } } return this; }, /** * @private * @static * @inheritable * @param {Object} members */ addInheritableStatics: function(members) { var inheritableStatics, hasInheritableStatics, prototype = this.prototype, name, member; inheritableStatics = prototype.$inheritableStatics; hasInheritableStatics = prototype.$hasInheritableStatics; if (!inheritableStatics) { inheritableStatics = prototype.$inheritableStatics = []; hasInheritableStatics = prototype.$hasInheritableStatics = {}; } for (name in members) { if (members.hasOwnProperty(name)) { member = members[name]; if (typeof member == 'function') { member.displayName = Ext.getClassName(this) + '.' + name; } this[name] = member; if (!hasInheritableStatics[name]) { hasInheritableStatics[name] = true; inheritableStatics.push(name); } } } return this; }, /** * Add methods / properties to the prototype of this class. * * Ext.define('My.awesome.Cat', { * constructor: function() { * ... * } * }); * * My.awesome.Cat.addMembers({ * meow: function() { * alert('Meowww...'); * } * }); * * var kitty = new My.awesome.Cat; * kitty.meow(); * * @param {Object} members * @static * @inheritable */ addMembers: function(members) { var prototype = this.prototype, enumerables = Ext.enumerables, names = [], i, ln, name, member; for (name in members) { names.push(name); } if (enumerables) { names.push.apply(names, enumerables); } for (i = 0,ln = names.length; i < ln; i++) { name = names[i]; if (members.hasOwnProperty(name)) { member = members[name]; if (typeof member == 'function' && !member.$isClass && member !== Ext.emptyFn && member !== Ext.identityFn) { member.$owner = this; member.$name = name; member.displayName = (this.$className || '') + '#' + name; } prototype[name] = member; } } return this; }, /** * @private * @static * @inheritable * @param name * @param member */ addMember: function(name, member) { if (typeof member == 'function' && !member.$isClass && member !== Ext.emptyFn && member !== Ext.identityFn) { member.$owner = this; member.$name = name; member.displayName = (this.$className || '') + '#' + name; } this.prototype[name] = member; return this; }, /** * Adds members to class. * @static * @inheritable * @deprecated 4.1 Use {@link #addMembers} instead. */ implement: function() { this.addMembers.apply(this, arguments); }, /** * Borrow another class' members to the prototype of this class. * * Ext.define('Bank', { * money: '$$$', * printMoney: function() { * alert('$$$$$$$'); * } * }); * * Ext.define('Thief', { * ... * }); * * Thief.borrow(Bank, ['money', 'printMoney']); * * var steve = new Thief(); * * alert(steve.money); // alerts '$$$' * steve.printMoney(); // alerts '$$$$$$$' * * @param {Ext.Base} fromClass The class to borrow members from * @param {Array/String} members The names of the members to borrow * @return {Ext.Base} this * @static * @inheritable * @private */ borrow: function(fromClass, members) { Ext.classSystemMonitor && Ext.classSystemMonitor(this, 'Ext.Base#borrow', arguments); var prototype = this.prototype, fromPrototype = fromClass.prototype, className = Ext.getClassName(this), i, ln, name, fn, toBorrow; members = Ext.Array.from(members); for (i = 0,ln = members.length; i < ln; i++) { name = members[i]; toBorrow = fromPrototype[name]; if (typeof toBorrow == 'function') { fn = Ext.Function.clone(toBorrow); if (className) { fn.displayName = className + '#' + name; } fn.$owner = this; fn.$name = name; prototype[name] = fn; } else { prototype[name] = toBorrow; } } return this; }, /** * Override members of this class. Overridden methods can be invoked via * {@link Ext.Base#callParent}. * * Ext.define('My.Cat', { * constructor: function() { * alert("I'm a cat!"); * } * }); * * My.Cat.override({ * constructor: function() { * alert("I'm going to be a cat!"); * * this.callParent(arguments); * * alert("Meeeeoooowwww"); * } * }); * * var kitty = new My.Cat(); // alerts "I'm going to be a cat!" * // alerts "I'm a cat!" * // alerts "Meeeeoooowwww" * * As of 4.1, direct use of this method is deprecated. Use {@link Ext#define Ext.define} * instead: * * Ext.define('My.CatOverride', { * override: 'My.Cat', * constructor: function() { * alert("I'm going to be a cat!"); * * this.callParent(arguments); * * alert("Meeeeoooowwww"); * } * }); * * The above accomplishes the same result but can be managed by the {@link Ext.Loader} * which can properly order the override and its target class and the build process * can determine whether the override is needed based on the required state of the * target class (My.Cat). * * @param {Object} members The properties to add to this class. This should be * specified as an object literal containing one or more properties. * @return {Ext.Base} this class * @static * @inheritable * @markdown * @deprecated 4.1.0 Use {@link Ext#define Ext.define} instead */ override: function(members) { var me = this, enumerables = Ext.enumerables, target = me.prototype, cloneFunction = Ext.Function.clone, name, index, member, statics, names, previous; if (arguments.length === 2) { name = members; members = {}; members[name] = arguments[1]; enumerables = null; } do { names = []; // clean slate for prototype (1st pass) and static (2nd pass) statics = null; // not needed 1st pass, but needs to be cleared for 2nd pass for (name in members) { // hasOwnProperty is checked in the next loop... if (name == 'statics') { statics = members[name]; } else if (name == 'inheritableStatics'){ me.addInheritableStatics(members[name]); } else if (name == 'config') { me.addConfig(members[name], true); } else { names.push(name); } } if (enumerables) { names.push.apply(names, enumerables); } for (index = names.length; index--; ) { name = names[index]; if (members.hasOwnProperty(name)) { member = members[name]; if (typeof member == 'function' && !member.$className && member !== Ext.emptyFn && member !== Ext.identityFn) { if (typeof member.$owner != 'undefined') { member = cloneFunction(member); } if (me.$className) { member.displayName = me.$className + '#' + name; } member.$owner = me; member.$name = name; previous = target[name]; if (previous) { member.$previous = previous; } } target[name] = member; } } target = me; // 2nd pass is for statics members = statics; // statics will be null on 2nd pass } while (members); return this; }, // Documented downwards callParent: function(args) { var method; // This code is intentionally inlined for the least number of debugger stepping return (method = this.callParent.caller) && (method.$previous || ((method = method.$owner ? method : method.caller) && method.$owner.superclass.self[method.$name])).apply(this, args || noArgs); }, // Documented downwards callSuper: function(args) { var method; // This code is intentionally inlined for the least number of debugger stepping return (method = this.callSuper.caller) && ((method = method.$owner ? method : method.caller) && method.$owner.superclass.self[method.$name]).apply(this, args || noArgs); }, /** * Used internally by the mixins pre-processor * @private * @static * @inheritable */ mixin: function(name, mixinClass) { var me = this, mixin = mixinClass.prototype, prototype = me.prototype, key, statics, i, ln, staticName, mixinValue, hookKey, hookFunction; if (typeof mixin.onClassMixedIn != 'undefined') { mixin.onClassMixedIn.call(mixinClass, me); } if (!prototype.hasOwnProperty('mixins')) { if ('mixins' in prototype) { prototype.mixins = Ext.Object.chain(prototype.mixins); } else { prototype.mixins = {}; } } for (key in mixin) { mixinValue = mixin[key]; if (key === 'mixins') { Ext.merge(prototype.mixins, mixinValue); } else if (key === 'xhooks') { for (hookKey in mixinValue) { hookFunction = mixinValue[hookKey]; // Mixed in xhook methods cannot call a parent. hookFunction.$previous = Ext.emptyFn; if (prototype.hasOwnProperty(hookKey)) { // Pass the hook function, and the existing function which it is to underride. // The existing function has its $previous pointer replaced by a closure // which calls the hookFunction and then the existing function's original $previous hookFunctionFactory(hookFunction, prototype[hookKey], hookKey, me); } else { // There's no original function, so generate an implementation which calls // the hook function. It will not get any $previous pointer. prototype[hookKey] = hookFunctionFactory(hookFunction, null, hookKey, me); } } } else if (!(key === 'mixinId' || key === 'config') && (prototype[key] === undefined)) { prototype[key] = mixinValue; } } // Mixin statics inheritance statics = mixin.$inheritableStatics; if (statics) { for (i = 0, ln = statics.length; i < ln; i++) { staticName = statics[i]; if (!me.hasOwnProperty(staticName)) { me[staticName] = mixinClass[staticName]; } } } if ('config' in mixin) { me.addConfig(mixin.config, false); } prototype.mixins[name] = mixin; return me; }, /** * Get the current class' name in string format. * * Ext.define('My.cool.Class', { * constructor: function() { * alert(this.self.getName()); // alerts 'My.cool.Class' * } * }); * * My.cool.Class.getName(); // 'My.cool.Class' * * @return {String} className * @static * @inheritable */ getName: function() { return Ext.getClassName(this); }, /** * Create aliases for existing prototype methods. Example: * * Ext.define('My.cool.Class', { * method1: function() { ... }, * method2: function() { ... } * }); * * var test = new My.cool.Class(); * * My.cool.Class.createAlias({ * method3: 'method1', * method4: 'method2' * }); * * test.method3(); // test.method1() * * My.cool.Class.createAlias('method5', 'method3'); * * test.method5(); // test.method3() -> test.method1() * * @param {String/Object} alias The new method name, or an object to set multiple aliases. See * {@link Ext.Function#flexSetter flexSetter} * @param {String/Object} origin The original method name * @static * @inheritable * @method */ createAlias: flexSetter(function(alias, origin) { this.override(alias, function() { return this[origin].apply(this, arguments); }); }), /** * @private * @static * @inheritable */ addXtype: function(xtype) { var prototype = this.prototype, xtypesMap = prototype.xtypesMap, xtypes = prototype.xtypes, xtypesChain = prototype.xtypesChain; if (!prototype.hasOwnProperty('xtypesMap')) { xtypesMap = prototype.xtypesMap = Ext.merge({}, prototype.xtypesMap || {}); xtypes = prototype.xtypes = prototype.xtypes ? [].concat(prototype.xtypes) : []; xtypesChain = prototype.xtypesChain = prototype.xtypesChain ? [].concat(prototype.xtypesChain) : []; prototype.xtype = xtype; } if (!xtypesMap[xtype]) { xtypesMap[xtype] = true; xtypes.push(xtype); xtypesChain.push(xtype); Ext.ClassManager.setAlias(this, 'widget.' + xtype); } return this; } }); Base.implement({ /** @private */ isInstance: true, /** @private */ $className: 'Ext.Base', /** @private */ configClass: Ext.emptyFn, /** @private */ initConfigList: [], /** @private */ configMap: {}, /** @private */ initConfigMap: {}, /** * Get the reference to the class from which this object was instantiated. Note that unlike {@link Ext.Base#self}, * `this.statics()` is scope-independent and it always returns the class from which it was called, regardless of what * `this` points to during run-time * * Ext.define('My.Cat', { * statics: { * totalCreated: 0, * speciesName: 'Cat' // My.Cat.speciesName = 'Cat' * }, * * constructor: function() { * var statics = this.statics(); * * alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to * // equivalent to: My.Cat.speciesName * * alert(this.self.speciesName); // dependent on 'this' * * statics.totalCreated++; * }, * * clone: function() { * var cloned = new this.self; // dependent on 'this' * * cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName * * return cloned; * } * }); * * * Ext.define('My.SnowLeopard', { * extend: 'My.Cat', * * statics: { * speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard' * }, * * constructor: function() { * this.callParent(); * } * }); * * var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat' * * var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard' * * var clone = snowLeopard.clone(); * alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard' * alert(clone.groupName); // alerts 'Cat' * * alert(My.Cat.totalCreated); // alerts 3 * * @protected * @return {Ext.Class} */ statics: function() { var method = this.statics.caller, self = this.self; if (!method) { return self; } return method.$owner; }, /** * Call the "parent" method of the current method. That is the method previously * overridden by derivation or by an override (see {@link Ext#define}). * * Ext.define('My.Base', { * constructor: function (x) { * this.x = x; * }, * * statics: { * method: function (x) { * return x; * } * } * }); * * Ext.define('My.Derived', { * extend: 'My.Base', * * constructor: function () { * this.callParent([21]); * } * }); * * var obj = new My.Derived(); * * alert(obj.x); // alerts 21 * * This can be used with an override as follows: * * Ext.define('My.DerivedOverride', { * override: 'My.Derived', * * constructor: function (x) { * this.callParent([x*2]); // calls original My.Derived constructor * } * }); * * var obj = new My.Derived(); * * alert(obj.x); // now alerts 42 * * This also works with static methods. * * Ext.define('My.Derived2', { * extend: 'My.Base', * * statics: { * method: function (x) { * return this.callParent([x*2]); // calls My.Base.method * } * } * }); * * alert(My.Base.method(10); // alerts 10 * alert(My.Derived2.method(10); // alerts 20 * * Lastly, it also works with overridden static methods. * * Ext.define('My.Derived2Override', { * override: 'My.Derived2', * * statics: { * method: function (x) { * return this.callParent([x*2]); // calls My.Derived2.method * } * } * }); * * alert(My.Derived2.method(10); // now alerts 40 * * To override a method and replace it and also call the superclass method, use * {@link #callSuper}. This is often done to patch a method to fix a bug. * * @protected * @param {Array/Arguments} args The arguments, either an array or the `arguments` object * from the current method, for example: `this.callParent(arguments)` * @return {Object} Returns the result of calling the parent method */ callParent: function(args) { // NOTE: this code is deliberately as few expressions (and no function calls) // as possible so that a debugger can skip over this noise with the minimum number // of steps. Basically, just hit Step Into until you are where you really wanted // to be. var method, superMethod = (method = this.callParent.caller) && (method.$previous || ((method = method.$owner ? method : method.caller) && method.$owner.superclass[method.$name])); if (!superMethod) { method = this.callParent.caller; var parentClass, methodName; if (!method.$owner) { if (!method.caller) { throw new Error("Attempting to call a protected method from the public scope, which is not allowed"); } method = method.caller; } parentClass = method.$owner.superclass; methodName = method.$name; if (!(methodName in parentClass)) { throw new Error("this.callParent() was called but there's no such method (" + methodName + ") found in the parent class (" + (Ext.getClassName(parentClass) || 'Object') + ")"); } } return superMethod.apply(this, args || noArgs); }, /** * This method is used by an override to call the superclass method but bypass any * overridden method. This is often done to "patch" a method that contains a bug * but for whatever reason cannot be fixed directly. * * Consider: * * Ext.define('Ext.some.Class', { * method: function () { * console.log('Good'); * } * }); * * Ext.define('Ext.some.DerivedClass', { * method: function () { * console.log('Bad'); * * // ... logic but with a bug ... * * this.callParent(); * } * }); * * To patch the bug in `DerivedClass.method`, the typical solution is to create an * override: * * Ext.define('App.paches.DerivedClass', { * override: 'Ext.some.DerivedClass', * * method: function () { * console.log('Fixed'); * * // ... logic but with bug fixed ... * * this.callSuper(); * } * }); * * The patch method cannot use `callParent` to call the superclass `method` since * that would call the overridden method containing the bug. In other words, the * above patch would only produce "Fixed" then "Good" in the console log, whereas, * using `callParent` would produce "Fixed" then "Bad" then "Good". * * @protected * @param {Array/Arguments} args The arguments, either an array or the `arguments` object * from the current method, for example: `this.callSuper(arguments)` * @return {Object} Returns the result of calling the superclass method */ callSuper: function(args) { // NOTE: this code is deliberately as few expressions (and no function calls) // as possible so that a debugger can skip over this noise with the minimum number // of steps. Basically, just hit Step Into until you are where you really wanted // to be. var method, superMethod = (method = this.callSuper.caller) && ((method = method.$owner ? method : method.caller) && method.$owner.superclass[method.$name]); if (!superMethod) { method = this.callSuper.caller; var parentClass, methodName; if (!method.$owner) { if (!method.caller) { throw new Error("Attempting to call a protected method from the public scope, which is not allowed"); } method = method.caller; } parentClass = method.$owner.superclass; methodName = method.$name; if (!(methodName in parentClass)) { throw new Error("this.callSuper() was called but there's no such method (" + methodName + ") found in the parent class (" + (Ext.getClassName(parentClass) || 'Object') + ")"); } } return superMethod.apply(this, args || noArgs); }, /** * @property {Ext.Class} self * * Get the reference to the current class from which this object was instantiated. Unlike {@link Ext.Base#statics}, * `this.self` is scope-dependent and it's meant to be used for dynamic inheritance. See {@link Ext.Base#statics} * for a detailed comparison * * Ext.define('My.Cat', { * statics: { * speciesName: 'Cat' // My.Cat.speciesName = 'Cat' * }, * * constructor: function() { * alert(this.self.speciesName); // dependent on 'this' * }, * * clone: function() { * return new this.self(); * } * }); * * * Ext.define('My.SnowLeopard', { * extend: 'My.Cat', * statics: { * speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard' * } * }); * * var cat = new My.Cat(); // alerts 'Cat' * var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard' * * var clone = snowLeopard.clone(); * alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard' * * @protected */ self: Base, // Default constructor, simply returns `this` constructor: function() { return this; }, /** * Initialize configuration for this class. a typical example: * * Ext.define('My.awesome.Class', { * // The default config * config: { * name: 'Awesome', * isAwesome: true * }, * * constructor: function(config) { * this.initConfig(config); * } * }); * * var awesome = new My.awesome.Class({ * name: 'Super Awesome' * }); * * alert(awesome.getName()); // 'Super Awesome' * * @protected * @param {Object} config * @return {Ext.Base} this */ initConfig: function(config) { var instanceConfig = config, configNameCache = Ext.Class.configNameCache, defaultConfig = new this.configClass(), defaultConfigList = this.initConfigList, hasConfig = this.configMap, nameMap, i, ln, name, initializedName; this.initConfig = Ext.emptyFn; this.initialConfig = instanceConfig || {}; this.config = config = (instanceConfig) ? Ext.merge(defaultConfig, config) : defaultConfig; if (instanceConfig) { defaultConfigList = defaultConfigList.slice(); for (name in instanceConfig) { if (hasConfig[name]) { if (instanceConfig[name] !== null) { defaultConfigList.push(name); this[configNameCache[name].initialized] = false; } } } } for (i = 0,ln = defaultConfigList.length; i < ln; i++) { name = defaultConfigList[i]; nameMap = configNameCache[name]; initializedName = nameMap.initialized; if (!this[initializedName]) { this[initializedName] = true; this[nameMap.set].call(this, config[name]); } } return this; }, /** * @private * @param config */ hasConfig: function(name) { return Boolean(this.configMap[name]); }, /** * @private */ setConfig: function(config, applyIfNotSet) { if (!config) { return this; } var configNameCache = Ext.Class.configNameCache, currentConfig = this.config, hasConfig = this.configMap, initialConfig = this.initialConfig, name, value; applyIfNotSet = Boolean(applyIfNotSet); for (name in config) { if (applyIfNotSet && initialConfig.hasOwnProperty(name)) { continue; } value = config[name]; currentConfig[name] = value; if (hasConfig[name]) { this[configNameCache[name].set](value); } } return this; }, /** * @private * @param name */ getConfig: function(name) { var configNameCache = Ext.Class.configNameCache; return this[configNameCache[name].get](); }, /** * Returns the initial configuration passed to constructor when instantiating * this class. * @param {String} [name] Name of the config option to return. * @return {Object/Mixed} The full config object or a single config value * when `name` parameter specified. */ getInitialConfig: function(name) { var config = this.config; if (!name) { return config; } else { return config[name]; } }, /** * @private * @param names * @param callback * @param scope */ onConfigUpdate: function(names, callback, scope) { var self = this.self, className = self.$className, i, ln, name, updaterName, updater, newUpdater; names = Ext.Array.from(names); scope = scope || this; for (i = 0,ln = names.length; i < ln; i++) { name = names[i]; updaterName = 'update' + Ext.String.capitalize(name); updater = this[updaterName] || Ext.emptyFn; newUpdater = function() { updater.apply(this, arguments); scope[callback].apply(scope, arguments); }; newUpdater.$name = updaterName; newUpdater.$owner = self; newUpdater.displayName = className + '#' + updaterName; this[updaterName] = newUpdater; } }, /** * @private */ destroy: function() { this.destroy = Ext.emptyFn; } }); /** * Call the original method that was previously overridden with {@link Ext.Base#override} * * Ext.define('My.Cat', { * constructor: function() { * alert("I'm a cat!"); * } * }); * * My.Cat.override({ * constructor: function() { * alert("I'm going to be a cat!"); * * this.callOverridden(); * * alert("Meeeeoooowwww"); * } * }); * * var kitty = new My.Cat(); // alerts "I'm going to be a cat!" * // alerts "I'm a cat!" * // alerts "Meeeeoooowwww" * * @param {Array/Arguments} args The arguments, either an array or the `arguments` object * from the current method, for example: `this.callOverridden(arguments)` * @return {Object} Returns the result of calling the overridden method * @protected * @deprecated as of 4.1. Use {@link #callParent} instead. */ Base.prototype.callOverridden = Base.prototype.callParent; Ext.Base = Base; }(Ext.Function.flexSetter)); // @tag foundation,core // @require Base.js // @define Ext.Class /** * @author Jacky Nguyen * @docauthor Jacky Nguyen * @class Ext.Class * * Handles class creation throughout the framework. This is a low level factory that is used by Ext.ClassManager and generally * should not be used directly. If you choose to use Ext.Class you will lose out on the namespace, aliasing and depency loading * features made available by Ext.ClassManager. The only time you would use Ext.Class directly is to create an anonymous class. * * If you wish to create a class you should use {@link Ext#define Ext.define} which aliases * {@link Ext.ClassManager#create Ext.ClassManager.create} to enable namespacing and dynamic dependency resolution. * * Ext.Class is the factory and **not** the superclass of everything. For the base class that **all** Ext classes inherit * from, see {@link Ext.Base}. */ (function() { var ExtClass, Base = Ext.Base, baseStaticMembers = [], baseStaticMember, baseStaticMemberLength; for (baseStaticMember in Base) { if (Base.hasOwnProperty(baseStaticMember)) { baseStaticMembers.push(baseStaticMember); } } baseStaticMemberLength = baseStaticMembers.length; // Creates a constructor that has nothing extra in its scope chain. function makeCtor (className) { function constructor () { // Opera has some problems returning from a constructor when Dragonfly isn't running. The || null seems to // be sufficient to stop it misbehaving. Known to be required against 10.53, 11.51 and 11.61. return this.constructor.apply(this, arguments) || null; } if (className) { constructor.displayName = className; } return constructor; } /** * @method constructor * Create a new anonymous class. * * @param {Object} data An object represent the properties of this class * @param {Function} onCreated Optional, the callback function to be executed when this class is fully created. * Note that the creation process can be asynchronous depending on the pre-processors used. * * @return {Ext.Base} The newly created class */ Ext.Class = ExtClass = function(Class, data, onCreated) { if (typeof Class != 'function') { onCreated = data; data = Class; Class = null; } if (!data) { data = {}; } Class = ExtClass.create(Class, data); ExtClass.process(Class, data, onCreated); return Class; }; Ext.apply(ExtClass, { /** * @private */ onBeforeCreated: function(Class, data, hooks) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, '>> Ext.Class#onBeforeCreated', arguments); Class.addMembers(data); hooks.onCreated.call(Class, Class); Ext.classSystemMonitor && Ext.classSystemMonitor(Class, '<< Ext.Class#onBeforeCreated', arguments); }, /** * @private */ create: function(Class, data) { var name, i; if (!Class) { Class = makeCtor( data.$className ); } for (i = 0; i < baseStaticMemberLength; i++) { name = baseStaticMembers[i]; Class[name] = Base[name]; } return Class; }, /** * @private */ process: function(Class, data, onCreated) { var preprocessorStack = data.preprocessors || ExtClass.defaultPreprocessors, registeredPreprocessors = this.preprocessors, hooks = { onBeforeCreated: this.onBeforeCreated }, preprocessors = [], preprocessor, preprocessorsProperties, i, ln, j, subLn, preprocessorProperty; delete data.preprocessors; for (i = 0,ln = preprocessorStack.length; i < ln; i++) { preprocessor = preprocessorStack[i]; if (typeof preprocessor == 'string') { preprocessor = registeredPreprocessors[preprocessor]; preprocessorsProperties = preprocessor.properties; if (preprocessorsProperties === true) { preprocessors.push(preprocessor.fn); } else if (preprocessorsProperties) { for (j = 0,subLn = preprocessorsProperties.length; j < subLn; j++) { preprocessorProperty = preprocessorsProperties[j]; if (data.hasOwnProperty(preprocessorProperty)) { preprocessors.push(preprocessor.fn); break; } } } } else { preprocessors.push(preprocessor); } } hooks.onCreated = onCreated ? onCreated : Ext.emptyFn; hooks.preprocessors = preprocessors; this.doProcess(Class, data, hooks); }, doProcess: function(Class, data, hooks) { var me = this, preprocessors = hooks.preprocessors, preprocessor = preprocessors.shift(), doProcess = me.doProcess; for ( ; preprocessor ; preprocessor = preprocessors.shift()) { // Returning false signifies an asynchronous preprocessor - it will call doProcess when we can continue if (preprocessor.call(me, Class, data, hooks, doProcess) === false) { return; } } hooks.onBeforeCreated.apply(me, arguments); }, /** @private */ preprocessors: {}, /** * Register a new pre-processor to be used during the class creation process * * @param {String} name The pre-processor's name * @param {Function} fn The callback function to be executed. Typical format: * * function(cls, data, fn) { * // Your code here * * // Execute this when the processing is finished. * // Asynchronous processing is perfectly ok * if (fn) { * fn.call(this, cls, data); * } * }); * * @param {Function} fn.cls The created class * @param {Object} fn.data The set of properties passed in {@link Ext.Class} constructor * @param {Function} fn.fn The callback function that **must** to be executed when this * pre-processor finishes, regardless of whether the processing is synchronous or aynchronous. * @return {Ext.Class} this * @private * @static */ registerPreprocessor: function(name, fn, properties, position, relativeTo) { if (!position) { position = 'last'; } if (!properties) { properties = [name]; } this.preprocessors[name] = { name: name, properties: properties || false, fn: fn }; this.setDefaultPreprocessorPosition(name, position, relativeTo); return this; }, /** * Retrieve a pre-processor callback function by its name, which has been registered before * * @param {String} name * @return {Function} preprocessor * @private * @static */ getPreprocessor: function(name) { return this.preprocessors[name]; }, /** * @private */ getPreprocessors: function() { return this.preprocessors; }, /** * @private */ defaultPreprocessors: [], /** * Retrieve the array stack of default pre-processors * @return {Function[]} defaultPreprocessors * @private * @static */ getDefaultPreprocessors: function() { return this.defaultPreprocessors; }, /** * Set the default array stack of default pre-processors * * @private * @param {Array} preprocessors * @return {Ext.Class} this * @static */ setDefaultPreprocessors: function(preprocessors) { this.defaultPreprocessors = Ext.Array.from(preprocessors); return this; }, /** * Insert this pre-processor at a specific position in the stack, optionally relative to * any existing pre-processor. For example: * * Ext.Class.registerPreprocessor('debug', function(cls, data, fn) { * // Your code here * * if (fn) { * fn.call(this, cls, data); * } * }).setDefaultPreprocessorPosition('debug', 'last'); * * @private * @param {String} name The pre-processor name. Note that it needs to be registered with * {@link Ext.Class#registerPreprocessor registerPreprocessor} before this * @param {String} offset The insertion position. Four possible values are: * 'first', 'last', or: 'before', 'after' (relative to the name provided in the third argument) * @param {String} relativeName * @return {Ext.Class} this * @static */ setDefaultPreprocessorPosition: function(name, offset, relativeName) { var defaultPreprocessors = this.defaultPreprocessors, index; if (typeof offset == 'string') { if (offset === 'first') { defaultPreprocessors.unshift(name); return this; } else if (offset === 'last') { defaultPreprocessors.push(name); return this; } offset = (offset === 'after') ? 1 : -1; } index = Ext.Array.indexOf(defaultPreprocessors, relativeName); if (index !== -1) { Ext.Array.splice(defaultPreprocessors, Math.max(0, index + offset), 0, name); } return this; }, configNameCache: {}, getConfigNameMap: function(name) { var cache = this.configNameCache, map = cache[name], capitalizedName; if (!map) { capitalizedName = name.charAt(0).toUpperCase() + name.substr(1); map = cache[name] = { internal: name, initialized: '_is' + capitalizedName + 'Initialized', apply: 'apply' + capitalizedName, update: 'update' + capitalizedName, 'set': 'set' + capitalizedName, 'get': 'get' + capitalizedName, doSet : 'doSet' + capitalizedName, changeEvent: name.toLowerCase() + 'change' }; } return map; } }); /** * @cfg {String} extend * The parent class that this class extends. For example: * * Ext.define('Person', { * say: function(text) { alert(text); } * }); * * Ext.define('Developer', { * extend: 'Person', * say: function(text) { this.callParent(["print "+text]); } * }); */ ExtClass.registerPreprocessor('extend', function(Class, data, hooks) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#extendPreProcessor', arguments); var Base = Ext.Base, basePrototype = Base.prototype, extend = data.extend, Parent, parentPrototype, i; delete data.extend; if (extend && extend !== Object) { Parent = extend; } else { Parent = Base; } parentPrototype = Parent.prototype; if (!Parent.$isClass) { for (i in basePrototype) { if (!parentPrototype[i]) { parentPrototype[i] = basePrototype[i]; } } } Class.extend(Parent); Class.triggerExtended.apply(Class, arguments); if (data.onClassExtended) { Class.onExtended(data.onClassExtended, Class); delete data.onClassExtended; } }, true); /** * @cfg {Object} statics * List of static methods for this class. For example: * * Ext.define('Computer', { * statics: { * factory: function(brand) { * // 'this' in static methods refer to the class itself * return new this(brand); * } * }, * * constructor: function() { ... } * }); * * var dellComputer = Computer.factory('Dell'); */ ExtClass.registerPreprocessor('statics', function(Class, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#staticsPreprocessor', arguments); Class.addStatics(data.statics); delete data.statics; }); /** * @cfg {Object} inheritableStatics * List of inheritable static methods for this class. * Otherwise just like {@link #statics} but subclasses inherit these methods. */ ExtClass.registerPreprocessor('inheritableStatics', function(Class, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#inheritableStaticsPreprocessor', arguments); Class.addInheritableStatics(data.inheritableStatics); delete data.inheritableStatics; }); /** * @cfg {Object} config * List of configuration options with their default values, for which automatically * accessor methods are generated. For example: * * Ext.define('SmartPhone', { * config: { * hasTouchScreen: false, * operatingSystem: 'Other', * price: 500 * }, * constructor: function(cfg) { * this.initConfig(cfg); * } * }); * * var iPhone = new SmartPhone({ * hasTouchScreen: true, * operatingSystem: 'iOS' * }); * * iPhone.getPrice(); // 500; * iPhone.getOperatingSystem(); // 'iOS' * iPhone.getHasTouchScreen(); // true; * * NOTE for when configs are reference types, the getter and setter methods do not make copies. * * For example, when a config value is set, the reference is stored on the instance. All instances that set * the same reference type will share it. * * In the case of the getter, the value with either come from the prototype if the setter was never called or from * the instance as the last value passed to the setter. * * For some config properties, the value passed to the setter is transformed prior to being stored on the instance. */ ExtClass.registerPreprocessor('config', function(Class, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#configPreProcessor', arguments); var config = data.config, prototype = Class.prototype; delete data.config; Ext.Object.each(config, function(name, value) { var nameMap = ExtClass.getConfigNameMap(name), internalName = nameMap.internal, initializedName = nameMap.initialized, applyName = nameMap.apply, updateName = nameMap.update, setName = nameMap.set, getName = nameMap.get, hasOwnSetter = (setName in prototype) || data.hasOwnProperty(setName), hasOwnApplier = (applyName in prototype) || data.hasOwnProperty(applyName), hasOwnUpdater = (updateName in prototype) || data.hasOwnProperty(updateName), optimizedGetter, customGetter; if (value === null || (!hasOwnSetter && !hasOwnApplier && !hasOwnUpdater)) { prototype[internalName] = value; prototype[initializedName] = true; } else { prototype[initializedName] = false; } if (!hasOwnSetter) { data[setName] = function(value) { var oldValue = this[internalName], applier = this[applyName], updater = this[updateName]; if (!this[initializedName]) { this[initializedName] = true; } if (applier) { value = applier.call(this, value, oldValue); } if (typeof value != 'undefined') { this[internalName] = value; if (updater && value !== oldValue) { updater.call(this, value, oldValue); } } return this; }; } if (!(getName in prototype) || data.hasOwnProperty(getName)) { customGetter = data[getName] || false; if (customGetter) { optimizedGetter = function() { return customGetter.apply(this, arguments); }; } else { optimizedGetter = function() { return this[internalName]; }; } data[getName] = function() { var currentGetter; if (!this[initializedName]) { this[initializedName] = true; this[setName](this.config[name]); } currentGetter = this[getName]; if ('$previous' in currentGetter) { currentGetter.$previous = optimizedGetter; } else { this[getName] = optimizedGetter; } return optimizedGetter.apply(this, arguments); }; } }); Class.addConfig(config, true); }); /** * @cfg {String[]/Object} mixins * List of classes to mix into this class. For example: * * Ext.define('CanSing', { * sing: function() { * alert("I'm on the highway to hell...") * } * }); * * Ext.define('Musician', { * mixins: ['CanSing'] * }) * * In this case the Musician class will get a `sing` method from CanSing mixin. * * But what if the Musician already has a `sing` method? Or you want to mix * in two classes, both of which define `sing`? In such a cases it's good * to define mixins as an object, where you assign a name to each mixin: * * Ext.define('Musician', { * mixins: { * canSing: 'CanSing' * }, * * sing: function() { * // delegate singing operation to mixin * this.mixins.canSing.sing.call(this); * } * }) * * In this case the `sing` method of Musician will overwrite the * mixed in `sing` method. But you can access the original mixed in method * through special `mixins` property. */ ExtClass.registerPreprocessor('mixins', function(Class, data, hooks) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#mixinsPreprocessor', arguments); var mixins = data.mixins, name, mixin, i, ln; delete data.mixins; Ext.Function.interceptBefore(hooks, 'onCreated', function() { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#mixinsPreprocessor#beforeCreated', arguments); if (mixins instanceof Array) { for (i = 0,ln = mixins.length; i < ln; i++) { mixin = mixins[i]; name = mixin.prototype.mixinId || mixin.$className; Class.mixin(name, mixin); } } else { for (var mixinName in mixins) { if (mixins.hasOwnProperty(mixinName)) { Class.mixin(mixinName, mixins[mixinName]); } } } }); }); // Backwards compatible Ext.extend = function(Class, Parent, members) { Ext.classSystemMonitor && Ext.classSystemMonitor(Class, 'Ext.Class#extend-backwards-compatible', arguments); if (arguments.length === 2 && Ext.isObject(Parent)) { members = Parent; Parent = Class; Class = null; } var cls; if (!Parent) { throw new Error("[Ext.extend] Attempting to extend from a class which has not been loaded on the page."); } members.extend = Parent; members.preprocessors = [ 'extend' ,'statics' ,'inheritableStatics' ,'mixins' ,'config' ]; if (Class) { cls = new ExtClass(Class, members); // The 'constructor' is given as 'Class' but also needs to be on prototype cls.prototype.constructor = Class; } else { cls = new ExtClass(members); } cls.prototype.override = function(o) { for (var m in o) { if (o.hasOwnProperty(m)) { this[m] = o[m]; } } }; return cls; }; }()); // @tag foundation,core // @require Class.js // @define Ext.ClassManager /** * @author Jacky Nguyen * @docauthor Jacky Nguyen * @class Ext.ClassManager * * Ext.ClassManager manages all classes and handles mapping from string class name to * actual class objects throughout the whole framework. It is not generally accessed directly, rather through * these convenient shorthands: * * - {@link Ext#define Ext.define} * - {@link Ext#create Ext.create} * - {@link Ext#widget Ext.widget} * - {@link Ext#getClass Ext.getClass} * - {@link Ext#getClassName Ext.getClassName} * * # Basic syntax: * * Ext.define(className, properties); * * in which `properties` is an object represent a collection of properties that apply to the class. See * {@link Ext.ClassManager#create} for more detailed instructions. * * Ext.define('Person', { * name: 'Unknown', * * constructor: function(name) { * if (name) { * this.name = name; * } * }, * * eat: function(foodType) { * alert("I'm eating: " + foodType); * * return this; * } * }); * * var aaron = new Person("Aaron"); * aaron.eat("Sandwich"); // alert("I'm eating: Sandwich"); * * Ext.Class has a powerful set of extensible {@link Ext.Class#registerPreprocessor pre-processors} which takes care of * everything related to class creation, including but not limited to inheritance, mixins, configuration, statics, etc. * * # Inheritance: * * Ext.define('Developer', { * extend: 'Person', * * constructor: function(name, isGeek) { * this.isGeek = isGeek; * * // Apply a method from the parent class' prototype * this.callParent([name]); * }, * * code: function(language) { * alert("I'm coding in: " + language); * * this.eat("Bugs"); * * return this; * } * }); * * var jacky = new Developer("Jacky", true); * jacky.code("JavaScript"); // alert("I'm coding in: JavaScript"); * // alert("I'm eating: Bugs"); * * See {@link Ext.Base#callParent} for more details on calling superclass' methods * * # Mixins: * * Ext.define('CanPlayGuitar', { * playGuitar: function() { * alert("F#...G...D...A"); * } * }); * * Ext.define('CanComposeSongs', { * composeSongs: function() { ... } * }); * * Ext.define('CanSing', { * sing: function() { * alert("I'm on the highway to hell...") * } * }); * * Ext.define('Musician', { * extend: 'Person', * * mixins: { * canPlayGuitar: 'CanPlayGuitar', * canComposeSongs: 'CanComposeSongs', * canSing: 'CanSing' * } * }) * * Ext.define('CoolPerson', { * extend: 'Person', * * mixins: { * canPlayGuitar: 'CanPlayGuitar', * canSing: 'CanSing' * }, * * sing: function() { * alert("Ahem...."); * * this.mixins.canSing.sing.call(this); * * alert("[Playing guitar at the same time...]"); * * this.playGuitar(); * } * }); * * var me = new CoolPerson("Jacky"); * * me.sing(); // alert("Ahem..."); * // alert("I'm on the highway to hell..."); * // alert("[Playing guitar at the same time...]"); * // alert("F#...G...D...A"); * * # Config: * * Ext.define('SmartPhone', { * config: { * hasTouchScreen: false, * operatingSystem: 'Other', * price: 500 * }, * * isExpensive: false, * * constructor: function(config) { * this.initConfig(config); * }, * * applyPrice: function(price) { * this.isExpensive = (price > 500); * * return price; * }, * * applyOperatingSystem: function(operatingSystem) { * if (!(/^(iOS|Android|BlackBerry)$/i).test(operatingSystem)) { * return 'Other'; * } * * return operatingSystem; * } * }); * * var iPhone = new SmartPhone({ * hasTouchScreen: true, * operatingSystem: 'iOS' * }); * * iPhone.getPrice(); // 500; * iPhone.getOperatingSystem(); // 'iOS' * iPhone.getHasTouchScreen(); // true; * iPhone.hasTouchScreen(); // true * * iPhone.isExpensive; // false; * iPhone.setPrice(600); * iPhone.getPrice(); // 600 * iPhone.isExpensive; // true; * * iPhone.setOperatingSystem('AlienOS'); * iPhone.getOperatingSystem(); // 'Other' * * # Statics: * * Ext.define('Computer', { * statics: { * factory: function(brand) { * // 'this' in static methods refer to the class itself * return new this(brand); * } * }, * * constructor: function() { ... } * }); * * var dellComputer = Computer.factory('Dell'); * * Also see {@link Ext.Base#statics} and {@link Ext.Base#self} for more details on accessing * static properties within class methods * * @singleton */ (function(Class, alias, arraySlice, arrayFrom, global) { // Creates a constructor that has nothing extra in its scope chain. function makeCtor () { function constructor () { // Opera has some problems returning from a constructor when Dragonfly isn't running. The || null seems to // be sufficient to stop it misbehaving. Known to be required against 10.53, 11.51 and 11.61. return this.constructor.apply(this, arguments) || null; } return constructor; } var Manager = Ext.ClassManager = { /** * @property {Object} classes * All classes which were defined through the ClassManager. Keys are the * name of the classes and the values are references to the classes. * @private */ classes: {}, /** * @private */ existCache: {}, /** * @private */ namespaceRewrites: [{ from: 'Ext.', to: Ext }], /** * @private */ maps: { alternateToName: {}, aliasToName: {}, nameToAliases: {}, nameToAlternates: {} }, /** @private */ enableNamespaceParseCache: true, /** @private */ namespaceParseCache: {}, /** @private */ instantiators: [], /** * Checks if a class has already been created. * * @param {String} className * @return {Boolean} exist */ isCreated: function(className) { var existCache = this.existCache, i, ln, part, root, parts; if (typeof className != 'string' || className.length < 1) { throw new Error("[Ext.ClassManager] Invalid classname, must be a string and must not be empty"); } if (this.classes[className] || existCache[className]) { return true; } root = global; parts = this.parseNamespace(className); for (i = 0, ln = parts.length; i < ln; i++) { part = parts[i]; if (typeof part != 'string') { root = part; } else { if (!root || !root[part]) { return false; } root = root[part]; } } existCache[className] = true; this.triggerCreated(className); return true; }, /** * @private */ createdListeners: [], /** * @private */ nameCreatedListeners: {}, /** * @private */ triggerCreated: function(className) { var listeners = this.createdListeners, nameListeners = this.nameCreatedListeners, alternateNames = this.maps.nameToAlternates[className], names = [className], i, ln, j, subLn, listener, name; for (i = 0,ln = listeners.length; i < ln; i++) { listener = listeners[i]; listener.fn.call(listener.scope, className); } if (alternateNames) { names.push.apply(names, alternateNames); } for (i = 0,ln = names.length; i < ln; i++) { name = names[i]; listeners = nameListeners[name]; if (listeners) { for (j = 0,subLn = listeners.length; j < subLn; j++) { listener = listeners[j]; listener.fn.call(listener.scope, name); } delete nameListeners[name]; } } }, /** * @private */ onCreated: function(fn, scope, className) { Ext.classSystemMonitor && Ext.classSystemMonitor(className, 'Ext.ClassManager#onCreated', arguments); var listeners = this.createdListeners, nameListeners = this.nameCreatedListeners, listener = { fn: fn, scope: scope }; if (className) { if (this.isCreated(className)) { fn.call(scope, className); return; } if (!nameListeners[className]) { nameListeners[className] = []; } nameListeners[className].push(listener); } else { listeners.push(listener); } }, /** * Supports namespace rewriting * @private */ parseNamespace: function(namespace) { if (typeof namespace != 'string') { throw new Error("[Ext.ClassManager] Invalid namespace, must be a string"); } var cache = this.namespaceParseCache, parts, rewrites, root, name, rewrite, from, to, i, ln; if (this.enableNamespaceParseCache) { if (cache.hasOwnProperty(namespace)) { return cache[namespace]; } } parts = []; rewrites = this.namespaceRewrites; root = global; name = namespace; for (i = 0, ln = rewrites.length; i < ln; i++) { rewrite = rewrites[i]; from = rewrite.from; to = rewrite.to; if (name === from || name.substring(0, from.length) === from) { name = name.substring(from.length); if (typeof to != 'string') { root = to; } else { parts = parts.concat(to.split('.')); } break; } } parts.push(root); parts = parts.concat(name.split('.')); if (this.enableNamespaceParseCache) { cache[namespace] = parts; } return parts; }, /** * Creates a namespace and assign the `value` to the created object * * Ext.ClassManager.setNamespace('MyCompany.pkg.Example', someObject); * * alert(MyCompany.pkg.Example === someObject); // alerts true * * @param {String} name * @param {Object} value */ setNamespace: function(name, value) { var root = global, parts = this.parseNamespace(name), ln = parts.length - 1, leaf = parts[ln], i, part; for (i = 0; i < ln; i++) { part = parts[i]; if (typeof part != 'string') { root = part; } else { if (!root[part]) { root[part] = {}; } root = root[part]; } } root[leaf] = value; return root[leaf]; }, /** * The new Ext.ns, supports namespace rewriting * @private */ createNamespaces: function() { var root = global, parts, part, i, j, ln, subLn; for (i = 0, ln = arguments.length; i < ln; i++) { parts = this.parseNamespace(arguments[i]); for (j = 0, subLn = parts.length; j < subLn; j++) { part = parts[j]; if (typeof part != 'string') { root = part; } else { if (!root[part]) { root[part] = {}; } root = root[part]; } } } return root; }, /** * Sets a name reference to a class. * * @param {String} name * @param {Object} value * @return {Ext.ClassManager} this */ set: function(name, value) { var me = this, maps = me.maps, nameToAlternates = maps.nameToAlternates, targetName = me.getName(value), alternates; me.classes[name] = me.setNamespace(name, value); if (targetName && targetName !== name) { maps.alternateToName[name] = targetName; alternates = nameToAlternates[targetName] || (nameToAlternates[targetName] = []); alternates.push(name); } return this; }, /** * Retrieve a class by its name. * * @param {String} name * @return {Ext.Class} class */ get: function(name) { var classes = this.classes, root, parts, part, i, ln; if (classes[name]) { return classes[name]; } root = global; parts = this.parseNamespace(name); for (i = 0, ln = parts.length; i < ln; i++) { part = parts[i]; if (typeof part != 'string') { root = part; } else { if (!root || !root[part]) { return null; } root = root[part]; } } return root; }, /** * Register the alias for a class. * * @param {Ext.Class/String} cls a reference to a class or a className * @param {String} alias Alias to use when referring to this class */ setAlias: function(cls, alias) { var aliasToNameMap = this.maps.aliasToName, nameToAliasesMap = this.maps.nameToAliases, className; if (typeof cls == 'string') { className = cls; } else { className = this.getName(cls); } if (alias && aliasToNameMap[alias] !== className) { if (aliasToNameMap[alias] && Ext.isDefined(global.console)) { global.console.log("[Ext.ClassManager] Overriding existing alias: '" + alias + "' " + "of: '" + aliasToNameMap[alias] + "' with: '" + className + "'. Be sure it's intentional."); } aliasToNameMap[alias] = className; } if (!nameToAliasesMap[className]) { nameToAliasesMap[className] = []; } if (alias) { Ext.Array.include(nameToAliasesMap[className], alias); } return this; }, /** * Adds a batch of class name to alias mappings * @param {Object} aliases The set of mappings of the form * className : [values...] */ addNameAliasMappings: function(aliases){ var aliasToNameMap = this.maps.aliasToName, nameToAliasesMap = this.maps.nameToAliases, className, aliasList, alias, i; for (className in aliases) { aliasList = nameToAliasesMap[className] || (nameToAliasesMap[className] = []); for (i = 0; i < aliases[className].length; i++) { alias = aliases[className][i]; if (!aliasToNameMap[alias]) { aliasToNameMap[alias] = className; aliasList.push(alias); } } } return this; }, /** * * @param {Object} alternates The set of mappings of the form * className : [values...] */ addNameAlternateMappings: function(alternates) { var alternateToName = this.maps.alternateToName, nameToAlternates = this.maps.nameToAlternates, className, aliasList, alternate, i; for (className in alternates) { aliasList = nameToAlternates[className] || (nameToAlternates[className] = []); for (i = 0; i < alternates[className].length; i++) { alternate = alternates[className][i]; if (!alternateToName[alternate]) { alternateToName[alternate] = className; aliasList.push(alternate); } } } return this; }, /** * Get a reference to the class by its alias. * * @param {String} alias * @return {Ext.Class} class */ getByAlias: function(alias) { return this.get(this.getNameByAlias(alias)); }, /** * Get the name of a class by its alias. * * @param {String} alias * @return {String} className */ getNameByAlias: function(alias) { return this.maps.aliasToName[alias] || ''; }, /** * Get the name of a class by its alternate name. * * @param {String} alternate * @return {String} className */ getNameByAlternate: function(alternate) { return this.maps.alternateToName[alternate] || ''; }, /** * Get the aliases of a class by the class name * * @param {String} name * @return {Array} aliases */ getAliasesByName: function(name) { return this.maps.nameToAliases[name] || []; }, /** * Get the name of the class by its reference or its instance; * * {@link Ext.ClassManager#getName} is usually invoked by the shorthand {@link Ext#getClassName}. * * Ext.getName(Ext.Action); // returns "Ext.Action" * * @param {Ext.Class/Object} object * @return {String} className */ getName: function(object) { return object && object.$className || ''; }, /** * Get the class of the provided object; returns null if it's not an instance * of any class created with Ext.define. * * {@link Ext.ClassManager#getClass} is usually invoked by the shorthand {@link Ext#getClass}. * * var component = new Ext.Component(); * * Ext.getClass(component); // returns Ext.Component * * @param {Object} object * @return {Ext.Class} class */ getClass: function(object) { return object && object.self || null; }, /** * Defines a class. * @deprecated 4.1.0 Use {@link Ext#define} instead, as that also supports creating overrides. */ create: function(className, data, createdFn) { if (className != null && typeof className != 'string') { throw new Error("[Ext.define] Invalid class name '" + className + "' specified, must be a non-empty string"); } var ctor = makeCtor(); if (typeof data == 'function') { data = data(ctor); } if (className) { ctor.displayName = className; } data.$className = className; return new Class(ctor, data, function() { var postprocessorStack = data.postprocessors || Manager.defaultPostprocessors, registeredPostprocessors = Manager.postprocessors, postprocessors = [], postprocessor, i, ln, j, subLn, postprocessorProperties, postprocessorProperty; delete data.postprocessors; for (i = 0,ln = postprocessorStack.length; i < ln; i++) { postprocessor = postprocessorStack[i]; if (typeof postprocessor == 'string') { postprocessor = registeredPostprocessors[postprocessor]; postprocessorProperties = postprocessor.properties; if (postprocessorProperties === true) { postprocessors.push(postprocessor.fn); } else if (postprocessorProperties) { for (j = 0,subLn = postprocessorProperties.length; j < subLn; j++) { postprocessorProperty = postprocessorProperties[j]; if (data.hasOwnProperty(postprocessorProperty)) { postprocessors.push(postprocessor.fn); break; } } } } else { postprocessors.push(postprocessor); } } data.postprocessors = postprocessors; data.createdFn = createdFn; Manager.processCreate(className, this, data); }); }, processCreate: function(className, cls, clsData){ var me = this, postprocessor = clsData.postprocessors.shift(), createdFn = clsData.createdFn; if (!postprocessor) { Ext.classSystemMonitor && Ext.classSystemMonitor(className, 'Ext.ClassManager#classCreated', arguments); if (className) { me.set(className, cls); } if (createdFn) { createdFn.call(cls, cls); } if (className) { me.triggerCreated(className); } return; } if (postprocessor.call(me, className, cls, clsData, me.processCreate) !== false) { me.processCreate(className, cls, clsData); } }, createOverride: function (className, data, createdFn) { var me = this, overriddenClassName = data.override, requires = data.requires, uses = data.uses, classReady = function () { var cls, temp; if (requires) { temp = requires; requires = null; // do the real thing next time (which may be now) // Since the override is going to be used (its target class is now // created), we need to fetch the required classes for the override // and call us back once they are loaded: Ext.Loader.require(temp, classReady); } else { // The target class and the required classes for this override are // ready, so we can apply the override now: cls = me.get(overriddenClassName); // We don't want to apply these: delete data.override; delete data.requires; delete data.uses; Ext.override(cls, data); // This pushes the overridding file itself into Ext.Loader.history // Hence if the target class never exists, the overriding file will // never be included in the build. me.triggerCreated(className); if (uses) { Ext.Loader.addUsedClasses(uses); // get these classes too! } if (createdFn) { createdFn.call(cls); // last but not least! } } }; me.existCache[className] = true; // Override the target class right after it's created me.onCreated(classReady, me, overriddenClassName); return me; }, /** * Instantiate a class by its alias. * * {@link Ext.ClassManager#instantiateByAlias} is usually invoked by the shorthand {@link Ext#createByAlias}. * * If {@link Ext.Loader} is {@link Ext.Loader#setConfig enabled} and the class has not been defined yet, it will * attempt to load the class via synchronous loading. * * var window = Ext.createByAlias('widget.window', { width: 600, height: 800, ... }); * * @param {String} alias * @param {Object...} args Additional arguments after the alias will be passed to the * class constructor. * @return {Object} instance */ instantiateByAlias: function() { var alias = arguments[0], args = arraySlice.call(arguments), className = this.getNameByAlias(alias); if (!className) { className = this.maps.aliasToName[alias]; if (!className) { throw new Error("[Ext.createByAlias] Cannot create an instance of unrecognized alias: " + alias); } if (global.console) { global.console.warn("[Ext.Loader] Synchronously loading '" + className + "'; consider adding " + "Ext.require('" + alias + "') above Ext.onReady"); } Ext.syncRequire(className); } args[0] = className; return this.instantiate.apply(this, args); }, /** * @private */ instantiate: function() { var name = arguments[0], nameType = typeof name, args = arraySlice.call(arguments, 1), alias = name, possibleName, cls; if (nameType != 'function') { if (nameType != 'string' && args.length === 0) { args = [name]; name = name.xclass; } if (typeof name != 'string' || name.length < 1) { throw new Error("[Ext.create] Invalid class name or alias '" + name + "' specified, must be a non-empty string"); } cls = this.get(name); } else { cls = name; } // No record of this class name, it's possibly an alias, so look it up if (!cls) { possibleName = this.getNameByAlias(name); if (possibleName) { name = possibleName; cls = this.get(name); } } // Still no record of this class name, it's possibly an alternate name, so look it up if (!cls) { possibleName = this.getNameByAlternate(name); if (possibleName) { name = possibleName; cls = this.get(name); } } // Still not existing at this point, try to load it via synchronous mode as the last resort if (!cls) { if (global.console) { global.console.warn("[Ext.Loader] Synchronously loading '" + name + "'; consider adding " + "Ext.require('" + ((possibleName) ? alias : name) + "') above Ext.onReady"); } Ext.syncRequire(name); cls = this.get(name); } if (!cls) { throw new Error("[Ext.create] Cannot create an instance of unrecognized class name / alias: " + alias); } if (typeof cls != 'function') { throw new Error("[Ext.create] '" + name + "' is a singleton and cannot be instantiated"); } return this.getInstantiator(args.length)(cls, args); }, /** * @private * @param name * @param args */ dynInstantiate: function(name, args) { args = arrayFrom(args, true); args.unshift(name); return this.instantiate.apply(this, args); }, /** * @private * @param length */ getInstantiator: function(length) { var instantiators = this.instantiators, instantiator, i, args; instantiator = instantiators[length]; if (!instantiator) { i = length; args = []; for (i = 0; i < length; i++) { args.push('a[' + i + ']'); } instantiator = instantiators[length] = new Function('c', 'a', 'return new c(' + args.join(',') + ')'); instantiator.displayName = "Ext.ClassManager.instantiate" + length; } return instantiator; }, /** * @private */ postprocessors: {}, /** * @private */ defaultPostprocessors: [], /** * Register a post-processor function. * * @private * @param {String} name * @param {Function} postprocessor */ registerPostprocessor: function(name, fn, properties, position, relativeTo) { if (!position) { position = 'last'; } if (!properties) { properties = [name]; } this.postprocessors[name] = { name: name, properties: properties || false, fn: fn }; this.setDefaultPostprocessorPosition(name, position, relativeTo); return this; }, /** * Set the default post processors array stack which are applied to every class. * * @private * @param {String/Array} postprocessors The name of a registered post processor or an array of registered names. * @return {Ext.ClassManager} this */ setDefaultPostprocessors: function(postprocessors) { this.defaultPostprocessors = arrayFrom(postprocessors); return this; }, /** * Insert this post-processor at a specific position in the stack, optionally relative to * any existing post-processor * * @private * @param {String} name The post-processor name. Note that it needs to be registered with * {@link Ext.ClassManager#registerPostprocessor} before this * @param {String} offset The insertion position. Four possible values are: * 'first', 'last', or: 'before', 'after' (relative to the name provided in the third argument) * @param {String} relativeName * @return {Ext.ClassManager} this */ setDefaultPostprocessorPosition: function(name, offset, relativeName) { var defaultPostprocessors = this.defaultPostprocessors, index; if (typeof offset == 'string') { if (offset === 'first') { defaultPostprocessors.unshift(name); return this; } else if (offset === 'last') { defaultPostprocessors.push(name); return this; } offset = (offset === 'after') ? 1 : -1; } index = Ext.Array.indexOf(defaultPostprocessors, relativeName); if (index !== -1) { Ext.Array.splice(defaultPostprocessors, Math.max(0, index + offset), 0, name); } return this; }, /** * Converts a string expression to an array of matching class names. An expression can either refers to class aliases * or class names. Expressions support wildcards: * * // returns ['Ext.window.Window'] * var window = Ext.ClassManager.getNamesByExpression('widget.window'); * * // returns ['widget.panel', 'widget.window', ...] * var allWidgets = Ext.ClassManager.getNamesByExpression('widget.*'); * * // returns ['Ext.data.Store', 'Ext.data.ArrayProxy', ...] * var allData = Ext.ClassManager.getNamesByExpression('Ext.data.*'); * * @param {String} expression * @return {String[]} classNames */ getNamesByExpression: function(expression) { var nameToAliasesMap = this.maps.nameToAliases, names = [], name, alias, aliases, possibleName, regex, i, ln; if (typeof expression != 'string' || expression.length < 1) { throw new Error("[Ext.ClassManager.getNamesByExpression] Expression " + expression + " is invalid, must be a non-empty string"); } if (expression.indexOf('*') !== -1) { expression = expression.replace(/\*/g, '(.*?)'); regex = new RegExp('^' + expression + '$'); for (name in nameToAliasesMap) { if (nameToAliasesMap.hasOwnProperty(name)) { aliases = nameToAliasesMap[name]; if (name.search(regex) !== -1) { names.push(name); } else { for (i = 0, ln = aliases.length; i < ln; i++) { alias = aliases[i]; if (alias.search(regex) !== -1) { names.push(name); break; } } } } } } else { possibleName = this.getNameByAlias(expression); if (possibleName) { names.push(possibleName); } else { possibleName = this.getNameByAlternate(expression); if (possibleName) { names.push(possibleName); } else { names.push(expression); } } } return names; } }; /** * @cfg {String[]} alias * @member Ext.Class * List of short aliases for class names. Most useful for defining xtypes for widgets: * * Ext.define('MyApp.CoolPanel', { * extend: 'Ext.panel.Panel', * alias: ['widget.coolpanel'], * title: 'Yeah!' * }); * * // Using Ext.create * Ext.create('widget.coolpanel'); * * // Using the shorthand for defining widgets by xtype * Ext.widget('panel', { * items: [ * {xtype: 'coolpanel', html: 'Foo'}, * {xtype: 'coolpanel', html: 'Bar'} * ] * }); * * Besides "widget" for xtype there are alias namespaces like "feature" for ftype and "plugin" for ptype. */ Manager.registerPostprocessor('alias', function(name, cls, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(name, 'Ext.ClassManager#aliasPostProcessor', arguments); var aliases = data.alias, i, ln; for (i = 0,ln = aliases.length; i < ln; i++) { alias = aliases[i]; this.setAlias(cls, alias); } }, ['xtype', 'alias']); /** * @cfg {Boolean} singleton * @member Ext.Class * When set to true, the class will be instantiated as singleton. For example: * * Ext.define('Logger', { * singleton: true, * log: function(msg) { * console.log(msg); * } * }); * * Logger.log('Hello'); */ Manager.registerPostprocessor('singleton', function(name, cls, data, fn) { Ext.classSystemMonitor && Ext.classSystemMonitor(name, 'Ext.ClassManager#singletonPostProcessor', arguments); if (data.singleton) { fn.call(this, name, new cls(), data); } else { return true; } return false; }); /** * @cfg {String/String[]} alternateClassName * @member Ext.Class * Defines alternate names for this class. For example: * * Ext.define('Developer', { * alternateClassName: ['Coder', 'Hacker'], * code: function(msg) { * alert('Typing... ' + msg); * } * }); * * var joe = Ext.create('Developer'); * joe.code('stackoverflow'); * * var rms = Ext.create('Hacker'); * rms.code('hack hack'); */ Manager.registerPostprocessor('alternateClassName', function(name, cls, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(name, 'Ext.ClassManager#alternateClassNamePostprocessor', arguments); var alternates = data.alternateClassName, i, ln, alternate; if (!(alternates instanceof Array)) { alternates = [alternates]; } for (i = 0, ln = alternates.length; i < ln; i++) { alternate = alternates[i]; if (typeof alternate != 'string') { throw new Error("[Ext.define] Invalid alternate of: '" + alternate + "' for class: '" + name + "'; must be a valid string"); } this.set(alternate, cls); } }); Ext.apply(Ext, { /** * Instantiate a class by either full name, alias or alternate name. * * If {@link Ext.Loader} is {@link Ext.Loader#setConfig enabled} and the class has * not been defined yet, it will attempt to load the class via synchronous loading. * * For example, all these three lines return the same result: * * // alias * var window = Ext.create('widget.window', { * width: 600, * height: 800, * ... * }); * * // alternate name * var window = Ext.create('Ext.Window', { * width: 600, * height: 800, * ... * }); * * // full class name * var window = Ext.create('Ext.window.Window', { * width: 600, * height: 800, * ... * }); * * // single object with xclass property: * var window = Ext.create({ * xclass: 'Ext.window.Window', // any valid value for 'name' (above) * width: 600, * height: 800, * ... * }); * * @param {String} [name] The class name or alias. Can be specified as `xclass` * property if only one object parameter is specified. * @param {Object...} [args] Additional arguments after the name will be passed to * the class' constructor. * @return {Object} instance * @member Ext * @method create */ create: alias(Manager, 'instantiate'), /** * Convenient shorthand to create a widget by its xtype or a config object. * See also {@link Ext.ClassManager#instantiateByAlias}. * * var button = Ext.widget('button'); // Equivalent to Ext.create('widget.button'); * * var panel = Ext.widget('panel', { // Equivalent to Ext.create('widget.panel') * title: 'Panel' * }); * * var grid = Ext.widget({ * xtype: 'grid', * ... * }); * * If a {@link Ext.Component component} instance is passed, it is simply returned. * * @member Ext * @param {String} [name] The xtype of the widget to create. * @param {Object} [config] The configuration object for the widget constructor. * @return {Object} The widget instance */ widget: function(name, config) { // forms: // 1: (xtype) // 2: (xtype, config) // 3: (config) // 4: (xtype, component) // 5: (component) // var xtype = name, alias, className, T, load; if (typeof xtype != 'string') { // if (form 3 or 5) // first arg is config or component config = name; // arguments[0] xtype = config.xtype; } else { config = config || {}; } if (config.isComponent) { return config; } alias = 'widget.' + xtype; className = Manager.getNameByAlias(alias); // this is needed to support demand loading of the class if (!className) { load = true; } T = Manager.get(className); if (load || !T) { return Manager.instantiateByAlias(alias, config); } return new T(config); }, /** * @inheritdoc Ext.ClassManager#instantiateByAlias * @member Ext * @method createByAlias */ createByAlias: alias(Manager, 'instantiateByAlias'), /** * Defines a class or override. A basic class is defined like this: * * Ext.define('My.awesome.Class', { * someProperty: 'something', * * someMethod: function(s) { * alert(s + this.someProperty); * } * * ... * }); * * var obj = new My.awesome.Class(); * * obj.someMethod('Say '); // alerts 'Say something' * * To create an anonymous class, pass `null` for the `className`: * * Ext.define(null, { * constructor: function () { * // ... * } * }); * * In some cases, it is helpful to create a nested scope to contain some private * properties. The best way to do this is to pass a function instead of an object * as the second parameter. This function will be called to produce the class * body: * * Ext.define('MyApp.foo.Bar', function () { * var id = 0; * * return { * nextId: function () { * return ++id; * } * }; * }); * * _Note_ that when using override, the above syntax will not override successfully, because * the passed function would need to be executed first to determine whether or not the result * is an override or defining a new object. As such, an alternative syntax that immediately * invokes the function can be used: * * Ext.define('MyApp.override.BaseOverride', function () { * var counter = 0; * * return { * override: 'Ext.Component', * logId: function () { * console.log(++counter, this.id); * } * }; * }()); * * * When using this form of `Ext.define`, the function is passed a reference to its * class. This can be used as an efficient way to access any static properties you * may have: * * Ext.define('MyApp.foo.Bar', function (Bar) { * return { * statics: { * staticMethod: function () { * // ... * } * }, * * method: function () { * return Bar.staticMethod(); * } * }; * }); * * To define an override, include the `override` property. The content of an * override is aggregated with the specified class in order to extend or modify * that class. This can be as simple as setting default property values or it can * extend and/or replace methods. This can also extend the statics of the class. * * One use for an override is to break a large class into manageable pieces. * * // File: /src/app/Panel.js * * Ext.define('My.app.Panel', { * extend: 'Ext.panel.Panel', * requires: [ * 'My.app.PanelPart2', * 'My.app.PanelPart3' * ] * * constructor: function (config) { * this.callParent(arguments); // calls Ext.panel.Panel's constructor * //... * }, * * statics: { * method: function () { * return 'abc'; * } * } * }); * * // File: /src/app/PanelPart2.js * Ext.define('My.app.PanelPart2', { * override: 'My.app.Panel', * * constructor: function (config) { * this.callParent(arguments); // calls My.app.Panel's constructor * //... * } * }); * * Another use of overrides is to provide optional parts of classes that can be * independently required. In this case, the class may even be unaware of the * override altogether. * * Ext.define('My.ux.CoolTip', { * override: 'Ext.tip.ToolTip', * * constructor: function (config) { * this.callParent(arguments); // calls Ext.tip.ToolTip's constructor * //... * } * }); * * The above override can now be required as normal. * * Ext.define('My.app.App', { * requires: [ * 'My.ux.CoolTip' * ] * }); * * Overrides can also contain statics: * * Ext.define('My.app.BarMod', { * override: 'Ext.foo.Bar', * * statics: { * method: function (x) { * return this.callParent([x * 2]); // call Ext.foo.Bar.method * } * } * }); * * IMPORTANT: An override is only included in a build if the class it overrides is * required. Otherwise, the override, like the target class, is not included. * * @param {String} className The class name to create in string dot-namespaced format, for example: * 'My.very.awesome.Class', 'FeedViewer.plugin.CoolPager' * It is highly recommended to follow this simple convention: * - The root and the class name are 'CamelCased' * - Everything else is lower-cased * Pass `null` to create an anonymous class. * @param {Object} data The key - value pairs of properties to apply to this class. Property names can be of any valid * strings, except those in the reserved listed below: * - `mixins` * - `statics` * - `config` * - `alias` * - `self` * - `singleton` * - `alternateClassName` * - `override` * * @param {Function} createdFn Optional callback to execute after the class is created, the execution scope of which * (`this`) will be the newly created class itself. * @return {Ext.Base} * @member Ext */ define: function (className, data, createdFn) { Ext.classSystemMonitor && Ext.classSystemMonitor(className, 'ClassManager#define', arguments); if (data.override) { return Manager.createOverride.apply(Manager, arguments); } return Manager.create.apply(Manager, arguments); }, /** * Undefines a class defined using the #define method. Typically used * for unit testing where setting up and tearing down a class multiple * times is required. For example: * * // define a class * Ext.define('Foo', { * ... * }); * * // run test * * // undefine the class * Ext.undefine('Foo'); * @param {String} className The class name to undefine in string dot-namespaced format. * @private */ undefine: function(className) { Ext.classSystemMonitor && Ext.classSystemMonitor(className, 'Ext.ClassManager#undefine', arguments); var classes = Manager.classes, maps = Manager.maps, aliasToName = maps.aliasToName, nameToAliases = maps.nameToAliases, alternateToName = maps.alternateToName, nameToAlternates = maps.nameToAlternates, aliases = nameToAliases[className], alternates = nameToAlternates[className], parts, partCount, namespace, i; delete Manager.namespaceParseCache[className]; delete nameToAliases[className]; delete nameToAlternates[className]; delete classes[className]; if (aliases) { for (i = aliases.length; i--;) { delete aliasToName[aliases[i]]; } } if (alternates) { for (i = alternates.length; i--; ) { delete alternateToName[alternates[i]]; } } parts = Manager.parseNamespace(className); partCount = parts.length - 1; namespace = parts[0]; for (i = 1; i < partCount; i++) { namespace = namespace[parts[i]]; if (!namespace) { return; } } // Old IE blows up on attempt to delete window property try { delete namespace[parts[partCount]]; } catch (e) { namespace[parts[partCount]] = undefined; } }, /** * @inheritdoc Ext.ClassManager#getName * @member Ext * @method getClassName */ getClassName: alias(Manager, 'getName'), /** * Returns the displayName property or className or object. When all else fails, returns "Anonymous". * @param {Object} object * @return {String} */ getDisplayName: function(object) { if (object) { if (object.displayName) { return object.displayName; } if (object.$name && object.$class) { return Ext.getClassName(object.$class) + '#' + object.$name; } if (object.$className) { return object.$className; } } return 'Anonymous'; }, /** * @inheritdoc Ext.ClassManager#getClass * @member Ext * @method getClass */ getClass: alias(Manager, 'getClass'), /** * Creates namespaces to be used for scoping variables and classes so that they are not global. * Specifying the last node of a namespace implicitly creates all other nodes. Usage: * * Ext.namespace('Company', 'Company.data'); * * // equivalent and preferable to the above syntax * Ext.ns('Company.data'); * * Company.Widget = function() { ... }; * * Company.data.CustomStore = function(config) { ... }; * * @param {String...} namespaces * @return {Object} The namespace object. * (If multiple arguments are passed, this will be the last namespace created) * @member Ext * @method namespace */ namespace: alias(Manager, 'createNamespaces') }); /** * Old name for {@link Ext#widget}. * @deprecated 4.0.0 Use {@link Ext#widget} instead. * @method createWidget * @member Ext */ Ext.createWidget = Ext.widget; /** * Convenient alias for {@link Ext#namespace Ext.namespace}. * @inheritdoc Ext#namespace * @member Ext * @method ns */ Ext.ns = Ext.namespace; Class.registerPreprocessor('className', function(cls, data) { if (data.$className) { cls.$className = data.$className; cls.displayName = cls.$className; } Ext.classSystemMonitor && Ext.classSystemMonitor(cls, 'Ext.ClassManager#classNamePreprocessor', arguments); }, true, 'first'); Class.registerPreprocessor('alias', function(cls, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(cls, 'Ext.ClassManager#aliasPreprocessor', arguments); var prototype = cls.prototype, xtypes = arrayFrom(data.xtype), aliases = arrayFrom(data.alias), widgetPrefix = 'widget.', widgetPrefixLength = widgetPrefix.length, xtypesChain = Array.prototype.slice.call(prototype.xtypesChain || []), xtypesMap = Ext.merge({}, prototype.xtypesMap || {}), i, ln, alias, xtype; for (i = 0,ln = aliases.length; i < ln; i++) { alias = aliases[i]; if (typeof alias != 'string' || alias.length < 1) { throw new Error("[Ext.define] Invalid alias of: '" + alias + "' for class: '" + name + "'; must be a valid string"); } if (alias.substring(0, widgetPrefixLength) === widgetPrefix) { xtype = alias.substring(widgetPrefixLength); Ext.Array.include(xtypes, xtype); } } cls.xtype = data.xtype = xtypes[0]; data.xtypes = xtypes; for (i = 0,ln = xtypes.length; i < ln; i++) { xtype = xtypes[i]; if (!xtypesMap[xtype]) { xtypesMap[xtype] = true; xtypesChain.push(xtype); } } data.xtypesChain = xtypesChain; data.xtypesMap = xtypesMap; Ext.Function.interceptAfter(data, 'onClassCreated', function() { Ext.classSystemMonitor && Ext.classSystemMonitor(cls, 'Ext.ClassManager#aliasPreprocessor#afterClassCreated', arguments); var mixins = prototype.mixins, key, mixin; for (key in mixins) { if (mixins.hasOwnProperty(key)) { mixin = mixins[key]; xtypes = mixin.xtypes; if (xtypes) { for (i = 0,ln = xtypes.length; i < ln; i++) { xtype = xtypes[i]; if (!xtypesMap[xtype]) { xtypesMap[xtype] = true; xtypesChain.push(xtype); } } } } } }); for (i = 0,ln = xtypes.length; i < ln; i++) { xtype = xtypes[i]; if (typeof xtype != 'string' || xtype.length < 1) { throw new Error("[Ext.define] Invalid xtype of: '" + xtype + "' for class: '" + name + "'; must be a valid non-empty string"); } Ext.Array.include(aliases, widgetPrefix + xtype); } data.alias = aliases; }, ['xtype', 'alias']); }(Ext.Class, Ext.Function.alias, Array.prototype.slice, Ext.Array.from, Ext.global)); // simple mechanism for automated means of injecting large amounts of dependency info // at the appropriate time in the load cycle if (Ext._alternatesMetadata) { Ext.ClassManager.addNameAlternateMappings(Ext._alternatesMetadata); Ext._alternatesMetadata = null; } if (Ext._aliasMetadata) { Ext.ClassManager.addNameAliasMappings(Ext._aliasMetadata); Ext._aliasMetadata = null; } // @tag foundation,core // @require ClassManager.js // @define Ext.Loader /** * @author Jacky Nguyen * @docauthor Jacky Nguyen * @class Ext.Loader * * Ext.Loader is the heart of the new dynamic dependency loading capability in Ext JS 4+. It is most commonly used * via the {@link Ext#require} shorthand. Ext.Loader supports both asynchronous and synchronous loading * approaches, and leverage their advantages for the best development flow. We'll discuss about the pros and cons of each approach: * * # Asynchronous Loading # * * - Advantages: * + Cross-domain * + No web server needed: you can run the application via the file system protocol (i.e: `file://path/to/your/index * .html`) * + Best possible debugging experience: error messages come with the exact file name and line number * * - Disadvantages: * + Dependencies need to be specified before-hand * * ### Method 1: Explicitly include what you need: ### * * // Syntax * Ext.require({String/Array} expressions); * * // Example: Single alias * Ext.require('widget.window'); * * // Example: Single class name * Ext.require('Ext.window.Window'); * * // Example: Multiple aliases / class names mix * Ext.require(['widget.window', 'layout.border', 'Ext.data.Connection']); * * // Wildcards * Ext.require(['widget.*', 'layout.*', 'Ext.data.*']); * * ### Method 2: Explicitly exclude what you don't need: ### * * // Syntax: Note that it must be in this chaining format. * Ext.exclude({String/Array} expressions) * .require({String/Array} expressions); * * // Include everything except Ext.data.* * Ext.exclude('Ext.data.*').require('*'); * * // Include all widgets except widget.checkbox*, * // which will match widget.checkbox, widget.checkboxfield, widget.checkboxgroup, etc. * Ext.exclude('widget.checkbox*').require('widget.*'); * * # Synchronous Loading on Demand # * * - Advantages: * + There's no need to specify dependencies before-hand, which is always the convenience of including ext-all.js * before * * - Disadvantages: * + Not as good debugging experience since file name won't be shown (except in Firebug at the moment) * + Must be from the same domain due to XHR restriction * + Need a web server, same reason as above * * There's one simple rule to follow: Instantiate everything with Ext.create instead of the `new` keyword * * Ext.create('widget.window', { ... }); // Instead of new Ext.window.Window({...}); * * Ext.create('Ext.window.Window', {}); // Same as above, using full class name instead of alias * * Ext.widget('window', {}); // Same as above, all you need is the traditional `xtype` * * Behind the scene, {@link Ext.ClassManager} will automatically check whether the given class name / alias has already * existed on the page. If it's not, Ext.Loader will immediately switch itself to synchronous mode and automatic load the given * class and all its dependencies. * * # Hybrid Loading - The Best of Both Worlds # * * It has all the advantages combined from asynchronous and synchronous loading. The development flow is simple: * * ### Step 1: Start writing your application using synchronous approach. * * Ext.Loader will automatically fetch all dependencies on demand as they're needed during run-time. For example: * * Ext.onReady(function(){ * var window = Ext.widget('window', { * width: 500, * height: 300, * layout: { * type: 'border', * padding: 5 * }, * title: 'Hello Dialog', * items: [{ * title: 'Navigation', * collapsible: true, * region: 'west', * width: 200, * html: 'Hello', * split: true * }, { * title: 'TabPanel', * region: 'center' * }] * }); * * window.show(); * }) * * ### Step 2: Along the way, when you need better debugging ability, watch the console for warnings like these: ### * * [Ext.Loader] Synchronously loading 'Ext.window.Window'; consider adding Ext.require('Ext.window.Window') before your application's code * ClassManager.js:432 * [Ext.Loader] Synchronously loading 'Ext.layout.container.Border'; consider adding Ext.require('Ext.layout.container.Border') before your application's code * * Simply copy and paste the suggested code above `Ext.onReady`, i.e: * * Ext.require('Ext.window.Window'); * Ext.require('Ext.layout.container.Border'); * * Ext.onReady(...); * * Everything should now load via asynchronous mode. * * # Deployment # * * It's important to note that dynamic loading should only be used during development on your local machines. * During production, all dependencies should be combined into one single JavaScript file. Ext.Loader makes * the whole process of transitioning from / to between development / maintenance and production as easy as * possible. Internally {@link Ext.Loader#history Ext.Loader.history} maintains the list of all dependencies your application * needs in the exact loading sequence. It's as simple as concatenating all files in this array into one, * then include it on top of your application. * * This process will be automated with Sencha Command, to be released and documented towards Ext JS 4 Final. * * @singleton */ Ext.Loader = new function() { var Loader = this, Manager = Ext.ClassManager, Class = Ext.Class, flexSetter = Ext.Function.flexSetter, alias = Ext.Function.alias, pass = Ext.Function.pass, defer = Ext.Function.defer, arrayErase = Ext.Array.erase, dependencyProperties = ['extend', 'mixins', 'requires'], isInHistory = {}, history = [], slashDotSlashRe = /\/\.\//g, dotRe = /\./g, setPathCount = 0; Ext.apply(Loader, { /** * @private */ isInHistory: isInHistory, /** * An array of class names to keep track of the dependency loading order. * This is not guaranteed to be the same everytime due to the asynchronous * nature of the Loader. * * @property {Array} history */ history: history, /** * Configuration * @private */ config: { /** * @cfg {Boolean} enabled * Whether or not to enable the dynamic dependency loading feature. */ enabled: false, /** * @cfg {Boolean} scriptChainDelay * millisecond delay between asynchronous script injection (prevents stack overflow on some user agents) * 'false' disables delay but potentially increases stack load. */ scriptChainDelay : false, /** * @cfg {Boolean} disableCaching * Appends current timestamp to script files to prevent caching. */ disableCaching: true, /** * @cfg {String} disableCachingParam * The get parameter name for the cache buster's timestamp. */ disableCachingParam: '_dc', /** * @cfg {Boolean} garbageCollect * True to prepare an asynchronous script tag for garbage collection (effective only * if {@link #preserveScripts preserveScripts} is false) */ garbageCollect : false, /** * @cfg {Object} paths * The mapping from namespaces to file paths * * { * 'Ext': '.', // This is set by default, Ext.layout.container.Container will be * // loaded from ./layout/Container.js * * 'My': './src/my_own_folder' // My.layout.Container will be loaded from * // ./src/my_own_folder/layout/Container.js * } * * Note that all relative paths are relative to the current HTML document. * If not being specified, for example, Other.awesome.Class * will simply be loaded from ./Other/awesome/Class.js */ paths: { 'Ext': '.' }, /** * @cfg {Boolean} preserveScripts * False to remove and optionally {@link #garbageCollect garbage-collect} asynchronously loaded scripts, * True to retain script element for browser debugger compatibility and improved load performance. */ preserveScripts : true, /** * @cfg {String} scriptCharset * Optional charset to specify encoding of dynamic script content. */ scriptCharset : undefined }, /** * Set the configuration for the loader. This should be called right after ext-(debug).js * is included in the page, and before Ext.onReady. i.e: * * * * * * Refer to config options of {@link Ext.Loader} for the list of possible properties * * @param {Object} config The config object to override the default values * @return {Ext.Loader} this */ setConfig: function(name, value) { if (Ext.isObject(name) && arguments.length === 1) { Ext.merge(Loader.config, name); if ('paths' in name) { Ext.app.collectNamespaces(name.paths); } } else { Loader.config[name] = (Ext.isObject(value)) ? Ext.merge(Loader.config[name], value) : value; if (name === 'paths') { Ext.app.collectNamespaces(value); } } return Loader; }, /** * Get the config value corresponding to the specified name. If no name is given, will return the config object * @param {String} name The config property name * @return {Object} */ getConfig: function(name) { if (name) { return Loader.config[name]; } return Loader.config; }, /** * Sets the path of a namespace. * For Example: * * Ext.Loader.setPath('Ext', '.'); * * @param {String/Object} name See {@link Ext.Function#flexSetter flexSetter} * @param {String} [path] See {@link Ext.Function#flexSetter flexSetter} * @return {Ext.Loader} this * @method */ setPath: flexSetter(function(name, path) { Loader.config.paths[name] = path; Ext.app.namespaces[name] = true; setPathCount++; return Loader; }), /** * Sets a batch of path entries * * @param {Object } paths a set of className: path mappings * @return {Ext.Loader} this */ addClassPathMappings: function(paths) { var name; if(setPathCount == 0){ Loader.config.paths = paths; } else { for(name in paths){ Loader.config.paths[name] = paths[name]; } } setPathCount++; return Loader; }, /** * Translates a className to a file path by adding the * the proper prefix and converting the .'s to /'s. For example: * * Ext.Loader.setPath('My', '/path/to/My'); * * alert(Ext.Loader.getPath('My.awesome.Class')); // alerts '/path/to/My/awesome/Class.js' * * Note that the deeper namespace levels, if explicitly set, are always resolved first. For example: * * Ext.Loader.setPath({ * 'My': '/path/to/lib', * 'My.awesome': '/other/path/for/awesome/stuff', * 'My.awesome.more': '/more/awesome/path' * }); * * alert(Ext.Loader.getPath('My.awesome.Class')); // alerts '/other/path/for/awesome/stuff/Class.js' * * alert(Ext.Loader.getPath('My.awesome.more.Class')); // alerts '/more/awesome/path/Class.js' * * alert(Ext.Loader.getPath('My.cool.Class')); // alerts '/path/to/lib/cool/Class.js' * * alert(Ext.Loader.getPath('Unknown.strange.Stuff')); // alerts 'Unknown/strange/Stuff.js' * * @param {String} className * @return {String} path */ getPath: function(className) { var path = '', paths = Loader.config.paths, prefix = Loader.getPrefix(className); if (prefix.length > 0) { if (prefix === className) { return paths[prefix]; } path = paths[prefix]; className = className.substring(prefix.length + 1); } if (path.length > 0) { path += '/'; } return path.replace(slashDotSlashRe, '/') + className.replace(dotRe, "/") + '.js'; }, /** * @private * @param {String} className */ getPrefix: function(className) { var paths = Loader.config.paths, prefix, deepestPrefix = ''; if (paths.hasOwnProperty(className)) { return className; } for (prefix in paths) { if (paths.hasOwnProperty(prefix) && prefix + '.' === className.substring(0, prefix.length + 1)) { if (prefix.length > deepestPrefix.length) { deepestPrefix = prefix; } } } return deepestPrefix; }, /** * @private * @param {String} className */ isAClassNameWithAKnownPrefix: function(className) { var prefix = Loader.getPrefix(className); // we can only say it's really a class if className is not equal to any known namespace return prefix !== '' && prefix !== className; }, /** * Loads all classes by the given names and all their direct dependencies; optionally executes * the given callback function when finishes, within the optional scope. * * {@link Ext#require} is alias for {@link Ext.Loader#require}. * * @param {String/Array} expressions Can either be a string or an array of string * @param {Function} fn (Optional) The callback function * @param {Object} scope (Optional) The execution scope (`this`) of the callback function * @param {String/Array} excludes (Optional) Classes to be excluded, useful when being used with expressions */ require: function(expressions, fn, scope, excludes) { if (fn) { fn.call(scope); } }, /** * Synchronously loads all classes by the given names and all their direct dependencies; optionally * executes the given callback function when finishes, within the optional scope. * * {@link Ext#syncRequire} is alias for {@link Ext.Loader#syncRequire}. * * @param {String/Array} expressions Can either be a string or an array of string * @param {Function} fn (Optional) The callback function * @param {Object} scope (Optional) The execution scope (`this`) of the callback function * @param {String/Array} excludes (Optional) Classes to be excluded, useful when being used with expressions */ syncRequire: function() {}, /** * Explicitly exclude files from being loaded. Useful when used in conjunction with a broad include expression. * Can be chained with more `require` and `exclude` methods, eg: * * Ext.exclude('Ext.data.*').require('*'); * * Ext.exclude('widget.button*').require('widget.*'); * * {@link Ext#exclude} is alias for {@link Ext.Loader#exclude}. * * @param {Array} excludes * @return {Object} object contains `require` method for chaining */ exclude: function(excludes) { return { require: function(expressions, fn, scope) { return Loader.require(expressions, fn, scope, excludes); }, syncRequire: function(expressions, fn, scope) { return Loader.syncRequire(expressions, fn, scope, excludes); } }; }, /** * Add a new listener to be executed when all required scripts are fully loaded * * @param {Function} fn The function callback to be executed * @param {Object} scope The execution scope (this) of the callback function * @param {Boolean} withDomReady Whether or not to wait for document dom ready as well */ onReady: function(fn, scope, withDomReady, options) { var oldFn; if (withDomReady !== false && Ext.onDocumentReady) { oldFn = fn; fn = function() { Ext.onDocumentReady(oldFn, scope, options); }; } fn.call(scope); } }); var queue = [], isClassFileLoaded = {}, isFileLoaded = {}, classNameToFilePathMap = {}, scriptElements = {}, readyListeners = [], usedClasses = [], requiresMap = {}, comparePriority = function(listenerA, listenerB) { return listenerB.priority - listenerA.priority; }; Ext.apply(Loader, { /** * @private */ documentHead: typeof document != 'undefined' && (document.head || document.getElementsByTagName('head')[0]), /** * Flag indicating whether there are still files being loaded * @private */ isLoading: false, /** * Maintain the queue for all dependencies. Each item in the array is an object of the format: * * { * requires: [...], // The required classes for this queue item * callback: function() { ... } // The function to execute when all classes specified in requires exist * } * * @private */ queue: queue, /** * Maintain the list of files that have already been handled so that they never get double-loaded * @private */ isClassFileLoaded: isClassFileLoaded, /** * @private */ isFileLoaded: isFileLoaded, /** * Maintain the list of listeners to execute when all required scripts are fully loaded * @private */ readyListeners: readyListeners, /** * Contains classes referenced in `uses` properties. * @private */ optionalRequires: usedClasses, /** * Map of fully qualified class names to an array of dependent classes. * @private */ requiresMap: requiresMap, /** * @private */ numPendingFiles: 0, /** * @private */ numLoadedFiles: 0, /** @private */ hasFileLoadError: false, /** * @private */ classNameToFilePathMap: classNameToFilePathMap, /** * The number of scripts loading via loadScript. * @private */ scriptsLoading: 0, /** * @private */ syncModeEnabled: false, scriptElements: scriptElements, /** * Refresh all items in the queue. If all dependencies for an item exist during looping, * it will execute the callback and call refreshQueue again. Triggers onReady when the queue is * empty * @private */ refreshQueue: function() { var ln = queue.length, i, item, j, requires; // When the queue of loading classes reaches zero, trigger readiness if (!ln && !Loader.scriptsLoading) { return Loader.triggerReady(); } for (i = 0; i < ln; i++) { item = queue[i]; if (item) { requires = item.requires; // Don't bother checking when the number of files loaded // is still less than the array length if (requires.length > Loader.numLoadedFiles) { continue; } // Remove any required classes that are loaded for (j = 0; j < requires.length; ) { if (Manager.isCreated(requires[j])) { // Take out from the queue arrayErase(requires, j, 1); } else { j++; } } // If we've ended up with no required classes, call the callback if (item.requires.length === 0) { arrayErase(queue, i, 1); item.callback.call(item.scope); Loader.refreshQueue(); break; } } } return Loader; }, /** * Inject a script element to document's head, call onLoad and onError accordingly * @private */ injectScriptElement: function(url, onLoad, onError, scope, charset) { var script = document.createElement('script'), dispatched = false, config = Loader.config, onLoadFn = function() { if(!dispatched) { dispatched = true; script.onload = script.onreadystatechange = script.onerror = null; if (typeof config.scriptChainDelay == 'number') { //free the stack (and defer the next script) defer(onLoad, config.scriptChainDelay, scope); } else { onLoad.call(scope); } Loader.cleanupScriptElement(script, config.preserveScripts === false, config.garbageCollect); } }, onErrorFn = function(arg) { defer(onError, 1, scope); //free the stack Loader.cleanupScriptElement(script, config.preserveScripts === false, config.garbageCollect); }; script.type = 'text/javascript'; script.onerror = onErrorFn; charset = charset || config.scriptCharset; if (charset) { script.charset = charset; } /* * IE9 Standards mode (and others) SHOULD follow the load event only * (Note: IE9 supports both onload AND readystatechange events) */ if ('addEventListener' in script ) { script.onload = onLoadFn; } else if ('readyState' in script) { // for = 200 && status < 300) || (status === 304) ) { // Debugger friendly, file names are still shown even though they're eval'ed code // Breakpoints work on both Firebug and Chrome's Web Inspector if (!Ext.isIE) { debugSourceURL = "\n//@ sourceURL=" + url; } Ext.globalEval(xhr.responseText + debugSourceURL); onLoad.call(scope); } else { onError.call(Loader, "Failed loading synchronously via XHR: '" + url + "'; please " + "verify that the file exists. " + "XHR status code: " + status, synchronous); } // Prevent potential IE memory leak xhr = null; } }, // documented above syncRequire: function() { var syncModeEnabled = Loader.syncModeEnabled; if (!syncModeEnabled) { Loader.syncModeEnabled = true; } Loader.require.apply(Loader, arguments); if (!syncModeEnabled) { Loader.syncModeEnabled = false; } Loader.refreshQueue(); }, // documented above require: function(expressions, fn, scope, excludes) { var excluded = {}, included = {}, excludedClassNames = [], possibleClassNames = [], classNames = [], references = [], callback, syncModeEnabled, filePath, expression, exclude, className, possibleClassName, i, j, ln, subLn; if (excludes) { // Convert possible single string to an array. excludes = (typeof excludes === 'string') ? [ excludes ] : excludes; for (i = 0,ln = excludes.length; i < ln; i++) { exclude = excludes[i]; if (typeof exclude == 'string' && exclude.length > 0) { excludedClassNames = Manager.getNamesByExpression(exclude); for (j = 0,subLn = excludedClassNames.length; j < subLn; j++) { excluded[excludedClassNames[j]] = true; } } } } // Convert possible single string to an array. expressions = (typeof expressions === 'string') ? [ expressions ] : (expressions ? expressions : []); if (fn) { if (fn.length > 0) { callback = function() { var classes = [], i, ln; for (i = 0,ln = references.length; i < ln; i++) { classes.push(Manager.get(references[i])); } return fn.apply(this, classes); }; } else { callback = fn; } } else { callback = Ext.emptyFn; } scope = scope || Ext.global; for (i = 0,ln = expressions.length; i < ln; i++) { expression = expressions[i]; if (typeof expression == 'string' && expression.length > 0) { possibleClassNames = Manager.getNamesByExpression(expression); subLn = possibleClassNames.length; for (j = 0; j < subLn; j++) { possibleClassName = possibleClassNames[j]; if (excluded[possibleClassName] !== true) { references.push(possibleClassName); if (!Manager.isCreated(possibleClassName) && !included[possibleClassName]) { included[possibleClassName] = true; classNames.push(possibleClassName); } } } } } // If the dynamic dependency feature is not being used, throw an error // if the dependencies are not defined if (classNames.length > 0) { if (!Loader.config.enabled) { throw new Error("Ext.Loader is not enabled, so dependencies cannot be resolved dynamically. " + "Missing required class" + ((classNames.length > 1) ? "es" : "") + ": " + classNames.join(', ')); } } else { callback.call(scope); return Loader; } syncModeEnabled = Loader.syncModeEnabled; if (!syncModeEnabled) { queue.push({ requires: classNames.slice(), // this array will be modified as the queue is processed, // so we need a copy of it callback: callback, scope: scope }); } ln = classNames.length; for (i = 0; i < ln; i++) { className = classNames[i]; filePath = Loader.getPath(className); // If we are synchronously loading a file that has already been asychronously loaded before // we need to destroy the script tag and revert the count // This file will then be forced loaded in synchronous if (syncModeEnabled && isClassFileLoaded.hasOwnProperty(className)) { if (!isClassFileLoaded[className]) { Loader.numPendingFiles--; Loader.removeScriptElement(filePath); delete isClassFileLoaded[className]; } } if (!isClassFileLoaded.hasOwnProperty(className)) { isClassFileLoaded[className] = false; classNameToFilePathMap[className] = filePath; Loader.numPendingFiles++; Loader.loadScriptFile( filePath, pass(Loader.onFileLoaded, [className, filePath], Loader), pass(Loader.onFileLoadError, [className, filePath], Loader), Loader, syncModeEnabled ); } } if (syncModeEnabled) { callback.call(scope); if (ln === 1) { return Manager.get(className); } } return Loader; }, /** * @private * @param {String} className * @param {String} filePath */ onFileLoaded: function(className, filePath) { var loaded = isClassFileLoaded[className]; Loader.numLoadedFiles++; isClassFileLoaded[className] = true; isFileLoaded[filePath] = true; // In FF, when we sync load something that has had a script tag inserted, the load event may // sometimes fire even if we clean it up and set it to null, so check if we're already loaded here. if (!loaded) { Loader.numPendingFiles--; } if (Loader.numPendingFiles === 0) { Loader.refreshQueue(); } if (!Loader.syncModeEnabled && Loader.numPendingFiles === 0 && Loader.isLoading && !Loader.hasFileLoadError) { var missingClasses = [], missingPaths = [], requires, i, ln, j, subLn; for (i = 0,ln = queue.length; i < ln; i++) { requires = queue[i].requires; for (j = 0,subLn = requires.length; j < subLn; j++) { if (isClassFileLoaded[requires[j]]) { missingClasses.push(requires[j]); } } } if (missingClasses.length < 1) { return; } missingClasses = Ext.Array.filter(Ext.Array.unique(missingClasses), function(item) { return !requiresMap.hasOwnProperty(item); }, Loader); if (missingClasses.length < 1) { return; } for (i = 0,ln = missingClasses.length; i < ln; i++) { missingPaths.push(classNameToFilePathMap[missingClasses[i]]); } throw new Error("The following classes are not declared even if their files have been " + "loaded: '" + missingClasses.join("', '") + "'. Please check the source code of their " + "corresponding files for possible typos: '" + missingPaths.join("', '")); } }, /** * @private */ onFileLoadError: function(className, filePath, errorMessage, isSynchronous) { Loader.numPendingFiles--; Loader.hasFileLoadError = true; throw new Error("[Ext.Loader] " + errorMessage); }, /** * @private * Ensure that any classes referenced in the `uses` property are loaded. */ addUsedClasses: function (classes) { var cls, i, ln; if (classes) { classes = (typeof classes == 'string') ? [classes] : classes; for (i = 0, ln = classes.length; i < ln; i++) { cls = classes[i]; if (typeof cls == 'string' && !Ext.Array.contains(usedClasses, cls)) { usedClasses.push(cls); } } } return Loader; }, /** * @private */ triggerReady: function() { var listener, refClasses = usedClasses; if (Loader.isLoading) { Loader.isLoading = false; if (refClasses.length !== 0) { // Clone then empty the array to eliminate potential recursive loop issue refClasses = refClasses.slice(); usedClasses.length = 0; // this may immediately call us back if all 'uses' classes // have been loaded Loader.require(refClasses, Loader.triggerReady, Loader); return Loader; } } Ext.Array.sort(readyListeners, comparePriority); // this method can be called with Loader.isLoading either true or false // (can be called with false when all 'uses' classes are already loaded) // this may bypass the above if condition while (readyListeners.length && !Loader.isLoading) { // calls to refreshQueue may re-enter triggerReady // so we cannot necessarily iterate the readyListeners array listener = readyListeners.shift(); listener.fn.call(listener.scope); } return Loader; }, // Documented above already onReady: function(fn, scope, withDomReady, options) { var oldFn; if (withDomReady !== false && Ext.onDocumentReady) { oldFn = fn; fn = function() { Ext.onDocumentReady(oldFn, scope, options); }; } if (!Loader.isLoading) { fn.call(scope); } else { readyListeners.push({ fn: fn, scope: scope, priority: (options && options.priority) || 0 }); } }, /** * @private * @param {String} className */ historyPush: function(className) { if (className && isClassFileLoaded.hasOwnProperty(className) && !isInHistory[className]) { isInHistory[className] = true; history.push(className); } return Loader; } }); /** * Turns on or off the "cache buster" applied to dynamically loaded scripts. Normally * dynamically loaded scripts have an extra query parameter appended to avoid stale * cached scripts. This method can be used to disable this mechanism, and is primarily * useful for testing. This is done using a cookie. * @param {Boolean} disable True to disable the cache buster. * @param {String} [path="/"] An optional path to scope the cookie. * @private */ Ext.disableCacheBuster = function (disable, path) { var date = new Date(); date.setTime(date.getTime() + (disable ? 10*365 : -1) * 24*60*60*1000); date = date.toGMTString(); document.cookie = 'ext-cache=1; expires=' + date + '; path='+(path || '/'); }; /** * @member Ext * @method require * @inheritdoc Ext.Loader#require */ Ext.require = alias(Loader, 'require'); /** * @member Ext * @method syncRequire * @inheritdoc Ext.Loader#syncRequire */ Ext.syncRequire = alias(Loader, 'syncRequire'); /** * Convenient shortcut to {@link Ext.Loader#exclude} * @member Ext * @method exclude * @inheritdoc Ext.Loader#exclude */ Ext.exclude = alias(Loader, 'exclude'); /** * @member Ext * @method onReady * @ignore */ Ext.onReady = function(fn, scope, options) { Loader.onReady(fn, scope, true, options); }; /** * @cfg {String[]} requires * @member Ext.Class * List of classes that have to be loaded before instantiating this class. * For example: * * Ext.define('Mother', { * requires: ['Child'], * giveBirth: function() { * // we can be sure that child class is available. * return new Child(); * } * }); */ Class.registerPreprocessor('loader', function(cls, data, hooks, continueFn) { Ext.classSystemMonitor && Ext.classSystemMonitor(cls, 'Ext.Loader#loaderPreprocessor', arguments); var me = this, dependencies = [], dependency, className = Manager.getName(cls), i, j, ln, subLn, value, propertyName, propertyValue, requiredMap, requiredDep; /* Loop through the dependencyProperties, look for string class names and push them into a stack, regardless of whether the property's value is a string, array or object. For example: { extend: 'Ext.MyClass', requires: ['Ext.some.OtherClass'], mixins: { observable: 'Ext.util.Observable'; } } which will later be transformed into: { extend: Ext.MyClass, requires: [Ext.some.OtherClass], mixins: { observable: Ext.util.Observable; } } */ for (i = 0,ln = dependencyProperties.length; i < ln; i++) { propertyName = dependencyProperties[i]; if (data.hasOwnProperty(propertyName)) { propertyValue = data[propertyName]; if (typeof propertyValue == 'string') { dependencies.push(propertyValue); } else if (propertyValue instanceof Array) { for (j = 0, subLn = propertyValue.length; j < subLn; j++) { value = propertyValue[j]; if (typeof value == 'string') { dependencies.push(value); } } } else if (typeof propertyValue != 'function') { for (j in propertyValue) { if (propertyValue.hasOwnProperty(j)) { value = propertyValue[j]; if (typeof value == 'string') { dependencies.push(value); } } } } } } if (dependencies.length === 0) { return; } var deadlockPath = [], detectDeadlock; /* Automatically detect deadlocks before-hand, will throw an error with detailed path for ease of debugging. Examples of deadlock cases: - A extends B, then B extends A - A requires B, B requires C, then C requires A The detectDeadlock function will recursively transverse till the leaf, hence it can detect deadlocks no matter how deep the path is. */ if (className) { requiresMap[className] = dependencies; requiredMap = Loader.requiredByMap || (Loader.requiredByMap = {}); for (i = 0,ln = dependencies.length; i < ln; i++) { dependency = dependencies[i]; (requiredMap[dependency] || (requiredMap[dependency] = [])).push(className); } detectDeadlock = function(cls) { deadlockPath.push(cls); if (requiresMap[cls]) { if (Ext.Array.contains(requiresMap[cls], className)) { throw new Error("Deadlock detected while loading dependencies! '" + className + "' and '" + deadlockPath[1] + "' " + "mutually require each other. Path: " + deadlockPath.join(' -> ') + " -> " + deadlockPath[0]); } for (i = 0,ln = requiresMap[cls].length; i < ln; i++) { detectDeadlock(requiresMap[cls][i]); } } }; detectDeadlock(className); } Loader.require(dependencies, function() { for (i = 0,ln = dependencyProperties.length; i < ln; i++) { propertyName = dependencyProperties[i]; if (data.hasOwnProperty(propertyName)) { propertyValue = data[propertyName]; if (typeof propertyValue == 'string') { data[propertyName] = Manager.get(propertyValue); } else if (propertyValue instanceof Array) { for (j = 0, subLn = propertyValue.length; j < subLn; j++) { value = propertyValue[j]; if (typeof value == 'string') { data[propertyName][j] = Manager.get(value); } } } else if (typeof propertyValue != 'function') { for (var k in propertyValue) { if (propertyValue.hasOwnProperty(k)) { value = propertyValue[k]; if (typeof value == 'string') { data[propertyName][k] = Manager.get(value); } } } } } } continueFn.call(me, cls, data, hooks); }); return false; }, true, 'after', 'className'); /** * @cfg {String[]} uses * @member Ext.Class * List of optional classes to load together with this class. These aren't neccessarily loaded before * this class is created, but are guaranteed to be available before Ext.onReady listeners are * invoked. For example: * * Ext.define('Mother', { * uses: ['Child'], * giveBirth: function() { * // This code might, or might not work: * // return new Child(); * * // Instead use Ext.create() to load the class at the spot if not loaded already: * return Ext.create('Child'); * } * }); */ Manager.registerPostprocessor('uses', function(name, cls, data) { Ext.classSystemMonitor && Ext.classSystemMonitor(cls, 'Ext.Loader#usesPostprocessor', arguments); var uses = data.uses; if (uses) { Loader.addUsedClasses(uses); } }); Manager.onCreated(Loader.historyPush); }; // simple mechanism for automated means of injecting large amounts of dependency info // at the appropriate time in the load cycle if (Ext._classPathMetadata) { Ext.Loader.addClassPathMappings(Ext._classPathMetadata); Ext._classPathMetadata = null; } // initalize the default path of the framework (function() { var scripts = document.getElementsByTagName('script'), currentScript = scripts[scripts.length - 1], src = currentScript.src, path = src.substring(0, src.lastIndexOf('/') + 1), Loader = Ext.Loader; if(src.indexOf("/platform/core/src/class/") != -1) { path = path + "../../../../extjs/"; } else if(src.indexOf("/core/src/class/") != -1) { path = path + "../../../"; } Loader.setConfig({ enabled: true, disableCaching: (/[?&](?:cache|disableCacheBuster)\b/i.test(location.search) || /(^|[ ;])ext-cache=1/.test(document.cookie)) ? false : true, paths: { 'Ext': path + 'src' } }); })(); // allows a tools like dynatrace to deterministically detect onReady state by invoking // a callback (intended for external consumption) Ext._endTime = new Date().getTime(); if (Ext._beforereadyhandler){ Ext._beforereadyhandler(); } // @tag foundation,core // @require ../class/Loader.js // @define Ext.Error /** * @author Brian Moeskau * @docauthor Brian Moeskau * * A wrapper class for the native JavaScript Error object that adds a few useful capabilities for handling * errors in an Ext application. When you use Ext.Error to {@link #raise} an error from within any class that * uses the Ext 4 class system, the Error class can automatically add the source class and method from which * the error was raised. It also includes logic to automatically log the error to the console, if available, * with additional metadata about the error. In all cases, the error will always be thrown at the end so that * execution will halt. * * Ext.Error also offers a global error {@link #handle handling} method that can be overridden in order to * handle application-wide errors in a single spot. You can optionally {@link #ignore} errors altogether, * although in a real application it's usually a better idea to override the handling function and perform * logging or some other method of reporting the errors in a way that is meaningful to the application. * * At its simplest you can simply raise an error as a simple string from within any code: * * Example usage: * * Ext.Error.raise('Something bad happened!'); * * If raised from plain JavaScript code, the error will be logged to the console (if available) and the message * displayed. In most cases however you'll be raising errors from within a class, and it may often be useful to add * additional metadata about the error being raised. The {@link #raise} method can also take a config object. * In this form the `msg` attribute becomes the error description, and any other data added to the config gets * added to the error object and, if the console is available, logged to the console for inspection. * * Example usage: * * Ext.define('Ext.Foo', { * doSomething: function(option){ * if (someCondition === false) { * Ext.Error.raise({ * msg: 'You cannot do that!', * option: option, // whatever was passed into the method * 'error code': 100 // other arbitrary info * }); * } * } * }); * * If a console is available (that supports the `console.dir` function) you'll see console output like: * * An error was raised with the following data: * option: Object { foo: "bar"} * foo: "bar" * error code: 100 * msg: "You cannot do that!" * sourceClass: "Ext.Foo" * sourceMethod: "doSomething" * * uncaught exception: You cannot do that! * * As you can see, the error will report exactly where it was raised and will include as much information as the * raising code can usefully provide. * * If you want to handle all application errors globally you can simply override the static {@link #handle} method * and provide whatever handling logic you need. If the method returns true then the error is considered handled * and will not be thrown to the browser. If anything but true is returned then the error will be thrown normally. * * Example usage: * * Ext.Error.handle = function(err) { * if (err.someProperty == 'NotReallyAnError') { * // maybe log something to the application here if applicable * return true; * } * // any non-true return value (including none) will cause the error to be thrown * } * */ Ext.Error = Ext.extend(Error, { statics: { /** * @property {Boolean} ignore * Static flag that can be used to globally disable error reporting to the browser if set to true * (defaults to false). Note that if you ignore Ext errors it's likely that some other code may fail * and throw a native JavaScript error thereafter, so use with caution. In most cases it will probably * be preferable to supply a custom error {@link #handle handling} function instead. * * Example usage: * * Ext.Error.ignore = true; * * @static */ ignore: false, /** * @property {Boolean} notify * Static flag that can be used to globally control error notification to the user. Unlike * Ex.Error.ignore, this does not effect exceptions. They are still thrown. This value can be * set to false to disable the alert notification (default is true for IE6 and IE7). * * Only the first error will generate an alert. Internally this flag is set to false when the * first error occurs prior to displaying the alert. * * This flag is not used in a release build. * * Example usage: * * Ext.Error.notify = false; * * @static */ //notify: Ext.isIE6 || Ext.isIE7, /** * Raise an error that can include additional data and supports automatic console logging if available. * You can pass a string error message or an object with the `msg` attribute which will be used as the * error message. The object can contain any other name-value attributes (or objects) to be logged * along with the error. * * Note that after displaying the error message a JavaScript error will ultimately be thrown so that * execution will halt. * * Example usage: * * Ext.Error.raise('A simple string error message'); * * // or... * * Ext.define('Ext.Foo', { * doSomething: function(option){ * if (someCondition === false) { * Ext.Error.raise({ * msg: 'You cannot do that!', * option: option, // whatever was passed into the method * 'error code': 100 // other arbitrary info * }); * } * } * }); * * @param {String/Object} err The error message string, or an object containing the attribute "msg" that will be * used as the error message. Any other data included in the object will also be logged to the browser console, * if available. * @static */ raise: function(err){ err = err || {}; if (Ext.isString(err)) { err = { msg: err }; } var method = this.raise.caller, msg; if (method) { if (method.$name) { err.sourceMethod = method.$name; } if (method.$owner) { err.sourceClass = method.$owner.$className; } } if (Ext.Error.handle(err) !== true) { msg = Ext.Error.prototype.toString.call(err); Ext.log({ msg: msg, level: 'error', dump: err, stack: true }); throw new Ext.Error(err); } }, /** * Globally handle any Ext errors that may be raised, optionally providing custom logic to * handle different errors individually. Return true from the function to bypass throwing the * error to the browser, otherwise the error will be thrown and execution will halt. * * Example usage: * * Ext.Error.handle = function(err) { * if (err.someProperty == 'NotReallyAnError') { * // maybe log something to the application here if applicable * return true; * } * // any non-true return value (including none) will cause the error to be thrown * } * * @param {Ext.Error} err The Ext.Error object being raised. It will contain any attributes that were originally * raised with it, plus properties about the method and class from which the error originated (if raised from a * class that uses the Ext 4 class system). * @static */ handle: function(){ return Ext.Error.ignore; } }, // This is the standard property that is the name of the constructor. name: 'Ext.Error', /** * Creates new Error object. * @param {String/Object} config The error message string, or an object containing the * attribute "msg" that will be used as the error message. Any other data included in * the object will be applied to the error instance and logged to the browser console, if available. */ constructor: function(config){ if (Ext.isString(config)) { config = { msg: config }; } var me = this; Ext.apply(me, config); me.message = me.message || me.msg; // 'message' is standard ('msg' is non-standard) // note: the above does not work in old WebKit (me.message is readonly) (Safari 4) }, /** * Provides a custom string representation of the error object. This is an override of the base JavaScript * `Object.toString` method, which is useful so that when logged to the browser console, an error object will * be displayed with a useful message instead of `[object Object]`, the default `toString` result. * * The default implementation will include the error message along with the raising class and method, if available, * but this can be overridden with a custom implementation either at the prototype level (for all errors) or on * a particular error instance, if you want to provide a custom description that will show up in the console. * @return {String} The error message. If raised from within the Ext 4 class system, the error message will also * include the raising class and method names, if available. */ toString: function(){ var me = this, className = me.sourceClass ? me.sourceClass : '', methodName = me.sourceMethod ? '.' + me.sourceMethod + '(): ' : '', msg = me.msg || '(No description provided)'; return className + methodName + msg; } }); /* * Create a function that will throw an error if called (in debug mode) with a message that * indicates the method has been removed. * @param {String} suggestion Optional text to include in the message (a workaround perhaps). * @return {Function} The generated function. * @private */ Ext.deprecated = function (suggestion) { if (!suggestion) { suggestion = ''; } function fail () { Ext.Error.raise('The method "' + fail.$owner.$className + '.' + fail.$name + '" has been removed. ' + suggestion); } return fail; return Ext.emptyFn; }; /* * This mechanism is used to notify the user of the first error encountered on the page. This * was previously internal to Ext.Error.raise and is a desirable feature since errors often * slip silently under the radar. It cannot live in Ext.Error.raise since there are times * where exceptions are handled in a try/catch. */ (function () { var timer, errors = 0, win = Ext.global, msg; if (typeof window === 'undefined') { return; // build system or some such environment... } // This method is called to notify the user of the current error status. function notify () { var counters = Ext.log.counters, supports = Ext.supports, hasOnError = supports && supports.WindowOnError; // TODO - timing // Put log counters to the status bar (for most browsers): if (counters && (counters.error + counters.warn + counters.info + counters.log)) { msg = [ 'Logged Errors:',counters.error, 'Warnings:',counters.warn, 'Info:',counters.info, 'Log:',counters.log].join(' '); if (errors) { msg = '*** Errors: ' + errors + ' - ' + msg; } else if (counters.error) { msg = '*** ' + msg; } win.status = msg; } // Display an alert on the first error: if (!Ext.isDefined(Ext.Error.notify)) { Ext.Error.notify = Ext.isIE6 || Ext.isIE7; // TODO - timing } if (Ext.Error.notify && (hasOnError ? errors : (counters && counters.error))) { Ext.Error.notify = false; if (timer) { win.clearInterval(timer); // ticks can queue up so stop... timer = null; } alert('Unhandled error on page: See console or log'); poll(); } } // Sets up polling loop. This is the only way to know about errors in some browsers // (Opera/Safari) and is the only way to update the status bar for warnings and other // non-errors. function poll () { timer = win.setInterval(notify, 1000); } // window.onerror sounds ideal but it prevents the built-in error dialog from doing // its (better) thing. poll(); }()); // @tag extras,core // @require ../lang/Error.js // @define Ext.JSON /** * Modified version of [Douglas Crockford's JSON.js][dc] that doesn't * mess with the Object prototype. * * [dc]: http://www.json.org/js.html * * @singleton */ Ext.JSON = (new(function() { var me = this, encodingFunction, decodingFunction, useNative = null, useHasOwn = !! {}.hasOwnProperty, isNative = function() { if (useNative === null) { useNative = Ext.USE_NATIVE_JSON && window.JSON && JSON.toString() == '[object JSON]'; } return useNative; }, pad = function(n) { return n < 10 ? "0" + n : n; }, doDecode = function(json) { return eval("(" + json + ')'); }, doEncode = function(o, newline) { // http://jsperf.com/is-undefined if (o === null || o === undefined) { return "null"; } else if (Ext.isDate(o)) { return Ext.JSON.encodeDate(o); } else if (Ext.isString(o)) { return Ext.JSON.encodeString(o); } else if (typeof o == "number") { //don't use isNumber here, since finite checks happen inside isNumber return isFinite(o) ? String(o) : "null"; } else if (Ext.isBoolean(o)) { return String(o); } // Allow custom zerialization by adding a toJSON method to any object type. // Date/String have a toJSON in some environments, so check these first. else if (o.toJSON) { return o.toJSON(); } else if (Ext.isArray(o)) { return encodeArray(o, newline); } else if (Ext.isObject(o)) { return encodeObject(o, newline); } else if (typeof o === "function") { return "null"; } return 'undefined'; }, m = { "\b": '\\b', "\t": '\\t', "\n": '\\n', "\f": '\\f', "\r": '\\r', '"': '\\"', "\\": '\\\\', '\x0b': '\\u000b' //ie doesn't handle \v }, charToReplace = /[\\\"\x00-\x1f\x7f-\uffff]/g, encodeString = function(s) { return '"' + s.replace(charToReplace, function(a) { var c = m[a]; return typeof c === 'string' ? c : '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4); }) + '"'; }, encodeArrayPretty = function(o, newline) { var len = o.length, cnewline = newline + ' ', sep = ',' + cnewline, a = ["[", cnewline], // Note newline in case there are no members i; for (i = 0; i < len; i += 1) { a.push(Ext.JSON.encodeValue(o[i], cnewline), sep); } // Overwrite trailing comma (or empty string) a[a.length - 1] = newline + ']'; return a.join(''); }, encodeObjectPretty = function(o, newline) { var cnewline = newline + ' ', sep = ',' + cnewline, a = ["{", cnewline], // Note newline in case there are no members i, val; for (i in o) { val = o[i]; if (!useHasOwn || o.hasOwnProperty(i)) { // To match JSON.stringify, we shouldn't encode functions or undefined if (typeof val === 'function' || val === undefined) { continue; } a.push(Ext.JSON.encodeValue(i) + ': ' + Ext.JSON.encodeValue(val, cnewline), sep); } } // Overwrite trailing comma (or empty string) a[a.length - 1] = newline + '}'; return a.join(''); }, encodeArray = function(o, newline) { if (newline) { return encodeArrayPretty(o, newline); } var a = ["[", ""], // Note empty string in case there are no serializable members. len = o.length, i; for (i = 0; i < len; i += 1) { a.push(Ext.JSON.encodeValue(o[i]), ','); } // Overwrite trailing comma (or empty string) a[a.length - 1] = ']'; return a.join(""); }, encodeObject = function(o, newline) { if (newline) { return encodeObjectPretty(o, newline); } var a = ["{", ""], // Note empty string in case there are no serializable members. i, val; for (i in o) { val = o[i]; if (!useHasOwn || o.hasOwnProperty(i)) { // To match JSON.stringify, we shouldn't encode functions or undefined if (typeof val === 'function' || val === undefined) { continue; } a.push(Ext.JSON.encodeValue(i), ":", Ext.JSON.encodeValue(val), ','); } } // Overwrite trailing comma (or empty string) a[a.length - 1] = '}'; return a.join(""); }; /** * Encodes a String. This returns the actual string which is inserted into the JSON string as the literal * expression. **The returned value includes enclosing double quotation marks.** * * To override this: * * Ext.JSON.encodeString = function(s) { * return 'Foo' + s; * }; * * @param {String} s The String to encode * @return {String} The string literal to use in a JSON string. * @method */ me.encodeString = encodeString; /** * The function which {@link #encode} uses to encode all javascript values to their JSON representations * when {@link Ext#USE_NATIVE_JSON} is `false`. * * This is made public so that it can be replaced with a custom implementation. * * @param {Object} o Any javascript value to be converted to its JSON representation * @return {String} The JSON representation of the passed value. * @method */ me.encodeValue = doEncode; /** * Encodes a Date. This returns the actual string which is inserted into the JSON string as the literal * expression. **The returned value includes enclosing double quotation marks.** * * The default return format is `"yyyy-mm-ddThh:mm:ss"`. * * To override this: * * Ext.JSON.encodeDate = function(d) { * return Ext.Date.format(d, '"Y-m-d"'); * }; * * @param {Date} d The Date to encode * @return {String} The string literal to use in a JSON string. */ me.encodeDate = function(o) { return '"' + o.getFullYear() + "-" + pad(o.getMonth() + 1) + "-" + pad(o.getDate()) + "T" + pad(o.getHours()) + ":" + pad(o.getMinutes()) + ":" + pad(o.getSeconds()) + '"'; }; /** * Encodes an Object, Array or other value. * * If the environment's native JSON encoding is not being used ({@link Ext#USE_NATIVE_JSON} is not set, * or the environment does not support it), then ExtJS's encoding will be used. This allows the developer * to add a `toJSON` method to their classes which need serializing to return a valid JSON representation * of the object. * * @param {Object} o The variable to encode * @return {String} The JSON string */ me.encode = function(o) { if (!encodingFunction) { // setup encoding function on first access encodingFunction = isNative() ? JSON.stringify : me.encodeValue; } return encodingFunction(o); }; /** * Decodes (parses) a JSON string to an object. If the JSON is invalid, this function throws * a SyntaxError unless the safe option is set. * * @param {String} json The JSON string * @param {Boolean} [safe=false] True to return null, false to throw an exception if the JSON is invalid. * @return {Object} The resulting object */ me.decode = function(json, safe) { if (!decodingFunction) { // setup decoding function on first access decodingFunction = isNative() ? JSON.parse : doDecode; } try { return decodingFunction(json); } catch (e) { if (safe === true) { return null; } Ext.Error.raise({ sourceClass: "Ext.JSON", sourceMethod: "decode", msg: "You're trying to decode an invalid JSON String: " + json }); } }; })()); /** * Shorthand for {@link Ext.JSON#encode} * @member Ext * @method encode * @inheritdoc Ext.JSON#encode */ Ext.encode = Ext.JSON.encode; /** * Shorthand for {@link Ext.JSON#decode} * @member Ext * @method decode * @inheritdoc Ext.JSON#decode */ Ext.decode = Ext.JSON.decode; // @tag extras,core // @require misc/JSON.js // @define Ext /** * @class Ext * * The Ext namespace (global object) encapsulates all classes, singletons, and * utility methods provided by Sencha's libraries. * * Most user interface Components are at a lower level of nesting in the namespace, * but many common utility functions are provided as direct properties of the Ext namespace. * * Also many frequently used methods from other classes are provided as shortcuts * within the Ext namespace. For example {@link Ext#getCmp Ext.getCmp} aliases * {@link Ext.ComponentManager#get Ext.ComponentManager.get}. * * Many applications are initiated with {@link Ext#onReady Ext.onReady} which is * called once the DOM is ready. This ensures all scripts have been loaded, * preventing dependency issues. For example: * * Ext.onReady(function(){ * new Ext.Component({ * renderTo: document.body, * html: 'DOM ready!' * }); * }); * * For more information about how to use the Ext classes, see: * * - The Learning Center * - The FAQ * - The forums * * @singleton */ Ext.apply(Ext, { userAgent: navigator.userAgent.toLowerCase(), cache: {}, idSeed: 1000, windowId: 'ext-window', documentId: 'ext-document', /** * True when the document is fully initialized and ready for action */ isReady: false, /** * True to automatically uncache orphaned Ext.Elements periodically */ enableGarbageCollector: true, /** * True to automatically purge event listeners during garbageCollection. */ enableListenerCollection: true, /** * @property {Object} rootHierarchyState the top level hierarchy state to which * all other hierarchy states are chained. If there is a viewport instance, * this object becomes the viewport's heirarchyState. See also * {@link Ext.AbstractComponent#getHierarchyState} * @private */ rootHierarchyState: {}, addCacheEntry: function(id, el, dom) { dom = dom || el.dom; if (!dom) { // Without the DOM node we can't GC the entry Ext.Error.raise('Cannot add an entry to the element cache without the DOM node'); } var cache = Ext.cache, key = id || (el && el.id) || dom.id, entry = cache[key] || (cache[key] = { data: {}, events: {}, dom: dom, // Skip garbage collection for special elements (window, document, iframes) skipGarbageCollection: !!(dom.getElementById || dom.navigator) }); if (el) { el.$cache = entry; // Inject the back link from the cache in case the cache entry // had already been created by Ext.fly. Ext.fly creates a cache entry with no el link. entry.el = el; } return entry; }, updateCacheEntry: function(cacheItem, dom){ cacheItem.dom = dom; if (cacheItem.el) { cacheItem.el.dom = dom; } return cacheItem; }, /** * Generates unique ids. If the element already has an id, it is unchanged * @param {HTMLElement/Ext.Element} [el] The element to generate an id for * @param {String} prefix (optional) Id prefix (defaults "ext-gen") * @return {String} The generated Id. */ id: function(el, prefix) { var me = this, sandboxPrefix = ''; el = Ext.getDom(el, true) || {}; if (el === document) { el.id = me.documentId; } else if (el === window) { el.id = me.windowId; } if (!el.id) { if (me.isSandboxed) { sandboxPrefix = Ext.sandboxName.toLowerCase() + '-'; } el.id = sandboxPrefix + (prefix || "ext-gen") + (++Ext.idSeed); } return el.id; }, escapeId: (function(){ var validIdRe = /^[a-zA-Z_][a-zA-Z0-9_\-]*$/i, escapeRx = /([\W]{1})/g, leadingNumRx = /^(\d)/g, escapeFn = function(match, capture){ return "\\" + capture; }, numEscapeFn = function(match, capture){ return '\\00' + capture.charCodeAt(0).toString(16) + ' '; }; return function(id) { return validIdRe.test(id) ? id // replace the number portion last to keep the trailing ' ' // from being escaped : id.replace(escapeRx, escapeFn) .replace(leadingNumRx, numEscapeFn); }; }()), /** * Returns the current document body as an {@link Ext.Element}. * @return {Ext.Element} The document body */ getBody: (function() { var body; return function() { return body || (body = Ext.get(document.body)); }; }()), /** * Returns the current document head as an {@link Ext.Element}. * @return {Ext.Element} The document head * @method */ getHead: (function() { var head; return function() { return head || (head = Ext.get(document.getElementsByTagName("head")[0])); }; }()), /** * Returns the current HTML document object as an {@link Ext.Element}. * @return {Ext.Element} The document */ getDoc: (function() { var doc; return function() { return doc || (doc = Ext.get(document)); }; }()), /** * Returns the current orientation of the mobile device * @return {String} Either 'portrait' or 'landscape' */ getOrientation: function() { return window.innerHeight > window.innerWidth ? 'portrait' : 'landscape'; }, /** * Attempts to destroy any objects passed to it by removing all event listeners, removing them from the * DOM (if applicable) and calling their destroy functions (if available). This method is primarily * intended for arguments of type {@link Ext.Element} and {@link Ext.Component}, but any subclass of * {@link Ext.util.Observable} can be passed in. Any number of elements and/or components can be * passed into this function in a single call as separate arguments. * * @param {Ext.dom.Element/Ext.util.Observable/Ext.dom.Element[]/Ext.util.Observable[]...} args * Any number of elements or components, or an Array of either of these to destroy. */ destroy: function() { var ln = arguments.length, i, arg; for (i = 0; i < ln; i++) { arg = arguments[i]; if (arg) { if (Ext.isArray(arg)) { this.destroy.apply(this, arg); } else if (arg.isStore) { arg.destroyStore(); } else if (Ext.isFunction(arg.destroy)) { arg.destroy(); } else if (arg.dom) { arg.remove(); } } } }, /** * Execute a callback function in a particular scope. If `callback` argument is a * function reference, that is called. If it is a string, the string is assumed to * be the name of a method on the given `scope`. If no function is passed the call * is ignored. * * For example, these calls are equivalent: * * var myFunc = this.myFunc; * * Ext.callback('myFunc', this, [arg1, arg2]); * Ext.callback(myFunc, this, [arg1, arg2]); * * Ext.isFunction(myFunc) && this.myFunc(arg1, arg2); * * @param {Function} callback The callback to execute * @param {Object} [scope] The scope to execute in * @param {Array} [args] The arguments to pass to the function * @param {Number} [delay] Pass a number to delay the call by a number of milliseconds. * @return The value returned by the callback or `undefined` (if there is a `delay` * or if the `callback` is not a function). */ callback: function (callback, scope, args, delay) { var fn, ret; if (Ext.isFunction(callback)){ fn = callback; } else if (scope && Ext.isString(callback)) { fn = scope[callback]; if (!fn) { Ext.Error.raise('No method named "' + callback + '"'); } } if (fn) { args = args || []; scope = scope || window; if (delay) { Ext.defer(fn, delay, scope, args); } else { ret = fn.apply(scope, args); } } return ret; }, /** * @private */ resolveMethod: function(fn, scope) { if (Ext.isFunction(fn)) { return fn; } if (!Ext.isObject(scope) || !Ext.isFunction(scope[fn])) { Ext.Error.raise('No method named "' + fn + '"'); } return scope[fn]; }, /** * Alias for {@link Ext.String#htmlEncode}. * @inheritdoc Ext.String#htmlEncode * @ignore */ htmlEncode : function(value) { return Ext.String.htmlEncode(value); }, /** * Alias for {@link Ext.String#htmlDecode}. * @inheritdoc Ext.String#htmlDecode * @ignore */ htmlDecode : function(value) { return Ext.String.htmlDecode(value); }, /** * Alias for {@link Ext.String#urlAppend}. * @inheritdoc Ext.String#urlAppend * @ignore */ urlAppend : function(url, s) { return Ext.String.urlAppend(url, s); } }); Ext.ns = Ext.namespace; // for old browsers window.undefined = window.undefined; /** * @class Ext */ (function(){ /* FF 3.6 - Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.17) Gecko/20110420 Firefox/3.6.17 FF 4.0.1 - Mozilla/5.0 (Windows NT 5.1; rv:2.0.1) Gecko/20100101 Firefox/4.0.1 FF 5.0 - Mozilla/5.0 (Windows NT 6.1; WOW64; rv:5.0) Gecko/20100101 Firefox/5.0 IE6 - Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1;) IE7 - Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1;) IE8 - Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0) IE9 - Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E)] IE10 - Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; WOW64; Trident/6.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; MS-RTC LM 8) Chrome 11 - Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/534.24 (KHTML, like Gecko) Chrome/11.0.696.60 Safari/534.24 Safari 5 - Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US) AppleWebKit/533.21.1 (KHTML, like Gecko) Version/5.0.5 Safari/533.21.1 Opera 11.11 - Opera/9.80 (Windows NT 6.1; U; en) Presto/2.8.131 Version/11.11 */ var check = function(regex){ return regex.test(Ext.userAgent); }, isStrict = document.compatMode == "CSS1Compat", version = function (is, regex) { var m; return (is && (m = regex.exec(Ext.userAgent))) ? parseFloat(m[1]) : 0; }, docMode = document.documentMode, isOpera = check(/opera/), isOpera10_5 = isOpera && check(/version\/10\.5/), isChrome = check(/\bchrome\b/), isWebKit = check(/webkit/), isSafari = !isChrome && check(/safari/), isSafari2 = isSafari && check(/applewebkit\/4/), // unique to Safari 2 isSafari3 = isSafari && check(/version\/3/), isSafari4 = isSafari && check(/version\/4/), isSafari5_0 = isSafari && check(/version\/5\.0/), isSafari5 = isSafari && check(/version\/5/), isIE = !isOpera && check(/msie/), isIE7 = isIE && ((check(/msie 7/) && docMode != 8 && docMode != 9 && docMode != 10) || docMode == 7), isIE8 = isIE && ((check(/msie 8/) && docMode != 7 && docMode != 9 && docMode != 10) || docMode == 8), isIE9 = isIE && ((check(/msie 9/) && docMode != 7 && docMode != 8 && docMode != 10) || docMode == 9), isIE10 = isIE && ((check(/msie 10/) && docMode != 7 && docMode != 8 && docMode != 9) || docMode == 10), isIE6 = isIE && check(/msie 6/), isGecko = !isWebKit && check(/gecko/), isGecko3 = isGecko && check(/rv:1\.9/), isGecko4 = isGecko && check(/rv:2\.0/), isGecko5 = isGecko && check(/rv:5\./), isGecko10 = isGecko && check(/rv:10\./), isFF3_0 = isGecko3 && check(/rv:1\.9\.0/), isFF3_5 = isGecko3 && check(/rv:1\.9\.1/), isFF3_6 = isGecko3 && check(/rv:1\.9\.2/), isWindows = check(/windows|win32/), isMac = check(/macintosh|mac os x/), isLinux = check(/linux/), scrollbarSize = null, chromeVersion = version(true, /\bchrome\/(\d+\.\d+)/), firefoxVersion = version(true, /\bfirefox\/(\d+\.\d+)/), ieVersion = version(isIE, /msie (\d+\.\d+)/), operaVersion = version(isOpera, /version\/(\d+\.\d+)/), safariVersion = version(isSafari, /version\/(\d+\.\d+)/), webKitVersion = version(isWebKit, /webkit\/(\d+\.\d+)/), isSecure = /^https/i.test(window.location.protocol), nullLog; // remove css image flicker try { document.execCommand("BackgroundImageCache", false, true); } catch(e) {} var primitiveRe = /string|number|boolean/; function dumpObject (object) { var member, type, value, name, members = []; // Cannot use Ext.encode since it can recurse endlessly (if we're lucky) // ...and the data could be prettier! for (name in object) { if (object.hasOwnProperty(name)) { value = object[name]; type = typeof value; if (type == "function") { continue; } if (type == 'undefined') { member = type; } else if (value === null || primitiveRe.test(type) || Ext.isDate(value)) { member = Ext.encode(value); } else if (Ext.isArray(value)) { member = '[ ]'; } else if (Ext.isObject(value)) { member = '{ }'; } else { member = type; } members.push(Ext.encode(name) + ': ' + member); } } if (members.length) { return ' \nData: {\n ' + members.join(',\n ') + '\n}'; } return ''; } function log (message) { var options, dump, con = Ext.global.console, level = 'log', indent = log.indent || 0, stack, out, max; log.indent = indent; if (typeof message != 'string') { options = message; message = options.msg || ''; level = options.level || level; dump = options.dump; stack = options.stack; if (options.indent) { ++log.indent; } else if (options.outdent) { log.indent = indent = Math.max(indent - 1, 0); } if (dump && !(con && con.dir)) { message += dumpObject(dump); dump = null; } } if (arguments.length > 1) { message += Array.prototype.slice.call(arguments, 1).join(''); } message = indent ? Ext.String.repeat(' ', log.indentSize * indent) + message : message; // w/o console, all messages are equal, so munge the level into the message: if (level != 'log') { message = '[' + level.charAt(0).toUpperCase() + '] ' + message; } // Not obvious, but 'console' comes and goes when Firebug is turned on/off, so // an early test may fail either direction if Firebug is toggled. // if (con) { // if (Firebug-like console) if (con[level]) { con[level](message); } else { con.log(message); } if (dump) { con.dir(dump); } if (stack && con.trace) { // Firebug's console.error() includes a trace already... if (!con.firebug || level != 'error') { con.trace(); } } } else { if (Ext.isOpera) { opera.postError(message); } else { out = log.out; max = log.max; if (out.length >= max) { // this formula allows out.max to change (via debugger), where the // more obvious "max/4" would not quite be the same Ext.Array.erase(out, 0, out.length - 3 * Math.floor(max / 4)); // keep newest 75% } out.push(message); } } // Mostly informational, but the Ext.Error notifier uses them: ++log.count; ++log.counters[level]; } function logx (level, args) { if (typeof args[0] == 'string') { args.unshift({}); } args[0].level = level; log.apply(this, args); } log.error = function () { logx('error', Array.prototype.slice.call(arguments)); }; log.info = function () { logx('info', Array.prototype.slice.call(arguments)); }; log.warn = function () { logx('warn', Array.prototype.slice.call(arguments)); }; log.count = 0; log.counters = { error: 0, warn: 0, info: 0, log: 0 }; log.indentSize = 2; log.out = []; log.max = 750; log.show = function () { window.open('','extlog').document.write([ ''].join('')); }; nullLog = function () {}; nullLog.info = nullLog.warn = nullLog.error = Ext.emptyFn; // also update Version.js Ext.setVersion('extjs', '4.2.1.883'); Ext.apply(Ext, { /** * @property {String} SSL_SECURE_URL * URL to a blank file used by Ext when in secure mode for iframe src and onReady src * to prevent the IE insecure content warning (`'about:blank'`, except for IE * in secure mode, which is `'javascript:""'`). */ SSL_SECURE_URL : isSecure && isIE ? 'javascript:\'\'' : 'about:blank', /** * @property {Boolean} enableFx * True if the {@link Ext.fx.Anim} Class is available. */ plainTableCls: Ext.buildSettings.baseCSSPrefix + 'table-plain', plainListCls: Ext.buildSettings.baseCSSPrefix + 'list-plain', /** * @property {Boolean} enableNestedListenerRemoval * **Experimental.** True to cascade listener removal to child elements when an element * is removed. Currently not optimized for performance. */ enableNestedListenerRemoval : false, /** * @property {Boolean} USE_NATIVE_JSON * Indicates whether to use native browser parsing for JSON methods. * This option is ignored if the browser does not support native JSON methods. * * **Note:** Native JSON methods will not work with objects that have functions. * Also, property names must be quoted, otherwise the data will not parse. */ USE_NATIVE_JSON : false, /** * Returns the dom node for the passed String (id), dom node, or Ext.Element. * Optional 'strict' flag is needed for IE since it can return 'name' and * 'id' elements by using getElementById. * * Here are some examples: * * // gets dom node based on id * var elDom = Ext.getDom('elId'); * // gets dom node based on the dom node * var elDom1 = Ext.getDom(elDom); * * // If we don't know if we are working with an * // Ext.Element or a dom node use Ext.getDom * function(el){ * var dom = Ext.getDom(el); * // do something with the dom node * } * * **Note:** the dom node to be found actually needs to exist (be rendered, etc) * when this method is called to be successful. * * @param {String/HTMLElement/Ext.Element} el * @return HTMLElement */ getDom : function(el, strict) { if (!el || !document) { return null; } if (el.dom) { return el.dom; } else { if (typeof el == 'string') { var e = Ext.getElementById(el); // IE returns elements with the 'name' and 'id' attribute. // we do a strict check to return the element with only the id attribute if (e && isIE && strict) { if (el == e.getAttribute('id')) { return e; } else { return null; } } return e; } else { return el; } } }, /** * Removes a DOM node from the document. * * Removes this element from the document, removes all DOM event listeners, and * deletes the cache reference. All DOM event listeners are removed from this element. * If {@link Ext#enableNestedListenerRemoval Ext.enableNestedListenerRemoval} is * `true`, then DOM event listeners are also removed from all child nodes. * The body node will be ignored if passed in. * * @param {HTMLElement} node The node to remove * @method */ removeNode : isIE6 || isIE7 || isIE8 ? (function() { var d; return function(n){ if(n && n.tagName.toUpperCase() != 'BODY'){ (Ext.enableNestedListenerRemoval) ? Ext.EventManager.purgeElement(n) : Ext.EventManager.removeAll(n); var cache = Ext.cache, id = n.id; if (cache[id]) { delete cache[id].dom; delete cache[id]; } if (isIE8 && n.parentNode) { n.parentNode.removeChild(n); } d = d || document.createElement('div'); d.appendChild(n); d.innerHTML = ''; } }; }()) : function(n) { if (n && n.parentNode && n.tagName.toUpperCase() != 'BODY') { (Ext.enableNestedListenerRemoval) ? Ext.EventManager.purgeElement(n) : Ext.EventManager.removeAll(n); var cache = Ext.cache, id = n.id; if (cache[id]) { delete cache[id].dom; delete cache[id]; } n.parentNode.removeChild(n); } }, isStrict: isStrict, // IE10 quirks behaves like Gecko/WebKit quirks, so don't include it here isIEQuirks: isIE && (!isStrict && (isIE6 || isIE7 || isIE8 || isIE9)), /** * True if the detected browser is Opera. * @type Boolean */ isOpera : isOpera, /** * True if the detected browser is Opera 10.5x. * @type Boolean */ isOpera10_5 : isOpera10_5, /** * True if the detected browser uses WebKit. * @type Boolean */ isWebKit : isWebKit, /** * True if the detected browser is Chrome. * @type Boolean */ isChrome : isChrome, /** * True if the detected browser is Safari. * @type Boolean */ isSafari : isSafari, /** * True if the detected browser is Safari 3.x. * @type Boolean */ isSafari3 : isSafari3, /** * True if the detected browser is Safari 4.x. * @type Boolean */ isSafari4 : isSafari4, /** * True if the detected browser is Safari 5.x. * @type Boolean */ isSafari5 : isSafari5, /** * True if the detected browser is Safari 5.0.x. * @type Boolean */ isSafari5_0 : isSafari5_0, /** * True if the detected browser is Safari 2.x. * @type Boolean */ isSafari2 : isSafari2, /** * True if the detected browser is Internet Explorer. * @type Boolean */ isIE : isIE, /** * True if the detected browser is Internet Explorer 6.x. * @type Boolean */ isIE6 : isIE6, /** * True if the detected browser is Internet Explorer 7.x. * @type Boolean */ isIE7 : isIE7, /** * True if the detected browser is Internet Explorer 7.x or lower. * @type Boolean */ isIE7m : isIE6 || isIE7, /** * True if the detected browser is Internet Explorer 7.x or higher. * @type Boolean */ isIE7p : isIE && !isIE6, /** * True if the detected browser is Internet Explorer 8.x. * @type Boolean */ isIE8 : isIE8, /** * True if the detected browser is Internet Explorer 8.x or lower. * @type Boolean */ isIE8m : isIE6 || isIE7 || isIE8, /** * True if the detected browser is Internet Explorer 8.x or higher. * @type Boolean */ isIE8p : isIE && !(isIE6 || isIE7), /** * True if the detected browser is Internet Explorer 9.x. * @type Boolean */ isIE9 : isIE9, /** * True if the detected browser is Internet Explorer 9.x or lower. * @type Boolean */ isIE9m : isIE6 || isIE7 || isIE8 || isIE9, /** * True if the detected browser is Internet Explorer 9.x or higher. * @type Boolean */ isIE9p : isIE && !(isIE6 || isIE7 || isIE8), /** * True if the detected browser is Internet Explorer 10.x. * @type Boolean */ isIE10 : isIE10, /** * True if the detected browser is Internet Explorer 10.x or lower. * @type Boolean */ isIE10m : isIE6 || isIE7 || isIE8 || isIE9 || isIE10, /** * True if the detected browser is Internet Explorer 10.x or higher. * @type Boolean */ isIE10p : isIE && !(isIE6 || isIE7 || isIE8 || isIE9), /** * True if the detected browser uses the Gecko layout engine (e.g. Mozilla, Firefox). * @type Boolean */ isGecko : isGecko, /** * True if the detected browser uses a Gecko 1.9+ layout engine (e.g. Firefox 3.x). * @type Boolean */ isGecko3 : isGecko3, /** * True if the detected browser uses a Gecko 2.0+ layout engine (e.g. Firefox 4.x). * @type Boolean */ isGecko4 : isGecko4, /** * True if the detected browser uses a Gecko 5.0+ layout engine (e.g. Firefox 5.x). * @type Boolean */ isGecko5 : isGecko5, /** * True if the detected browser uses a Gecko 5.0+ layout engine (e.g. Firefox 5.x). * @type Boolean */ isGecko10 : isGecko10, /** * True if the detected browser uses FireFox 3.0 * @type Boolean */ isFF3_0 : isFF3_0, /** * True if the detected browser uses FireFox 3.5 * @type Boolean */ isFF3_5 : isFF3_5, /** * True if the detected browser uses FireFox 3.6 * @type Boolean */ isFF3_6 : isFF3_6, /** * True if the detected browser uses FireFox 4 * @type Boolean */ isFF4 : 4 <= firefoxVersion && firefoxVersion < 5, /** * True if the detected browser uses FireFox 5 * @type Boolean */ isFF5 : 5 <= firefoxVersion && firefoxVersion < 6, /** * True if the detected browser uses FireFox 10 * @type Boolean */ isFF10 : 10 <= firefoxVersion && firefoxVersion < 11, /** * True if the detected platform is Linux. * @type Boolean */ isLinux : isLinux, /** * True if the detected platform is Windows. * @type Boolean */ isWindows : isWindows, /** * True if the detected platform is Mac OS. * @type Boolean */ isMac : isMac, /** * The current version of Chrome (0 if the browser is not Chrome). * @type Number */ chromeVersion: chromeVersion, /** * The current version of Firefox (0 if the browser is not Firefox). * @type Number */ firefoxVersion: firefoxVersion, /** * The current version of IE (0 if the browser is not IE). This does not account * for the documentMode of the current page, which is factored into {@link #isIE7}, * {@link #isIE8} and {@link #isIE9}. Thus this is not always true: * * Ext.isIE8 == (Ext.ieVersion == 8) * * @type Number */ ieVersion: ieVersion, /** * The current version of Opera (0 if the browser is not Opera). * @type Number */ operaVersion: operaVersion, /** * The current version of Safari (0 if the browser is not Safari). * @type Number */ safariVersion: safariVersion, /** * The current version of WebKit (0 if the browser does not use WebKit). * @type Number */ webKitVersion: webKitVersion, /** * True if the page is running over SSL * @type Boolean */ isSecure: isSecure, /** * URL to a 1x1 transparent gif image used by Ext to create inline icons with * CSS background images. In older versions of IE, this defaults to * "http://sencha.com/s.gif" and you should change this to a URL on your server. * For other browsers it uses an inline data URL. * @type String */ BLANK_IMAGE_URL : (isIE6 || isIE7) ? '/' + '/www.sencha.com/s.gif' : 'data:image/gif;base64,R0lGODlhAQABAID/AMDAwAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==', /** * Utility method for returning a default value if the passed value is empty. * * The value is deemed to be empty if it is: * * - null * - undefined * - an empty array * - a zero length string (Unless the `allowBlank` parameter is `true`) * * @param {Object} value The value to test * @param {Object} defaultValue The value to return if the original value is empty * @param {Boolean} [allowBlank=false] true to allow zero length strings to qualify as non-empty. * @return {Object} value, if non-empty, else defaultValue * @deprecated 4.0.0 Use {@link Ext#valueFrom} instead */ value : function(v, defaultValue, allowBlank){ return Ext.isEmpty(v, allowBlank) ? defaultValue : v; }, /** * Escapes the passed string for use in a regular expression. * @param {String} str * @return {String} * @deprecated 4.0.0 Use {@link Ext.String#escapeRegex} instead */ escapeRe : function(s) { return s.replace(/([-.*+?\^${}()|\[\]\/\\])/g, "\\$1"); }, /** * Applies event listeners to elements by selectors when the document is ready. * The event name is specified with an `@` suffix. * * Ext.addBehaviors({ * // add a listener for click on all anchors in element with id foo * '#foo a@click' : function(e, t){ * // do something * }, * * // add the same listener to multiple selectors (separated by comma BEFORE the @) * '#foo a, #bar span.some-class@mouseover' : function(){ * // do something * } * }); * * @param {Object} obj The list of behaviors to apply */ addBehaviors : function(o){ if(!Ext.isReady){ Ext.onReady(function(){ Ext.addBehaviors(o); }); } else { var cache = {}, // simple cache for applying multiple behaviors to same selector does query multiple times parts, b, s; for (b in o) { if ((parts = b.split('@'))[1]) { // for Object prototype breakers s = parts[0]; if(!cache[s]){ cache[s] = Ext.select(s); } cache[s].on(parts[1], o[b]); } } cache = null; } }, /** * Returns the size of the browser scrollbars. This can differ depending on * operating system settings, such as the theme or font size. * @param {Boolean} [force] true to force a recalculation of the value. * @return {Object} An object containing scrollbar sizes. * @return {Number} return.width The width of the vertical scrollbar. * @return {Number} return.height The height of the horizontal scrollbar. */ getScrollbarSize: function (force) { if (!Ext.isReady) { return {}; } if (force || !scrollbarSize) { var db = document.body, div = document.createElement('div'); div.style.width = div.style.height = '100px'; div.style.overflow = 'scroll'; div.style.position = 'absolute'; db.appendChild(div); // now we can measure the div... // at least in iE9 the div is not 100px - the scrollbar size is removed! scrollbarSize = { width: div.offsetWidth - div.clientWidth, height: div.offsetHeight - div.clientHeight }; db.removeChild(div); } return scrollbarSize; }, /** * Utility method for getting the width of the browser's vertical scrollbar. This * can differ depending on operating system settings, such as the theme or font size. * * This method is deprected in favor of {@link #getScrollbarSize}. * * @param {Boolean} [force] true to force a recalculation of the value. * @return {Number} The width of a vertical scrollbar. * @deprecated */ getScrollBarWidth: function(force){ var size = Ext.getScrollbarSize(force); return size.width + 2; // legacy fudge factor }, /** * Copies a set of named properties fom the source object to the destination object. * * Example: * * ImageComponent = Ext.extend(Ext.Component, { * initComponent: function() { * this.autoEl = { tag: 'img' }; * MyComponent.superclass.initComponent.apply(this, arguments); * this.initialBox = Ext.copyTo({}, this.initialConfig, 'x,y,width,height'); * } * }); * * Important note: To borrow class prototype methods, use {@link Ext.Base#borrow} instead. * * @param {Object} dest The destination object. * @param {Object} source The source object. * @param {String/String[]} names Either an Array of property names, or a comma-delimited list * of property names to copy. * @param {Boolean} [usePrototypeKeys] Defaults to false. Pass true to copy keys off of the * prototype as well as the instance. * @return {Object} The modified object. */ copyTo : function(dest, source, names, usePrototypeKeys){ if(typeof names == 'string'){ names = names.split(/[,;\s]/); } var n, nLen = names? names.length : 0, name; for(n = 0; n < nLen; n++) { name = names[n]; if(usePrototypeKeys || source.hasOwnProperty(name)){ dest[name] = source[name]; } } return dest; }, /** * Attempts to destroy and then remove a set of named properties of the passed object. * @param {Object} o The object (most likely a Component) who's properties you wish to destroy. * @param {String...} args One or more names of the properties to destroy and remove from the object. */ destroyMembers : function(o){ for (var i = 1, a = arguments, len = a.length; i < len; i++) { Ext.destroy(o[a[i]]); delete o[a[i]]; } }, /** * Logs a message. If a console is present it will be used. On Opera, the method * "opera.postError" is called. In other cases, the message is logged to an array * "Ext.log.out". An attached debugger can watch this array and view the log. The * log buffer is limited to a maximum of "Ext.log.max" entries (defaults to 250). * The `Ext.log.out` array can also be written to a popup window by entering the * following in the URL bar (a "bookmarklet"): * * javascript:void(Ext.log.show()); * * If additional parameters are passed, they are joined and appended to the message. * A technique for tracing entry and exit of a function is this: * * function foo () { * Ext.log({ indent: 1 }, '>> foo'); * * // log statements in here or methods called from here will be indented * // by one step * * Ext.log({ outdent: 1 }, '<< foo'); * } * * This method does nothing in a release build. * * @param {String/Object} [options] The message to log or an options object with any * of the following properties: * * - `msg`: The message to log (required). * - `level`: One of: "error", "warn", "info" or "log" (the default is "log"). * - `dump`: An object to dump to the log as part of the message. * - `stack`: True to include a stack trace in the log. * - `indent`: Cause subsequent log statements to be indented one step. * - `outdent`: Cause this and following statements to be one step less indented. * * @param {String...} [message] The message to log (required unless specified in * options object). * * @method */ log : log || nullLog, /** * Partitions the set into two sets: a true set and a false set. * * Example 1: * * Ext.partition([true, false, true, true, false]); * // returns [[true, true, true], [false, false]] * * Example 2: * * Ext.partition( * Ext.query("p"), * function(val){ * return val.className == "class1" * } * ); * // true are those paragraph elements with a className of "class1", * // false set are those that do not have that className. * * @param {Array/NodeList} arr The array to partition * @param {Function} truth (optional) a function to determine truth. * If this is omitted the element itself must be able to be evaluated for its truthfulness. * @return {Array} [array of truish values, array of falsy values] * @deprecated 4.0.0 Will be removed in the next major version */ partition : function(arr, truth){ var ret = [[],[]], a, v, aLen = arr.length; for (a = 0; a < aLen; a++) { v = arr[a]; ret[ (truth && truth(v, a, arr)) || (!truth && v) ? 0 : 1].push(v); } return ret; }, /** * Invokes a method on each item in an Array. * * Example: * * Ext.invoke(Ext.query("p"), "getAttribute", "id"); * // [el1.getAttribute("id"), el2.getAttribute("id"), ..., elN.getAttribute("id")] * * @param {Array/NodeList} arr The Array of items to invoke the method on. * @param {String} methodName The method name to invoke. * @param {Object...} args Arguments to send into the method invocation. * @return {Array} The results of invoking the method on each item in the array. * @deprecated 4.0.0 Will be removed in the next major version */ invoke : function(arr, methodName){ var ret = [], args = Array.prototype.slice.call(arguments, 2), a, v, aLen = arr.length; for (a = 0; a < aLen; a++) { v = arr[a]; if (v && typeof v[methodName] == 'function') { ret.push(v[methodName].apply(v, args)); } else { ret.push(undefined); } } return ret; }, /** * Zips N sets together. * * Example 1: * * Ext.zip([1,2,3],[4,5,6]); // [[1,4],[2,5],[3,6]] * * Example 2: * * Ext.zip( * [ "+", "-", "+"], * [ 12, 10, 22], * [ 43, 15, 96], * function(a, b, c){ * return "$" + a + "" + b + "." + c * } * ); // ["$+12.43", "$-10.15", "$+22.96"] * * @param {Array/NodeList...} arr This argument may be repeated. Array(s) * to contribute values. * @param {Function} zipper (optional) The last item in the argument list. * This will drive how the items are zipped together. * @return {Array} The zipped set. * @deprecated 4.0.0 Will be removed in the next major version */ zip : function(){ var parts = Ext.partition(arguments, function( val ){ return typeof val != 'function'; }), arrs = parts[0], fn = parts[1][0], len = Ext.max(Ext.pluck(arrs, "length")), ret = [], i, j, aLen; for (i = 0; i < len; i++) { ret[i] = []; if(fn){ ret[i] = fn.apply(fn, Ext.pluck(arrs, i)); }else{ for (j = 0, aLen = arrs.length; j < aLen; j++){ ret[i].push( arrs[j][i] ); } } } return ret; }, /** * Turns an array into a sentence, joined by a specified connector - e.g.: * * Ext.toSentence(['Adama', 'Tigh', 'Roslin']); //'Adama, Tigh and Roslin' * Ext.toSentence(['Adama', 'Tigh', 'Roslin'], 'or'); //'Adama, Tigh or Roslin' * * @param {String[]} items The array to create a sentence from * @param {String} connector The string to use to connect the last two words. * Usually 'and' or 'or' - defaults to 'and'. * @return {String} The sentence string * @deprecated 4.0.0 Will be removed in the next major version */ toSentence: function(items, connector) { var length = items.length, head, tail; if (length <= 1) { return items[0]; } else { head = items.slice(0, length - 1); tail = items[length - 1]; return Ext.util.Format.format("{0} {1} {2}", head.join(", "), connector || 'and', tail); } }, /** * Sets the default font-family to use for components that support a `glyph` config. * @param {String} fontFamily The name of the font-family */ setGlyphFontFamily: function(fontFamily) { Ext._glyphFontFamily = fontFamily; }, /** * @property {Boolean} useShims * By default, Ext intelligently decides whether floating elements should be shimmed. * If you are using flash, you may want to set this to true. */ useShims: isIE6 }); }()); /** * Loads Ext.app.Application class and starts it up with given configuration after the * page is ready. * * See `Ext.app.Application` for details. * * @param {Object/String} config Application config object or name of a class derived from Ext.app.Application. */ Ext.application = function(config) { var App, paths, ns; if (typeof config === "string") { Ext.require(config, function(){ App = Ext.ClassManager.get(config); }); } else { // We have to process `paths` before creating Application class, // or `requires` won't work. Ext.Loader.setPath(config.name, config.appFolder || 'app'); if (paths = config.paths) { for (ns in paths) { if (paths.hasOwnProperty(ns)) { Ext.Loader.setPath(ns, paths[ns]); } } } config['paths processed'] = true; // Let Ext.define do the hard work but don't assign a class name. // Ext.define(config.name + ".$application", Ext.apply({ extend: 'Ext.app.Application' // can be replaced by config! }, config), // call here when the App class gets full defined function () { App = this; }); } Ext.onReady(function() { // this won't be called until App has been created and its requires have been // met... Ext.app.Application.instance = new App(); }); }; // @tag extras,core // @require ../Ext-more.js // @define Ext.util.Format /** * @class Ext.util.Format * * This class is a centralized place for formatting functions. It includes * functions to format various different types of data, such as text, dates and numeric values. * * ## Localization * * This class contains several options for localization. These can be set once the library has loaded, * all calls to the functions from that point will use the locale settings that were specified. * * Options include: * * - thousandSeparator * - decimalSeparator * - currenyPrecision * - currencySign * - currencyAtEnd * * This class also uses the default date format defined here: {@link Ext.Date#defaultFormat}. * * ## Using with renderers * * There are two helper functions that return a new function that can be used in conjunction with * grid renderers: * * columns: [{ * dataIndex: 'date', * renderer: Ext.util.Format.dateRenderer('Y-m-d') * }, { * dataIndex: 'time', * renderer: Ext.util.Format.numberRenderer('0.000') * }] * * Functions that only take a single argument can also be passed directly: * * columns: [{ * dataIndex: 'cost', * renderer: Ext.util.Format.usMoney * }, { * dataIndex: 'productCode', * renderer: Ext.util.Format.uppercase * }] * * ## Using with XTemplates * * XTemplates can also directly use Ext.util.Format functions: * * new Ext.XTemplate([ * 'Date: {startDate:date("Y-m-d")}', * 'Cost: {cost:usMoney}' * ]); * * @singleton */ (function() { Ext.ns('Ext.util'); var UtilFormat = Ext.util.Format = {}, stripTagsRE = /<\/?[^>]+>/gi, stripScriptsRe = /(?:)((\n|\r|.)*?)(?:<\/script>)/ig, nl2brRe = /\r?\n/g, allHashes = /^#+$/, // Match a format string characters to be able to detect remaining "literal" characters formatPattern = /[\d,\.#]+/, // A RegExp to remove from a number format string, all characters except digits and '.' formatCleanRe = /[^\d\.#]/g, // A RegExp to remove from a number format string, all characters except digits and the local decimal separator. // Created on first use. The local decimal separator character must be initialized for this to be created. I18NFormatCleanRe, // Cache ofg number formatting functions keyed by format string formatFns = {}; Ext.apply(UtilFormat, { // /** * @property {String} thousandSeparator * The character that the {@link #number} function uses as a thousand separator. * * This may be overridden in a locale file. */ thousandSeparator: ',', // // /** * @property {String} decimalSeparator * The character that the {@link #number} function uses as a decimal point. * * This may be overridden in a locale file. */ decimalSeparator: '.', // // /** * @property {Number} currencyPrecision * The number of decimal places that the {@link #currency} function displays. * * This may be overridden in a locale file. */ currencyPrecision: 2, // // /** * @property {String} currencySign * The currency sign that the {@link #currency} function displays. * * This may be overridden in a locale file. */ currencySign: '$', // // /** * @property {Boolean} currencyAtEnd * This may be set to true to make the {@link #currency} function * append the currency sign to the formatted value. * * This may be overridden in a locale file. */ currencyAtEnd: false, // /** * Checks a reference and converts it to empty string if it is undefined. * @param {Object} value Reference to check * @return {Object} Empty string if converted, otherwise the original value */ undef : function(value) { return value !== undefined ? value : ""; }, /** * Checks a reference and converts it to the default value if it's empty. * @param {Object} value Reference to check * @param {String} [defaultValue=""] The value to insert of it's undefined. * @return {String} */ defaultValue : function(value, defaultValue) { return value !== undefined && value !== '' ? value : defaultValue; }, /** * Returns a substring from within an original string. * @param {String} value The original text * @param {Number} start The start index of the substring * @param {Number} length The length of the substring * @return {String} The substring * @method */ substr : 'ab'.substr(-1) != 'b' ? function (value, start, length) { var str = String(value); return (start < 0) ? str.substr(Math.max(str.length + start, 0), length) : str.substr(start, length); } : function(value, start, length) { return String(value).substr(start, length); }, /** * Converts a string to all lower case letters. * @param {String} value The text to convert * @return {String} The converted text */ lowercase : function(value) { return String(value).toLowerCase(); }, /** * Converts a string to all upper case letters. * @param {String} value The text to convert * @return {String} The converted text */ uppercase : function(value) { return String(value).toUpperCase(); }, /** * Format a number as US currency. * @param {Number/String} value The numeric value to format * @return {String} The formatted currency string */ usMoney : function(v) { return UtilFormat.currency(v, '$', 2); }, /** * Format a number as a currency. * @param {Number/String} value The numeric value to format * @param {String} [sign] The currency sign to use (defaults to {@link #currencySign}) * @param {Number} [decimals] The number of decimals to use for the currency * (defaults to {@link #currencyPrecision}) * @param {Boolean} [end] True if the currency sign should be at the end of the string * (defaults to {@link #currencyAtEnd}) * @return {String} The formatted currency string */ currency: function(v, currencySign, decimals, end) { var negativeSign = '', format = ",0", i = 0; v = v - 0; if (v < 0) { v = -v; negativeSign = '-'; } decimals = Ext.isDefined(decimals) ? decimals : UtilFormat.currencyPrecision; format += (decimals > 0 ? '.' : ''); for (; i < decimals; i++) { format += '0'; } v = UtilFormat.number(v, format); if ((end || UtilFormat.currencyAtEnd) === true) { return Ext.String.format("{0}{1}{2}", negativeSign, v, currencySign || UtilFormat.currencySign); } else { return Ext.String.format("{0}{1}{2}", negativeSign, currencySign || UtilFormat.currencySign, v); } }, /** * Formats the passed date using the specified format pattern. * @param {String/Date} value The value to format. If a string is passed, it is converted to a Date * by the Javascript's built-in Date#parse method. * @param {String} [format] Any valid date format string. Defaults to {@link Ext.Date#defaultFormat}. * @return {String} The formatted date string. */ date: function(v, format) { if (!v) { return ""; } if (!Ext.isDate(v)) { v = new Date(Date.parse(v)); } return Ext.Date.dateFormat(v, format || Ext.Date.defaultFormat); }, /** * Returns a date rendering function that can be reused to apply a date format multiple times efficiently. * @param {String} format Any valid date format string. Defaults to {@link Ext.Date#defaultFormat}. * @return {Function} The date formatting function */ dateRenderer : function(format) { return function(v) { return UtilFormat.date(v, format); }; }, /** * Strips all HTML tags. * @param {Object} value The text from which to strip tags * @return {String} The stripped text */ stripTags : function(v) { return !v ? v : String(v).replace(stripTagsRE, ""); }, /** * Strips all script tags. * @param {Object} value The text from which to strip script tags * @return {String} The stripped text */ stripScripts : function(v) { return !v ? v : String(v).replace(stripScriptsRe, ""); }, /** * Simple format for a file size (xxx bytes, xxx KB, xxx MB). * @param {Number/String} size The numeric value to format * @return {String} The formatted file size */ fileSize : (function(){ var byteLimit = 1024, kbLimit = 1048576, mbLimit = 1073741824; return function(size) { var out; if (size < byteLimit) { if (size === 1) { out = '1 byte'; } else { out = size + ' bytes'; } } else if (size < kbLimit) { out = (Math.round(((size*10) / byteLimit))/10) + ' KB'; } else if (size < mbLimit) { out = (Math.round(((size*10) / kbLimit))/10) + ' MB'; } else { out = (Math.round(((size*10) / mbLimit))/10) + ' GB'; } return out; }; })(), /** * It does simple math for use in a template, for example: * * var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}'); * * @return {Function} A function that operates on the passed value. * @method */ math : (function(){ var fns = {}; return function(v, a){ if (!fns[a]) { fns[a] = Ext.functionFactory('v', 'return v ' + a + ';'); } return fns[a](v); }; }()), /** * Rounds the passed number to the required decimal precision. * @param {Number/String} value The numeric value to round. * @param {Number} precision The number of decimal places to which to round the first parameter's value. * @return {Number} The rounded value. */ round : function(value, precision) { var result = Number(value); if (typeof precision == 'number') { precision = Math.pow(10, precision); result = Math.round(value * precision) / precision; } return result; }, /** * Formats the passed number according to the passed format string. * * The number of digits after the decimal separator character specifies the number of * decimal places in the resulting string. The *local-specific* decimal character is * used in the result. * * The *presence* of a thousand separator character in the format string specifies that * the *locale-specific* thousand separator (if any) is inserted separating thousand groups. * * By default, "," is expected as the thousand separator, and "." is expected as the decimal separator. * * ## New to Ext JS 4 * * Locale-specific characters are always used in the formatted output when inserting * thousand and decimal separators. * * The format string must specify separator characters according to US/UK conventions ("," as the * thousand separator, and "." as the decimal separator) * * To allow specification of format strings according to local conventions for separator characters, add * the string `/i` to the end of the format string. * * examples (123456.789): * * - `0` - (123456) show only digits, no precision * - `0.00` - (123456.78) show only digits, 2 precision * - `0.0000` - (123456.7890) show only digits, 4 precision * - `0,000` - (123,456) show comma and digits, no precision * - `0,000.00` - (123,456.78) show comma and digits, 2 precision * - `0,0.00` - (123,456.78) shortcut method, show comma and digits, 2 precision * - `0.####` - (123,456,789) Allow maximum 4 decimal places, but do not right pad with zeroes * * @param {Number} v The number to format. * @param {String} format The way you would like to format this text. * @return {String} The formatted number. */ number : function(v, formatString) { if (!formatString) { return v; } var formatFn = formatFns[formatString]; // Generate formatting function to be cached and reused keyed by the format string. // This results in a 100% performance increase over analyzing the format string each invocation. if (!formatFn) { var originalFormatString = formatString, comma = UtilFormat.thousandSeparator, decimalSeparator = UtilFormat.decimalSeparator, hasComma, splitFormat, extraChars, precision = 0, multiplier, trimTrailingZeroes, code; // The "/i" suffix allows caller to use a locale-specific formatting string. // Clean the format string by removing all but numerals and the decimal separator. // Then split the format string into pre and post decimal segments according to *what* the // decimal separator is. If they are specifying "/i", they are using the local convention in the format string. if (formatString.substr(formatString.length - 2) == '/i') { if (!I18NFormatCleanRe) { I18NFormatCleanRe = new RegExp('[^\\d\\' + UtilFormat.decimalSeparator + ']','g'); } formatString = formatString.substr(0, formatString.length - 2); hasComma = formatString.indexOf(comma) != -1; splitFormat = formatString.replace(I18NFormatCleanRe, '').split(decimalSeparator); } else { hasComma = formatString.indexOf(',') != -1; splitFormat = formatString.replace(formatCleanRe, '').split('.'); } extraChars = formatString.replace(formatPattern, ''); if (splitFormat.length > 2) { Ext.Error.raise({ sourceClass: "Ext.util.Format", sourceMethod: "number", value: v, formatString: formatString, msg: "Invalid number format, should have no more than 1 decimal" }); } else if (splitFormat.length === 2) { precision = splitFormat[1].length; // Formatting ending in .##### means maximum 5 trailing significant digits trimTrailingZeroes = allHashes.test(splitFormat[1]); } // The function we create is called immediately and returns a closure which has access to vars and some fixed values; RegExes and the format string. code = [ 'var utilFormat=Ext.util.Format,extNumber=Ext.Number,neg,fnum,parts' + (hasComma ? ',thousandSeparator,thousands=[],j,n,i' : '') + (extraChars ? ',formatString="' + formatString + '",formatPattern=/[\\d,\\.#]+/' : '') + (trimTrailingZeroes ? ',trailingZeroes=/\\.?0+$/;' : ';') + 'return function(v){' + 'if(typeof v!=="number"&&isNaN(v=extNumber.from(v,NaN)))return"";' + 'neg=v<0;', 'fnum=Ext.Number.toFixed(Math.abs(v), ' + precision + ');' ]; if (hasComma) { // If we have to insert commas... // split the string up into whole and decimal parts if there are decimals if (precision) { code[code.length] = 'parts=fnum.split(".");'; code[code.length] = 'fnum=parts[0];'; } code[code.length] = 'if(v>=1000) {'; code[code.length] = 'thousandSeparator=utilFormat.thousandSeparator;' + 'thousands.length=0;' + 'j=fnum.length;' + 'n=fnum.length%3||3;' + 'for(i=0;i` * * @param {String} v The string value to format. * @return {String} The string with embedded `
` tags in place of newlines. */ nl2br : function(v) { return Ext.isEmpty(v) ? '' : v.replace(nl2brRe, '
'); }, /** * Alias for {@link Ext.String#capitalize}. * @method * @inheritdoc Ext.String#capitalize */ capitalize: Ext.String.capitalize, /** * Alias for {@link Ext.String#ellipsis}. * @method * @inheritdoc Ext.String#ellipsis */ ellipsis: Ext.String.ellipsis, /** * Alias for {@link Ext.String#format}. * @method * @inheritdoc Ext.String#format */ format: Ext.String.format, /** * Alias for {@link Ext.String#htmlDecode}. * @method * @inheritdoc Ext.String#htmlDecode */ htmlDecode: Ext.String.htmlDecode, /** * Alias for {@link Ext.String#htmlEncode}. * @method * @inheritdoc Ext.String#htmlEncode */ htmlEncode: Ext.String.htmlEncode, /** * Alias for {@link Ext.String#leftPad}. * @method * @inheritdoc Ext.String#leftPad */ leftPad: Ext.String.leftPad, /** * Alias for {@link Ext.String#trim}. * @method * @inheritdoc Ext.String#trim */ trim : Ext.String.trim, /** * Parses a number or string representing margin sizes into an object. * Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and * "10 10 10 10" are all valid options and would return the same result). * * @param {Number/String} v The encoded margins * @return {Object} An object with margin sizes for top, right, bottom and left */ parseBox : function(box) { box = box || 0; if (typeof box === 'number') { return { top : box, right : box, bottom: box, left : box }; } var parts = box.split(' '), ln = parts.length; if (ln == 1) { parts[1] = parts[2] = parts[3] = parts[0]; } else if (ln == 2) { parts[2] = parts[0]; parts[3] = parts[1]; } else if (ln == 3) { parts[3] = parts[1]; } return { top :parseInt(parts[0], 10) || 0, right :parseInt(parts[1], 10) || 0, bottom:parseInt(parts[2], 10) || 0, left :parseInt(parts[3], 10) || 0 }; }, /** * Escapes the passed string for use in a regular expression. * @param {String} str * @return {String} */ escapeRegex : function(s) { return s.replace(/([\-.*+?\^${}()|\[\]\/\\])/g, "\\$1"); } }); }()); // @tag extras,core // @require Format.js /** * Provides the ability to execute one or more arbitrary tasks in a asynchronous manner. * Generally, you can use the singleton {@link Ext.TaskManager} instead, but if needed, * you can create separate instances of TaskRunner. Any number of separate tasks can be * started at any time and will run independently of each other. * * Example usage: * * // Start a simple clock task that updates a div once per second * var updateClock = function () { * Ext.fly('clock').update(new Date().format('g:i:s A')); * } * * var runner = new Ext.util.TaskRunner(); * var task = runner.start({ * run: updateClock, * interval: 1000 * } * * The equivalent using TaskManager: * * var task = Ext.TaskManager.start({ * run: updateClock, * interval: 1000 * }); * * To end a running task: * * task.destroy(); * * If a task needs to be started and stopped repeated over time, you can create a * {@link Ext.util.TaskRunner.Task Task} instance. * * var task = runner.newTask({ * run: function () { * // useful code * }, * interval: 1000 * }); * * task.start(); * * // ... * * task.stop(); * * // ... * * task.start(); * * A re-usable, one-shot task can be managed similar to the above: * * var task = runner.newTask({ * run: function () { * // useful code to run once * }, * repeat: 1 * }); * * task.start(); * * // ... * * task.start(); * * See the {@link #start} method for details about how to configure a task object. * * Also see {@link Ext.util.DelayedTask}. * * @constructor * @param {Number/Object} [interval=10] The minimum precision in milliseconds supported by this * TaskRunner instance. Alternatively, a config object to apply to the new instance. */ Ext.define('Ext.util.TaskRunner', { /** * @cfg {Boolean} [fireIdleEvent=true] * This may be configured `false` to inhibit firing of the {@link Ext.EventManager#idleEvent idle event} after task invocation. */ /** * @cfg interval * The timer resolution. */ interval: 10, /** * @property timerId * The id of the current timer. * @private */ timerId: null, constructor: function (interval) { var me = this; if (typeof interval == 'number') { me.interval = interval; } else if (interval) { Ext.apply(me, interval); } me.tasks = []; me.timerFn = Ext.Function.bind(me.onTick, me); }, /** * Creates a new {@link Ext.util.TaskRunner.Task Task} instance. These instances can * be easily started and stopped. * @param {Object} config The config object. For details on the supported properties, * see {@link #start}. */ newTask: function (config) { var task = new Ext.util.TaskRunner.Task(config); task.manager = this; return task; }, /** * Starts a new task. * * Before each invocation, Ext injects the property `taskRunCount` into the task object * so that calculations based on the repeat count can be performed. * * The returned task will contain a `destroy` method that can be used to destroy the * task and cancel further calls. This is equivalent to the {@link #stop} method. * * @param {Object} task A config object that supports the following properties: * @param {Function} task.run The function to execute each time the task is invoked. The * function will be called at each interval and passed the `args` argument if specified, * and the current invocation count if not. * * If a particular scope (`this` reference) is required, be sure to specify it using * the `scope` argument. * * @param {Function} task.onError The function to execute in case of unhandled * error on task.run. * * @param {Boolean} task.run.return `false` from this function to terminate the task. * * @param {Number} task.interval The frequency in milliseconds with which the task * should be invoked. * * @param {Object[]} task.args An array of arguments to be passed to the function * specified by `run`. If not specified, the current invocation count is passed. * * @param {Object} task.scope The scope (`this` reference) in which to execute the * `run` function. Defaults to the task config object. * * @param {Number} task.duration The length of time in milliseconds to invoke the task * before stopping automatically (defaults to indefinite). * * @param {Number} task.repeat The number of times to invoke the task before stopping * automatically (defaults to indefinite). * @return {Object} The task */ start: function(task) { var me = this, now = Ext.Date.now(); if (!task.pending) { me.tasks.push(task); task.pending = true; // don't allow the task to be added to me.tasks again } task.stopped = false; // might have been previously stopped... task.taskStartTime = now; task.taskRunTime = task.fireOnStart !== false ? 0 : task.taskStartTime; task.taskRunCount = 0; if (!me.firing) { if (task.fireOnStart !== false) { me.startTimer(0, now); } else { me.startTimer(task.interval, now); } } return task; }, /** * Stops an existing running task. * @param {Object} task The task to stop * @return {Object} The task */ stop: function(task) { // NOTE: we don't attempt to remove the task from me.tasks at this point because // this could be called from inside a task which would then corrupt the state of // the loop in onTick if (!task.stopped) { task.stopped = true; if (task.onStop) { task.onStop.call(task.scope || task, task); } } return task; }, /** * Stops all tasks that are currently running. */ stopAll: function() { // onTick will take care of cleaning up the mess after this point... Ext.each(this.tasks, this.stop, this); }, //------------------------------------------------------------------------- firing: false, nextExpires: 1e99, // private onTick: function () { var me = this, tasks = me.tasks, now = Ext.Date.now(), nextExpires = 1e99, len = tasks.length, expires, newTasks, i, task, rt, remove; me.timerId = null; me.firing = true; // ensure we don't startTimer during this loop... // tasks.length can be > len if start is called during a task.run call... so we // first check len to avoid tasks.length reference but eventually we need to also // check tasks.length. we avoid repeating use of tasks.length by setting len at // that time (to help the next loop) for (i = 0; i < len || i < (len = tasks.length); ++i) { task = tasks[i]; if (!(remove = task.stopped)) { expires = task.taskRunTime + task.interval; if (expires <= now) { rt = 1; // otherwise we have a stale "rt" try { rt = task.run.apply(task.scope || task, task.args || [++task.taskRunCount]); } catch (taskError) { try { Ext.log({ msg: taskError, level: 'error' }); if (task.onError) { rt = task.onError.call(task.scope || task, task, taskError); } } catch (ignore) { } } task.taskRunTime = now; if (rt === false || task.taskRunCount === task.repeat) { me.stop(task); remove = true; } else { remove = task.stopped; // in case stop was called by run expires = now + task.interval; } } if (!remove && task.duration && task.duration <= (now - task.taskStartTime)) { me.stop(task); remove = true; } } if (remove) { task.pending = false; // allow the task to be added to me.tasks again // once we detect that a task needs to be removed, we copy the tasks that // will carry forward into newTasks... this way we avoid O(N*N) to remove // each task from the tasks array (and ripple the array down) and also the // potentially wasted effort of making a new tasks[] even if all tasks are // going into the next wave. if (!newTasks) { newTasks = tasks.slice(0, i); // we don't set me.tasks here because callbacks can also start tasks, // which get added to me.tasks... so we will visit them in this loop // and account for their expirations in nextExpires... } } else { if (newTasks) { newTasks.push(task); // we've cloned the tasks[], so keep this one... } if (nextExpires > expires) { nextExpires = expires; // track the nearest expiration time } } } if (newTasks) { // only now can we copy the newTasks to me.tasks since no user callbacks can // take place me.tasks = newTasks; } me.firing = false; // we're done, so allow startTimer afterwards if (me.tasks.length) { // we create a new Date here because all the callbacks could have taken a long // time... we want to base the next timeout on the current time (after the // callback storm): me.startTimer(nextExpires - now, Ext.Date.now()); } // After a tick if (me.fireIdleEvent !== false) { Ext.EventManager.idleEvent.fire(); } }, // private startTimer: function (timeout, now) { var me = this, expires = now + timeout, timerId = me.timerId; // Check to see if this request is enough in advance of the current timer. If so, // we reschedule the timer based on this new expiration. if (timerId && me.nextExpires - expires > me.interval) { clearTimeout(timerId); timerId = null; } if (!timerId) { if (timeout < me.interval) { timeout = me.interval; } me.timerId = setTimeout(me.timerFn, timeout); me.nextExpires = expires; } } }, function () { var me = this, proto = me.prototype; /** * Destroys this instance, stopping all tasks that are currently running. * @method destroy */ proto.destroy = proto.stopAll; // Documented in TaskManager.js Ext.util.TaskManager = Ext.TaskManager = new me(); /** * Instances of this class are created by {@link Ext.util.TaskRunner#newTask} method. * * For details on config properties, see {@link Ext.util.TaskRunner#start}. * @class Ext.util.TaskRunner.Task */ me.Task = new Ext.Class({ isTask: true, /** * This flag is set to `true` by {@link #stop}. * @private */ stopped: true, // this avoids the odd combination of !stopped && !pending /** * Override default behavior */ fireOnStart: false, constructor: function (config) { Ext.apply(this, config); }, /** * Restarts this task, clearing it duration, expiration and run count. * @param {Number} [interval] Optionally reset this task's interval. */ restart: function (interval) { if (interval !== undefined) { this.interval = interval; } this.manager.start(this); }, /** * Starts this task if it is not already started. * @param {Number} [interval] Optionally reset this task's interval. */ start: function (interval) { if (this.stopped) { this.restart(interval); } }, /** * Stops this task. */ stop: function () { this.manager.stop(this); } }); proto = me.Task.prototype; /** * Destroys this instance, stopping this task's execution. * @method destroy */ proto.destroy = proto.stop; }); // @tag extras,core /** * A static {@link Ext.util.TaskRunner} instance that can be used to start and stop * arbitrary tasks. See {@link Ext.util.TaskRunner} for supported methods and task * config properties. * * // Start a simple clock task that updates a div once per second * var task = { * run: function(){ * Ext.fly('clock').update(new Date().format('g:i:s A')); * }, * interval: 1000 //1 second * } * * Ext.TaskManager.start(task); * * See the {@link #start} method for details about how to configure a task object. */ Ext.define('Ext.util.TaskManager', { extend: Ext.util.TaskRunner , alternateClassName: [ 'Ext.TaskManager' ], singleton: true }); // @tag extras,core // @require ../util/TaskManager.js /** * @class Ext.perf.Accumulator * @private */ Ext.define('Ext.perf.Accumulator', (function () { var currentFrame = null, khrome = Ext.global['chrome'], formatTpl, // lazy init on first request for timestamp (avoids infobar in IE until needed) // Also avoids kicking off Chrome's microsecond timer until first needed getTimestamp = function () { getTimestamp = function () { return new Date().getTime(); }; var interval, toolbox; // If Chrome is started with the --enable-benchmarking switch if (Ext.isChrome && khrome && khrome.Interval) { interval = new khrome.Interval(); interval.start(); getTimestamp = function () { return interval.microseconds() / 1000; }; } else if (window.ActiveXObject) { try { // the above technique is not very accurate for small intervals... toolbox = new ActiveXObject('SenchaToolbox.Toolbox'); Ext.senchaToolbox = toolbox; // export for other uses getTimestamp = function () { return toolbox.milliseconds; }; } catch (e) { // ignore } } else if (Date.now) { getTimestamp = Date.now; } Ext.perf.getTimestamp = Ext.perf.Accumulator.getTimestamp = getTimestamp; return getTimestamp(); }; function adjustSet (set, time) { set.sum += time; set.min = Math.min(set.min, time); set.max = Math.max(set.max, time); } function leaveFrame (time) { var totalTime = time ? time : (getTimestamp() - this.time), // do this first me = this, // me = frame accum = me.accum; ++accum.count; if (! --accum.depth) { adjustSet(accum.total, totalTime); } adjustSet(accum.pure, totalTime - me.childTime); currentFrame = me.parent; if (currentFrame) { ++currentFrame.accum.childCount; currentFrame.childTime += totalTime; } } function makeSet () { return { min: Number.MAX_VALUE, max: 0, sum: 0 }; } function makeTap (me, fn) { return function () { var frame = me.enter(), ret = fn.apply(this, arguments); frame.leave(); return ret; }; } function round (x) { return Math.round(x * 100) / 100; } function setToJSON (count, childCount, calibration, set) { var data = { avg: 0, min: set.min, max: set.max, sum: 0 }; if (count) { calibration = calibration || 0; data.sum = set.sum - childCount * calibration; data.avg = data.sum / count; // min and max cannot be easily corrected since we don't know the number of // child calls for them. } return data; } return { constructor: function (name) { var me = this; me.count = me.childCount = me.depth = me.maxDepth = 0; me.pure = makeSet(); me.total = makeSet(); me.name = name; }, statics: { getTimestamp: getTimestamp }, format: function (calibration) { if (!formatTpl) { formatTpl = new Ext.XTemplate([ '{name} - {count} call(s)', '', '', ' ({childCount} children)', '', '', ' ({depth} deep)', '', '', ', {type}: {[this.time(values.sum)]} msec (', //'min={[this.time(values.min)]}, ', 'avg={[this.time(values.sum / parent.count)]}', //', max={[this.time(values.max)]}', ')', '', '' ].join(''), { time: function (t) { return Math.round(t * 100) / 100; } }); } var data = this.getData(calibration); data.name = this.name; data.pure.type = 'Pure'; data.total.type = 'Total'; data.times = [data.pure, data.total]; return formatTpl.apply(data); }, getData: function (calibration) { var me = this; return { count: me.count, childCount: me.childCount, depth: me.maxDepth, pure: setToJSON(me.count, me.childCount, calibration, me.pure), total: setToJSON(me.count, me.childCount, calibration, me.total) }; }, enter: function () { var me = this, frame = { accum: me, leave: leaveFrame, childTime: 0, parent: currentFrame }; ++me.depth; if (me.maxDepth < me.depth) { me.maxDepth = me.depth; } currentFrame = frame; frame.time = getTimestamp(); // do this last return frame; }, monitor: function (fn, scope, args) { var frame = this.enter(); if (args) { fn.apply(scope, args); } else { fn.call(scope); } frame.leave(); }, report: function () { Ext.log(this.format()); }, tap: function (className, methodName) { var me = this, methods = typeof methodName == 'string' ? [methodName] : methodName, klass, statik, i, parts, length, name, src, tapFunc; tapFunc = function(){ if (typeof className == 'string') { klass = Ext.global; parts = className.split('.'); for (i = 0, length = parts.length; i < length; ++i) { klass = klass[parts[i]]; } } else { klass = className; } for (i = 0, length = methods.length; i < length; ++i) { name = methods[i]; statik = name.charAt(0) == '!'; if (statik) { name = name.substring(1); } else { statik = !(name in klass.prototype); } src = statik ? klass : klass.prototype; src[name] = makeTap(me, src[name]); } }; Ext.ClassManager.onCreated(tapFunc, me, className); return me; } }; }()), function () { Ext.perf.getTimestamp = this.getTimestamp; }); // @tag extras,core // @require Accumulator.js /** * @class Ext.perf.Monitor * @singleton * @private */ Ext.define('Ext.perf.Monitor', { singleton: true, alternateClassName: 'Ext.Perf', constructor: function () { this.accumulators = []; this.accumulatorsByName = {}; }, calibrate: function () { var accum = new Ext.perf.Accumulator('$'), total = accum.total, getTimestamp = Ext.perf.Accumulator.getTimestamp, count = 0, frame, endTime, startTime; startTime = getTimestamp(); do { frame = accum.enter(); frame.leave(); ++count; } while (total.sum < 100); endTime = getTimestamp(); return (endTime - startTime) / count; }, get: function (name) { var me = this, accum = me.accumulatorsByName[name]; if (!accum) { me.accumulatorsByName[name] = accum = new Ext.perf.Accumulator(name); me.accumulators.push(accum); } return accum; }, enter: function (name) { return this.get(name).enter(); }, monitor: function (name, fn, scope) { this.get(name).monitor(fn, scope); }, report: function () { var me = this, accumulators = me.accumulators, calibration = me.calibrate(); accumulators.sort(function (a, b) { return (a.name < b.name) ? -1 : ((b.name < a.name) ? 1 : 0); }); me.updateGC(); Ext.log('Calibration: ' + Math.round(calibration * 100) / 100 + ' msec/sample'); Ext.each(accumulators, function (accum) { Ext.log(accum.format(calibration)); }); }, getData: function (all) { var ret = {}, accumulators = this.accumulators; Ext.each(accumulators, function (accum) { if (all || accum.count) { ret[accum.name] = accum.getData(); } }); return ret; }, reset: function(){ Ext.each(this.accumulators, function(accum){ var me = accum; me.count = me.childCount = me.depth = me.maxDepth = 0; me.pure = { min: Number.MAX_VALUE, max: 0, sum: 0 }; me.total = { min: Number.MAX_VALUE, max: 0, sum: 0 }; }); }, updateGC: function () { var accumGC = this.accumulatorsByName.GC, toolbox = Ext.senchaToolbox, bucket; if (accumGC) { accumGC.count = toolbox.garbageCollectionCounter || 0; if (accumGC.count) { bucket = accumGC.pure; accumGC.total.sum = bucket.sum = toolbox.garbageCollectionMilliseconds; bucket.min = bucket.max = bucket.sum / accumGC.count; bucket = accumGC.total; bucket.min = bucket.max = bucket.sum / accumGC.count; } } }, watchGC: function () { Ext.perf.getTimestamp(); // initializes SenchaToolbox (if available) var toolbox = Ext.senchaToolbox; if (toolbox) { this.get("GC"); toolbox.watchGarbageCollector(false); // no logging, just totals } }, setup: function (config) { if (!config) { config = { /*insertHtml: { 'Ext.dom.Helper': 'insertHtml' },*/ /*xtplCompile: { 'Ext.XTemplateCompiler': 'compile' },*/ // doInsert: { // 'Ext.Template': 'doInsert' // }, // applyOut: { // 'Ext.XTemplate': 'applyOut' // }, render: { 'Ext.AbstractComponent': 'render' }, // fnishRender: { // 'Ext.AbstractComponent': 'finishRender' // }, // renderSelectors: { // 'Ext.AbstractComponent': 'applyRenderSelectors' // }, // compAddCls: { // 'Ext.AbstractComponent': 'addCls' // }, // compRemoveCls: { // 'Ext.AbstractComponent': 'removeCls' // }, // getStyle: { // 'Ext.core.Element': 'getStyle' // }, // setStyle: { // 'Ext.core.Element': 'setStyle' // }, // addCls: { // 'Ext.core.Element': 'addCls' // }, // removeCls: { // 'Ext.core.Element': 'removeCls' // }, // measure: { // 'Ext.layout.component.Component': 'measureAutoDimensions' // }, // moveItem: { // 'Ext.layout.Layout': 'moveItem' // }, // layoutFlush: { // 'Ext.layout.Context': 'flush' // }, layout: { 'Ext.layout.Context': 'run' } }; } this.currentConfig = config; var key, prop, accum, className, methods; for (key in config) { if (config.hasOwnProperty(key)) { prop = config[key]; accum = Ext.Perf.get(key); for (className in prop) { if (prop.hasOwnProperty(className)) { methods = prop[className]; accum.tap(className, methods); } } } } this.watchGC(); } }); // @tag extras,core // @require perf/Monitor.js // @define Ext.Supports /** * @class Ext.is * * Determines information about the current platform the application is running on. * * @singleton */ Ext.is = { init : function(navigator) { var platforms = this.platforms, ln = platforms.length, i, platform; navigator = navigator || window.navigator; for (i = 0; i < ln; i++) { platform = platforms[i]; this[platform.identity] = platform.regex.test(navigator[platform.property]); } /** * @property Desktop True if the browser is running on a desktop machine * @type {Boolean} */ this.Desktop = this.Mac || this.Windows || (this.Linux && !this.Android); /** * @property Tablet True if the browser is running on a tablet (iPad) */ this.Tablet = this.iPad; /** * @property Phone True if the browser is running on a phone. * @type {Boolean} */ this.Phone = !this.Desktop && !this.Tablet; /** * @property iOS True if the browser is running on iOS * @type {Boolean} */ this.iOS = this.iPhone || this.iPad || this.iPod; /** * @property Standalone Detects when application has been saved to homescreen. * @type {Boolean} */ this.Standalone = !!window.navigator.standalone; }, /** * @property iPhone True when the browser is running on a iPhone * @type {Boolean} */ platforms: [{ property: 'platform', regex: /iPhone/i, identity: 'iPhone' }, /** * @property iPod True when the browser is running on a iPod * @type {Boolean} */ { property: 'platform', regex: /iPod/i, identity: 'iPod' }, /** * @property iPad True when the browser is running on a iPad * @type {Boolean} */ { property: 'userAgent', regex: /iPad/i, identity: 'iPad' }, /** * @property Blackberry True when the browser is running on a Blackberry * @type {Boolean} */ { property: 'userAgent', regex: /Blackberry/i, identity: 'Blackberry' }, /** * @property Android True when the browser is running on an Android device * @type {Boolean} */ { property: 'userAgent', regex: /Android/i, identity: 'Android' }, /** * @property Mac True when the browser is running on a Mac * @type {Boolean} */ { property: 'platform', regex: /Mac/i, identity: 'Mac' }, /** * @property Windows True when the browser is running on Windows * @type {Boolean} */ { property: 'platform', regex: /Win/i, identity: 'Windows' }, /** * @property Linux True when the browser is running on Linux * @type {Boolean} */ { property: 'platform', regex: /Linux/i, identity: 'Linux' }] }; Ext.is.init(); /** * @class Ext.supports * * Determines information about features are supported in the current environment * * @singleton */ (function(){ // this is a local copy of certain logic from (Abstract)Element.getStyle // to break a dependancy between the supports mechanism and Element // use this instead of element references to check for styling info var getStyle = function(element, styleName){ var view = element.ownerDocument.defaultView, style = (view ? view.getComputedStyle(element, null) : element.currentStyle) || element.style; return style[styleName]; }, supportsVectors = { 'IE6-quirks': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,0,0,0,0,1,0,0,1,0,0,1,0,1,0,0,0], 'IE6-strict': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,0,0,0,0,1,0,1,1,0,0,1,0,1,0,0,0], 'IE7-quirks': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,0,0,0,0,1,0,0,1,0,0,1,0,1,0,0,0], 'IE7-strict': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,0,0,0,0,1,1,0,1,0,0,1,0,1,0,0,0], 'IE8-quirks': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,0,0,0,0,1,0,0,1,0,0,1,0,1,0,0,0], 'IE8-strict': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,0,0,0,0,1,1,1,1,0,0,1,0,1,0,0,1], 'IE9-quirks': [0,1,0,0,1,0,0,0,1,0,0,0,0,0,0,0,1,1,1,0,0,0,1,0,0,1,0,0,1,0,1,0,0,0], 'IE9-strict': [0,1,0,0,1,1,1,1,1,1,1,0,0,0,1,1,1,1,1,0,1,1,1,1,1,1,1,0,1,0,0,0,0,1], 'IE10-quirks': [1,1,0,0,1,1,1,1,0,1,1,1,0,0,1,1,1,1,1,1,1,1,0,1,1,1,1,1,1,0,0,0,0,1], 'IE10-strict': [1,1,0,0,1,1,1,1,0,1,1,1,0,0,1,1,1,1,1,1,1,1,0,1,1,1,1,1,1,0,0,0,0,1] }; function getBrowserKey() { var browser = Ext.isIE6 ? 'IE6' : Ext.isIE7 ? 'IE7' : Ext.isIE8 ? 'IE8' : Ext.isIE9 ? 'IE9': Ext.isIE10 ? 'IE10' : ''; return browser ? browser + (Ext.isStrict ? '-strict' : '-quirks') : ''; } Ext.supports = { /** * Runs feature detection routines and sets the various flags. This is called when * the scripts loads (very early) and again at {@link Ext#onReady}. Some detections * are flagged as `early` and run immediately. Others that require the document body * will not run until ready. * * Each test is run only once, so calling this method from an onReady function is safe * and ensures that all flags have been set. * @markdown * @private */ init : function() { var me = this, doc = document, toRun = me.toRun || me.tests, n = toRun.length, div = n && Ext.isReady && doc.createElement('div'), notRun = [], browserKey = getBrowserKey(), test, vector, value; if (div) { div.innerHTML = [ '
', '
', '
', '
', '
', '
', '
', '
' ].join(''); doc.body.appendChild(div); } vector = supportsVectors[browserKey]; while (n--) { test = toRun[n]; value = vector && vector[n]; if (value !== undefined) { me[test.identity] = value; } else if (div || test.early) { me[test.identity] = test.fn.call(me, doc, div); } else { notRun.push(test); } } if (div) { doc.body.removeChild(div); } me.toRun = notRun; }, /** * Generates a support vector for the current browser/mode. The result can be * added to supportsVectors to eliminate feature detection at startup time. * @private */ generateVector: function() { var tests = this.tests, vector = [], i = 0, ln = tests.length, test; for (; i < ln; i++) { test = tests[i]; vector.push(this[test.identity] ? 1 : 0); } return vector; }, /** * @property PointerEvents True if document environment supports the CSS3 pointer-events style. * @type {Boolean} */ PointerEvents: 'pointerEvents' in document.documentElement.style, // IE10/Win8 throws "Access Denied" accessing window.localStorage, so this test // needs to have a try/catch /** * @property LocalStorage True if localStorage is supported */ LocalStorage: (function() { try { return 'localStorage' in window && window['localStorage'] !== null; } catch (e) { return false; } })(), /** * @property CSS3BoxShadow True if document environment supports the CSS3 box-shadow style. * @type {Boolean} */ CSS3BoxShadow: 'boxShadow' in document.documentElement.style || 'WebkitBoxShadow' in document.documentElement.style || 'MozBoxShadow' in document.documentElement.style, /** * @property ClassList True if document environment supports the HTML5 classList API. * @type {Boolean} */ ClassList: !!document.documentElement.classList, /** * @property OrientationChange True if the device supports orientation change * @type {Boolean} */ OrientationChange: ((typeof window.orientation != 'undefined') && ('onorientationchange' in window)), /** * @property DeviceMotion True if the device supports device motion (acceleration and rotation rate) * @type {Boolean} */ DeviceMotion: ('ondevicemotion' in window), /** * @property Touch True if the device supports touch * @type {Boolean} */ // is.Desktop is needed due to the bug in Chrome 5.0.375, Safari 3.1.2 // and Safari 4.0 (they all have 'ontouchstart' in the window object). Touch: ('ontouchstart' in window) && (!Ext.is.Desktop), /** * @property TimeoutActualLateness True if the browser passes the "actualLateness" parameter to * setTimeout. See: https://developer.mozilla.org/en/DOM/window.setTimeout * @type {Boolean} */ TimeoutActualLateness: (function(){ setTimeout(function(){ Ext.supports.TimeoutActualLateness = arguments.length !== 0; }, 0); }()), tests: [ /** * @property Transitions True if the device supports CSS3 Transitions * @type {Boolean} */ { identity: 'Transitions', fn: function(doc, div) { var prefix = [ 'webkit', 'Moz', 'o', 'ms', 'khtml' ], TE = 'TransitionEnd', transitionEndName = [ prefix[0] + TE, 'transitionend', //Moz bucks the prefixing convention prefix[2] + TE, prefix[3] + TE, prefix[4] + TE ], ln = prefix.length, i = 0, out = false; for (; i < ln; i++) { if (getStyle(div, prefix[i] + "TransitionProperty")) { Ext.supports.CSS3Prefix = prefix[i]; Ext.supports.CSS3TransitionEnd = transitionEndName[i]; out = true; break; } } return out; } }, /** * @property RightMargin True if the device supports right margin. * See https://bugs.webkit.org/show_bug.cgi?id=13343 for why this is needed. * @type {Boolean} */ { identity: 'RightMargin', fn: function(doc, div) { var view = doc.defaultView; return !(view && view.getComputedStyle(div.firstChild.firstChild, null).marginRight != '0px'); } }, /** * @property DisplayChangeInputSelectionBug True if INPUT elements lose their * selection when their display style is changed. Essentially, if a text input * has focus and its display style is changed, the I-beam disappears. * * This bug is encountered due to the work around in place for the {@link #RightMargin} * bug. This has been observed in Safari 4.0.4 and older, and appears to be fixed * in Safari 5. It's not clear if Safari 4.1 has the bug, but it has the same WebKit * version number as Safari 5 (according to http://unixpapa.com/js/gecko.html). */ { identity: 'DisplayChangeInputSelectionBug', early: true, fn: function() { var webKitVersion = Ext.webKitVersion; // WebKit but older than Safari 5 or Chrome 6: return 0 < webKitVersion && webKitVersion < 533; } }, /** * @property DisplayChangeTextAreaSelectionBug True if TEXTAREA elements lose their * selection when their display style is changed. Essentially, if a text area has * focus and its display style is changed, the I-beam disappears. * * This bug is encountered due to the work around in place for the {@link #RightMargin} * bug. This has been observed in Chrome 10 and Safari 5 and older, and appears to * be fixed in Chrome 11. */ { identity: 'DisplayChangeTextAreaSelectionBug', early: true, fn: function() { var webKitVersion = Ext.webKitVersion; /* Has bug w/textarea: (Chrome) Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7; en-US) AppleWebKit/534.16 (KHTML, like Gecko) Chrome/10.0.648.127 Safari/534.16 (Safari) Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7; en-us) AppleWebKit/533.21.1 (KHTML, like Gecko) Version/5.0.5 Safari/533.21.1 No bug: (Chrome) Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_7) AppleWebKit/534.24 (KHTML, like Gecko) Chrome/11.0.696.57 Safari/534.24 */ return 0 < webKitVersion && webKitVersion < 534.24; } }, /** * @property TransparentColor True if the device supports transparent color * @type {Boolean} */ { identity: 'TransparentColor', fn: function(doc, div, view) { view = doc.defaultView; return !(view && view.getComputedStyle(div.lastChild, null).backgroundColor != 'transparent'); } }, /** * @property ComputedStyle True if the browser supports document.defaultView.getComputedStyle() * @type {Boolean} */ { identity: 'ComputedStyle', fn: function(doc, div, view) { view = doc.defaultView; return view && view.getComputedStyle; } }, /** * @property Svg True if the device supports SVG * @type {Boolean} */ { identity: 'Svg', fn: function(doc) { return !!doc.createElementNS && !!doc.createElementNS( "http:/" + "/www.w3.org/2000/svg", "svg").createSVGRect; } }, /** * @property Canvas True if the device supports Canvas * @type {Boolean} */ { identity: 'Canvas', fn: function(doc) { return !!doc.createElement('canvas').getContext; } }, /** * @property Vml True if the device supports VML * @type {Boolean} */ { identity: 'Vml', fn: function(doc) { var d = doc.createElement("div"); d.innerHTML = ""; return (d.childNodes.length == 2); } }, /** * @property Float True if the device supports CSS float * @type {Boolean} */ { identity: 'Float', fn: function(doc, div) { return !!div.lastChild.style.cssFloat; } }, /** * @property AudioTag True if the device supports the HTML5 audio tag * @type {Boolean} */ { identity: 'AudioTag', fn: function(doc) { return !!doc.createElement('audio').canPlayType; } }, /** * @property History True if the device supports HTML5 history * @type {Boolean} */ { identity: 'History', fn: function() { var history = window.history; return !!(history && history.pushState); } }, /** * @property CSS3DTransform True if the device supports CSS3DTransform * @type {Boolean} */ { identity: 'CSS3DTransform', fn: function() { return (typeof WebKitCSSMatrix != 'undefined' && new WebKitCSSMatrix().hasOwnProperty('m41')); } }, /** * @property CSS3LinearGradient True if the device supports CSS3 linear gradients * @type {Boolean} */ { identity: 'CSS3LinearGradient', fn: function(doc, div) { var property = 'background-image:', webkit = '-webkit-gradient(linear, left top, right bottom, from(black), to(white))', w3c = 'linear-gradient(left top, black, white)', moz = '-moz-' + w3c, ms = '-ms-' + w3c, opera = '-o-' + w3c, options = [property + webkit, property + w3c, property + moz, property + ms, property + opera]; div.style.cssText = options.join(';'); return (("" + div.style.backgroundImage).indexOf('gradient') !== -1) && !Ext.isIE9; } }, /** * @property CSS3BorderRadius True if the device supports CSS3 border radius * @type {Boolean} */ { identity: 'CSS3BorderRadius', fn: function(doc, div) { var domPrefixes = ['borderRadius', 'BorderRadius', 'MozBorderRadius', 'WebkitBorderRadius', 'OBorderRadius', 'KhtmlBorderRadius'], pass = false, i; for (i = 0; i < domPrefixes.length; i++) { if (document.body.style[domPrefixes[i]] !== undefined) { return true; } } return pass; } }, /** * @property GeoLocation True if the device supports GeoLocation * @type {Boolean} */ { identity: 'GeoLocation', fn: function() { // Use the in check for geolocation, see https://github.com/Modernizr/Modernizr/issues/513 return (typeof navigator != 'undefined' && 'geolocation' in navigator) || (typeof google != 'undefined' && typeof google.gears != 'undefined'); } }, /** * @property MouseEnterLeave True if the browser supports mouseenter and mouseleave events * @type {Boolean} */ { identity: 'MouseEnterLeave', fn: function(doc, div){ return ('onmouseenter' in div && 'onmouseleave' in div); } }, /** * @property MouseWheel True if the browser supports the mousewheel event * @type {Boolean} */ { identity: 'MouseWheel', fn: function(doc, div) { return ('onmousewheel' in div); } }, /** * @property Opacity True if the browser supports normal css opacity * @type {Boolean} */ { identity: 'Opacity', fn: function(doc, div){ // Not a strict equal comparison in case opacity can be converted to a number. if (Ext.isIE6 || Ext.isIE7 || Ext.isIE8) { return false; } div.firstChild.style.cssText = 'opacity:0.73'; return div.firstChild.style.opacity == '0.73'; } }, /** * @property Placeholder True if the browser supports the HTML5 placeholder attribute on inputs * @type {Boolean} */ { identity: 'Placeholder', fn: function(doc) { return 'placeholder' in doc.createElement('input'); } }, /** * @property Direct2DBug True if when asking for an element's dimension via offsetWidth or offsetHeight, * getBoundingClientRect, etc. the browser returns the subpixel width rounded to the nearest pixel. * @type {Boolean} */ { identity: 'Direct2DBug', fn: function() { return Ext.isString(document.body.style.msTransformOrigin) && Ext.isIE10m; } }, /** * @property BoundingClientRect True if the browser supports the getBoundingClientRect method on elements * @type {Boolean} */ { identity: 'BoundingClientRect', fn: function(doc, div) { return Ext.isFunction(div.getBoundingClientRect); } }, /** * @property RotatedBoundingClientRect True if the BoundingClientRect is * rotated when the element is rotated using a CSS transform. * @type {Boolean} */ { identity: 'RotatedBoundingClientRect', fn: function() { var body = document.body, supports = false, el = document.createElement('div'), style = el.style; if (el.getBoundingClientRect) { style.WebkitTransform = style.MozTransform = style.OTransform = style.transform = 'rotate(90deg)'; style.width = '100px'; style.height = '30px'; body.appendChild(el) supports = el.getBoundingClientRect().height !== 100; body.removeChild(el); } return supports; } }, { identity: 'IncludePaddingInWidthCalculation', fn: function(doc, div){ return div.childNodes[1].firstChild.offsetWidth == 210; } }, { identity: 'IncludePaddingInHeightCalculation', fn: function(doc, div){ return div.childNodes[1].firstChild.offsetHeight == 210; } }, /** * @property ArraySort True if the Array sort native method isn't bugged. * @type {Boolean} */ { identity: 'ArraySort', fn: function() { var a = [1,2,3,4,5].sort(function(){ return 0; }); return a[0] === 1 && a[1] === 2 && a[2] === 3 && a[3] === 4 && a[4] === 5; } }, /** * @property Range True if browser support document.createRange native method. * @type {Boolean} */ { identity: 'Range', fn: function() { return !!document.createRange; } }, /** * @property CreateContextualFragment True if browser support CreateContextualFragment range native methods. * @type {Boolean} */ { identity: 'CreateContextualFragment', fn: function() { var range = Ext.supports.Range ? document.createRange() : false; return range && !!range.createContextualFragment; } }, /** * @property WindowOnError True if browser supports window.onerror. * @type {Boolean} */ { identity: 'WindowOnError', fn: function () { // sadly, we cannot feature detect this... return Ext.isIE || Ext.isGecko || Ext.webKitVersion >= 534.16; // Chrome 10+ } }, /** * @property TextAreaMaxLength True if the browser supports maxlength on textareas. * @type {Boolean} */ { identity: 'TextAreaMaxLength', fn: function(){ var el = document.createElement('textarea'); return ('maxlength' in el); } }, /** * @property GetPositionPercentage True if the browser will return the left/top/right/bottom * position as a percentage when explicitly set as a percentage value. * @type {Boolean} */ // Related bug: https://bugzilla.mozilla.org/show_bug.cgi?id=707691#c7 { identity: 'GetPositionPercentage', fn: function(doc, div){ return getStyle(div.childNodes[2], 'left') == '10%'; } }, /** * @property {Boolean} PercentageHeightOverflowBug * In some browsers (IE quirks, IE6, IE7, IE9, chrome, safari and opera at the time * of this writing) a percentage-height element ignores the horizontal scrollbar * of its parent element. This method returns true if the browser is affected * by this bug. * * @private */ { identity: 'PercentageHeightOverflowBug', fn: function(doc) { var hasBug = false, style, el; if (Ext.getScrollbarSize().height) { // must have space-consuming scrollbars for bug to be possible el = doc.createElement('div'); style = el.style; style.height = '50px'; style.width = '50px'; style.overflow = 'auto'; style.position = 'absolute'; el.innerHTML = [ '
', // The element that causes the horizontal overflow must be // a child of the element with the 100% height, otherwise // horizontal overflow is not triggered in webkit quirks mode '
', '
' ].join(''); doc.body.appendChild(el); if (el.firstChild.offsetHeight === 50) { hasBug = true; } doc.body.removeChild(el); } return hasBug; } }, /** * @property {Boolean} xOriginBug * In Chrome 24.0, an RTL element which has vertical overflow positions its right X origin incorrectly. * It skips a non-existent scrollbar which has been moved to the left edge due to the RTL setting. * * http://code.google.com/p/chromium/issues/detail?id=174656 * * This method returns true if the browser is affected by this bug. * * @private */ { identity: 'xOriginBug', fn: function(doc, div) { div.innerHTML = '
' + '
' + '
' + '
'; var outerBox = document.getElementById('b1').getBoundingClientRect(), b2 = document.getElementById('b2').getBoundingClientRect(), b3 = document.getElementById('b3').getBoundingClientRect(); return (b2.left !== outerBox.left && b3.right !== outerBox.right); } }, /** * @property {Boolean} ScrollWidthInlinePaddingBug * In some browsers the right padding of an overflowing element is not accounted * for in its scrollWidth. The result can vary depending on whether or not * The element contains block-level children. This method tests the effect * of padding on scrollWidth when there are no block-level children inside the * overflowing element. * * This method returns true if the browser is affected by this bug. */ { identity: 'ScrollWidthInlinePaddingBug', fn: function(doc) { var hasBug = false, style, el; el = doc.createElement('div'); style = el.style; style.height = '50px'; style.width = '50px'; style.padding = '10px'; style.overflow = 'hidden'; style.position = 'absolute'; el.innerHTML = ''; doc.body.appendChild(el); if (el.scrollWidth === 70) { hasBug = true; } doc.body.removeChild(el); return hasBug; } } ] }; }()); Ext.supports.init(); // run the "early" detections now // @tag dom,core // @require ../Support.js // @define Ext.util.DelayedTask /** * @class Ext.util.DelayedTask * * The DelayedTask class provides a convenient way to "buffer" the execution of a method, * performing setTimeout where a new timeout cancels the old timeout. When called, the * task will wait the specified time period before executing. If durng that time period, * the task is called again, the original call will be cancelled. This continues so that * the function is only called a single time for each iteration. * * This method is especially useful for things like detecting whether a user has finished * typing in a text field. An example would be performing validation on a keypress. You can * use this class to buffer the keypress events for a certain number of milliseconds, and * perform only if they stop for that amount of time. * * ## Usage * * var task = new Ext.util.DelayedTask(function(){ * alert(Ext.getDom('myInputField').value.length); * }); * * // Wait 500ms before calling our function. If the user presses another key * // during that 500ms, it will be cancelled and we'll wait another 500ms. * Ext.get('myInputField').on('keypress', function() { * task.{@link #delay}(500); * }); * * Note that we are using a DelayedTask here to illustrate a point. The configuration * option `buffer` for {@link Ext.util.Observable#addListener addListener/on} will * also setup a delayed task for you to buffer events. * * @constructor The parameters to this constructor serve as defaults and are not required. * @param {Function} fn (optional) The default function to call. If not specified here, it must be specified during the {@link #delay} call. * @param {Object} scope (optional) The default scope (The **`this`** reference) in which the * function is called. If not specified, `this` will refer to the browser window. * @param {Array} args (optional) The default Array of arguments. * @param {Boolean} [cancelOnDelay=true] By default, each call to {@link #delay} cancels any pending invocation and reschedules a new * invocation. Specifying this as `false` means that calls to {@link #delay} when an invocation is pending just update the call settings, * `newDelay`, `newFn`, `newScope` or `newArgs`, whichever are passed. */ Ext.util.DelayedTask = function(fn, scope, args, cancelOnDelay) { var me = this, delay, call = function() { clearInterval(me.id); me.id = null; fn.apply(scope, args || []); Ext.EventManager.idleEvent.fire(); }; cancelOnDelay = typeof cancelOnDelay === 'boolean' ? cancelOnDelay : true; /** * @property {Number} id * The id of the currently pending invocation. Will be set to `null` if there is no * invocation pending. */ me.id = null; /** * By default, cancels any pending timeout and queues a new one. * * If the `cancelOnDelay` parameter was specified as `false` in the constructor, this does not cancel and * reschedule, but just updates the call settings, `newDelay`, `newFn`, `newScope` or `newArgs`, whichever are passed. * * @param {Number} newDelay The milliseconds to delay * @param {Function} newFn (optional) Overrides function passed to constructor * @param {Object} newScope (optional) Overrides scope passed to constructor. Remember that if no scope * is specified, this will refer to the browser window. * @param {Array} newArgs (optional) Overrides args passed to constructor */ me.delay = function(newDelay, newFn, newScope, newArgs) { if (cancelOnDelay) { me.cancel(); } delay = newDelay || delay, fn = newFn || fn; scope = newScope || scope; args = newArgs || args; if (!me.id) { me.id = setInterval(call, delay); } }; /** * Cancel the last queued timeout */ me.cancel = function() { if (me.id) { clearInterval(me.id); me.id = null; } }; }; // @tag dom,core /** * Represents single event type that an Observable object listens to. * All actual listeners are tracked inside here. When the event fires, * it calls all the registered listener functions. * * @private */ Ext.define('Ext.util.Event', function() { var arraySlice = Array.prototype.slice, arrayInsert = Ext.Array.insert, toArray = Ext.Array.toArray, DelayedTask = Ext.util.DelayedTask; return { /** * @property {Boolean} isEvent * `true` in this class to identify an object as an instantiated Event, or subclass thereof. */ isEvent: true, // Private. Event suspend count suspended: 0, noOptions: {}, constructor: function(observable, name) { this.name = name; this.observable = observable; this.listeners = []; }, addListener: function(fn, scope, options) { var me = this, listeners, listener, priority, isNegativePriority, highestNegativePriorityIndex, hasNegativePriorityIndex, length, index, i, listenerPriority; scope = scope || me.observable; if (!fn) { Ext.Error.raise({ sourceClass: Ext.getClassName(this.observable), sourceMethod: "addListener", msg: "The specified callback function is undefined" }); } if (!me.isListening(fn, scope)) { listener = me.createListener(fn, scope, options); if (me.firing) { // if we are currently firing this event, don't disturb the listener loop me.listeners = me.listeners.slice(0); } listeners = me.listeners; index = length = listeners.length; priority = options && options.priority; highestNegativePriorityIndex = me._highestNegativePriorityIndex; hasNegativePriorityIndex = (highestNegativePriorityIndex !== undefined); if (priority) { // Find the index at which to insert the listener into the listeners array, // sorted by priority highest to lowest. isNegativePriority = (priority < 0); if (!isNegativePriority || hasNegativePriorityIndex) { // If the priority is a positive number, or if it is a negative number // and there are other existing negative priority listenrs, then we // need to calcuate the listeners priority-order index. // If the priority is a negative number, begin the search for priority // order index at the index of the highest existing negative priority // listener, otherwise begin at 0 for(i = (isNegativePriority ? highestNegativePriorityIndex : 0); i < length; i++) { // Listeners created without options will have no "o" property listenerPriority = listeners[i].o ? listeners[i].o.priority||0 : 0; if (listenerPriority < priority) { index = i; break; } } } else { // if the priority is a negative number, and there are no other negative // priority listeners, then no calculation is needed - the negative // priority listener gets appended to the end of the listeners array. me._highestNegativePriorityIndex = index; } } else if (hasNegativePriorityIndex) { // listeners with a priority of 0 or undefined are appended to the end of // the listeners array unless there are negative priority listeners in the // listeners array, then they are inserted before the highest negative // priority listener. index = highestNegativePriorityIndex; } if (!isNegativePriority && index <= highestNegativePriorityIndex) { me._highestNegativePriorityIndex ++; } if (index === length) { me.listeners[length] = listener; } else { arrayInsert(me.listeners, index, [listener]); } } }, createListener: function(fn, scope, o) { scope = scope || this.observable; var me = this, listener = { fn: fn, scope: scope, ev: me }, handler = fn; // The order is important. The 'single' wrapper must be wrapped by the 'buffer' and 'delayed' wrapper // because the event removal that the single listener does destroys the listener's DelayedTask(s) if (o) { listener.o = o; if (o.single) { handler = me.createSingle(handler, listener, o, scope); } if (o.target) { handler = me.createTargeted(handler, listener, o, scope); } if (o.delay) { handler = me.createDelayed(handler, listener, o, scope); } if (o.buffer) { handler = me.createBuffered(handler, listener, o, scope); } } listener.fireFn = handler; return listener; }, findListener: function(fn, scope) { var listeners = this.listeners, i = listeners.length, listener, s; while (i--) { listener = listeners[i]; if (listener) { s = listener.scope; // Compare the listener's scope with *JUST THE PASSED SCOPE* if one is passed, and only fall back to the owning Observable if none is passed. // We cannot use the test (s == scope || s == this.observable) // Otherwise, if the Observable itself adds Ext.emptyFn as a listener, and then Ext.emptyFn is added under another scope, there will be a false match. if (listener.fn == fn && (s == (scope || this.observable))) { return i; } } } return - 1; }, isListening: function(fn, scope) { return this.findListener(fn, scope) !== -1; }, removeListener: function(fn, scope) { var me = this, index, listener, highestNegativePriorityIndex, k; index = me.findListener(fn, scope); if (index != -1) { listener = me.listeners[index]; highestNegativePriorityIndex = me._highestNegativePriorityIndex; if (me.firing) { me.listeners = me.listeners.slice(0); } // cancel and remove a buffered handler that hasn't fired yet if (listener.task) { listener.task.cancel(); delete listener.task; } // cancel and remove all delayed handlers that haven't fired yet k = listener.tasks && listener.tasks.length; if (k) { while (k--) { listener.tasks[k].cancel(); } delete listener.tasks; } // Remove this listener from the listeners array // We can use splice directly. The IE8 bug which Ext.Array works around only affects *insertion* // http://social.msdn.microsoft.com/Forums/en-US/iewebdevelopment/thread/6e946d03-e09f-4b22-a4dd-cd5e276bf05a/ me.listeners.splice(index, 1); // if the listeners array contains negative priority listeners, adjust the // internal index if needed. if (highestNegativePriorityIndex) { if (index < highestNegativePriorityIndex) { me._highestNegativePriorityIndex --; } else if (index === highestNegativePriorityIndex && index === me.listeners.length) { delete me._highestNegativePriorityIndex; } } return true; } return false; }, // Iterate to stop any buffered/delayed events clearListeners: function() { var listeners = this.listeners, i = listeners.length; while (i--) { this.removeListener(listeners[i].fn, listeners[i].scope); } }, suspend: function() { this.suspended += 1; }, resume: function() { if (this.suspended) { this.suspended--; } }, fire: function() { var me = this, listeners = me.listeners, count = listeners.length, i, args, listener, len; if (!me.suspended && count > 0) { me.firing = true; args = arguments.length ? arraySlice.call(arguments, 0) : [] len = args.length; for (i = 0; i < count; i++) { listener = listeners[i]; if (listener.o) { args[len] = listener.o; } if (listener && listener.fireFn.apply(listener.scope || me.observable, args) === false) { return (me.firing = false); } } } me.firing = false; return true; }, createTargeted: function (handler, listener, o, scope) { return function(){ if (o.target === arguments[0]){ handler.apply(scope, arguments); } }; }, createBuffered: function (handler, listener, o, scope) { listener.task = new DelayedTask(); return function() { listener.task.delay(o.buffer, handler, scope, toArray(arguments)); }; }, createDelayed: function (handler, listener, o, scope) { return function() { var task = new DelayedTask(); if (!listener.tasks) { listener.tasks = []; } listener.tasks.push(task); task.delay(o.delay || 10, handler, scope, toArray(arguments)); }; }, createSingle: function (handler, listener, o, scope) { return function() { var event = listener.ev; if (event.removeListener(listener.fn, scope) && event.observable) { // Removing from a regular Observable-owned, named event (not an anonymous // event such as Ext's readyEvent): Decrement the listeners count event.observable.hasListeners[event.name]--; } return handler.apply(scope, arguments); }; } }; }); // @tag dom,core // @require util/Event.js // @define Ext.EventManager /** * @class Ext.EventManager * Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides * several useful events directly. * * See {@link Ext.EventObject} for more details on normalized event objects. * @singleton */ Ext.EventManager = new function() { var EventManager = this, doc = document, win = window, escapeRx = /\\/g, prefix = Ext.baseCSSPrefix, // IE9strict addEventListener has some issues with using synthetic events supportsAddEventListener = !Ext.isIE9 && 'addEventListener' in doc, readyEvent, initExtCss = function() { // find the body element var bd = doc.body || doc.getElementsByTagName('body')[0], cls = [prefix + 'body'], htmlCls = [], supportsLG = Ext.supports.CSS3LinearGradient, supportsBR = Ext.supports.CSS3BorderRadius, html; if (!bd) { return false; } html = bd.parentNode; function add (c) { cls.push(prefix + c); } //Let's keep this human readable! if (Ext.isIE && Ext.isIE9m) { add('ie'); // very often CSS needs to do checks like "IE7+" or "IE6 or 7". To help // reduce the clutter (since CSS/SCSS cannot do these tests), we add some // additional classes: // // x-ie7p : IE7+ : 7 <= ieVer // x-ie7m : IE7- : ieVer <= 7 // x-ie8p : IE8+ : 8 <= ieVer // x-ie8m : IE8- : ieVer <= 8 // x-ie9p : IE9+ : 9 <= ieVer // x-ie78 : IE7 or 8 : 7 <= ieVer <= 8 // if (Ext.isIE6) { add('ie6'); } else { // ignore pre-IE6 :) add('ie7p'); if (Ext.isIE7) { add('ie7'); } else { add('ie8p'); if (Ext.isIE8) { add('ie8'); } else { add('ie9p'); if (Ext.isIE9) { add('ie9'); } } } } if (Ext.isIE7m) { add('ie7m'); } if (Ext.isIE8m) { add('ie8m'); } if (Ext.isIE9m) { add('ie9m'); } if (Ext.isIE7 || Ext.isIE8) { add('ie78'); } } if (Ext.isIE10) { add('ie10'); } if (Ext.isGecko) { add('gecko'); if (Ext.isGecko3) { add('gecko3'); } if (Ext.isGecko4) { add('gecko4'); } if (Ext.isGecko5) { add('gecko5'); } } if (Ext.isOpera) { add('opera'); } if (Ext.isWebKit) { add('webkit'); } if (Ext.isSafari) { add('safari'); if (Ext.isSafari2) { add('safari2'); } if (Ext.isSafari3) { add('safari3'); } if (Ext.isSafari4) { add('safari4'); } if (Ext.isSafari5) { add('safari5'); } if (Ext.isSafari5_0) { add('safari5_0') } } if (Ext.isChrome) { add('chrome'); } if (Ext.isMac) { add('mac'); } if (Ext.isLinux) { add('linux'); } if (!supportsBR) { add('nbr'); } if (!supportsLG) { add('nlg'); } // add to the parent to allow for selectors x-strict x-border-box, also set the isBorderBox property correctly if (html) { if (Ext.isStrict && (Ext.isIE6 || Ext.isIE7)) { Ext.isBorderBox = false; } else { Ext.isBorderBox = true; } if(!Ext.isBorderBox) { htmlCls.push(prefix + 'content-box'); } if (Ext.isStrict) { htmlCls.push(prefix + 'strict'); } else { htmlCls.push(prefix + 'quirks'); } Ext.fly(html, '_internal').addCls(htmlCls); } Ext.fly(bd, '_internal').addCls(cls); return true; }; Ext.apply(EventManager, { /** * Check if we have bound our global onReady listener * @private */ hasBoundOnReady: false, /** * Check if fireDocReady has been called * @private */ hasFiredReady: false, /** * Additionally, allow the 'DOM' listener thread to complete (usually desirable with mobWebkit, Gecko) * before firing the entire onReady chain (high stack load on Loader) by specifying a delay value. * Defaults to 1ms. * @private */ deferReadyEvent : 1, /* * diags: a list of event names passed to onReadyEvent (in chron order) * @private */ onReadyChain : [], /** * Holds references to any onReady functions * @private */ readyEvent: (function () { readyEvent = new Ext.util.Event(); readyEvent.fire = function () { Ext._beforeReadyTime = Ext._beforeReadyTime || new Date().getTime(); readyEvent.self.prototype.fire.apply(readyEvent, arguments); Ext._afterReadytime = new Date().getTime(); }; return readyEvent; }()), /** * Fires when an event handler finishes its run, just before returning to browser control. * * This includes DOM event handlers, Ajax (including JSONP) event handlers, and {@link Ext.util.TaskRunner TaskRunners} * * This can be useful for performing cleanup, or update tasks which need to happen only * after all code in an event handler has been run, but which should not be executed in a timer * due to the intervening browser reflow/repaint which would take place. * */ idleEvent: new Ext.util.Event(), /** * detects whether the EventManager has been placed in a paused state for synchronization * with external debugging / perf tools (PageAnalyzer) * @private */ isReadyPaused: function(){ return (/[?&]ext-pauseReadyFire\b/i.test(location.search) && !Ext._continueFireReady); }, /** * Binds the appropriate browser event for checking if the DOM has loaded. * @private */ bindReadyEvent: function() { if (EventManager.hasBoundOnReady) { return; } // Test scenario where Core is dynamically loaded AFTER window.load if ( doc.readyState == 'complete' ) { // Firefox4+ got support for this state, others already do. EventManager.onReadyEvent({ type: doc.readyState || 'body' }); } else { doc.addEventListener('DOMContentLoaded', EventManager.onReadyEvent, false); win.addEventListener('load', EventManager.onReadyEvent, false); EventManager.hasBoundOnReady = true; } }, onReadyEvent : function(e) { if (e && e.type) { EventManager.onReadyChain.push(e.type); } if (EventManager.hasBoundOnReady) { doc.removeEventListener('DOMContentLoaded', EventManager.onReadyEvent, false); win.removeEventListener('load', EventManager.onReadyEvent, false); } if (!Ext.isReady) { EventManager.fireDocReady(); } }, /** * We know the document is loaded, so trigger any onReady events. * @private */ fireDocReady: function() { if (!Ext.isReady) { Ext._readyTime = new Date().getTime(); Ext.isReady = true; Ext.supports.init(); EventManager.onWindowUnload(); readyEvent.onReadyChain = EventManager.onReadyChain; //diags report if (Ext.isNumber(EventManager.deferReadyEvent)) { Ext.Function.defer(EventManager.fireReadyEvent, EventManager.deferReadyEvent); EventManager.hasDocReadyTimer = true; } else { EventManager.fireReadyEvent(); } } }, /** * Fires the ready event * @private */ fireReadyEvent: function() { // Unset the timer flag here since other onReady events may be // added during the fire() call and we don't want to block them EventManager.hasDocReadyTimer = false; EventManager.isFiring = true; // Ready events are all single: true, if we get to the end // & there are more listeners, it means they were added // inside some other ready event while (readyEvent.listeners.length && !EventManager.isReadyPaused()) { readyEvent.fire(); } EventManager.isFiring = false; EventManager.hasFiredReady = true; Ext.EventManager.idleEvent.fire(); }, /** * Adds a listener to be notified when the document is ready (before onload and before images are loaded). * * {@link Ext#onDocumentReady} is an alias for {@link Ext.EventManager#onDocumentReady}. * * @param {Function} fn The method the event invokes. * @param {Object} [scope] The scope (`this` reference) in which the handler function executes. * Defaults to the browser window. * @param {Object} [options] Options object as passed to {@link Ext.Element#addListener}. */ onDocumentReady: function(fn, scope, options) { options = options || {}; // force single, only ever fire it once options.single = true; readyEvent.addListener(fn, scope, options); // If we're in the middle of firing, or we have a deferred timer // pending, drop out since the event will be fired later if (!(EventManager.isFiring || EventManager.hasDocReadyTimer)) { if (Ext.isReady) { EventManager.fireReadyEvent(); } else { EventManager.bindReadyEvent(); } } }, // --------------------- event binding --------------------- /** * Contains a list of all document mouse downs, so we can ensure they fire even when stopEvent is called. * @private */ stoppedMouseDownEvent: new Ext.util.Event(), /** * Options to parse for the 4th argument to addListener. * @private */ propRe: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|freezeEvent)$/, /** * Get the id of the element. If one has not been assigned, automatically assign it. * @param {HTMLElement/Ext.Element} element The element to get the id for. * @return {String} id */ getId : function(element) { var id; element = Ext.getDom(element); if (element === doc || element === win) { id = element === doc ? Ext.documentId : Ext.windowId; } else { id = Ext.id(element); } if (!Ext.cache[id]) { Ext.addCacheEntry(id, null, element); } return id; }, /** * Convert a "config style" listener into a set of flat arguments so they can be passed to addListener * @private * @param {Object} element The element the event is for * @param {Object} event The event configuration * @param {Object} isRemove True if a removal should be performed, otherwise an add will be done. */ prepareListenerConfig: function(element, config, isRemove) { var propRe = EventManager.propRe, key, value, args; // loop over all the keys in the object for (key in config) { if (config.hasOwnProperty(key)) { // if the key is something else then an event option if (!propRe.test(key)) { value = config[key]; // if the value is a function it must be something like click: function() {}, scope: this // which means that there might be multiple event listeners with shared options if (typeof value == 'function') { // shared options args = [element, key, value, config.scope, config]; } else { // if its not a function, it must be an object like click: {fn: function() {}, scope: this} args = [element, key, value.fn, value.scope, value]; } if (isRemove) { EventManager.removeListener.apply(EventManager, args); } else { EventManager.addListener.apply(EventManager, args); } } } } }, mouseEnterLeaveRe: /mouseenter|mouseleave/, /** * Normalize cross browser event differences * @private * @param {Object} eventName The event name * @param {Object} fn The function to execute * @return {Object} The new event name/function */ normalizeEvent: function(eventName, fn) { if (EventManager.mouseEnterLeaveRe.test(eventName) && !Ext.supports.MouseEnterLeave) { if (fn) { fn = Ext.Function.createInterceptor(fn, EventManager.contains); } eventName = eventName == 'mouseenter' ? 'mouseover' : 'mouseout'; } else if (eventName == 'mousewheel' && !Ext.supports.MouseWheel && !Ext.isOpera) { eventName = 'DOMMouseScroll'; } return { eventName: eventName, fn: fn }; }, /** * Checks whether the event's relatedTarget is contained inside (or is) the element. * @private * @param {Object} event */ contains: function(event) { event = event.browserEvent || event; var parent = event.currentTarget, child = EventManager.getRelatedTarget(event); if (parent && parent.firstChild) { while (child) { if (child === parent) { return false; } child = child.parentNode; if (child && (child.nodeType != 1)) { child = null; } } } return true; }, /** * Appends an event handler to an element. The shorthand version {@link #on} is equivalent. * Typically you will use {@link Ext.Element#addListener} directly on an Element in favor of * calling this version. * * {@link Ext.EventManager#on} is an alias for {@link Ext.EventManager#addListener}. * * @param {String/Ext.Element/HTMLElement/Window} el The html element or id to assign the event handler to. * * @param {String} eventName The name of the event to listen for. * * @param {Function/String} handler The handler function the event invokes. A String parameter * is assumed to be method name in `scope` object, or Element object if no scope is provided. * @param {Ext.EventObject} handler.event The {@link Ext.EventObject EventObject} describing the event. * @param {Ext.dom.Element} handler.target The Element which was the target of the event. * Note that this may be filtered by using the `delegate` option. * @param {Object} handler.options The options object from the addListener call. * * @param {Object} [scope] The scope (`this` reference) in which the handler function is executed. * Defaults to the Element. * * @param {Object} [options] An object containing handler configuration properties. * This may contain any of the following properties (See {@link Ext.Element#addListener} * for examples of how to use these options.): * @param {Object} options.scope The scope (`this` reference) in which the handler function is executed. Defaults to the Element. * @param {String} options.delegate A simple selector to filter the target or look for a descendant of the target * @param {Boolean} options.stopEvent True to stop the event. That is stop propagation, and prevent the default action. * @param {Boolean} options.preventDefault True to prevent the default action * @param {Boolean} options.stopPropagation True to prevent event propagation * @param {Boolean} options.normalized False to pass a browser event to the handler function instead of an Ext.EventObject * @param {Number} options.delay The number of milliseconds to delay the invocation of the handler after te event fires. * @param {Boolean} options.single True to add a handler to handle just the next firing of the event, and then remove itself. * @param {Number} options.buffer Causes the handler to be scheduled to run in an {@link Ext.util.DelayedTask} delayed * by the specified number of milliseconds. If the event fires again within that time, the original * handler is *not* invoked, but the new handler is scheduled in its place. * @param {Ext.dom.Element} options.target Only call the handler if the event was fired on the target Element, * *not* if the event was bubbled up from a child node. */ addListener: function(element, eventName, fn, scope, options) { // Check if we've been passed a "config style" event. if (typeof eventName !== 'string') { EventManager.prepareListenerConfig(element, eventName); return; } var dom = element.dom || Ext.getDom(element), hasAddEventListener, bind, wrap, cache, id, cacheItem, capture; if (typeof fn === 'string') { fn = Ext.resolveMethod(fn, scope || element); } if (!fn) { Ext.Error.raise({ sourceClass: 'Ext.EventManager', sourceMethod: 'addListener', targetElement: element, eventName: eventName, msg: 'Error adding "' + eventName + '\" listener. The handler function is undefined.' }); } // create the wrapper function options = options || {}; bind = EventManager.normalizeEvent(eventName, fn); wrap = EventManager.createListenerWrap(dom, eventName, bind.fn, scope, options); // add all required data into the event cache cache = EventManager.getEventListenerCache(element.dom ? element : dom, eventName); eventName = bind.eventName; // In IE9 we prefer to use attachEvent but it's not available for some Elements (SVG) hasAddEventListener = supportsAddEventListener || (Ext.isIE9 && !dom.attachEvent); if (!hasAddEventListener) { id = EventManager.normalizeId(dom); // If there's no id we don't have any events bound, so we never // need to clone at this point. if (id) { cacheItem = Ext.cache[id][eventName]; if (cacheItem && cacheItem.firing) { // If we're in the middle of firing we want to update the class // cache reference so it is different to the array we referenced // when we started firing the event. Though this is a more difficult // way of not mutating the collection while firing, a vast majority of // the time we won't be adding listeners for the same element/event type // while firing the same event. cache = EventManager.cloneEventListenerCache(dom, eventName); } } } capture = !!options.capture; cache.push({ fn: fn, wrap: wrap, scope: scope, capture: capture }); if (!hasAddEventListener) { // If cache length is 1, it means we're binding the first event // for this element for this type if (cache.length === 1) { id = EventManager.normalizeId(dom, true); fn = Ext.Function.bind(EventManager.handleSingleEvent, EventManager, [id, eventName], true); Ext.cache[id][eventName] = { firing: false, fn: fn }; dom.attachEvent('on' + eventName, fn); } } else { dom.addEventListener(eventName, wrap, capture); } if (dom == doc && eventName == 'mousedown') { EventManager.stoppedMouseDownEvent.addListener(wrap); } }, // Handle the case where the window/document already has an id attached. // In this case we still want to return our custom window/doc id. normalizeId: function(dom, force) { var id; if (dom === document) { id = Ext.documentId; } else if (dom === window) { id = Ext.windowId; } else { id = dom.id; } if (!id && force) { id = EventManager.getId(dom); } return id; }, handleSingleEvent: function(e, id, eventName) { // Don't create a copy here, since we fire lots of events and it's likely // that we won't add an event during a fire. Instead, we'll handle this during // the process of adding events var listenerCache = EventManager.getEventListenerCache(id, eventName), attachItem = Ext.cache[id][eventName], len, i; // Typically this will never occur, however, the framework allows the creation // of synthetic events in Ext.EventObject. As such, it makes it possible to fire // off the same event on the same element during this method. if (attachItem.firing) { return; } attachItem.firing = true; for (i = 0, len = listenerCache.length; i < len; ++i) { listenerCache[i].wrap(e); } attachItem.firing = false; }, /** * Removes an event handler from an element. The shorthand version {@link #un} is equivalent. Typically * you will use {@link Ext.Element#removeListener} directly on an Element in favor of calling this version. * * {@link Ext.EventManager#on} is an alias for {@link Ext.EventManager#addListener}. * * @param {String/Ext.Element/HTMLElement/Window} el The id or html element from which to remove the listener. * @param {String} eventName The name of the event. * @param {Function} fn The handler function to remove. **This must be a reference to the function passed * into the {@link #addListener} call.** * @param {Object} scope If a scope (`this` reference) was specified when the listener was added, * then this must refer to the same object. */ removeListener : function(element, eventName, fn, scope) { // handle our listener config object syntax if (typeof eventName !== 'string') { EventManager.prepareListenerConfig(element, eventName, true); return; } var dom = Ext.getDom(element), id, el = element.dom ? element : Ext.get(dom), cache = EventManager.getEventListenerCache(el, eventName), bindName = EventManager.normalizeEvent(eventName).eventName, i = cache.length, j, cacheItem, hasRemoveEventListener, listener, wrap; if (!dom) { return; } // In IE9 we prefer to use detachEvent but it's not available for some Elements (SVG) hasRemoveEventListener = supportsAddEventListener || (Ext.isIE9 && !dom.detachEvent); if (typeof fn === 'string') { fn = Ext.resolveMethod(fn, scope || element); } while (i--) { listener = cache[i]; if (listener && (!fn || listener.fn == fn) && (!scope || listener.scope === scope)) { wrap = listener.wrap; // clear buffered calls if (wrap.task) { clearTimeout(wrap.task); delete wrap.task; } // clear delayed calls j = wrap.tasks && wrap.tasks.length; if (j) { while (j--) { clearTimeout(wrap.tasks[j]); } delete wrap.tasks; } if (!hasRemoveEventListener) { // if length is 1, we're removing the final event, actually // unbind it from the element id = EventManager.normalizeId(dom, true); cacheItem = Ext.cache[id][bindName]; if (cacheItem && cacheItem.firing) { // See code in addListener for why we create a copy cache = EventManager.cloneEventListenerCache(dom, bindName); } if (cache.length === 1) { fn = cacheItem.fn; delete Ext.cache[id][bindName]; dom.detachEvent('on' + bindName, fn); } } else { dom.removeEventListener(bindName, wrap, listener.capture); } if (wrap && dom == doc && eventName == 'mousedown') { EventManager.stoppedMouseDownEvent.removeListener(wrap); } // remove listener from cache Ext.Array.erase(cache, i, 1); } } }, /** * Removes all event handers from an element. Typically you will use {@link Ext.Element#removeAllListeners} * directly on an Element in favor of calling this version. * @param {String/Ext.Element/HTMLElement/Window} el The id or html element from which to remove all event handlers. */ removeAll : function(element) { var id = (typeof element === 'string') ? element : element.id, cache, events, eventName; // If the element does not have an ID or a cache entry for its ID, then this is a no-op if (id && (cache = Ext.cache[id])) { events = cache.events; for (eventName in events) { if (events.hasOwnProperty(eventName)) { EventManager.removeListener(element, eventName); } } cache.events = {}; } }, /** * Recursively removes all previous added listeners from an element and its children. Typically you will use {@link Ext.Element#purgeAllListeners} * directly on an Element in favor of calling this version. * @param {String/Ext.Element/HTMLElement/Window} el The id or html element from which to remove all event handlers. * @param {String} eventName (optional) The name of the event. */ purgeElement : function(element, eventName) { var dom = Ext.getDom(element), i = 0, len, childNodes; if (eventName) { EventManager.removeListener(element, eventName); } else { EventManager.removeAll(element); } if (dom && dom.childNodes) { childNodes = dom.childNodes; for (len = childNodes.length; i < len; i++) { EventManager.purgeElement(childNodes[i], eventName); } } }, /** * Create the wrapper function for the event * @private * @param {HTMLElement} dom The dom element * @param {String} ename The event name * @param {Function} fn The function to execute * @param {Object} scope The scope to execute callback in * @param {Object} options The options * @return {Function} the wrapper function */ createListenerWrap : function(dom, ename, fn, scope, options) { options = options || {}; var f, gen, wrap = function(e, args) { // Compile the implementation upon first firing if (!gen) { f = ['if(!' + Ext.name + ') {return;}']; if (options.buffer || options.delay || options.freezeEvent) { if (options.freezeEvent) { // If we're freezing, we still want to update the singleton event object // as well as returning a frozen copy f.push('e = X.EventObject.setEvent(e);'); } f.push('e = new X.EventObjectImpl(e, ' + (options.freezeEvent ? 'true' : 'false' ) + ');'); } else { f.push('e = X.EventObject.setEvent(e);'); } if (options.delegate) { // double up '\' characters so escape sequences survive the // string-literal translation f.push('var result, t = e.getTarget("' + (options.delegate + '').replace(escapeRx, '\\\\') + '", this);'); f.push('if(!t) {return;}'); } else { f.push('var t = e.target, result;'); } if (options.target) { f.push('if(e.target !== options.target) {return;}'); } if (options.stopEvent) { f.push('e.stopEvent();'); } else { if(options.preventDefault) { f.push('e.preventDefault();'); } if(options.stopPropagation) { f.push('e.stopPropagation();'); } } if (options.normalized === false) { f.push('e = e.browserEvent;'); } if (options.buffer) { f.push('(wrap.task && clearTimeout(wrap.task));'); f.push('wrap.task = setTimeout(function() {'); } if (options.delay) { f.push('wrap.tasks = wrap.tasks || [];'); f.push('wrap.tasks.push(setTimeout(function() {'); } // finally call the actual handler fn f.push('result = fn.call(scope || dom, e, t, options);'); if (options.single) { f.push('evtMgr.removeListener(dom, ename, fn, scope);'); } // Fire the global idle event for all events except mousemove which is too common, and // fires too frequently and fast to be use in tiggering onIdle processing. Do not fire on page unload. if (ename !== 'mousemove' && ename !== 'unload') { f.push('if (evtMgr.idleEvent.listeners.length) {'); f.push('evtMgr.idleEvent.fire();'); f.push('}'); } if (options.delay) { f.push('}, ' + options.delay + '));'); } if (options.buffer) { f.push('}, ' + options.buffer + ');'); } f.push('return result;'); gen = Ext.cacheableFunctionFactory('e', 'options', 'fn', 'scope', 'ename', 'dom', 'wrap', 'args', 'X', 'evtMgr', f.join('\n')); } return gen.call(dom, e, options, fn, scope, ename, dom, wrap, args, Ext, EventManager); }; return wrap; }, /** * Gets the event cache object for a particular element * @private * @param {HTMLElement} element The element * @return {Object} The event cache object */ getEventCache: function(element) { var elementCache, eventCache, id; if (!element) { return []; } if (element.$cache) { elementCache = element.$cache; } else { // getId will populate the cache for this element if it isn't already present if (typeof element === 'string') { id = element; } else { id = EventManager.getId(element); } elementCache = Ext.cache[id]; } eventCache = elementCache.events || (elementCache.events = {}); return eventCache; }, /** * Get the event cache for a particular element for a particular event * @private * @param {HTMLElement} element The element * @param {Object} eventName The event name * @return {Array} The events for the element */ getEventListenerCache : function(element, eventName) { var eventCache = EventManager.getEventCache(element); return eventCache[eventName] || (eventCache[eventName] = []); }, /** * Clones the event cache for a particular element for a particular event * @private * @param {HTMLElement} element The element * @param {Object} eventName The event name * @return {Array} The cloned events for the element */ cloneEventListenerCache: function(element, eventName){ var eventCache = EventManager.getEventCache(element), out; if (eventCache[eventName]) { out = eventCache[eventName].slice(0); } else { out = []; } eventCache[eventName] = out; return out; }, // --------------------- utility methods --------------------- mouseLeaveRe: /(mouseout|mouseleave)/, mouseEnterRe: /(mouseover|mouseenter)/, /** * Stop the event (preventDefault and stopPropagation) * @param {Event} event The event to stop */ stopEvent: function(event) { EventManager.stopPropagation(event); EventManager.preventDefault(event); }, /** * Cancels bubbling of the event. * @param {Event} event The event to stop bubbling. */ stopPropagation: function(event) { event = event.browserEvent || event; if (event.stopPropagation) { event.stopPropagation(); } else { event.cancelBubble = true; } }, /** * Prevents the browsers default handling of the event. * @param {Event} event The event to prevent the default */ preventDefault: function(event) { event = event.browserEvent || event; if (event.preventDefault) { event.preventDefault(); } else { event.returnValue = false; // Some keys events require setting the keyCode to -1 to be prevented try { // all ctrl + X and F1 -> F12 if (event.ctrlKey || event.keyCode > 111 && event.keyCode < 124) { event.keyCode = -1; } } catch (e) { // see this outdated document http://support.microsoft.com/kb/934364/en-us for more info } } }, /** * Gets the related target from the event. * @param {Object} event The event * @return {HTMLElement} The related target. */ getRelatedTarget: function(event) { event = event.browserEvent || event; var target = event.relatedTarget; if (!target) { if (EventManager.mouseLeaveRe.test(event.type)) { target = event.toElement; } else if (EventManager.mouseEnterRe.test(event.type)) { target = event.fromElement; } } return EventManager.resolveTextNode(target); }, /** * Gets the x coordinate from the event * @param {Object} event The event * @return {Number} The x coordinate */ getPageX: function(event) { return EventManager.getPageXY(event)[0]; }, /** * Gets the y coordinate from the event * @param {Object} event The event * @return {Number} The y coordinate */ getPageY: function(event) { return EventManager.getPageXY(event)[1]; }, /** * Gets the x & y coordinate from the event * @param {Object} event The event * @return {Number[]} The x/y coordinate */ getPageXY: function(event) { event = event.browserEvent || event; var x = event.pageX, y = event.pageY, docEl = doc.documentElement, body = doc.body; // pageX/pageY not available (undefined, not null), use clientX/clientY instead if (!x && x !== 0) { x = event.clientX + (docEl && docEl.scrollLeft || body && body.scrollLeft || 0) - (docEl && docEl.clientLeft || body && body.clientLeft || 0); y = event.clientY + (docEl && docEl.scrollTop || body && body.scrollTop || 0) - (docEl && docEl.clientTop || body && body.clientTop || 0); } return [x, y]; }, /** * Gets the target of the event. * @param {Object} event The event * @return {HTMLElement} target */ getTarget: function(event) { event = event.browserEvent || event; return EventManager.resolveTextNode(event.target || event.srcElement); }, // technically no need to browser sniff this, however it makes // no sense to check this every time, for every event, whether // the string is equal. /** * Resolve any text nodes accounting for browser differences. * @private * @param {HTMLElement} node The node * @return {HTMLElement} The resolved node */ resolveTextNode: Ext.isGecko ? function(node) { if (node) { // work around firefox bug, https://bugzilla.mozilla.org/show_bug.cgi?id=101197 var s = HTMLElement.prototype.toString.call(node); if (s !== '[xpconnect wrapped native prototype]' && s !== '[object XULElement]') { return node.nodeType == 3 ? node.parentNode: node; } } } : function(node) { return node && node.nodeType == 3 ? node.parentNode: node; }, // --------------------- custom event binding --------------------- // Keep track of the current width/height curWidth: 0, curHeight: 0, /** * Adds a listener to be notified when the browser window is resized and provides resize event buffering (100 milliseconds), * passes new viewport width and height to handlers. * @param {Function} fn The handler function the window resize event invokes. * @param {Object} scope The scope (this reference) in which the handler function executes. Defaults to the browser window. * @param {Boolean} [options] Options object as passed to {@link Ext.Element#addListener} */ onWindowResize: function(fn, scope, options) { var resize = EventManager.resizeEvent; if (!resize) { EventManager.resizeEvent = resize = new Ext.util.Event(); EventManager.on(win, 'resize', EventManager.fireResize, null, {buffer: 100}); } resize.addListener(fn, scope, options); }, /** * Fire the resize event. * @private */ fireResize: function() { var w = Ext.Element.getViewWidth(), h = Ext.Element.getViewHeight(); //whacky problem in IE where the resize event will sometimes fire even though the w/h are the same. if (EventManager.curHeight != h || EventManager.curWidth != w) { EventManager.curHeight = h; EventManager.curWidth = w; EventManager.resizeEvent.fire(w, h); } }, /** * Removes the passed window resize listener. * @param {Function} fn The method the event invokes * @param {Object} scope The scope of handler */ removeResizeListener: function(fn, scope) { var resize = EventManager.resizeEvent; if (resize) { resize.removeListener(fn, scope); } }, /** * Adds a listener to be notified when the browser window is unloaded. * @param {Function} fn The handler function the window unload event invokes. * @param {Object} scope The scope (this reference) in which the handler function executes. Defaults to the browser window. * @param {Boolean} options Options object as passed to {@link Ext.Element#addListener} */ onWindowUnload: function(fn, scope, options) { var unload = EventManager.unloadEvent; if (!unload) { EventManager.unloadEvent = unload = new Ext.util.Event(); EventManager.addListener(win, 'unload', EventManager.fireUnload); } if (fn) { unload.addListener(fn, scope, options); } }, /** * Fires the unload event for items bound with onWindowUnload * @private */ fireUnload: function() { // wrap in a try catch, could have some problems during unload try { // relinquish references. doc = win = undefined; var gridviews, i, ln, el, cache; EventManager.unloadEvent.fire(); // Work around FF3 remembering the last scroll position when refreshing the grid and then losing grid view if (Ext.isGecko3) { gridviews = Ext.ComponentQuery.query('gridview'); i = 0; ln = gridviews.length; for (; i < ln; i++) { gridviews[i].scrollToTop(); } } // Purge all elements in the cache cache = Ext.cache; for (el in cache) { if (cache.hasOwnProperty(el)) { EventManager.removeAll(el); } } } catch(e) { } }, /** * Removes the passed window unload listener. * @param {Function} fn The method the event invokes * @param {Object} scope The scope of handler */ removeUnloadListener: function(fn, scope) { var unload = EventManager.unloadEvent; if (unload) { unload.removeListener(fn, scope); } }, /** * note 1: IE fires ONLY the keydown event on specialkey autorepeat * note 2: Safari < 3.1, Gecko (Mac/Linux) & Opera fire only the keypress event on specialkey autorepeat * (research done by Jan Wolter at http://unixpapa.com/js/key.html) * @private */ useKeyDown: Ext.isWebKit ? parseInt(navigator.userAgent.match(/AppleWebKit\/(\d+)/)[1], 10) >= 525 : !((Ext.isGecko && !Ext.isWindows) || Ext.isOpera), /** * Indicates which event to use for getting key presses. * @return {String} The appropriate event name. */ getKeyEvent: function() { return EventManager.useKeyDown ? 'keydown' : 'keypress'; } }); // route "< ie9-Standards" to a legacy IE onReady implementation if(!supportsAddEventListener && document.attachEvent) { Ext.apply( EventManager, { /* Customized implementation for Legacy IE. The default implementation is configured for use * with all other 'standards compliant' agents. * References: http://javascript.nwbox.com/IEContentLoaded/ * licensed courtesy of http://developer.yahoo.com/yui/license.html */ /** * This strategy has minimal benefits for Sencha solutions that build themselves (ie. minimal initial page markup). * However, progressively-enhanced pages (with image content and/or embedded frames) will benefit the most from it. * Browser timer resolution is too poor to ensure a doScroll check more than once on a page loaded with minimal * assets (the readystatechange event 'complete' usually beats the doScroll timer on a 'lightly-loaded' initial document). */ pollScroll : function() { var scrollable = true; try { document.documentElement.doScroll('left'); } catch(e) { scrollable = false; } // on IE8, when running within an iFrame, document.body is not immediately available if (scrollable && document.body) { EventManager.onReadyEvent({ type:'doScroll' }); } else { /* * minimize thrashing -- * adjusted for setTimeout's close-to-minimums (not too low), * as this method SHOULD always be called once initially */ EventManager.scrollTimeout = setTimeout(EventManager.pollScroll, 20); } return scrollable; }, /** * Timer for doScroll polling * @private */ scrollTimeout: null, /* @private */ readyStatesRe : /complete/i, /* @private */ checkReadyState: function() { var state = document.readyState; if (EventManager.readyStatesRe.test(state)) { EventManager.onReadyEvent({ type: state }); } }, bindReadyEvent: function() { var topContext = true; if (EventManager.hasBoundOnReady) { return; } //are we in an IFRAME? (doScroll ineffective here) try { topContext = window.frameElement === undefined; } catch(e) { // If we throw an exception, it means we're probably getting access denied, // which means we're in an iframe cross domain. topContext = false; } if (!topContext || !doc.documentElement.doScroll) { EventManager.pollScroll = Ext.emptyFn; //then noop this test altogether } // starts doScroll polling if necessary if (EventManager.pollScroll() === true) { return; } // Core is loaded AFTER initial document write/load ? if (doc.readyState == 'complete' ) { EventManager.onReadyEvent({type: 'already ' + (doc.readyState || 'body') }); } else { doc.attachEvent('onreadystatechange', EventManager.checkReadyState); window.attachEvent('onload', EventManager.onReadyEvent); EventManager.hasBoundOnReady = true; } }, onReadyEvent : function(e) { if (e && e.type) { EventManager.onReadyChain.push(e.type); } if (EventManager.hasBoundOnReady) { document.detachEvent('onreadystatechange', EventManager.checkReadyState); window.detachEvent('onload', EventManager.onReadyEvent); } if (Ext.isNumber(EventManager.scrollTimeout)) { clearTimeout(EventManager.scrollTimeout); delete EventManager.scrollTimeout; } if (!Ext.isReady) { EventManager.fireDocReady(); } }, //diags: a list of event types passed to onReadyEvent (in chron order) onReadyChain : [] }); } /** * Adds a function to be called when the DOM is ready, and all required classes have been loaded. * * If the DOM is ready and all classes are loaded, the passed function is executed immediately. * @member Ext * @method onReady * @param {Function} fn The function callback to be executed * @param {Object} scope The execution scope (`this` reference) of the callback function * @param {Object} options The options to modify the listener as passed to {@link Ext.util.Observable#addListener addListener}. */ Ext.onReady = function(fn, scope, options) { Ext.Loader.onReady(fn, scope, true, options); }; /** * @member Ext * @method onDocumentReady * @inheritdoc Ext.EventManager#onDocumentReady */ Ext.onDocumentReady = EventManager.onDocumentReady; /** * @member Ext.EventManager * @method on * @inheritdoc Ext.EventManager#addListener */ EventManager.on = EventManager.addListener; /** * @member Ext.EventManager * @method un * @inheritdoc Ext.EventManager#removeListener */ EventManager.un = EventManager.removeListener; Ext.onReady(initExtCss); }; // @tag core /** * Base class that provides a common interface for publishing events. Subclasses are expected to to have a property * "events" with all the events defined, and, optionally, a property "listeners" with configured listeners defined. * * For example: * * Ext.define('Employee', { * mixins: { * observable: 'Ext.util.Observable' * }, * * constructor: function (config) { * // The Observable constructor copies all of the properties of `config` on * // to `this` using {@link Ext#apply}. Further, the `listeners` property is * // processed to add listeners. * // * this.mixins.observable.constructor.call(this, config); * * this.addEvents( * 'fired', * 'quit' * ); * } * }); * * This could then be used like this: * * var newEmployee = new Employee({ * name: employeeName, * listeners: { * quit: function() { * // By default, "this" will be the object that fired the event. * alert(this.name + " has quit!"); * } * } * }); */ Ext.define('Ext.util.Observable', function(Observable) { // Private Destroyable class which removes listeners var emptyArray = [], arrayProto = Array.prototype, arraySlice = arrayProto.slice, ExtEvent = Ext.util.Event, ListenerRemover = function(observable) { // Passed a ListenerRemover: return it if (observable instanceof ListenerRemover) { return observable; } this.observable = observable; // Called when addManagedListener is used with the event source as the second arg: // (owner, eventSource, args...) if (arguments[1].isObservable) { this.managedListeners = true; } this.args = arraySlice.call(arguments, 1); }; ListenerRemover.prototype.destroy = function() { this.observable[this.managedListeners ? 'mun' : 'un'].apply(this.observable, this.args); }; return { /* Begin Definitions */ statics: { /** * Removes **all** added captures from the Observable. * * @param {Ext.util.Observable} o The Observable to release * @static */ releaseCapture: function(o) { o.fireEventArgs = this.prototype.fireEventArgs; }, /** * Starts capture on the specified Observable. All events will be passed to the supplied function with the event * name + standard signature of the event **before** the event is fired. If the supplied function returns false, * the event will not fire. * * @param {Ext.util.Observable} o The Observable to capture events from. * @param {Function} fn The function to call when an event is fired. * @param {Object} scope (optional) The scope (`this` reference) in which the function is executed. Defaults to * the Observable firing the event. * @static */ capture: function(o, fn, scope) { // We're capturing calls to fireEventArgs to avoid duplication of events; // however fn expects fireEvent's signature so we have to convert it here. // To avoid unnecessary conversions, observe() below is aware of the changes // and will capture fireEventArgs instead. var newFn = function(eventName, args) { return fn.apply(scope, [eventName].concat(args)); } this.captureArgs(o, newFn, scope); }, /** * @private */ captureArgs: function(o, fn, scope) { o.fireEventArgs = Ext.Function.createInterceptor(o.fireEventArgs, fn, scope); }, /** * Sets observability on the passed class constructor. * * This makes any event fired on any instance of the passed class also fire a single event through * the **class** allowing for central handling of events on many instances at once. * * Usage: * * Ext.util.Observable.observe(Ext.data.Connection); * Ext.data.Connection.on('beforerequest', function(con, options) { * console.log('Ajax request made to ' + options.url); * }); * * @param {Function} c The class constructor to make observable. * @param {Object} listeners An object containing a series of listeners to add. See {@link #addListener}. * @static */ observe: function(cls, listeners) { if (cls) { if (!cls.isObservable) { Ext.applyIf(cls, new this()); this.captureArgs(cls.prototype, cls.fireEventArgs, cls); } if (Ext.isObject(listeners)) { cls.on(listeners); } } return cls; }, /** * Prepares a given class for observable instances. This method is called when a * class derives from this class or uses this class as a mixin. * @param {Function} T The class constructor to prepare. * @private */ prepareClass: function (T, mixin) { // T.hasListeners is the object to track listeners on class T. This object's // prototype (__proto__) is the "hasListeners" of T.superclass. // Instances of T will create "hasListeners" that have T.hasListeners as their // immediate prototype (__proto__). if (!T.HasListeners) { // We create a HasListeners "class" for this class. The "prototype" of the // HasListeners class is an instance of the HasListeners class associated // with this class's super class (or with Observable). var HasListeners = function () {}, SuperHL = T.superclass.HasListeners || (mixin && mixin.HasListeners) || Observable.HasListeners; // Make the HasListener class available on the class and its prototype: T.prototype.HasListeners = T.HasListeners = HasListeners; // And connect its "prototype" to the new HasListeners of our super class // (which is also the class-level "hasListeners" instance). HasListeners.prototype = T.hasListeners = new SuperHL(); } } }, /* End Definitions */ /** * @cfg {Object} listeners * * 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 {@link #addListener} example for attaching multiple * handlers at once. * * **DOM events from Ext JS {@link Ext.Component Components}** * * While _some_ Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually * only done when extra value can be added. For example the {@link Ext.view.View DataView}'s **`{@link * Ext.view.View#itemclick itemclick}`** event passing the node clicked on. To access DOM events directly from a * child element of a Component, we need to specify the `element` option to identify the Component property to add a * DOM listener to: * * new Ext.panel.Panel({ * width: 400, * height: 200, * dockedItems: [{ * xtype: 'toolbar' * }], * listeners: { * click: { * element: 'el', //bind to the underlying el property on the panel * fn: function(){ console.log('click el'); } * }, * dblclick: { * element: 'body', //bind to the underlying body property on the panel * fn: function(){ console.log('dblclick body'); } * } * } * }); */ /** * @property {Boolean} isObservable * `true` in this class to identify an object as an instantiated Observable, or subclass thereof. */ isObservable: true, /** * @private * Initial suspended call count. Incremented when {@link #suspendEvents} is called, decremented when {@link #resumeEvents} is called. */ eventsSuspended: 0, /** * @property {Object} hasListeners * @readonly * This object holds a key for any event that has a listener. The listener may be set * directly on the instance, or on its class or a super class (via {@link #observe}) or * on the {@link Ext.app.EventBus MVC EventBus}. The values of this object are truthy * (a non-zero number) and falsy (0 or undefined). They do not represent an exact count * of listeners. The value for an event is truthy if the event must be fired and is * falsy if there is no need to fire the event. * * The intended use of this property is to avoid the expense of fireEvent calls when * there are no listeners. This can be particularly helpful when one would otherwise * have to call fireEvent hundreds or thousands of times. It is used like this: * * if (this.hasListeners.foo) { * this.fireEvent('foo', this, arg1); * } */ constructor: function(config) { var me = this; Ext.apply(me, config); // The subclass may have already initialized it. if (!me.hasListeners) { me.hasListeners = new me.HasListeners(); } me.events = me.events || {}; if (me.listeners) { me.on(me.listeners); me.listeners = null; //Set as an instance property to pre-empt the prototype in case any are set there. } if (me.bubbleEvents) { me.enableBubble(me.bubbleEvents); } }, onClassExtended: function (T) { if (!T.HasListeners) { // Some classes derive from us and some others derive from those classes. All // of these are passed to this method. Observable.prepareClass(T); } }, // @private // Matches options property names within a listeners specification object - property names which are never used as event names. eventOptionsRe : /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|destroyable|vertical|horizontal|freezeEvent|priority)$/, /** * Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is * destroyed. * * @param {Ext.util.Observable/Ext.Element} item The item to which to add a listener/listeners. * @param {Object/String} ename The event name, or an object containing event name properties. * @param {Function} fn (optional) If the `ename` parameter was an event name, this is the handler function. * @param {Object} scope (optional) If the `ename` parameter was an event name, this is the scope (`this` reference) * in which the handler function is executed. * @param {Object} options (optional) If the `ename` parameter was an event name, this is the * {@link Ext.util.Observable#addListener addListener} options. * @return {Object} **Only when the `destroyable` option is specified. ** * * A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. For example: * * this.btnListeners = = myButton.mon({ * destroyable: true * mouseover: function() { console.log('mouseover'); }, * mouseout: function() { console.log('mouseout'); }, * click: function() { console.log('click'); } * }); * * And when those listeners need to be removed: * * Ext.destroy(this.btnListeners); * * or * * this.btnListeners.destroy(); */ addManagedListener: function(item, ename, fn, scope, options, /* private */ noDestroy) { var me = this, managedListeners = me.managedListeners = me.managedListeners || [], config, passedOptions; if (typeof ename !== 'string') { // When creating listeners using the object form, allow caller to override the default of // using the listeners object as options. // This is used by relayEvents, when adding its relayer so that it does not contibute // a spurious options param to the end of the arg list. passedOptions = arguments.length > 4 ? options : ename; options = ename; for (ename in options) { if (options.hasOwnProperty(ename)) { config = options[ename]; if (!me.eventOptionsRe.test(ename)) { // recurse, but pass the noDestroy parameter as true so that lots of individual Destroyables are not created. // We create a single one at the end if necessary. me.addManagedListener(item, ename, config.fn || config, config.scope || options.scope || scope, config.fn ? config : passedOptions, true); } } } if (options && options.destroyable) { return new ListenerRemover(me, item, options); } } else { if (typeof fn === 'string') { scope = scope || me; fn = Ext.resolveMethod(fn, scope); } managedListeners.push({ item: item, ename: ename, fn: fn, scope: scope, options: options }); item.on(ename, fn, scope, options); // The 'noDestroy' flag is sent if we're looping through a hash of listeners passing each one to addManagedListener separately if (!noDestroy && options && options.destroyable) { return new ListenerRemover(me, item, ename, fn, scope); } } }, /** * Removes listeners that were added by the {@link #mon} method. * * @param {Ext.util.Observable/Ext.Element} item The item from which to remove a listener/listeners. * @param {Object/String} ename The event name, or an object containing event name properties. * @param {Function} fn (optional) If the `ename` parameter was an event name, this is the handler function. * @param {Object} scope (optional) If the `ename` parameter was an event name, this is the scope (`this` reference) * in which the handler function is executed. */ removeManagedListener: function(item, ename, fn, scope) { var me = this, options, config, managedListeners, length, i, func; if (typeof ename !== 'string') { options = ename; for (ename in options) { if (options.hasOwnProperty(ename)) { config = options[ename]; if (!me.eventOptionsRe.test(ename)) { me.removeManagedListener(item, ename, config.fn || config, config.scope || options.scope || scope); } } } } else { managedListeners = me.managedListeners ? me.managedListeners.slice() : []; if (typeof fn === 'string') { scope = scope || me; fn = Ext.resolveMethod(fn, scope); } for (i = 0, length = managedListeners.length; i < length; i++) { me.removeManagedListenerItem(false, managedListeners[i], item, ename, fn, scope); } } }, /** * Fires the specified event with the passed parameters (minus the event name, plus the `options` object passed * to {@link #addListener}). * * An event may be set to bubble up an Observable parent hierarchy (See {@link Ext.Component#getBubbleTarget}) by * calling {@link #enableBubble}. * * @param {String} eventName The name of the event to fire. * @param {Object...} args Variable number of parameters are passed to handlers. * @return {Boolean} returns false if any of the handlers return false otherwise it returns true. */ fireEvent: function(eventName) { return this.fireEventArgs(eventName, arraySlice.call(arguments, 1)); }, /** * Fires the specified event with the passed parameter list. * * An event may be set to bubble up an Observable parent hierarchy (See {@link Ext.Component#getBubbleTarget}) by * calling {@link #enableBubble}. * * @param {String} eventName The name of the event to fire. * @param {Object[]} args An array of parameters which are passed to handlers. * @return {Boolean} returns false if any of the handlers return false otherwise it returns true. */ fireEventArgs: function(eventName, args) { eventName = eventName.toLowerCase(); var me = this, events = me.events, event = events && events[eventName], ret = true; // Only continue firing the event if there are listeners to be informed. // Bubbled events will always have a listener count, so will be fired. if (event && me.hasListeners[eventName]) { ret = me.continueFireEvent(eventName, args || emptyArray, event.bubble); } return ret; }, /** * Continue to fire event. * @private * * @param {String} eventName * @param {Array} args * @param {Boolean} bubbles */ continueFireEvent: function(eventName, args, bubbles) { var target = this, queue, event, ret = true; do { if (target.eventsSuspended) { if ((queue = target.eventQueue)) { queue.push([eventName, args, bubbles]); } return ret; } else { event = target.events[eventName]; // Continue bubbling if event exists and it is `true` or the handler didn't returns false and it // configure to bubble. if (event && event !== true) { if ((ret = event.fire.apply(event, args)) === false) { break; } } } } while (bubbles && (target = target.getBubbleParent())); return ret; }, /** * Gets the bubbling parent for an Observable * @private * @return {Ext.util.Observable} The bubble parent. null is returned if no bubble target exists */ getBubbleParent: function() { var me = this, parent = me.getBubbleTarget && me.getBubbleTarget(); if (parent && parent.isObservable) { return parent; } return null; }, /** * Appends an event handler to this object. For example: * * myGridPanel.on("mouseover", this.onMouseOver, this); * * The method also allows for a single argument to be passed which is a config object * containing properties which specify multiple events. For example: * * myGridPanel.on({ * cellClick: this.onCellClick, * mouseover: this.onMouseOver, * mouseout: this.onMouseOut, * scope: this // Important. Ensure "this" is correct during handler execution * }); * * One can also specify options for each event handler separately: * * myGridPanel.on({ * cellClick: {fn: this.onCellClick, scope: this, single: true}, * mouseover: {fn: panel.onMouseOver, scope: panel} * }); * * *Names* of methods in a specified scope may also be used. Note that * `scope` MUST be specified to use this option: * * myGridPanel.on({ * cellClick: {fn: 'onCellClick', scope: this, single: true}, * mouseover: {fn: 'onMouseOver', scope: panel} * }); * * @param {String/Object} eventName The name of the event to listen for. * May also be an object who's property names are event names. * * @param {Function} [fn] The method the event invokes, or *if `scope` is specified, the *name* of the method within * the specified `scope`. Will be called with arguments * given to {@link Ext.util.Observable#fireEvent} plus the `options` parameter described below. * * @param {Object} [scope] The scope (`this` reference) in which the handler function is * executed. **If omitted, defaults to the object which fired the event.** * * @param {Object} [options] An object containing handler configuration. * * **Note:** Unlike in ExtJS 3.x, the options object will also be passed as the last * argument to every event handler. * * This object may contain any of the following properties: * * @param {Object} options.scope * The scope (`this` reference) in which the handler function is executed. **If omitted, * defaults to the object which fired the event.** * * @param {Number} options.delay * The number of milliseconds to delay the invocation of the handler after the event fires. * * @param {Boolean} options.single * True to add a handler to handle just the next firing of the event, and then remove itself. * * @param {Number} options.buffer * Causes the handler to be scheduled to run in an {@link Ext.util.DelayedTask} delayed * by the specified number of milliseconds. If the event fires again within that time, * the original handler is _not_ invoked, but the new handler is scheduled in its place. * * @param {Ext.util.Observable} options.target * Only call the handler if the event was fired on the target Observable, _not_ if the event * was bubbled up from a child Observable. * * @param {String} options.element * **This option is only valid for listeners bound to {@link Ext.Component Components}.** * The name of a Component property which references an element to add a listener to. * * This option is useful during Component construction to add DOM event listeners to elements of * {@link Ext.Component Components} which will exist only after the Component is rendered. * For example, to add a click listener to a Panel's body: * * new Ext.panel.Panel({ * title: 'The title', * listeners: { * click: this.handlePanelClick, * element: 'body' * } * }); * * @param {Boolean} [options.destroyable=false] * When specified as `true`, the function returns A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. * * @param {Number} [options.priority] * An optional numeric priority that determines the order in which event handlers * are run. Event handlers with no priority will be run as if they had a priority * of 0. Handlers with a higher priority will be prioritized to run sooner than * those with a lower priority. Negative numbers can be used to set a priority * lower than the default. Internally, the framework uses a range of 1000 or * greater, and -1000 or lesser for handers that are intended to run before or * after all others, so it is recommended to stay within the range of -999 to 999 * when setting the priority of event handlers in application-level code. * * **Combining Options** * * Using the options argument, it is possible to combine different types of listeners: * * A delayed, one-time listener. * * myPanel.on('hide', this.handleClick, this, { * single: true, * delay: 100 * }); * * @return {Object} **Only when the `destroyable` option is specified. ** * * A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. For example: * * this.btnListeners = = myButton.on({ * destroyable: true * mouseover: function() { console.log('mouseover'); }, * mouseout: function() { console.log('mouseout'); }, * click: function() { console.log('click'); } * }); * * And when those listeners need to be removed: * * Ext.destroy(this.btnListeners); * * or * * this.btnListeners.destroy(); */ addListener: function(ename, fn, scope, options) { var me = this, config, event, prevListenerCount = 0; // Object listener hash passed if (typeof ename !== 'string') { options = ename; for (ename in options) { if (options.hasOwnProperty(ename)) { config = options[ename]; if (!me.eventOptionsRe.test(ename)) { /* This would be an API change so check removed until https://sencha.jira.com/browse/EXTJSIV-7183 is fully implemented in 4.2 // Test must go here as well as in the simple form because of the attempted property access here on the config object. if (!config || (typeof config !== 'function' && !config.fn)) { Ext.Error.raise('No function passed for event ' + me.$className + '.' + ename); } */ me.addListener(ename, config.fn || config, config.scope || options.scope, config.fn ? config : options); } } } if (options && options.destroyable) { return new ListenerRemover(me, options); } } // String, function passed else { ename = ename.toLowerCase(); event = me.events[ename]; if (event && event.isEvent) { prevListenerCount = event.listeners.length; } else { me.events[ename] = event = new ExtEvent(me, ename); } if (!fn) { Ext.Error.raise('No function passed for event ' + me.$className + '.' + ename); } // Allow listeners: { click: 'onClick', scope: myObject } if (typeof fn === 'string') { scope = scope || me; fn = Ext.resolveMethod(fn, scope); } event.addListener(fn, scope, options); // If a new listener has been added (Event.addListener rejects duplicates of the same fn+scope) // then increment the hasListeners counter if (event.listeners.length !== prevListenerCount) { me.hasListeners._incr_(ename); } if (options && options.destroyable) { return new ListenerRemover(me, ename, fn, scope, options); } } }, /** * Removes an event handler. * * @param {String} eventName The type of event the handler was associated with. * @param {Function} fn The handler to remove. **This must be a reference to the function passed into the * {@link Ext.util.Observable#addListener} call.** * @param {Object} scope (optional) The scope originally specified for the handler. It must be the same as the * scope argument specified in the original call to {@link Ext.util.Observable#addListener} or the listener will not be removed. */ removeListener: function(ename, fn, scope) { var me = this, config, event, options; if (typeof ename !== 'string') { options = ename; for (ename in options) { if (options.hasOwnProperty(ename)) { config = options[ename]; if (!me.eventOptionsRe.test(ename)) { me.removeListener(ename, config.fn || config, config.scope || options.scope); } } } } else { ename = ename.toLowerCase(); event = me.events[ename]; if (event && event.isEvent) { if (typeof fn === 'string') { scope = scope || me; fn = Ext.resolveMethod(fn, scope); } if (event.removeListener(fn, scope)) { me.hasListeners._decr_(ename); } } } }, /** * Removes all listeners for this object including the managed listeners */ clearListeners: function() { var events = this.events, hasListeners = this.hasListeners, event, key; for (key in events) { if (events.hasOwnProperty(key)) { event = events[key]; if (event.isEvent) { delete hasListeners[key]; event.clearListeners(); } } } this.clearManagedListeners(); }, purgeListeners : function() { if (Ext.global.console) { Ext.global.console.warn('Observable: purgeListeners has been deprecated. Please use clearListeners.'); } return this.clearListeners.apply(this, arguments); }, /** * Removes all managed listeners for this object. */ clearManagedListeners : function() { var managedListeners = this.managedListeners || [], i = 0, len = managedListeners.length; for (; i < len; i++) { this.removeManagedListenerItem(true, managedListeners[i]); } this.managedListeners = []; }, /** * Remove a single managed listener item * @private * @param {Boolean} isClear True if this is being called during a clear * @param {Object} managedListener The managed listener item * See removeManagedListener for other args */ removeManagedListenerItem: function(isClear, managedListener, item, ename, fn, scope){ if (isClear || (managedListener.item === item && managedListener.ename === ename && (!fn || managedListener.fn === fn) && (!scope || managedListener.scope === scope))) { managedListener.item.un(managedListener.ename, managedListener.fn, managedListener.scope); if (!isClear) { Ext.Array.remove(this.managedListeners, managedListener); } } }, purgeManagedListeners : function() { if (Ext.global.console) { Ext.global.console.warn('Observable: purgeManagedListeners has been deprecated. Please use clearManagedListeners.'); } return this.clearManagedListeners.apply(this, arguments); }, /** * Adds the specified events to the list of events which this Observable may fire. * * @param {Object/String...} eventNames Either an object with event names as properties with * a value of `true`. For example: * * this.addEvents({ * storeloaded: true, * storecleared: true * }); * * Or any number of event names as separate parameters. For example: * * this.addEvents('storeloaded', 'storecleared'); * */ addEvents: function(o) { var me = this, events = me.events || (me.events = {}), arg, args, i; if (typeof o == 'string') { for (args = arguments, i = args.length; i--; ) { arg = args[i]; if (!events[arg]) { events[arg] = true; } } } else { Ext.applyIf(me.events, o); } }, /** * Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer * indicates whether the event needs firing or not. * * @param {String} eventName The name of the event to check for * @return {Boolean} `true` if the event is being listened for or bubbles, else `false` */ hasListener: function(ename) { return !!this.hasListeners[ename.toLowerCase()]; }, /** * Suspends the firing of all events. (see {@link #resumeEvents}) * * @param {Boolean} queueSuspended Pass as true to queue up suspended events to be fired * after the {@link #resumeEvents} call instead of discarding all suspended events. */ suspendEvents: function(queueSuspended) { this.eventsSuspended += 1; if (queueSuspended && !this.eventQueue) { this.eventQueue = []; } }, /** * Suspends firing of the named event(s). * * After calling this method to suspend events, the events will no longer fire when requested to fire. * * **Note that if this is called multiple times for a certain event, the converse method * {@link #resumeEvent} will have to be called the same number of times for it to resume firing.** * * @param {String...} eventName Multiple event names to suspend. */ suspendEvent: function(eventName) { var len = arguments.length, i, event; for (i = 0; i < len; i++) { event = this.events[arguments[i]]; // If it exists, and is an Event object (not still a boolean placeholder), suspend it if (event && event.suspend) { event.suspend(); } } }, /** * Resumes firing of the named event(s). * * After calling this method to resume events, the events will fire when requested to fire. * * **Note that if the {@link #suspendEvent} method is called multiple times for a certain event, * this converse method will have to be called the same number of times for it to resume firing.** * * @param {String...} eventName Multiple event names to resume. */ resumeEvent: function() { var len = arguments.length, i, event; for (i = 0; i < len; i++) { // If it exists, and is an Event object (not still a boolean placeholder), resume it event = this.events[arguments[i]]; if (event && event.resume) { event.resume(); } } }, /** * Resumes firing events (see {@link #suspendEvents}). * * If events were suspended using the `queueSuspended` parameter, then all events fired * during event suspension will be sent to any listeners now. */ resumeEvents: function() { var me = this, queued = me.eventQueue, qLen, q; if (me.eventsSuspended && ! --me.eventsSuspended) { delete me.eventQueue; if (queued) { qLen = queued.length; for (q = 0; q < qLen; q++) { me.continueFireEvent.apply(me, queued[q]); } } } }, /** * Relays selected events from the specified Observable as if the events were fired by `this`. * * For example if you are extending Grid, you might decide to forward some events from store. * So you can do this inside your initComponent: * * this.relayEvents(this.getStore(), ['load']); * * The grid instance will then have an observable 'load' event which will be passed the * parameters of the store's load event and any function fired with the grid's load event * would have access to the grid using the `this` keyword. * * @param {Object} origin The Observable whose events this object is to relay. * @param {String[]} events Array of event names to relay. * @param {String} [prefix] A common prefix to prepend to the event names. For example: * * this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); * * Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'. * * @return {Object} A `Destroyable` object. An object which implements the `destroy` method which, when destroyed, removes all relayers. For example: * * this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); * * Can be undone by calling * * Ext.destroy(this.storeRelayers); * * or * this.store.relayers.destroy(); */ relayEvents : function(origin, events, prefix) { var me = this, len = events.length, i = 0, oldName, relayers = {}; for (; i < len; i++) { oldName = events[i]; // Build up the listener hash. relayers[oldName] = me.createRelayer(prefix ? prefix + oldName : oldName); } // Add the relaying listeners as ManagedListeners so that they are removed when this.clearListeners is called (usually when _this_ is destroyed) // Explicitly pass options as undefined so that the listener does not get an extra options param // which then has to be sliced off in the relayer. me.mon(origin, relayers, null, null, undefined); // relayed events are always destroyable. return new ListenerRemover(me, origin, relayers); }, /** * @private * Creates an event handling function which refires the event from this object as the passed event name. * @param {String} newName The name under which to refire the passed parameters. * @param {Array} beginEnd (optional) The caller can specify on which indices to slice. * @returns {Function} */ createRelayer: function(newName, beginEnd) { var me = this; return function() { return me.fireEventArgs.call(me, newName, beginEnd ? arraySlice.apply(arguments, beginEnd) : arguments); }; }, /** * Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if * present. There is no implementation in the Observable base class. * * This is commonly used by Ext.Components to bubble events to owner Containers. * See {@link Ext.Component#getBubbleTarget}. The default implementation in Ext.Component returns the * Component's immediate owner. But if a known target is required, this can be overridden to access the * required target more quickly. * * Example: * * Ext.define('Ext.overrides.form.field.Base', { * override: 'Ext.form.field.Base', * * // Add functionality to Field's initComponent to enable the change event to bubble * initComponent: function () { * this.callParent(); * this.enableBubble('change'); * } * }); * * var myForm = Ext.create('Ext.form.Panel', { * title: 'User Details', * items: [{ * ... * }], * listeners: { * change: function() { * // Title goes red if form has been modified. * myForm.header.setStyle('color', 'red'); * } * } * }); * * @param {String/String[]} eventNames The event name to bubble, or an Array of event names. */ enableBubble: function(eventNames) { if (eventNames) { var me = this, names = (typeof eventNames == 'string') ? arguments : eventNames, length = names.length, events = me.events, ename, event, i; for (i = 0; i < length; ++i) { ename = names[i].toLowerCase(); event = events[ename]; if (!event || typeof event == 'boolean') { events[ename] = event = new ExtEvent(me, ename); } // Event must fire if it bubbles (We don't know if anyone up the // bubble hierarchy has listeners added) me.hasListeners._incr_(ename); event.bubble = true; } } } }; }, function() { var Observable = this, proto = Observable.prototype, HasListeners = function () {}, prepareMixin = function (T) { if (!T.HasListeners) { var proto = T.prototype; // Classes that use us as a mixin (best practice) need to be prepared. Observable.prepareClass(T, this); // Now that we are mixed in to class T, we need to watch T for derivations // and prepare them also. T.onExtended(function (U) { Ext.classSystemMonitor && Ext.classSystemMonitor('extend mixin', arguments); Observable.prepareClass(U); }); // Also, if a class uses us as a mixin and that class is then used as // a mixin, we need to be notified of that as well. if (proto.onClassMixedIn) { // play nice with other potential overrides... Ext.override(T, { onClassMixedIn: function (U) { prepareMixin.call(this, U); this.callParent(arguments); } }); } else { // just us chickens, so add the method... proto.onClassMixedIn = function (U) { prepareMixin.call(this, U); }; } } }, globalEvents; HasListeners.prototype = { //$$: 42 // to make sure we have a proper prototype _decr_: function (ev) { if (! --this[ev]) { // Delete this entry, since 0 does not mean no one is listening, just // that no one is *directly* listening. This allows the eventBus or // class observers to "poke" through and expose their presence. delete this[ev]; } }, _incr_: function (ev) { if (this.hasOwnProperty(ev)) { // if we already have listeners at this level, just increment the count... ++this[ev]; } else { // otherwise, start the count at 1 (which hides whatever is in our prototype // chain)... this[ev] = 1; } } }; proto.HasListeners = Observable.HasListeners = HasListeners; Observable.createAlias({ /** * @method * Shorthand for {@link #addListener}. * @inheritdoc Ext.util.Observable#addListener */ on: 'addListener', /** * @method * Shorthand for {@link #removeListener}. * @inheritdoc Ext.util.Observable#removeListener */ un: 'removeListener', /** * @method * Shorthand for {@link #addManagedListener}. * @inheritdoc Ext.util.Observable#addManagedListener */ mon: 'addManagedListener', /** * @method * Shorthand for {@link #removeManagedListener}. * @inheritdoc Ext.util.Observable#removeManagedListener */ mun: 'removeManagedListener' }); //deprecated, will be removed in 5.0 Observable.observeClass = Observable.observe; /** * @member Ext * @property {Ext.util.Observable} globalEvents * An instance of `{@link Ext.util.Observable}` through which Ext fires global events. * * This Observable instance fires the following events: * * * **`idle`** * * Fires when an event handler finishes its run, just before returning to browser control. * * This includes DOM event handlers, Ajax (including JSONP) event handlers, and {@link Ext.util.TaskRunner TaskRunners} * * This can be useful for performing cleanup, or update tasks which need to happen only * after all code in an event handler has been run, but which should not be executed in a timer * due to the intervening browser reflow/repaint which would take place. * * * **`ready`** * * Fires when the DOM is ready, and all required classes have been loaded. Functionally * the same as {@link Ext#onReady}, but must be called with the `single` option: * * Ext.on({ * ready: function() { * console.log('document is ready!'); * }, * single: true * }); * * * **`resumelayouts`** * * Fires after global layout processing has been resumed in {@link Ext.AbstractComponent#resumeLayouts}. */ Ext.globalEvents = globalEvents = new Observable({ events: { idle: Ext.EventManager.idleEvent, ready: Ext.EventManager.readyEvent } }); /** * @member Ext * @method on * Shorthand for the {@link Ext.util.Observable#addListener} method of the * {@link Ext#globalEvents} Observable instance. * @inheritdoc Ext.util.Observable#addListener */ Ext.on = function() { return globalEvents.addListener.apply(globalEvents, arguments); }; /** * @member Ext * @method * Shorthand for the {@link Ext.util.Observable#removeListener} method of the * {@link Ext#globalEvents} Observable instance. * @inheritdoc Ext.util.Observable#removeListener */ Ext.un = function() { return globalEvents.removeListener.apply(globalEvents, arguments); }; // this is considered experimental (along with beforeMethod, afterMethod, removeMethodListener?) // allows for easier interceptor and sequences, including cancelling and overwriting the return value of the call // private function getMethodEvent(method){ var e = (this.methodEvents = this.methodEvents || {})[method], returnValue, v, cancel, obj = this, makeCall; if (!e) { this.methodEvents[method] = e = {}; e.originalFn = this[method]; e.methodName = method; e.before = []; e.after = []; makeCall = function(fn, scope, args){ if((v = fn.apply(scope || obj, args)) !== undefined){ if (typeof v == 'object') { if(v.returnValue !== undefined){ returnValue = v.returnValue; }else{ returnValue = v; } cancel = !!v.cancel; } else if (v === false) { cancel = true; } else { returnValue = v; } } }; this[method] = function(){ var args = Array.prototype.slice.call(arguments, 0), b, i, len; returnValue = v = undefined; cancel = false; for(i = 0, len = e.before.length; i < len; i++){ b = e.before[i]; makeCall(b.fn, b.scope, args); if (cancel) { return returnValue; } } if((v = e.originalFn.apply(obj, args)) !== undefined){ returnValue = v; } for(i = 0, len = e.after.length; i < len; i++){ b = e.after[i]; makeCall(b.fn, b.scope, args); if (cancel) { return returnValue; } } return returnValue; }; } return e; } Ext.apply(proto, { onClassMixedIn: prepareMixin, // these are considered experimental // allows for easier interceptor and sequences, including cancelling and overwriting the return value of the call // adds an 'interceptor' called before the original method beforeMethod : function(method, fn, scope){ getMethodEvent.call(this, method).before.push({ fn: fn, scope: scope }); }, // adds a 'sequence' called after the original method afterMethod : function(method, fn, scope){ getMethodEvent.call(this, method).after.push({ fn: fn, scope: scope }); }, removeMethodListener: function(method, fn, scope){ var e = this.getMethodEvent(method), i, len; for(i = 0, len = e.before.length; i < len; i++){ if(e.before[i].fn == fn && e.before[i].scope == scope){ Ext.Array.erase(e.before, i, 1); return; } } for(i = 0, len = e.after.length; i < len; i++){ if(e.after[i].fn == fn && e.after[i].scope == scope){ Ext.Array.erase(e.after, i, 1); return; } } }, toggleEventLogging: function(toggle) { Ext.util.Observable[toggle ? 'capture' : 'releaseCapture'](this, function(en) { if (Ext.isDefined(Ext.global.console)) { Ext.global.console.log(en, arguments); } }); } }); }); // @tag dom,core // @require EventManager.js // @define Ext.EventObject /** * @class Ext.EventObject Just as {@link Ext.Element} wraps around a native DOM node, Ext.EventObject wraps the browser's native event-object normalizing cross-browser differences, such as which mouse button is clicked, keys pressed, mechanisms to stop event-propagation along with a method to prevent default actions from taking place. For example: function handleClick(e, t){ // e is not a standard event object, it is a Ext.EventObject e.preventDefault(); var target = e.getTarget(); // same as t (the target HTMLElement) ... } var myDiv = {@link Ext#get Ext.get}("myDiv"); // get reference to an {@link Ext.Element} myDiv.on( // 'on' is shorthand for addListener "click", // perform an action on click of myDiv handleClick // reference to the action handler ); // other methods to do the same: Ext.EventManager.on("myDiv", 'click', handleClick); Ext.EventManager.addListener("myDiv", 'click', handleClick); * @singleton * @markdown */ Ext.define('Ext.EventObjectImpl', { /** Key constant @type Number */ BACKSPACE: 8, /** Key constant @type Number */ TAB: 9, /** Key constant @type Number */ NUM_CENTER: 12, /** Key constant @type Number */ ENTER: 13, /** Key constant @type Number */ RETURN: 13, /** Key constant @type Number */ SHIFT: 16, /** Key constant @type Number */ CTRL: 17, /** Key constant @type Number */ ALT: 18, /** Key constant @type Number */ PAUSE: 19, /** Key constant @type Number */ CAPS_LOCK: 20, /** Key constant @type Number */ ESC: 27, /** Key constant @type Number */ SPACE: 32, /** Key constant @type Number */ PAGE_UP: 33, /** Key constant @type Number */ PAGE_DOWN: 34, /** Key constant @type Number */ END: 35, /** Key constant @type Number */ HOME: 36, /** Key constant @type Number */ LEFT: 37, /** Key constant @type Number */ UP: 38, /** Key constant @type Number */ RIGHT: 39, /** Key constant @type Number */ DOWN: 40, /** Key constant @type Number */ PRINT_SCREEN: 44, /** Key constant @type Number */ INSERT: 45, /** Key constant @type Number */ DELETE: 46, /** Key constant @type Number */ ZERO: 48, /** Key constant @type Number */ ONE: 49, /** Key constant @type Number */ TWO: 50, /** Key constant @type Number */ THREE: 51, /** Key constant @type Number */ FOUR: 52, /** Key constant @type Number */ FIVE: 53, /** Key constant @type Number */ SIX: 54, /** Key constant @type Number */ SEVEN: 55, /** Key constant @type Number */ EIGHT: 56, /** Key constant @type Number */ NINE: 57, /** Key constant @type Number */ A: 65, /** Key constant @type Number */ B: 66, /** Key constant @type Number */ C: 67, /** Key constant @type Number */ D: 68, /** Key constant @type Number */ E: 69, /** Key constant @type Number */ F: 70, /** Key constant @type Number */ G: 71, /** Key constant @type Number */ H: 72, /** Key constant @type Number */ I: 73, /** Key constant @type Number */ J: 74, /** Key constant @type Number */ K: 75, /** Key constant @type Number */ L: 76, /** Key constant @type Number */ M: 77, /** Key constant @type Number */ N: 78, /** Key constant @type Number */ O: 79, /** Key constant @type Number */ P: 80, /** Key constant @type Number */ Q: 81, /** Key constant @type Number */ R: 82, /** Key constant @type Number */ S: 83, /** Key constant @type Number */ T: 84, /** Key constant @type Number */ U: 85, /** Key constant @type Number */ V: 86, /** Key constant @type Number */ W: 87, /** Key constant @type Number */ X: 88, /** Key constant @type Number */ Y: 89, /** Key constant @type Number */ Z: 90, /** Key constant @type Number */ CONTEXT_MENU: 93, /** Key constant @type Number */ NUM_ZERO: 96, /** Key constant @type Number */ NUM_ONE: 97, /** Key constant @type Number */ NUM_TWO: 98, /** Key constant @type Number */ NUM_THREE: 99, /** Key constant @type Number */ NUM_FOUR: 100, /** Key constant @type Number */ NUM_FIVE: 101, /** Key constant @type Number */ NUM_SIX: 102, /** Key constant @type Number */ NUM_SEVEN: 103, /** Key constant @type Number */ NUM_EIGHT: 104, /** Key constant @type Number */ NUM_NINE: 105, /** Key constant @type Number */ NUM_MULTIPLY: 106, /** Key constant @type Number */ NUM_PLUS: 107, /** Key constant @type Number */ NUM_MINUS: 109, /** Key constant @type Number */ NUM_PERIOD: 110, /** Key constant @type Number */ NUM_DIVISION: 111, /** Key constant @type Number */ F1: 112, /** Key constant @type Number */ F2: 113, /** Key constant @type Number */ F3: 114, /** Key constant @type Number */ F4: 115, /** Key constant @type Number */ F5: 116, /** Key constant @type Number */ F6: 117, /** Key constant @type Number */ F7: 118, /** Key constant @type Number */ F8: 119, /** Key constant @type Number */ F9: 120, /** Key constant @type Number */ F10: 121, /** Key constant @type Number */ F11: 122, /** Key constant @type Number */ F12: 123, /** * The mouse wheel delta scaling factor. This value depends on browser version and OS and * attempts to produce a similar scrolling experience across all platforms and browsers. * * To change this value: * * Ext.EventObjectImpl.prototype.WHEEL_SCALE = 72; * * @type Number * @markdown */ WHEEL_SCALE: (function () { var scale; if (Ext.isGecko) { // Firefox uses 3 on all platforms scale = 3; } else if (Ext.isMac) { // Continuous scrolling devices have momentum and produce much more scroll than // discrete devices on the same OS and browser. To make things exciting, Safari // (and not Chrome) changed from small values to 120 (like IE). if (Ext.isSafari && Ext.webKitVersion >= 532.0) { // Safari changed the scrolling factor to match IE (for details see // https://bugs.webkit.org/show_bug.cgi?id=24368). The WebKit version where this // change was introduced was 532.0 // Detailed discussion: // https://bugs.webkit.org/show_bug.cgi?id=29601 // http://trac.webkit.org/browser/trunk/WebKit/chromium/src/mac/WebInputEventFactory.mm#L1063 scale = 120; } else { // MS optical wheel mouse produces multiples of 12 which is close enough // to help tame the speed of the continuous mice... scale = 12; } // Momentum scrolling produces very fast scrolling, so increase the scale factor // to help produce similar results cross platform. This could be even larger and // it would help those mice, but other mice would become almost unusable as a // result (since we cannot tell which device type is in use). scale *= 3; } else { // IE, Opera and other Windows browsers use 120. scale = 120; } return scale; }()), /** * Simple click regex * @private */ clickRe: /(dbl)?click/, // safari keypress events for special keys return bad keycodes safariKeys: { 3: 13, // enter 63234: 37, // left 63235: 39, // right 63232: 38, // up 63233: 40, // down 63276: 33, // page up 63277: 34, // page down 63272: 46, // delete 63273: 36, // home 63275: 35 // end }, // normalize button clicks, don't see any way to feature detect this. btnMap: Ext.isIE ? { 1: 0, 4: 1, 2: 2 } : { 0: 0, 1: 1, 2: 2 }, /** * @property {Boolean} ctrlKey * True if the control key was down during the event. * In Mac this will also be true when meta key was down. */ /** * @property {Boolean} altKey * True if the alt key was down during the event. */ /** * @property {Boolean} shiftKey * True if the shift key was down during the event. */ constructor: function(event, freezeEvent){ if (event) { this.setEvent(event.browserEvent || event, freezeEvent); } }, setEvent: function(event, freezeEvent){ var me = this, button, options; if (event === me || (event && event.browserEvent)) { // already wrapped return event; } me.browserEvent = event; if (event) { // normalize buttons button = event.button ? me.btnMap[event.button] : (event.which ? event.which - 1 : -1); if (me.clickRe.test(event.type) && button == -1) { button = 0; } options = { type: event.type, button: button, shiftKey: event.shiftKey, // mac metaKey behaves like ctrlKey ctrlKey: event.ctrlKey || event.metaKey || false, altKey: event.altKey, // in getKey these will be normalized for the mac keyCode: event.keyCode, charCode: event.charCode, // cache the targets for the delayed and or buffered events target: Ext.EventManager.getTarget(event), relatedTarget: Ext.EventManager.getRelatedTarget(event), currentTarget: event.currentTarget, xy: (freezeEvent ? me.getXY() : null) }; } else { options = { button: -1, shiftKey: false, ctrlKey: false, altKey: false, keyCode: 0, charCode: 0, target: null, xy: [0, 0] }; } Ext.apply(me, options); return me; }, /** * Stop the event (preventDefault and stopPropagation) */ stopEvent: function(){ this.stopPropagation(); this.preventDefault(); }, /** * Prevents the browsers default handling of the event. */ preventDefault: function(){ if (this.browserEvent) { Ext.EventManager.preventDefault(this.browserEvent); } }, /** * Cancels bubbling of the event. */ stopPropagation: function(){ var browserEvent = this.browserEvent; if (browserEvent) { if (browserEvent.type == 'mousedown') { Ext.EventManager.stoppedMouseDownEvent.fire(this); } Ext.EventManager.stopPropagation(browserEvent); } }, /** * Gets the character code for the event. * @return {Number} */ getCharCode: function(){ return this.charCode || this.keyCode; }, /** * Returns a normalized keyCode for the event. * @return {Number} The key code */ getKey: function(){ return this.normalizeKey(this.keyCode || this.charCode); }, /** * Normalize key codes across browsers * @private * @param {Number} key The key code * @return {Number} The normalized code */ normalizeKey: function(key){ // can't feature detect this return Ext.isWebKit ? (this.safariKeys[key] || key) : key; }, /** * Gets the x coordinate of the event. * @return {Number} * @deprecated 4.0 Replaced by {@link #getX} */ getPageX: function(){ return this.getX(); }, /** * Gets the y coordinate of the event. * @return {Number} * @deprecated 4.0 Replaced by {@link #getY} */ getPageY: function(){ return this.getY(); }, /** * Gets the x coordinate of the event. * @return {Number} */ getX: function() { return this.getXY()[0]; }, /** * Gets the y coordinate of the event. * @return {Number} */ getY: function() { return this.getXY()[1]; }, /** * Gets the page coordinates of the event. * @return {Number[]} The xy values like [x, y] */ getXY: function() { if (!this.xy) { // same for XY this.xy = Ext.EventManager.getPageXY(this.browserEvent); } return this.xy; }, /** * Gets the target for the event. * @param {String} selector (optional) A simple selector to filter the target or look for an ancestor of the target * @param {Number/HTMLElement} maxDepth (optional) The max depth to search as a number or element (defaults to 10 || document.body) * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node * @return {HTMLElement} */ getTarget : function(selector, maxDepth, returnEl){ if (selector) { return Ext.fly(this.target).findParent(selector, maxDepth, returnEl); } return returnEl ? Ext.get(this.target) : this.target; }, /** * Gets the related target. * @param {String} selector (optional) A simple selector to filter the target or look for an ancestor of the target * @param {Number/HTMLElement} maxDepth (optional) The max depth to search as a number or element (defaults to 10 || document.body) * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node * @return {HTMLElement} */ getRelatedTarget : function(selector, maxDepth, returnEl){ if (selector && this.relatedTarget) { return Ext.fly(this.relatedTarget).findParent(selector, maxDepth, returnEl); } return returnEl ? Ext.get(this.relatedTarget) : this.relatedTarget; }, /** * Correctly scales a given wheel delta. * @param {Number} delta The delta value. */ correctWheelDelta : function (delta) { var scale = this.WHEEL_SCALE, ret = Math.round(delta / scale); if (!ret && delta) { ret = (delta < 0) ? -1 : 1; // don't allow non-zero deltas to go to zero! } return ret; }, /** * Returns the mouse wheel deltas for this event. * @return {Object} An object with "x" and "y" properties holding the mouse wheel deltas. */ getWheelDeltas : function () { var me = this, event = me.browserEvent, dx = 0, dy = 0; // the deltas if (Ext.isDefined(event.wheelDeltaX)) { // WebKit has both dimensions dx = event.wheelDeltaX; dy = event.wheelDeltaY; } else if (event.wheelDelta) { // old WebKit and IE dy = event.wheelDelta; } else if (event.detail) { // Gecko dy = -event.detail; // gecko is backwards // Gecko sometimes returns really big values if the user changes settings to // scroll a whole page per scroll if (dy > 100) { dy = 3; } else if (dy < -100) { dy = -3; } // Firefox 3.1 adds an axis field to the event to indicate direction of // scroll. See https://developer.mozilla.org/en/Gecko-Specific_DOM_Events if (Ext.isDefined(event.axis) && event.axis === event.HORIZONTAL_AXIS) { dx = dy; dy = 0; } } return { x: me.correctWheelDelta(dx), y: me.correctWheelDelta(dy) }; }, /** * Normalizes mouse wheel y-delta across browsers. To get x-delta information, use * {@link #getWheelDeltas} instead. * @return {Number} The mouse wheel y-delta */ getWheelDelta : function(){ var deltas = this.getWheelDeltas(); return deltas.y; }, /** * Returns true if the target of this event is a child of el. Unless the allowEl parameter is set, it will return false if if the target is el. * Example usage:

// Handle click on any child of an element
Ext.getBody().on('click', function(e){
    if(e.within('some-el')){
        alert('Clicked on a child of some-el!');
    }
});

// Handle click directly on an element, ignoring clicks on child nodes
Ext.getBody().on('click', function(e,t){
    if((t.id == 'some-el') && !e.within(t, true)){
        alert('Clicked directly on some-el!');
    }
});
* @param {String/HTMLElement/Ext.Element} el The id, DOM element or Ext.Element to check * @param {Boolean} [related] `true` to test if the related target is within el instead of the target * @param {Boolean} [allowEl] `true` to also check if the passed element is the target or related target * @return {Boolean} */ within : function(el, related, allowEl){ if(el){ var t = related ? this.getRelatedTarget() : this.getTarget(), result; if (t) { result = Ext.fly(el, '_internal').contains(t); if (!result && allowEl) { result = t == Ext.getDom(el); } return result; } } return false; }, /** * Checks if the key pressed was a "navigation" key * @return {Boolean} True if the press is a navigation keypress */ isNavKeyPress : function(){ var me = this, k = this.normalizeKey(me.keyCode); return (k >= 33 && k <= 40) || // Page Up/Down, End, Home, Left, Up, Right, Down k == me.RETURN || k == me.TAB || k == me.ESC; }, /** * Checks if the key pressed was a "special" key * @return {Boolean} True if the press is a special keypress */ isSpecialKey : function(){ var k = this.normalizeKey(this.keyCode); return (this.type == 'keypress' && this.ctrlKey) || this.isNavKeyPress() || (k == this.BACKSPACE) || // Backspace (k >= 16 && k <= 20) || // Shift, Ctrl, Alt, Pause, Caps Lock (k >= 44 && k <= 46); // Print Screen, Insert, Delete }, /** * Returns a point object that consists of the object coordinates. * @return {Ext.util.Point} point */ getPoint : function(){ var xy = this.getXY(); return new Ext.util.Point(xy[0], xy[1]); }, /** * Returns true if the control, meta, shift or alt key was pressed during this event. * @return {Boolean} */ hasModifier : function(){ return this.ctrlKey || this.altKey || this.shiftKey || this.metaKey; }, /** * Injects a DOM event using the data in this object and (optionally) a new target. * This is a low-level technique and not likely to be used by application code. The * currently supported event types are: *

HTMLEvents

*
    *
  • load
  • *
  • unload
  • *
  • select
  • *
  • change
  • *
  • submit
  • *
  • reset
  • *
  • resize
  • *
  • scroll
  • *
*

MouseEvents

*
    *
  • click
  • *
  • dblclick
  • *
  • mousedown
  • *
  • mouseup
  • *
  • mouseover
  • *
  • mousemove
  • *
  • mouseout
  • *
*

UIEvents

*
    *
  • focusin
  • *
  • focusout
  • *
  • activate
  • *
  • focus
  • *
  • blur
  • *
* @param {Ext.Element/HTMLElement} target (optional) If specified, the target for the event. This * is likely to be used when relaying a DOM event. If not specified, {@link #getTarget} * is used to determine the target. */ injectEvent: (function () { var API, dispatchers = {}, // keyed by event type (e.g., 'mousedown') crazyIEButtons; // Good reference: http://developer.yahoo.com/yui/docs/UserAction.js.html // IE9 has createEvent, but this code causes major problems with htmleditor (it // blocks all mouse events and maybe more). TODO if (!Ext.isIE9m && document.createEvent) { // if (DOM compliant) API = { createHtmlEvent: function (doc, type, bubbles, cancelable) { var event = doc.createEvent('HTMLEvents'); event.initEvent(type, bubbles, cancelable); return event; }, createMouseEvent: function (doc, type, bubbles, cancelable, detail, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget) { var event = doc.createEvent('MouseEvents'), view = doc.defaultView || window; if (event.initMouseEvent) { event.initMouseEvent(type, bubbles, cancelable, view, detail, clientX, clientY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget); } else { // old Safari event = doc.createEvent('UIEvents'); event.initEvent(type, bubbles, cancelable); event.view = view; event.detail = detail; event.screenX = clientX; event.screenY = clientY; event.clientX = clientX; event.clientY = clientY; event.ctrlKey = ctrlKey; event.altKey = altKey; event.metaKey = metaKey; event.shiftKey = shiftKey; event.button = button; event.relatedTarget = relatedTarget; } return event; }, createUIEvent: function (doc, type, bubbles, cancelable, detail) { var event = doc.createEvent('UIEvents'), view = doc.defaultView || window; event.initUIEvent(type, bubbles, cancelable, view, detail); return event; }, fireEvent: function (target, type, event) { target.dispatchEvent(event); }, fixTarget: function (target) { // Safari3 doesn't have window.dispatchEvent() if (target == window && !target.dispatchEvent) { return document; } return target; } }; } else if (document.createEventObject) { // else if (IE) crazyIEButtons = { 0: 1, 1: 4, 2: 2 }; API = { createHtmlEvent: function (doc, type, bubbles, cancelable) { var event = doc.createEventObject(); event.bubbles = bubbles; event.cancelable = cancelable; return event; }, createMouseEvent: function (doc, type, bubbles, cancelable, detail, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget) { var event = doc.createEventObject(); event.bubbles = bubbles; event.cancelable = cancelable; event.detail = detail; event.screenX = clientX; event.screenY = clientY; event.clientX = clientX; event.clientY = clientY; event.ctrlKey = ctrlKey; event.altKey = altKey; event.shiftKey = shiftKey; event.metaKey = metaKey; event.button = crazyIEButtons[button] || button; event.relatedTarget = relatedTarget; // cannot assign to/fromElement return event; }, createUIEvent: function (doc, type, bubbles, cancelable, detail) { var event = doc.createEventObject(); event.bubbles = bubbles; event.cancelable = cancelable; return event; }, fireEvent: function (target, type, event) { target.fireEvent('on' + type, event); }, fixTarget: function (target) { if (target == document) { // IE6,IE7 thinks window==document and doesn't have window.fireEvent() // IE6,IE7 cannot properly call document.fireEvent() return document.documentElement; } return target; } }; } //---------------- // HTMLEvents Ext.Object.each({ load: [false, false], unload: [false, false], select: [true, false], change: [true, false], submit: [true, true], reset: [true, false], resize: [true, false], scroll: [true, false] }, function (name, value) { var bubbles = value[0], cancelable = value[1]; dispatchers[name] = function (targetEl, srcEvent) { var e = API.createHtmlEvent(name, bubbles, cancelable); API.fireEvent(targetEl, name, e); }; }); //---------------- // MouseEvents function createMouseEventDispatcher (type, detail) { var cancelable = (type != 'mousemove'); return function (targetEl, srcEvent) { var xy = srcEvent.getXY(), e = API.createMouseEvent(targetEl.ownerDocument, type, true, cancelable, detail, xy[0], xy[1], srcEvent.ctrlKey, srcEvent.altKey, srcEvent.shiftKey, srcEvent.metaKey, srcEvent.button, srcEvent.relatedTarget); API.fireEvent(targetEl, type, e); }; } Ext.each(['click', 'dblclick', 'mousedown', 'mouseup', 'mouseover', 'mousemove', 'mouseout'], function (eventName) { dispatchers[eventName] = createMouseEventDispatcher(eventName, 1); }); //---------------- // UIEvents Ext.Object.each({ focusin: [true, false], focusout: [true, false], activate: [true, true], focus: [false, false], blur: [false, false] }, function (name, value) { var bubbles = value[0], cancelable = value[1]; dispatchers[name] = function (targetEl, srcEvent) { var e = API.createUIEvent(targetEl.ownerDocument, name, bubbles, cancelable, 1); API.fireEvent(targetEl, name, e); }; }); //--------- if (!API) { // not even sure what ancient browsers fall into this category... dispatchers = {}; // never mind all those we just built :P API = { fixTarget: Ext.identityFn }; } function cannotInject (target, srcEvent) { // TODO log something } return function (target) { var me = this, dispatcher = dispatchers[me.type] || cannotInject, t = target ? (target.dom || target) : me.getTarget(); t = API.fixTarget(t); dispatcher(t, me); }; }()) // call to produce method }, function() { Ext.EventObject = new Ext.EventObjectImpl(); }); // @tag dom,core // @require ../EventObject.js /** * @class Ext.dom.AbstractQuery * @private */ Ext.define('Ext.dom.AbstractQuery', { /** * Selects a group of elements. * @param {String} selector The selector/xpath query (can be a comma separated list of selectors) * @param {HTMLElement/String} [root] The start of the query (defaults to document). * @return {HTMLElement[]} An Array of DOM elements which match the selector. If there are * no matches, and empty Array is returned. */ select: function(q, root) { var results = [], nodes, i, j, qlen, nlen; root = root || document; if (typeof root == 'string') { root = document.getElementById(root); } q = q.split(","); for (i = 0,qlen = q.length; i < qlen; i++) { if (typeof q[i] == 'string') { //support for node attribute selection if (typeof q[i][0] == '@') { nodes = root.getAttributeNode(q[i].substring(1)); results.push(nodes); } else { nodes = root.querySelectorAll(q[i]); for (j = 0,nlen = nodes.length; j < nlen; j++) { results.push(nodes[j]); } } } } return results; }, /** * Selects a single element. * @param {String} selector The selector/xpath query * @param {HTMLElement/String} [root] The start of the query (defaults to document). * @return {HTMLElement} The DOM element which matched the selector. */ selectNode: function(q, root) { return this.select(q, root)[0]; }, /** * Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child) * @param {String/HTMLElement/Array} el An element id, element or array of elements * @param {String} selector The simple selector to test * @return {Boolean} */ is: function(el, q) { if (typeof el == "string") { el = document.getElementById(el); } return this.select(q).indexOf(el) !== -1; } }); // @tag dom,core // @require AbstractQuery.js /** * Abstract base class for {@link Ext.dom.Helper}. * @private */ Ext.define('Ext.dom.AbstractHelper', { emptyTags : /^(?:br|frame|hr|img|input|link|meta|range|spacer|wbr|area|param|col)$/i, confRe : /^(?:tag|children|cn|html|tpl|tplData)$/i, endRe : /end/i, styleSepRe: /\s*(?::|;)\s*/, // Since cls & for are reserved words, we need to transform them attributeTransform: { cls : 'class', htmlFor : 'for' }, closeTags: {}, decamelizeName : (function () { var camelCaseRe = /([a-z])([A-Z])/g, cache = {}; function decamel (match, p1, p2) { return p1 + '-' + p2.toLowerCase(); } return function (s) { return cache[s] || (cache[s] = s.replace(camelCaseRe, decamel)); }; }()), generateMarkup: function(spec, buffer) { var me = this, specType = typeof spec, attr, val, tag, i, closeTags; if (specType == "string" || specType == "number") { buffer.push(spec); } else if (Ext.isArray(spec)) { for (i = 0; i < spec.length; i++) { if (spec[i]) { me.generateMarkup(spec[i], buffer); } } } else { tag = spec.tag || 'div'; buffer.push('<', tag); for (attr in spec) { if (spec.hasOwnProperty(attr)) { val = spec[attr]; if (!me.confRe.test(attr)) { if (typeof val == "object") { buffer.push(' ', attr, '="'); me.generateStyles(val, buffer).push('"'); } else { buffer.push(' ', me.attributeTransform[attr] || attr, '="', val, '"'); } } } } // Now either just close the tag or try to add children and close the tag. if (me.emptyTags.test(tag)) { buffer.push('/>'); } else { buffer.push('>'); // Apply the tpl html, and cn specifications if ((val = spec.tpl)) { val.applyOut(spec.tplData, buffer); } if ((val = spec.html)) { buffer.push(val); } if ((val = spec.cn || spec.children)) { me.generateMarkup(val, buffer); } // we generate a lot of close tags, so cache them rather than push 3 parts closeTags = me.closeTags; buffer.push(closeTags[tag] || (closeTags[tag] = '')); } } return buffer; }, /** * Converts the styles from the given object to text. The styles are CSS style names * with their associated value. * * The basic form of this method returns a string: * * var s = Ext.DomHelper.generateStyles({ * backgroundColor: 'red' * }); * * // s = 'background-color:red;' * * Alternatively, this method can append to an output array. * * var buf = []; * * ... * * Ext.DomHelper.generateStyles({ * backgroundColor: 'red' * }, buf); * * In this case, the style text is pushed on to the array and the array is returned. * * @param {Object} styles The object describing the styles. * @param {String[]} [buffer] The output buffer. * @return {String/String[]} If buffer is passed, it is returned. Otherwise the style * string is returned. */ generateStyles: function (styles, buffer) { var a = buffer || [], name; for (name in styles) { if (styles.hasOwnProperty(name)) { a.push(this.decamelizeName(name), ':', styles[name], ';'); } } return buffer || a.join(''); }, /** * Returns the markup for the passed Element(s) config. * @param {Object} spec The DOM object spec (and children) * @return {String} */ markup: function(spec) { if (typeof spec == "string") { return spec; } var buf = this.generateMarkup(spec, []); return buf.join(''); }, /** * Applies a style specification to an element. * @param {String/HTMLElement} el The element to apply styles to * @param {String/Object/Function} styles A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or * a function which returns such a specification. */ applyStyles: function(el, styles) { if (styles) { var i = 0, len; el = Ext.fly(el, '_applyStyles'); if (typeof styles == 'function') { styles = styles.call(); } if (typeof styles == 'string') { styles = Ext.util.Format.trim(styles).split(this.styleSepRe); for (len = styles.length; i < len;) { el.setStyle(styles[i++], styles[i++]); } } else if (Ext.isObject(styles)) { el.setStyle(styles); } } }, /** * Inserts an HTML fragment into the DOM. * @param {String} where Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd. * * For example take the following HTML: `
Contents
` * * Using different `where` values inserts element to the following places: * * - beforeBegin: `
Contents
` * - afterBegin: `
Contents
` * - beforeEnd: `
Contents
` * - afterEnd: `
Contents
` * * @param {HTMLElement/TextNode} el The context element * @param {String} html The HTML fragment * @return {HTMLElement} The new node */ insertHtml: function(where, el, html) { var hash = {}, setStart, range, frag, rangeEl; where = where.toLowerCase(); // add these here because they are used in both branches of the condition. hash['beforebegin'] = ['BeforeBegin', 'previousSibling']; hash['afterend'] = ['AfterEnd', 'nextSibling']; range = el.ownerDocument.createRange(); setStart = 'setStart' + (this.endRe.test(where) ? 'After' : 'Before'); if (hash[where]) { range[setStart](el); frag = range.createContextualFragment(html); el.parentNode.insertBefore(frag, where == 'beforebegin' ? el : el.nextSibling); return el[(where == 'beforebegin' ? 'previous' : 'next') + 'Sibling']; } else { rangeEl = (where == 'afterbegin' ? 'first' : 'last') + 'Child'; if (el.firstChild) { range[setStart](el[rangeEl]); frag = range.createContextualFragment(html); if (where == 'afterbegin') { el.insertBefore(frag, el.firstChild); } else { el.appendChild(frag); } } else { el.innerHTML = html; } return el[rangeEl]; } throw 'Illegal insertion point -> "' + where + '"'; }, /** * Creates new DOM element(s) and inserts them before el. * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/String} o The DOM object spec (and children) or raw HTML blob * @param {Boolean} [returnElement] true to return a Ext.Element * @return {HTMLElement/Ext.Element} The new node */ insertBefore: function(el, o, returnElement) { return this.doInsert(el, o, returnElement, 'beforebegin'); }, /** * Creates new DOM element(s) and inserts them after el. * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object} o The DOM object spec (and children) * @param {Boolean} [returnElement] true to return a Ext.Element * @return {HTMLElement/Ext.Element} The new node */ insertAfter: function(el, o, returnElement) { return this.doInsert(el, o, returnElement, 'afterend', 'nextSibling'); }, /** * Creates new DOM element(s) and inserts them as the first child of el. * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/String} o The DOM object spec (and children) or raw HTML blob * @param {Boolean} [returnElement] true to return a Ext.Element * @return {HTMLElement/Ext.Element} The new node */ insertFirst: function(el, o, returnElement) { return this.doInsert(el, o, returnElement, 'afterbegin', 'firstChild'); }, /** * Creates new DOM element(s) and appends them to el. * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/String} o The DOM object spec (and children) or raw HTML blob * @param {Boolean} [returnElement] true to return a Ext.Element * @return {HTMLElement/Ext.Element} The new node */ append: function(el, o, returnElement) { return this.doInsert(el, o, returnElement, 'beforeend', '', true); }, /** * Creates new DOM element(s) and overwrites the contents of el with them. * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/String} o The DOM object spec (and children) or raw HTML blob * @param {Boolean} [returnElement] true to return a Ext.Element * @return {HTMLElement/Ext.Element} The new node */ overwrite: function(el, o, returnElement) { el = Ext.getDom(el); el.innerHTML = this.markup(o); return returnElement ? Ext.get(el.firstChild) : el.firstChild; }, doInsert: function(el, o, returnElement, pos, sibling, append) { var newNode = this.insertHtml(pos, Ext.getDom(el), this.markup(o)); return returnElement ? Ext.get(newNode, true) : newNode; } }); // @tag dom,core /** */ Ext.define('Ext.dom.AbstractElement_static', { override: 'Ext.dom.AbstractElement', inheritableStatics: { unitRe: /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i, camelRe: /(-[a-z])/gi, msRe: /^-ms-/, cssRe: /([a-z0-9\-]+)\s*:\s*([^;\s]+(?:\s*[^;\s]+)*)?;?/gi, opacityRe: /alpha\(opacity=(.*)\)/i, propertyCache: {}, defaultUnit : "px", borders: {l: 'border-left-width', r: 'border-right-width', t: 'border-top-width', b: 'border-bottom-width'}, paddings: {l: 'padding-left', r: 'padding-right', t: 'padding-top', b: 'padding-bottom'}, margins: {l: 'margin-left', r: 'margin-right', t: 'margin-top', b: 'margin-bottom'}, /** * Test if size has a unit, otherwise appends the passed unit string, or the default for this Element. * @param size {Object} The size to set * @param units {String} The units to append to a numeric size value * @private * @static */ addUnits: function(size, units) { // Most common case first: Size is set to a number if (typeof size == 'number') { return size + (units || this.defaultUnit || 'px'); } // Size set to a value which means "auto" if (size === "" || size == "auto" || size === undefined || size === null) { return size || ''; } // Otherwise, warn if it's not a valid CSS measurement if (!this.unitRe.test(size)) { if (Ext.isDefined(Ext.global.console)) { Ext.global.console.warn("Warning, size detected as NaN on Element.addUnits."); } return size || ''; } return size; }, /** * @static * @private */ isAncestor: function(p, c) { var ret = false; p = Ext.getDom(p); c = Ext.getDom(c); if (p && c) { if (p.contains) { return p.contains(c); } else if (p.compareDocumentPosition) { return !!(p.compareDocumentPosition(c) & 16); } else { while ((c = c.parentNode)) { ret = c == p || ret; } } } return ret; }, /** * Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations * (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result) * @static * @param {Number/String} box The encoded margins * @return {Object} An object with margin sizes for top, right, bottom and left */ parseBox: function(box) { box = box || 0; var type = typeof box, parts, ln; if (type === 'number') { return { top : box, right : box, bottom: box, left : box }; } else if (type !== 'string') { // If not a number or a string, assume we've been given a box config. return box; } parts = box.split(' '); ln = parts.length; if (ln == 1) { parts[1] = parts[2] = parts[3] = parts[0]; } else if (ln == 2) { parts[2] = parts[0]; parts[3] = parts[1]; } else if (ln == 3) { parts[3] = parts[1]; } return { top :parseFloat(parts[0]) || 0, right :parseFloat(parts[1]) || 0, bottom:parseFloat(parts[2]) || 0, left :parseFloat(parts[3]) || 0 }; }, /** * Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations * (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result) * @static * @param {Number/String/Object} box The encoded margins, or an object with top, right, * bottom, and left properties * @param {String} units The type of units to add * @return {String} An string with unitized (px if units is not specified) metrics for top, right, bottom and left */ unitizeBox: function(box, units) { var a = this.addUnits, b = this.parseBox(box); return a(b.top, units) + ' ' + a(b.right, units) + ' ' + a(b.bottom, units) + ' ' + a(b.left, units); }, // private camelReplaceFn: function(m, a) { return a.charAt(1).toUpperCase(); }, /** * Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax. * For example: * * - border-width -> borderWidth * - padding-top -> paddingTop * * @static * @param {String} prop The property to normalize * @return {String} The normalized string */ normalize: function(prop) { // TODO: Mobile optimization? if (prop == 'float') { prop = Ext.supports.Float ? 'cssFloat' : 'styleFloat'; } // For '-ms-foo' we need msFoo return this.propertyCache[prop] || (this.propertyCache[prop] = prop.replace(this.msRe, 'ms-').replace(this.camelRe, this.camelReplaceFn)); }, /** * Retrieves the document height * @static * @return {Number} documentHeight */ getDocumentHeight: function() { return Math.max(!Ext.isStrict ? document.body.scrollHeight : document.documentElement.scrollHeight, this.getViewportHeight()); }, /** * Retrieves the document width * @static * @return {Number} documentWidth */ getDocumentWidth: function() { return Math.max(!Ext.isStrict ? document.body.scrollWidth : document.documentElement.scrollWidth, this.getViewportWidth()); }, /** * Retrieves the viewport height of the window. * @static * @return {Number} viewportHeight */ getViewportHeight: function(){ return window.innerHeight; }, /** * Retrieves the viewport width of the window. * @static * @return {Number} viewportWidth */ getViewportWidth: function() { return window.innerWidth; }, /** * Retrieves the viewport size of the window. * @static * @return {Object} object containing width and height properties */ getViewSize: function() { return { width: window.innerWidth, height: window.innerHeight }; }, /** * Retrieves the current orientation of the window. This is calculated by * determing if the height is greater than the width. * @static * @return {String} Orientation of window: 'portrait' or 'landscape' */ getOrientation: function() { if (Ext.supports.OrientationChange) { return (window.orientation == 0) ? 'portrait' : 'landscape'; } return (window.innerHeight > window.innerWidth) ? 'portrait' : 'landscape'; }, /** * Returns the top Element that is located at the passed coordinates * @static * @param {Number} x The x coordinate * @param {Number} y The y coordinate * @return {String} The found Element */ fromPoint: function(x, y) { return Ext.get(document.elementFromPoint(x, y)); }, /** * Converts a CSS string into an object with a property for each style. * * The sample code below would return an object with 2 properties, one * for background-color and one for color. * * var css = 'background-color: red;color: blue; '; * console.log(Ext.dom.Element.parseStyles(css)); * * @static * @param {String} styles A CSS string * @return {Object} styles */ parseStyles: function(styles){ var out = {}, cssRe = this.cssRe, matches; if (styles) { // Since we're using the g flag on the regex, we need to set the lastIndex. // This automatically happens on some implementations, but not others, see: // http://stackoverflow.com/questions/2645273/javascript-regular-expression-literal-persists-between-function-calls // http://blog.stevenlevithan.com/archives/fixing-javascript-regexp cssRe.lastIndex = 0; while ((matches = cssRe.exec(styles))) { out[matches[1]] = matches[2]||''; } } return out; } } }, function () { var doc = document, activeElement = null, isCSS1 = doc.compatMode == "CSS1Compat"; // If the browser does not support document.activeElement we need some assistance. // This covers old Safari 3.2 (4.0 added activeElement along with just about all // other browsers). We need this support to handle issues with old Safari. if (!('activeElement' in doc) && doc.addEventListener) { doc.addEventListener('focus', function (ev) { if (ev && ev.target) { activeElement = (ev.target == doc) ? null : ev.target; } }, true); } /* * Helper function to create the function that will restore the selection. */ function makeSelectionRestoreFn (activeEl, start, end) { return function () { activeEl.selectionStart = start; activeEl.selectionEnd = end; }; } this.addInheritableStatics({ /** * Returns the active element in the DOM. If the browser supports activeElement * on the document, this is returned. If not, the focus is tracked and the active * element is maintained internally. * @return {HTMLElement} The active (focused) element in the document. */ getActiveElement: function () { var active; // In IE 6/7, calling activeElement can sometimes throw an Unspecified Error, // so we need to wrap it in a try catch try { active = doc.activeElement; } catch(e) {} // Default to the body if we can't find anything // https://developer.mozilla.org/en-US/docs/DOM/document.activeElement active = active || activeElement; if (!active) { active = activeElement = document.body; } return active; }, /** * Creates a function to call to clean up problems with the work-around for the * WebKit RightMargin bug. The work-around is to add "display: 'inline-block'" to * the element before calling getComputedStyle and then to restore its original * display value. The problem with this is that it corrupts the selection of an * INPUT or TEXTAREA element (as in the "I-beam" goes away but ths focus remains). * To cleanup after this, we need to capture the selection of any such element and * then restore it after we have restored the display style. * * @param {Ext.dom.Element} target The top-most element being adjusted. * @private */ getRightMarginFixCleaner: function (target) { var supports = Ext.supports, hasInputBug = supports.DisplayChangeInputSelectionBug, hasTextAreaBug = supports.DisplayChangeTextAreaSelectionBug, activeEl, tag, start, end; if (hasInputBug || hasTextAreaBug) { activeEl = doc.activeElement || activeElement; // save a call tag = activeEl && activeEl.tagName; if ((hasTextAreaBug && tag == 'TEXTAREA') || (hasInputBug && tag == 'INPUT' && activeEl.type == 'text')) { if (Ext.dom.Element.isAncestor(target, activeEl)) { start = activeEl.selectionStart; end = activeEl.selectionEnd; if (Ext.isNumber(start) && Ext.isNumber(end)) { // to be safe... // We don't create the raw closure here inline because that // will be costly even if we don't want to return it (nested // function decls and exprs are often instantiated on entry // regardless of whether execution ever reaches them): return makeSelectionRestoreFn(activeEl, start, end); } } } } return Ext.emptyFn; // avoid special cases, just return a nop }, getViewWidth: function(full) { return full ? Ext.dom.Element.getDocumentWidth() : Ext.dom.Element.getViewportWidth(); }, getViewHeight: function(full) { return full ? Ext.dom.Element.getDocumentHeight() : Ext.dom.Element.getViewportHeight(); }, getDocumentHeight: function() { return Math.max(!isCSS1 ? doc.body.scrollHeight : doc.documentElement.scrollHeight, Ext.dom.Element.getViewportHeight()); }, getDocumentWidth: function() { return Math.max(!isCSS1 ? doc.body.scrollWidth : doc.documentElement.scrollWidth, Ext.dom.Element.getViewportWidth()); }, getViewportHeight: function(){ return Ext.isIE9m ? (Ext.isStrict ? doc.documentElement.clientHeight : doc.body.clientHeight) : self.innerHeight; }, getViewportWidth: function() { return (!Ext.isStrict && !Ext.isOpera) ? doc.body.clientWidth : Ext.isIE9m ? doc.documentElement.clientWidth : self.innerWidth; }, /** * Serializes a DOM form into a url encoded string * @param {Object} form The form * @return {String} The url encoded form */ serializeForm: function(form) { var fElements = form.elements || (document.forms[form] || Ext.getDom(form)).elements, hasSubmit = false, encoder = encodeURIComponent, data = '', eLen = fElements.length, element, name, type, options, hasValue, e, o, oLen, opt; for (e = 0; e < eLen; e++) { element = fElements[e]; name = element.name; type = element.type; options = element.options; if (!element.disabled && name) { if (/select-(one|multiple)/i.test(type)) { oLen = options.length; for (o = 0; o < oLen; o++) { opt = options[o]; if (opt.selected) { hasValue = opt.hasAttribute ? opt.hasAttribute('value') : opt.getAttributeNode('value').specified; data += Ext.String.format("{0}={1}&", encoder(name), encoder(hasValue ? opt.value : opt.text)); } } } else if (!(/file|undefined|reset|button/i.test(type))) { if (!(/radio|checkbox/i.test(type) && !element.checked) && !(type == 'submit' && hasSubmit)) { data += encoder(name) + '=' + encoder(element.value) + '&'; hasSubmit = /submit/i.test(type); } } } } return data.substr(0, data.length - 1); } }); }); // @tag dom,core /** */ Ext.define('Ext.dom.AbstractElement_insertion', { override: 'Ext.dom.AbstractElement', /** * Appends the passed element(s) to this element * @param {String/HTMLElement/Ext.dom.AbstractElement/Object} el The id or element to insert or a DomHelper config * The id of the node, a DOM Node or an existing Element. * @param {Boolean} [returnDom=false] True to return the raw DOM element instead of Ext.dom.AbstractElement * @return {Ext.dom.AbstractElement} The inserted Element. */ appendChild: function(el, returnDom) { var me = this, insertEl, eLen, e, oldUseDom; if (el.nodeType || el.dom || typeof el == 'string') { // element el = Ext.getDom(el); me.dom.appendChild(el); return !returnDom ? Ext.get(el) : el; } else if (el.length) { // append all elements to a documentFragment insertEl = Ext.fly(document.createDocumentFragment(), '_internal'); eLen = el.length; // DocumentFragments cannot accept innerHTML Ext.DomHelper.useDom = true; for (e = 0; e < eLen; e++) { insertEl.appendChild(el[e], returnDom); } Ext.DomHelper.useDom = oldUseDom; me.dom.appendChild(insertEl.dom); return returnDom ? insertEl.dom : insertEl; } else { // dh config return me.createChild(el, null, returnDom); } }, /** * Appends this element to the passed element * @param {String/HTMLElement/Ext.dom.AbstractElement} el The new parent element. * The id of the node, a DOM Node or an existing Element. * @return {Ext.dom.AbstractElement} This element */ appendTo: function(el) { Ext.getDom(el).appendChild(this.dom); return this; }, /** * Inserts this element before the passed element in the DOM * @param {String/HTMLElement/Ext.dom.AbstractElement} el The element before which this element will be inserted. * The id of the node, a DOM Node or an existing Element. * @return {Ext.dom.AbstractElement} This element */ insertBefore: function(el) { el = Ext.getDom(el); el.parentNode.insertBefore(this.dom, el); return this; }, /** * Inserts this element after the passed element in the DOM * @param {String/HTMLElement/Ext.dom.AbstractElement} el The element to insert after. * The id of the node, a DOM Node or an existing Element. * @return {Ext.dom.AbstractElement} This element */ insertAfter: function(el) { el = Ext.getDom(el); el.parentNode.insertBefore(this.dom, el.nextSibling); return this; }, /** * Inserts (or creates) an element (or DomHelper config) as the first child of this element * @param {String/HTMLElement/Ext.dom.AbstractElement/Object} el The id or element to insert or a DomHelper config * to create and insert * @return {Ext.dom.AbstractElement} The new child */ insertFirst: function(el, returnDom) { el = el || {}; if (el.nodeType || el.dom || typeof el == 'string') { // element el = Ext.getDom(el); this.dom.insertBefore(el, this.dom.firstChild); return !returnDom ? Ext.get(el) : el; } else { // dh config return this.createChild(el, this.dom.firstChild, returnDom); } }, /** * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element * @param {String/HTMLElement/Ext.dom.AbstractElement/Object/Array} el The id, element to insert or a DomHelper config * to create and insert *or* an array of any of those. * @param {String} [where='before'] 'before' or 'after' * @param {Boolean} [returnDom=false] True to return the raw DOM element instead of Ext.dom.AbstractElement * @return {Ext.dom.AbstractElement} The inserted Element. If an array is passed, the last inserted element is returned. */ insertSibling: function(el, where, returnDom) { var me = this, DomHelper = Ext.core.DomHelper, oldUseDom = DomHelper.useDom, isAfter = (where || 'before').toLowerCase() == 'after', rt, insertEl, eLen, e; if (Ext.isArray(el)) { // append all elements to a documentFragment insertEl = Ext.fly(document.createDocumentFragment(), '_internal'); eLen = el.length; // DocumentFragments cannot accept innerHTML DomHelper.useDom = true; for (e = 0; e < eLen; e++) { rt = insertEl.appendChild(el[e], returnDom); } DomHelper.useDom = oldUseDom; // Insert fragment into document me.dom.parentNode.insertBefore(insertEl.dom, isAfter ? me.dom.nextSibling : me.dom); return rt; } el = el || {}; if (el.nodeType || el.dom) { rt = me.dom.parentNode.insertBefore(Ext.getDom(el), isAfter ? me.dom.nextSibling : me.dom); if (!returnDom) { rt = Ext.get(rt); } } else { if (isAfter && !me.dom.nextSibling) { rt = DomHelper.append(me.dom.parentNode, el, !returnDom); } else { rt = DomHelper[isAfter ? 'insertAfter' : 'insertBefore'](me.dom, el, !returnDom); } } return rt; }, /** * Replaces the passed element with this element * @param {String/HTMLElement/Ext.dom.AbstractElement} el The element to replace. * The id of the node, a DOM Node or an existing Element. * @return {Ext.dom.AbstractElement} This element */ replace: function(el) { el = Ext.get(el); this.insertBefore(el); el.remove(); return this; }, /** * Replaces this element with the passed element * @param {String/HTMLElement/Ext.dom.AbstractElement/Object} el The new element (id of the node, a DOM Node * or an existing Element) or a DomHelper config of an element to create * @return {Ext.dom.AbstractElement} This element */ replaceWith: function(el){ var me = this; if (el.nodeType || el.dom || typeof el == 'string') { el = Ext.get(el); me.dom.parentNode.insertBefore(el.dom, me.dom); } else { el = Ext.core.DomHelper.insertBefore(me.dom, el); } delete Ext.cache[me.id]; Ext.removeNode(me.dom); me.id = Ext.id(me.dom = el); Ext.dom.AbstractElement.addToCache(me.isFlyweight ? new Ext.dom.AbstractElement(me.dom) : me); return me; }, /** * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element. * @param {Object} config DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be * automatically generated with the specified attributes. * @param {HTMLElement} [insertBefore] a child element of this element * @param {Boolean} [returnDom=false] true to return the dom node instead of creating an Element * @return {Ext.dom.AbstractElement} The new child element */ createChild: function(config, insertBefore, returnDom) { config = config || {tag:'div'}; if (insertBefore) { return Ext.core.DomHelper.insertBefore(insertBefore, config, returnDom !== true); } else { return Ext.core.DomHelper.append(this.dom, config, returnDom !== true); } }, /** * Creates and wraps this element with another element * @param {Object} [config] DomHelper element config object for the wrapper element or null for an empty div * @param {Boolean} [returnDom=false] True to return the raw DOM element instead of Ext.dom.AbstractElement * @param {String} [selector] A {@link Ext.dom.Query DomQuery} selector to select a descendant node within the created element to use as the wrapping element. * @return {HTMLElement/Ext.dom.AbstractElement} The newly created wrapper element */ wrap: function(config, returnDom, selector) { var newEl = Ext.core.DomHelper.insertBefore(this.dom, config || {tag: "div"}, true), target = newEl; if (selector) { target = Ext.DomQuery.selectNode(selector, newEl.dom); } target.appendChild(this.dom); return returnDom ? newEl.dom : newEl; }, /** * Inserts an html fragment into this element * @param {String} where Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd. * See {@link Ext.dom.Helper#insertHtml} for details. * @param {String} html The HTML fragment * @param {Boolean} [returnEl=false] True to return an Ext.dom.AbstractElement * @return {HTMLElement/Ext.dom.AbstractElement} The inserted node (or nearest related if more than 1 inserted) */ insertHtml: function(where, html, returnEl) { var el = Ext.core.DomHelper.insertHtml(where, this.dom, html); return returnEl ? Ext.get(el) : el; } }); // @tag dom,core /** */ Ext.define('Ext.dom.AbstractElement_style', { override: 'Ext.dom.AbstractElement' }, function() { // local style camelizing for speed var Element = this, wordsRe = /\w/g, spacesRe = /\s+/, transparentRe = /^(?:transparent|(?:rgba[(](?:\s*\d+\s*[,]){3}\s*0\s*[)]))$/i, // In some browsers, currently IE10 and older chrome versions, when ClassList is // supported most elements will have the classList attribute, but some svg elements // will still not have it present, so in a small amount of cases we'll still need // to check at run time whether we can use it. hasClassList = Ext.supports.ClassList, PADDING = 'padding', MARGIN = 'margin', BORDER = 'border', LEFT_SUFFIX = '-left', RIGHT_SUFFIX = '-right', TOP_SUFFIX = '-top', BOTTOM_SUFFIX = '-bottom', WIDTH = '-width', // special markup used throughout Ext when box wrapping elements borders = {l: BORDER + LEFT_SUFFIX + WIDTH, r: BORDER + RIGHT_SUFFIX + WIDTH, t: BORDER + TOP_SUFFIX + WIDTH, b: BORDER + BOTTOM_SUFFIX + WIDTH}, paddings = {l: PADDING + LEFT_SUFFIX, r: PADDING + RIGHT_SUFFIX, t: PADDING + TOP_SUFFIX, b: PADDING + BOTTOM_SUFFIX}, margins = {l: MARGIN + LEFT_SUFFIX, r: MARGIN + RIGHT_SUFFIX, t: MARGIN + TOP_SUFFIX, b: MARGIN + BOTTOM_SUFFIX}, internalFly = new Element.Fly(); Ext.override(Element, { /** * This shared object is keyed by style name (e.g., 'margin-left' or 'marginLeft'). The * values are objects with the following properties: * * * `name` (String) : The actual name to be presented to the DOM. This is typically the value * returned by {@link #normalize}. * * `get` (Function) : A hook function that will perform the get on this style. These * functions receive "(dom, el)" arguments. The `dom` parameter is the DOM Element * from which to get ths tyle. The `el` argument (may be null) is the Ext.Element. * * `set` (Function) : A hook function that will perform the set on this style. These * functions receive "(dom, value, el)" arguments. The `dom` parameter is the DOM Element * from which to get ths tyle. The `value` parameter is the new value for the style. The * `el` argument (may be null) is the Ext.Element. * * The `this` pointer is the object that contains `get` or `set`, which means that * `this.name` can be accessed if needed. The hook functions are both optional. * @private */ styleHooks: {}, // private addStyles : function(sides, styles){ var totalSize = 0, sidesArr = (sides || '').match(wordsRe), i, len = sidesArr.length, side, styleSides = []; if (len == 1) { totalSize = Math.abs(parseFloat(this.getStyle(styles[sidesArr[0]])) || 0); } else if (len) { for (i = 0; i < len; i++) { side = sidesArr[i]; styleSides.push(styles[side]); } //Gather all at once, returning a hash styleSides = this.getStyle(styleSides); for (i=0; i < len; i++) { side = sidesArr[i]; totalSize += Math.abs(parseFloat(styleSides[styles[side]]) || 0); } } return totalSize; }, /** * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. * @param {String/String[]} className The CSS classes to add separated by space, or an array of classes * @return {Ext.dom.Element} this * @method */ addCls: (function(){ var addWithClassList = function(className) { if (String(className).indexOf('undefined') > -1) { Ext.Logger.warn("called with an undefined className: " + className); } var me = this, dom = me.dom, trimRe = me.trimRe, origClassName = className, classList, newCls, i, len, cls; if (typeof(className) == 'string') { // split string on spaces to make an array of className className = className.replace(trimRe, '').split(spacesRe); } // the gain we have here is that we can skip parsing className and use the // classList.contains method, so now O(M) not O(M+N) if (dom && className && !!(len = className.length)) { if (!dom.className) { dom.className = className.join(' '); } else { classList = dom.classList; if (classList) { for (i = 0; i < len; ++i) { cls = className[i]; if (cls) { if (!classList.contains(cls)) { if (newCls) { newCls.push(cls); } else { newCls = dom.className.replace(trimRe, ''); newCls = newCls ? [newCls, cls] : [cls]; } } } } if (newCls) { dom.className = newCls.join(' '); // write to DOM once } } else { addWithoutClassList(origClassName); } } } return me; }, addWithoutClassList = function(className) { if (String(className).indexOf('undefined') > -1) { Ext.Logger.warn("called with an undefined className: '" + className + "'"); } var me = this, dom = me.dom, elClasses; if (dom && className && className.length) { elClasses = Ext.Element.mergeClsList(dom.className, className); if (elClasses.changed) { dom.className = elClasses.join(' '); // write to DOM once } } return me; }; return hasClassList ? addWithClassList : addWithoutClassList; })(), /** * Removes one or more CSS classes from the element. * @param {String/String[]} className The CSS classes to remove separated by space, or an array of classes * @return {Ext.dom.Element} this */ removeCls: function(className) { var me = this, dom = me.dom, classList, len, elClasses; if (typeof(className) == 'string') { // split string on spaces to make an array of className className = className.replace(me.trimRe, '').split(spacesRe); } if (dom && dom.className && className && !!(len = className.length)) { classList = dom.classList; if (len === 1 && classList) { if (className[0]) { classList.remove(className[0]); // one DOM write } } else { elClasses = Ext.Element.removeCls(dom.className, className); if (elClasses.changed) { dom.className = elClasses.join(' '); } } } return me; }, /** * Adds one or more CSS classes to this element and removes the same class(es) from all siblings. * @param {String/String[]} className The CSS class to add, or an array of classes * @return {Ext.dom.Element} this */ radioCls: function(className) { var cn = this.dom.parentNode.childNodes, v, i, len; className = Ext.isArray(className) ? className: [className]; for (i = 0, len = cn.length; i < len; i++) { v = cn[i]; if (v && v.nodeType == 1) { internalFly.attach(v).removeCls(className); } } return this.addCls(className); }, /** * Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). * @param {String} className The CSS class to toggle * @return {Ext.dom.Element} this * @method */ toggleCls: (function(){ var toggleWithClassList = function(className){ var me = this, dom = me.dom, classList; if (dom) { className = className.replace(me.trimRe, ''); if (className) { classList = dom.classList; if (classList) { classList.toggle(className); } else { toggleWithoutClassList(className); } } } return me; }, toggleWithoutClassList = function(className){ return this.hasCls(className) ? this.removeCls(className) : this.addCls(className); }; return hasClassList ? toggleWithClassList : toggleWithoutClassList; })(), /** * Checks if the specified CSS class exists on this element's DOM node. * @param {String} className The CSS class to check for * @return {Boolean} True if the class exists, else false * @method */ hasCls: (function(){ var hasClsWithClassList = function(className) { var dom = this.dom, out = false, classList; if (dom && className) { classList = dom.classList; if (classList) { out = classList.contains(className); } else { out = hasClsWithoutClassList(className); } } return out; }, hasClsWithoutClassList = function(className){ var dom = this.dom; return dom ? className && (' '+dom.className+' ').indexOf(' '+className+' ') !== -1 : false; }; return hasClassList ? hasClsWithClassList : hasClsWithoutClassList; })(), /** * Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. * @param {String} oldClassName The CSS class to replace * @param {String} newClassName The replacement CSS class * @return {Ext.dom.Element} this */ replaceCls: function(oldClassName, newClassName){ return this.removeCls(oldClassName).addCls(newClassName); }, /** * Checks if the current value of a style is equal to a given value. * @param {String} style property whose value is returned. * @param {String} value to check against. * @return {Boolean} true for when the current value equals the given value. */ isStyle: function(style, val) { return this.getStyle(style) == val; }, /** * Returns a named style property based on computed/currentStyle (primary) and * inline-style if primary is not available. * * @param {String/String[]} property The style property (or multiple property names * in an array) whose value is returned. * @param {Boolean} [inline=false] if `true` only inline styles will be returned. * @return {String/Object} The current value of the style property for this element * (or a hash of named style values if multiple property arguments are requested). * @method */ getStyle: function (property, inline) { var me = this, dom = me.dom, multiple = typeof property != 'string', hooks = me.styleHooks, prop = property, props = prop, len = 1, domStyle, camel, values, hook, out, style, i; if (multiple) { values = {}; prop = props[0]; i = 0; if (!(len = props.length)) { return values; } } if (!dom || dom.documentElement) { return values || ''; } domStyle = dom.style; if (inline) { style = domStyle; } else { // Caution: Firefox will not render "presentation" (ie. computed styles) in // iframes that are display:none or those inheriting display:none. Similar // issues with legacy Safari. // style = dom.ownerDocument.defaultView.getComputedStyle(dom, null); // fallback to inline style if rendering context not available if (!style) { inline = true; style = domStyle; } } do { hook = hooks[prop]; if (!hook) { hooks[prop] = hook = { name: Element.normalize(prop) }; } if (hook.get) { out = hook.get(dom, me, inline, style); } else { camel = hook.name; out = style[camel]; } if (!multiple) { return out; } values[prop] = out; prop = props[++i]; } while (i < len); return values; }, getStyles: function () { var props = Ext.Array.slice(arguments), len = props.length, inline; if (len && typeof props[len-1] == 'boolean') { inline = props.pop(); } return this.getStyle(props, inline); }, /** * Returns true if the value of the given property is visually transparent. This * may be due to a 'transparent' style value or an rgba value with 0 in the alpha * component. * @param {String} prop The style property whose value is to be tested. * @return {Boolean} True if the style property is visually transparent. */ isTransparent: function (prop) { var value = this.getStyle(prop); return value ? transparentRe.test(value) : false; }, /** * Wrapper for setting style properties, also takes single object parameter of multiple styles. * @param {String/Object} property The style property to be set, or an object of multiple styles. * @param {String} [value] The value to apply to the given property, or null if an object was passed. * @return {Ext.dom.Element} this */ setStyle: function(prop, value) { var me = this, dom = me.dom, hooks = me.styleHooks, style = dom.style, name = prop, hook; // we don't promote the 2-arg form to object-form to avoid the overhead... if (typeof name == 'string') { hook = hooks[name]; if (!hook) { hooks[name] = hook = { name: Element.normalize(name) }; } value = (value == null) ? '' : value; if (hook.set) { hook.set(dom, value, me); } else { style[hook.name] = value; } if (hook.afterSet) { hook.afterSet(dom, value, me); } } else { for (name in prop) { if (prop.hasOwnProperty(name)) { hook = hooks[name]; if (!hook) { hooks[name] = hook = { name: Element.normalize(name) }; } value = prop[name]; value = (value == null) ? '' : value; if (hook.set) { hook.set(dom, value, me); } else { style[hook.name] = value; } if (hook.afterSet) { hook.afterSet(dom, value, me); } } } } return me; }, /** * Returns the offset height of the element * @param {Boolean} [contentHeight] true to get the height minus borders and padding * @return {Number} The element's height */ getHeight: function(contentHeight) { var dom = this.dom, height = contentHeight ? (dom.clientHeight - this.getPadding("tb")) : dom.offsetHeight; return height > 0 ? height: 0; }, /** * Returns the offset width of the element * @param {Boolean} [contentWidth] true to get the width minus borders and padding * @return {Number} The element's width */ getWidth: function(contentWidth) { var dom = this.dom, width = contentWidth ? (dom.clientWidth - this.getPadding("lr")) : dom.offsetWidth; return width > 0 ? width: 0; }, /** * Set the width of this Element. * @param {Number/String} width The new width. This may be one of: * * - A Number specifying the new width in this Element's {@link #defaultUnit}s (by default, pixels). * - A String used to set the CSS width style. Animation may **not** be used. * * @return {Ext.dom.Element} this */ setWidth: function(width) { var me = this; me.dom.style.width = Element.addUnits(width); return me; }, /** * Set the height of this Element. * * // change the height to 200px and animate with default configuration * Ext.fly('elementId').setHeight(200, true); * * // change the height to 150px and animate with a custom configuration * Ext.fly('elId').setHeight(150, { * duration : 500, // animation will have a duration of .5 seconds * // will change the content to "finished" * callback: function(){ this.{@link #update}("finished"); } * }); * * @param {Number/String} height The new height. This may be one of: * * - A Number specifying the new height in this Element's {@link #defaultUnit}s (by default, pixels.) * - A String used to set the CSS height style. Animation may **not** be used. * * @return {Ext.dom.Element} this */ setHeight: function(height) { var me = this; me.dom.style.height = Element.addUnits(height); return me; }, /** * Gets the width of the border(s) for the specified side(s) * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example, * passing `'lr'` would get the border **l**eft width + the border **r**ight width. * @return {Number} The width of the sides passed added together */ getBorderWidth: function(side){ return this.addStyles(side, borders); }, /** * Gets the width of the padding(s) for the specified side(s) * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example, * passing `'lr'` would get the padding **l**eft + the padding **r**ight. * @return {Number} The padding of the sides passed added together */ getPadding: function(side){ return this.addStyles(side, paddings); }, margins : margins, /** * More flexible version of {@link #setStyle} for setting style properties. * @param {String/Object/Function} styles A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or * a function which returns such a specification. * @return {Ext.dom.Element} this */ applyStyles: function(styles) { if (styles) { var i, len, dom = this.dom; if (typeof styles == 'function') { styles = styles.call(); } if (typeof styles == 'string') { styles = Ext.util.Format.trim(styles).split(/\s*(?::|;)\s*/); for (i = 0, len = styles.length; i < len;) { dom.style[Element.normalize(styles[i++])] = styles[i++]; } } else if (typeof styles == 'object') { this.setStyle(styles); } } }, /** * Set the size of this Element. If animation is true, both width and height will be animated concurrently. * @param {Number/String} width The new width. This may be one of: * * - A Number specifying the new width in this Element's {@link #defaultUnit}s (by default, pixels). * - A String used to set the CSS width style. Animation may **not** be used. * - A size object in the format `{width: widthValue, height: heightValue}`. * * @param {Number/String} height The new height. This may be one of: * * - A Number specifying the new height in this Element's {@link #defaultUnit}s (by default, pixels). * - A String used to set the CSS height style. Animation may **not** be used. * * @return {Ext.dom.Element} this */ setSize: function(width, height) { var me = this, style = me.dom.style; if (Ext.isObject(width)) { // in case of object from getSize() height = width.height; width = width.width; } style.width = Element.addUnits(width); style.height = Element.addUnits(height); return me; }, /** * Returns the dimensions of the element available to lay content out in. * * If the element (or any ancestor element) has CSS style `display: none`, the dimensions will be zero. * * Example: * * var vpSize = Ext.getBody().getViewSize(); * * // all Windows created afterwards will have a default value of 90% height and 95% width * Ext.Window.override({ * width: vpSize.width * 0.9, * height: vpSize.height * 0.95 * }); * // To handle window resizing you would have to hook onto onWindowResize. * * getViewSize utilizes clientHeight/clientWidth which excludes sizing of scrollbars. * To obtain the size including scrollbars, use getStyleSize * * Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc. * * @return {Object} Object describing width and height. * @return {Number} return.width * @return {Number} return.height */ getViewSize: function() { var doc = document, dom = this.dom; if (dom == doc || dom == doc.body) { return { width: Element.getViewportWidth(), height: Element.getViewportHeight() }; } else { return { width: dom.clientWidth, height: dom.clientHeight }; } }, /** * Returns the size of the element. * @param {Boolean} [contentSize] true to get the width/size minus borders and padding * @return {Object} An object containing the element's size: * @return {Number} return.width * @return {Number} return.height */ getSize: function(contentSize) { var dom = this.dom; return { width: Math.max(0, contentSize ? (dom.clientWidth - this.getPadding("lr")) : dom.offsetWidth), height: Math.max(0, contentSize ? (dom.clientHeight - this.getPadding("tb")) : dom.offsetHeight) }; }, /** * Forces the browser to repaint this element * @return {Ext.dom.Element} this */ repaint: function() { var dom = this.dom; this.addCls(Ext.baseCSSPrefix + 'repaint'); setTimeout(function(){ internalFly.attach(dom).removeCls(Ext.baseCSSPrefix + 'repaint'); }, 1); return this; }, /** * Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed, * then it returns the calculated width of the sides (see getPadding) * @param {String} [sides] Any combination of l, r, t, b to get the sum of those sides * @return {Object/Number} */ getMargin: function(side){ var me = this, hash = {t:"top", l:"left", r:"right", b: "bottom"}, key, o, margins; if (!side) { margins = []; for (key in me.margins) { if(me.margins.hasOwnProperty(key)) { margins.push(me.margins[key]); } } o = me.getStyle(margins); if(o && typeof o == 'object') { //now mixin nomalized values (from hash table) for (key in me.margins) { if(me.margins.hasOwnProperty(key)) { o[hash[key]] = parseFloat(o[me.margins[key]]) || 0; } } } return o; } else { return me.addStyles(side, me.margins); } }, /** * Puts a mask over this element to disable user interaction. Requires core.css. * This method can only be applied to elements which accept child nodes. * @param {String} [msg] A message to display in the mask * @param {String} [msgCls] A css class to apply to the msg element */ mask: function(msg, msgCls, transparent) { var me = this, dom = me.dom, data = (me.$cache || me.getCache()).data, el = data.mask, mask, size, cls = '', prefix = Ext.baseCSSPrefix; me.addCls(prefix + 'masked'); if (me.getStyle("position") == "static") { me.addCls(prefix + 'masked-relative'); } if (el) { el.remove(); } if (msgCls && typeof msgCls == 'string' ) { cls = ' ' + msgCls; } else { cls = ' ' + prefix + 'mask-gray'; } mask = me.createChild({ cls: prefix + 'mask' + ((transparent !== false) ? '' : (' ' + prefix + 'mask-gray')), html: msg ? ('
' + msg + '
') : '' }); size = me.getSize(); data.mask = mask; if (dom === document.body) { size.height = window.innerHeight; if (me.orientationHandler) { Ext.EventManager.unOrientationChange(me.orientationHandler, me); } me.orientationHandler = function() { size = me.getSize(); size.height = window.innerHeight; mask.setSize(size); }; Ext.EventManager.onOrientationChange(me.orientationHandler, me); } mask.setSize(size); if (Ext.is.iPad) { Ext.repaint(); } }, /** * Removes a previously applied mask. */ unmask: function() { var me = this, data = (me.$cache || me.getCache()).data, mask = data.mask, prefix = Ext.baseCSSPrefix; if (mask) { mask.remove(); delete data.mask; } me.removeCls([prefix + 'masked', prefix + 'masked-relative']); if (me.dom === document.body) { Ext.EventManager.unOrientationChange(me.orientationHandler, me); delete me.orientationHandler; } } }); Ext.onReady(function () { var supports = Ext.supports, styleHooks, colorStyles, i, name, camel; function fixTransparent (dom, el, inline, style) { var value = style[this.name] || ''; return transparentRe.test(value) ? 'transparent' : value; } function fixRightMargin (dom, el, inline, style) { var result = style.marginRight, domStyle, display; // Ignore cases when the margin is correctly reported as 0, the bug only shows // numbers larger. if (result != '0px') { domStyle = dom.style; display = domStyle.display; domStyle.display = 'inline-block'; result = (inline ? style : dom.ownerDocument.defaultView.getComputedStyle(dom, null)).marginRight; domStyle.display = display; } return result; } function fixRightMarginAndInputFocus (dom, el, inline, style) { var result = style.marginRight, domStyle, cleaner, display; if (result != '0px') { domStyle = dom.style; cleaner = Element.getRightMarginFixCleaner(dom); display = domStyle.display; domStyle.display = 'inline-block'; result = (inline ? style : dom.ownerDocument.defaultView.getComputedStyle(dom, '')).marginRight; domStyle.display = display; cleaner(); } return result; } styleHooks = Element.prototype.styleHooks; // Ext.supports needs to be initialized (we run very early in the onready sequence), // but it is OK to call Ext.supports.init() more times than necessary... if (supports.init) { supports.init(); } // Fix bug caused by this: https://bugs.webkit.org/show_bug.cgi?id=13343 if (!supports.RightMargin) { styleHooks.marginRight = styleHooks['margin-right'] = { name: 'marginRight', // TODO - Touch should use conditional compilation here or ensure that the // underlying Ext.supports flags are set correctly... get: (supports.DisplayChangeInputSelectionBug || supports.DisplayChangeTextAreaSelectionBug) ? fixRightMarginAndInputFocus : fixRightMargin }; } if (!supports.TransparentColor) { colorStyles = ['background-color', 'border-color', 'color', 'outline-color']; for (i = colorStyles.length; i--; ) { name = colorStyles[i]; camel = Element.normalize(name); styleHooks[name] = styleHooks[camel] = { name: camel, get: fixTransparent }; } } }); }); // @tag dom,core /** */ Ext.define('Ext.dom.AbstractElement_traversal', { override: 'Ext.dom.AbstractElement', /** * Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) * @param {String} selector The simple selector to test * @param {Number/String/HTMLElement/Ext.Element} [limit] * The max depth to search as a number or an element which causes the upward traversal to stop * and is not considered for inclusion as the result. (defaults to 50 || document.documentElement) * @param {Boolean} [returnEl=false] True to return a Ext.Element object instead of DOM node * @return {HTMLElement} The matching DOM node (or null if no match was found) */ findParent: function(simpleSelector, limit, returnEl) { var target = this.dom, topmost = document.documentElement, depth = 0, stopEl; limit = limit || 50; if (isNaN(limit)) { stopEl = Ext.getDom(limit); limit = Number.MAX_VALUE; } while (target && target.nodeType == 1 && depth < limit && target != topmost && target != stopEl) { if (Ext.DomQuery.is(target, simpleSelector)) { return returnEl ? Ext.get(target) : target; } depth++; target = target.parentNode; } return null; }, /** * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) * @param {String} selector The simple selector to test * @param {Number/String/HTMLElement/Ext.Element} [limit] * The max depth to search as a number or an element which causes the upward traversal to stop * and is not considered for inclusion as the result. (defaults to 50 || document.documentElement) * @param {Boolean} [returnEl=false] True to return a Ext.Element object instead of DOM node * @return {HTMLElement} The matching DOM node (or null if no match was found) */ findParentNode: function(simpleSelector, limit, returnEl) { var p = Ext.fly(this.dom.parentNode, '_internal'); return p ? p.findParent(simpleSelector, limit, returnEl) : null; }, /** * Walks up the DOM looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child). * This is a shortcut for findParentNode() that always returns an Ext.dom.Element. * @param {String} selector The simple selector to test * @param {Number/String/HTMLElement/Ext.Element} [limit] * The max depth to search as a number or an element which causes the upward traversal to stop * and is not considered for inclusion as the result. (defaults to 50 || document.documentElement) * @param {Boolean} [returnDom=false] True to return the DOM node instead of Ext.dom.Element * @return {Ext.Element} The matching DOM node (or null if no match was found) */ up: function(simpleSelector, limit, returnDom) { return this.findParentNode(simpleSelector, limit, !returnDom); }, /** * Creates a {@link Ext.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id). * @param {String} selector The CSS selector * @param {Boolean} [unique] True to create a unique Ext.Element for each element. Defaults to a shared flyweight object. * @return {Ext.CompositeElement} The composite element */ select: function(selector, composite) { return Ext.dom.Element.select(selector, this.dom, composite); }, /** * Selects child nodes based on the passed CSS selector (the selector should not contain an id). * @param {String} selector The CSS selector * @return {HTMLElement[]} An array of the matched nodes */ query: function(selector) { return Ext.DomQuery.select(selector, this.dom); }, /** * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). * @param {String} selector The CSS selector * @param {Boolean} [returnDom=false] True to return the DOM node instead of Ext.dom.Element * @return {HTMLElement/Ext.dom.Element} The child Ext.dom.Element (or DOM node if returnDom = true) */ down: function(selector, returnDom) { var n = Ext.DomQuery.selectNode(selector, this.dom); return returnDom ? n : Ext.get(n); }, /** * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id). * @param {String} selector The CSS selector * @param {Boolean} [returnDom=false] True to return the DOM node instead of Ext.dom.Element. * @return {HTMLElement/Ext.dom.Element} The child Ext.dom.Element (or DOM node if returnDom = true) */ child: function(selector, returnDom) { var node, me = this, id; // Pull the ID from the DOM (Ext.id also ensures that there *is* an ID). // If this object is a Flyweight, it will not have an ID id = Ext.id(me.dom); // Escape "invalid" chars id = Ext.escapeId(id); node = Ext.DomQuery.selectNode('#' + id + " > " + selector, me.dom); return returnDom ? node : Ext.get(node); }, /** * Gets the parent node for this element, optionally chaining up trying to match a selector * @param {String} [selector] Find a parent node that matches the passed simple selector * @param {Boolean} [returnDom=false] True to return a raw dom node instead of an Ext.dom.Element * @return {Ext.dom.Element/HTMLElement} The parent node or null */ parent: function(selector, returnDom) { return this.matchNode('parentNode', 'parentNode', selector, returnDom); }, /** * Gets the next sibling, skipping text nodes * @param {String} [selector] Find the next sibling that matches the passed simple selector * @param {Boolean} [returnDom=false] True to return a raw dom node instead of an Ext.dom.Element * @return {Ext.dom.Element/HTMLElement} The next sibling or null */ next: function(selector, returnDom) { return this.matchNode('nextSibling', 'nextSibling', selector, returnDom); }, /** * Gets the previous sibling, skipping text nodes * @param {String} [selector] Find the previous sibling that matches the passed simple selector * @param {Boolean} [returnDom=false] True to return a raw dom node instead of an Ext.dom.Element * @return {Ext.dom.Element/HTMLElement} The previous sibling or null */ prev: function(selector, returnDom) { return this.matchNode('previousSibling', 'previousSibling', selector, returnDom); }, /** * Gets the first child, skipping text nodes * @param {String} [selector] Find the next sibling that matches the passed simple selector * @param {Boolean} [returnDom=false] True to return a raw dom node instead of an Ext.dom.Element * @return {Ext.dom.Element/HTMLElement} The first child or null */ first: function(selector, returnDom) { return this.matchNode('nextSibling', 'firstChild', selector, returnDom); }, /** * Gets the last child, skipping text nodes * @param {String} [selector] Find the previous sibling that matches the passed simple selector * @param {Boolean} [returnDom=false] True to return a raw dom node instead of an Ext.dom.Element * @return {Ext.dom.Element/HTMLElement} The last child or null */ last: function(selector, returnDom) { return this.matchNode('previousSibling', 'lastChild', selector, returnDom); }, matchNode: function(dir, start, selector, returnDom) { if (!this.dom) { return null; } var n = this.dom[start]; while (n) { if (n.nodeType == 1 && (!selector || Ext.DomQuery.is(n, selector))) { return !returnDom ? Ext.get(n) : n; } n = n[dir]; } return null; }, isAncestor: function(element) { return this.self.isAncestor.call(this.self, this.dom, element); } }); // @tag dom,core // @require Ext.Supports /** * @private */ Ext.define('Ext.dom.AbstractElement', { trimRe: /^\s+|\s+$/g, whitespaceRe: /\s/, inheritableStatics: { trimRe: /^\s+|\s+$/g, whitespaceRe: /\s/, /** * Retrieves Ext.dom.Element objects. {@link Ext#get} is alias for {@link Ext.dom.Element#get}. * * **This method does not retrieve {@link Ext.Component Component}s.** This method retrieves Ext.dom.Element * objects which encapsulate DOM elements. To retrieve a Component by its ID, use {@link Ext.ComponentManager#get}. * * When passing an id, it should not include the `#` character that is used for a css selector. * * // For an element with id 'foo' * Ext.get('foo'); // Correct * Ext.get('#foo'); // Incorrect * * Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with * the same id via AJAX or DOM. * * @param {String/HTMLElement/Ext.Element} el The id of the node, a DOM Node or an existing Element. * @return {Ext.dom.Element} The Element object (or null if no matching element was found) * @static * @inheritable */ get: function(el) { var me = this, document = window.document, El = Ext.dom.Element, cacheItem, docEl, extEl, dom, id; if (!el) { return null; } // Ext.get(flyweight) must return an Element instance, not the flyweight if (el.isFly) { el = el.dom; } if (typeof el == "string") { // element id if (el == Ext.windowId) { return El.get(window); } else if (el == Ext.documentId) { return El.get(document); } cacheItem = Ext.cache[el]; // This code is here to catch the case where we've got a reference to a document of an iframe // It getElementById will fail because it's not part of the document, so if we're skipping // GC it means it's a window/document object that isn't the default window/document, which we have // already handled above if (cacheItem && cacheItem.skipGarbageCollection) { extEl = cacheItem.el; return extEl; } if (!(dom = document.getElementById(el))) { return null; } if (cacheItem && cacheItem.el) { extEl = Ext.updateCacheEntry(cacheItem, dom).el; } else { // Force new element if there's a cache but no el attached extEl = new El(dom, !!cacheItem); } return extEl; } else if (el.tagName) { // dom element if (!(id = el.id)) { id = Ext.id(el); } cacheItem = Ext.cache[id]; if (cacheItem && cacheItem.el) { extEl = Ext.updateCacheEntry(cacheItem, el).el; } else { // Force new element if there's a cache but no el attached extEl = new El(el, !!cacheItem); } return extEl; } else if (el instanceof me) { if (el != me.docEl && el != me.winEl) { id = el.id; // refresh dom element in case no longer valid, // catch case where it hasn't been appended cacheItem = Ext.cache[id]; if (cacheItem) { Ext.updateCacheEntry(cacheItem, document.getElementById(id) || el.dom); } } return el; } else if (el.isComposite) { return el; } else if (Ext.isArray(el)) { return me.select(el); } else if (el === document) { // create a bogus element object representing the document object if (!me.docEl) { docEl = me.docEl = Ext.Object.chain(El.prototype); docEl.dom = document; // set an "el" property on the element that references itself. // This allows Ext.util.Positionable methods to operate on // this.el.dom since it gets mixed into both Element and Component docEl.el = docEl; docEl.id = Ext.id(document); me.addToCache(docEl); } return me.docEl; } else if (el === window) { if (!me.winEl) { me.winEl = Ext.Object.chain(El.prototype); me.winEl.dom = window; me.winEl.id = Ext.id(window); me.addToCache(me.winEl); } return me.winEl; } return null; }, addToCache: function(el, id) { if (el) { Ext.addCacheEntry(id, el); } return el; }, addMethods: function() { this.override.apply(this, arguments); }, /** *

Returns an array of unique class names based upon the input strings, or string arrays.

*

The number of parameters is unlimited.

*

Example


// Add x-invalid and x-mandatory classes, do not duplicate
myElement.dom.className = Ext.core.Element.mergeClsList(this.initialClasses, 'x-invalid x-mandatory');
* @param {Mixed} clsList1 A string of class names, or an array of class names. * @param {Mixed} clsList2 A string of class names, or an array of class names. * @return {Array} An array of strings representing remaining unique, merged class names. If class names were added to the first list, the changed property will be true. * @static * @inheritable */ mergeClsList: function() { var clsList, clsHash = {}, i, length, j, listLength, clsName, result = [], changed = false, trimRe = this.trimRe, whitespaceRe = this.whitespaceRe; for (i = 0, length = arguments.length; i < length; i++) { clsList = arguments[i]; if (Ext.isString(clsList)) { clsList = clsList.replace(trimRe, '').split(whitespaceRe); } if (clsList) { for (j = 0, listLength = clsList.length; j < listLength; j++) { clsName = clsList[j]; if (!clsHash[clsName]) { if (i) { changed = true; } clsHash[clsName] = true; } } } } for (clsName in clsHash) { result.push(clsName); } result.changed = changed; return result; }, /** *

Returns an array of unique class names deom the first parameter with all class names * from the second parameter removed.

*

Example


// Remove x-invalid and x-mandatory classes if present.
myElement.dom.className = Ext.core.Element.removeCls(this.initialClasses, 'x-invalid x-mandatory');
* @param {Mixed} existingClsList A string of class names, or an array of class names. * @param {Mixed} removeClsList A string of class names, or an array of class names to remove from existingClsList. * @return {Array} An array of strings representing remaining class names. If class names were removed, the changed property will be true. * @static * @inheritable */ removeCls: function(existingClsList, removeClsList) { var clsHash = {}, i, length, clsName, result = [], changed = false, whitespaceRe = this.whitespaceRe; if (existingClsList) { if (Ext.isString(existingClsList)) { existingClsList = existingClsList.replace(this.trimRe, '').split(whitespaceRe); } for (i = 0, length = existingClsList.length; i < length; i++) { clsHash[existingClsList[i]] = true; } } if (removeClsList) { if (Ext.isString(removeClsList)) { removeClsList = removeClsList.split(whitespaceRe); } for (i = 0, length = removeClsList.length; i < length; i++) { clsName = removeClsList[i]; if (clsHash[clsName]) { changed = true; delete clsHash[clsName]; } } } for (clsName in clsHash) { result.push(clsName); } result.changed = changed; return result; }, /** * @property {Number} * Visibility mode constant for use with {@link Ext.dom.Element#setVisibilityMode}. * Use the CSS 'visibility' property to hide the element. * * Note that in this mode, {@link Ext.dom.Element#isVisible isVisible} may return true * for an element even though it actually has a parent element that is hidden. For this * reason, and in most cases, using the {@link #OFFSETS} mode is a better choice. * @static * @inheritable */ VISIBILITY: 1, /** * @property {Number} * Visibility mode constant for use with {@link Ext.dom.Element#setVisibilityMode}. * Use the CSS 'display' property to hide the element. * @static * @inheritable */ DISPLAY: 2, /** * @property {Number} * Visibility mode constant for use with {@link Ext.dom.Element#setVisibilityMode}. * Use CSS absolute positioning and top/left offsets to hide the element. * @static * @inheritable */ OFFSETS: 3, /** * @property {Number} * Visibility mode constant for use with {@link Ext.dom.Element#setVisibilityMode}. * Add or remove the {@link Ext.Layer#visibilityCls} class to hide the element. * @static * @inheritable */ ASCLASS: 4 }, constructor: function(element, forceNew) { var me = this, dom = typeof element == 'string' ? document.getElementById(element) : element, id; // set an "el" property that references "this". This allows // Ext.util.Positionable methods to operate on this.el.dom since it // gets mixed into both Element and Component me.el = me; if (!dom) { return null; } id = dom.id; if (!forceNew && id && Ext.cache[id]) { // element object already exists return Ext.cache[id].el; } /** * @property {HTMLElement} dom * The DOM element */ me.dom = dom; /** * @property {String} id * The DOM element ID */ me.id = id || Ext.id(dom); me.self.addToCache(me); }, /** * Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function) * @param {Object} o The object with the attributes * @param {Boolean} [useSet=true] false to override the default setAttribute to use expandos. * @return {Ext.dom.Element} this */ set: function(o, useSet) { var el = this.dom, attr, value; for (attr in o) { if (o.hasOwnProperty(attr)) { value = o[attr]; if (attr == 'style') { this.applyStyles(value); } else if (attr == 'cls') { el.className = value; } else if (useSet !== false) { if (value === undefined) { el.removeAttribute(attr); } else { el.setAttribute(attr, value); } } else { el[attr] = value; } } } return this; }, /** * @property {String} defaultUnit * The default unit to append to CSS values where a unit isn't provided. */ defaultUnit: "px", /** * Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) * @param {String} selector The simple selector to test * @return {Boolean} True if this element matches the selector, else false */ is: function(simpleSelector) { return Ext.DomQuery.is(this.dom, simpleSelector); }, /** * Returns the value of the "value" attribute * @param {Boolean} asNumber true to parse the value as a number * @return {String/Number} */ getValue: function(asNumber) { var val = this.dom.value; return asNumber ? parseInt(val, 10) : val; }, /** * Removes this element's dom reference. Note that event and cache removal is handled at {@link Ext#removeNode * Ext.removeNode} */ remove: function() { var me = this, dom = me.dom; if (me.isAnimate) { me.stopAnimation(); } if (dom) { Ext.removeNode(dom); delete me.dom; } }, /** * Returns true if this element is an ancestor of the passed element * @param {HTMLElement/String} el The element to check * @return {Boolean} True if this element is an ancestor of el, else false */ contains: function(el) { if (!el) { return false; } var me = this, dom = el.dom || el; // we need el-contains-itself logic here because isAncestor does not do that: return (dom === me.dom) || Ext.dom.AbstractElement.isAncestor(me.dom, dom); }, /** * Returns the value of an attribute from the element's underlying DOM node. * @param {String} name The attribute name * @param {String} [namespace] The namespace in which to look for the attribute * @return {String} The attribute value */ getAttribute: function(name, ns) { var dom = this.dom; return dom.getAttributeNS(ns, name) || dom.getAttribute(ns + ":" + name) || dom.getAttribute(name) || dom[name]; }, /** * Update the innerHTML of this element * @param {String} html The new HTML * @return {Ext.dom.Element} this */ update: function(html) { if (this.dom) { this.dom.innerHTML = html; } return this; }, /** * Set the innerHTML of this element * @param {String} html The new HTML * @return {Ext.Element} this */ setHTML: function(html) { if(this.dom) { this.dom.innerHTML = html; } return this; }, /** * Returns the innerHTML of an Element or an empty string if the element's * dom no longer exists. */ getHTML: function() { return this.dom ? this.dom.innerHTML : ''; }, /** * Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}. * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object * @return {Ext.Element} this */ hide: function() { this.setVisible(false); return this; }, /** * Show this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}. * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object * @return {Ext.Element} this */ show: function() { this.setVisible(true); return this; }, /** * Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use * the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property. * @param {Boolean} visible Whether the element is visible * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object * @return {Ext.Element} this */ setVisible: function(visible, animate) { var me = this, statics = me.self, mode = me.getVisibilityMode(), prefix = Ext.baseCSSPrefix; switch (mode) { case statics.VISIBILITY: me.removeCls([prefix + 'hidden-display', prefix + 'hidden-offsets']); me[visible ? 'removeCls' : 'addCls'](prefix + 'hidden-visibility'); break; case statics.DISPLAY: me.removeCls([prefix + 'hidden-visibility', prefix + 'hidden-offsets']); me[visible ? 'removeCls' : 'addCls'](prefix + 'hidden-display'); break; case statics.OFFSETS: me.removeCls([prefix + 'hidden-visibility', prefix + 'hidden-display']); me[visible ? 'removeCls' : 'addCls'](prefix + 'hidden-offsets'); break; } return me; }, getVisibilityMode: function() { // Only flyweights won't have a $cache object, by calling getCache the cache // will be created for future accesses. As such, we're eliminating the method // call since it's mostly redundant var data = (this.$cache || this.getCache()).data, visMode = data.visibilityMode; if (visMode === undefined) { data.visibilityMode = visMode = this.self.DISPLAY; } return visMode; }, /** * Use this to change the visibility mode between {@link #VISIBILITY}, {@link #DISPLAY}, {@link #OFFSETS} or {@link #ASCLASS}. */ setVisibilityMode: function(mode) { (this.$cache || this.getCache()).data.visibilityMode = mode; return this; }, getCache: function() { var me = this, id = me.dom.id || Ext.id(me.dom); // Note that we do not assign an ID to the calling object here. // An Ext.dom.Element will have one assigned at construction, and an Ext.dom.Element.Fly must not have one. // We assign an ID to the DOM element if it does not have one. me.$cache = Ext.cache[id] || Ext.addCacheEntry(id, null, me.dom); return me.$cache; } }, function() { var AbstractElement = this; /** * @private * @member Ext */ Ext.getDetachedBody = function () { var detachedEl = AbstractElement.detachedBodyEl; if (!detachedEl) { detachedEl = document.createElement('div'); AbstractElement.detachedBodyEl = detachedEl = new AbstractElement.Fly(detachedEl); detachedEl.isDetachedBody = true; } return detachedEl; }; /** * @private * @member Ext */ Ext.getElementById = function (id) { var el = document.getElementById(id), detachedBodyEl; if (!el && (detachedBodyEl = AbstractElement.detachedBodyEl)) { el = detachedBodyEl.dom.querySelector('#' + Ext.escapeId(id)); } return el; }; /** * @member Ext * @method get * @inheritdoc Ext.dom.Element#get */ Ext.get = function(el) { return Ext.dom.Element.get(el); }; this.addStatics({ /** * @class Ext.dom.Element.Fly * @alternateClassName Ext.dom.AbstractElement.Fly * @extends Ext.dom.Element * * A non-persistent wrapper for a DOM element which may be used to execute methods of {@link Ext.dom.Element} * upon a DOM element without creating an instance of {@link Ext.dom.Element}. * * A **singleton** instance of this class is returned when you use {@link Ext#fly} * * Because it is a singleton, this Flyweight does not have an ID, and must be used and discarded in a single line. * You should not keep and use the reference to this singleton over multiple lines because methods that you call * may themselves make use of {@link Ext#fly} and may change the DOM element to which the instance refers. */ Fly: new Ext.Class({ // Although here the class is extending from AbstractElement, // the class will be overwritten by Element definition with // a class extending from Element instead. // Therefore above we document it as extending Ext.Element. extend: AbstractElement, /** * @property {Boolean} isFly * This is `true` to identify Element flyweights */ isFly: true, constructor: function(dom) { this.dom = dom; // set an "el" property that references "this". This allows // Ext.util.Positionable methods to operate on this.el.dom since it // gets mixed into both Element and Component this.el = this; }, /** * @private * Attach this fliyweight instance to the passed DOM element. * * Note that a flightweight does **not** have an ID, and does not acquire the ID of the DOM element. */ attach: function (dom) { // Attach to the passed DOM element. The same code as in Ext.Fly this.dom = dom; // Use cached data if there is existing cached data for the referenced DOM element, // otherwise it will be created when needed by getCache. this.$cache = dom.id ? Ext.cache[dom.id] : null; return this; } }), _flyweights: {}, /** * Gets the singleton {@link Ext.dom.Element.Fly flyweight} element, with the passed node as the active element. * * Because it is a singleton, this Flyweight does not have an ID, and must be used and discarded in a single line. * You may not keep and use the reference to this singleton over multiple lines because methods that you call * may themselves make use of {@link Ext#fly} and may change the DOM element to which the instance refers. * * {@link Ext#fly} is alias for {@link Ext.dom.AbstractElement#fly}. * * Use this to make one-time references to DOM elements which are not going to be accessed again either by * application code, or by Ext's classes. If accessing an element which will be processed regularly, then {@link * Ext#get Ext.get} will be more appropriate to take advantage of the caching provided by the Ext.dom.Element * class. * * @param {String/HTMLElement} dom The dom node or id * @param {String} [named] Allows for creation of named reusable flyweights to prevent conflicts (e.g. * internally Ext uses "_global") * @return {Ext.dom.Element.Fly} The singleton flyweight object (or null if no matching element was found) * @static * @member Ext.dom.AbstractElement */ fly: function(dom, named) { var fly = null, _flyweights = AbstractElement._flyweights; named = named || '_global'; dom = Ext.getDom(dom); if (dom) { fly = _flyweights[named] || (_flyweights[named] = new AbstractElement.Fly()); // Attach to the passed DOM element. // This code performs the same function as Fly.attach, but inline it for efficiency fly.dom = dom; // Use cached data if there is existing cached data for the referenced DOM element, // otherwise it will be created when needed by getCache. fly.$cache = dom.id ? Ext.cache[dom.id] : null; } return fly; } }); /** * @member Ext * @method fly * @inheritdoc Ext.dom.AbstractElement#fly */ Ext.fly = function() { return AbstractElement.fly.apply(AbstractElement, arguments); }; (function (proto) { /** * @method destroy * @member Ext.dom.AbstractElement * @inheritdoc Ext.dom.AbstractElement#remove * Alias to {@link #remove}. */ proto.destroy = proto.remove; /** * Returns a child element of this element given its `id`. * @method getById * @member Ext.dom.AbstractElement * @param {String} id The id of the desired child element. * @param {Boolean} [asDom=false] True to return the DOM element, false to return a * wrapped Element object. */ if (document.querySelector) { proto.getById = function (id, asDom) { // for normal elements getElementById is the best solution, but if the el is // not part of the document.body, we have to resort to querySelector var dom = document.getElementById(id) || this.dom.querySelector('#'+Ext.escapeId(id)); return asDom ? dom : (dom ? Ext.get(dom) : null); }; } else { proto.getById = function (id, asDom) { var dom = document.getElementById(id); return asDom ? dom : (dom ? Ext.get(dom) : null); }; } }(this.prototype)); }); // @tag dom,core // @define Ext.DomHelper // @define Ext.core.DomHelper /** * @class Ext.DomHelper * @extends Ext.dom.Helper * @alternateClassName Ext.core.DomHelper * @singleton * * The DomHelper class provides a layer of abstraction from DOM and transparently supports creating elements via DOM or * using HTML fragments. It also has the ability to create HTML fragment templates from your DOM building code. * * # DomHelper element specification object * * A specification object is used when creating elements. Attributes of this object are assumed to be element * attributes, except for 4 special attributes: * * - **tag** - The tag name of the element. * - **children** or **cn** - An array of the same kind of element definition objects to be created and appended. * These can be nested as deep as you want. * - **cls** - The class attribute of the element. This will end up being either the "class" attribute on a HTML * fragment or className for a DOM node, depending on whether DomHelper is using fragments or DOM. * - **html** - The innerHTML for the element. * * **NOTE:** For other arbitrary attributes, the value will currently **not** be automatically HTML-escaped prior to * building the element's HTML string. This means that if your attribute value contains special characters that would * not normally be allowed in a double-quoted attribute value, you **must** manually HTML-encode it beforehand (see * {@link Ext.String#htmlEncode}) or risk malformed HTML being created. This behavior may change in a future release. * * # Insertion methods * * Commonly used insertion methods: * * - **{@link #append}** * - **{@link #insertBefore}** * - **{@link #insertAfter}** * - **{@link #overwrite}** * - **{@link #createTemplate}** * - **{@link #insertHtml}** * * # Example * * This is an example, where an unordered list with 3 children items is appended to an existing element with * id 'my-div': * * var dh = Ext.DomHelper; // create shorthand alias * // specification object * var spec = { * id: 'my-ul', * tag: 'ul', * cls: 'my-list', * // append children after creating * children: [ // may also specify 'cn' instead of 'children' * {tag: 'li', id: 'item0', html: 'List Item 0'}, * {tag: 'li', id: 'item1', html: 'List Item 1'}, * {tag: 'li', id: 'item2', html: 'List Item 2'} * ] * }; * var list = dh.append( * 'my-div', // the context element 'my-div' can either be the id or the actual node * spec // the specification object * ); * * Element creation specification parameters in this class may also be passed as an Array of specification objects. This * can be used to insert multiple sibling nodes into an existing container very efficiently. For example, to add more * list items to the example above: * * dh.append('my-ul', [ * {tag: 'li', id: 'item3', html: 'List Item 3'}, * {tag: 'li', id: 'item4', html: 'List Item 4'} * ]); * * # Templating * * The real power is in the built-in templating. Instead of creating or appending any elements, {@link #createTemplate} * returns a Template object which can be used over and over to insert new elements. Revisiting the example above, we * could utilize templating this time: * * // create the node * var list = dh.append('my-div', {tag: 'ul', cls: 'my-list'}); * // get template * var tpl = dh.createTemplate({tag: 'li', id: 'item{0}', html: 'List Item {0}'}); * * for(var i = 0; i < 5, i++){ * tpl.append(list, [i]); // use template to append to the actual node * } * * An example using a template: * * var html = '{2}'; * * var tpl = new Ext.DomHelper.createTemplate(html); * tpl.append('blog-roll', ['link1', 'http://www.edspencer.net/', "Ed's Site"]); * tpl.append('blog-roll', ['link2', 'http://www.dustindiaz.com/', "Dustin's Site"]); * * The same example using named parameters: * * var html = '{text}'; * * var tpl = new Ext.DomHelper.createTemplate(html); * tpl.append('blog-roll', { * id: 'link1', * url: 'http://www.edspencer.net/', * text: "Ed's Site" * }); * tpl.append('blog-roll', { * id: 'link2', * url: 'http://www.dustindiaz.com/', * text: "Dustin's Site" * }); * * # Compiling Templates * * Templates are applied using regular expressions. The performance is great, but if you are adding a bunch of DOM * elements using the same template, you can increase performance even further by {@link Ext.Template#compile * "compiling"} the template. The way "{@link Ext.Template#compile compile()}" works is the template is parsed and * broken up at the different variable points and a dynamic function is created and eval'ed. The generated function * performs string concatenation of these parts and the passed variables instead of using regular expressions. * * var html = '{text}'; * * var tpl = new Ext.DomHelper.createTemplate(html); * tpl.compile(); * * //... use template like normal * * # Performance Boost * * DomHelper will transparently create HTML fragments when it can. Using HTML fragments instead of DOM can significantly * boost performance. * * Element creation specification parameters may also be strings. If {@link #useDom} is false, then the string is used * as innerHTML. If {@link #useDom} is true, a string specification results in the creation of a text node. Usage: * * Ext.DomHelper.useDom = true; // force it to use DOM; reduces performance * */ Ext.define('Ext.dom.Helper', (function() { // kill repeat to save bytes var afterbegin = 'afterbegin', afterend = 'afterend', beforebegin = 'beforebegin', beforeend = 'beforeend', ts = '', te = '
', tbs = ts+'', tbe = ''+te, trs = tbs + '', tre = ''+tbe, detachedDiv = document.createElement('div'), bbValues = ['BeforeBegin', 'previousSibling'], aeValues = ['AfterEnd', 'nextSibling'], bb_ae_PositionHash = { beforebegin: bbValues, afterend: aeValues }, fullPositionHash = { beforebegin: bbValues, afterend: aeValues, afterbegin: ['AfterBegin', 'firstChild'], beforeend: ['BeforeEnd', 'lastChild'] }; /** * @class Ext.dom.Helper * @extends Ext.dom.AbstractHelper * @requires Ext.dom.AbstractElement * * The actual class of which {@link Ext.DomHelper} is instance of. * * Use singleton {@link Ext.DomHelper} instead. * * @private */ return { extend: Ext.dom.AbstractHelper , tableRe: /^(?:table|thead|tbody|tr|td)$/i, tableElRe: /td|tr|tbody|thead/i, /** * @property {Boolean} useDom * True to force the use of DOM instead of html fragments. */ useDom : false, /** * Creates new DOM element(s) without inserting them to the document. * @param {Object/String} o The DOM object spec (and children) or raw HTML blob * @return {HTMLElement} The new uninserted node */ createDom: function(o, parentNode){ var el, doc = document, useSet, attr, val, cn, i, l; if (Ext.isArray(o)) { // Allow Arrays of siblings to be inserted el = doc.createDocumentFragment(); // in one shot using a DocumentFragment for (i = 0, l = o.length; i < l; i++) { this.createDom(o[i], el); } } else if (typeof o == 'string') { // Allow a string as a child spec. el = doc.createTextNode(o); } else { el = doc.createElement(o.tag || 'div'); useSet = !!el.setAttribute; // In IE some elements don't have setAttribute for (attr in o) { if (!this.confRe.test(attr)) { val = o[attr]; if (attr == 'cls') { el.className = val; } else { if (useSet) { el.setAttribute(attr, val); } else { el[attr] = val; } } } } Ext.DomHelper.applyStyles(el, o.style); if ((cn = o.children || o.cn)) { this.createDom(cn, el); } else if (o.html) { el.innerHTML = o.html; } } if (parentNode) { parentNode.appendChild(el); } return el; }, ieTable: function(depth, openingTags, htmlContent, closingTags){ detachedDiv.innerHTML = [openingTags, htmlContent, closingTags].join(''); var i = -1, el = detachedDiv, ns; while (++i < depth) { el = el.firstChild; } // If the result is multiple siblings, then encapsulate them into one fragment. ns = el.nextSibling; if (ns) { ns = el; el = document.createDocumentFragment(); while (ns) { nx = ns.nextSibling; el.appendChild(ns); ns = nx; } } return el; }, /** * @private * Nasty code for IE's broken table implementation */ insertIntoTable: function(tag, where, destinationEl, html) { var node, before, bb = where == beforebegin, ab = where == afterbegin, be = where == beforeend, ae = where == afterend; if (tag == 'td' && (ab || be) || !this.tableElRe.test(tag) && (bb || ae)) { return null; } before = bb ? destinationEl : ae ? destinationEl.nextSibling : ab ? destinationEl.firstChild : null; if (bb || ae) { destinationEl = destinationEl.parentNode; } if (tag == 'td' || (tag == 'tr' && (be || ab))) { node = this.ieTable(4, trs, html, tre); } else if (((tag == 'tbody' || tag == 'thead') && (be || ab)) || (tag == 'tr' && (bb || ae))) { node = this.ieTable(3, tbs, html, tbe); } else { node = this.ieTable(2, ts, html, te); } destinationEl.insertBefore(node, before); return node; }, /** * @private * Fix for IE9 createContextualFragment missing method */ createContextualFragment: function(html) { var fragment = document.createDocumentFragment(), length, childNodes; detachedDiv.innerHTML = html; childNodes = detachedDiv.childNodes; length = childNodes.length; // Move nodes into fragment, don't clone: http://jsperf.com/create-fragment while (length--) { fragment.appendChild(childNodes[0]); } return fragment; }, applyStyles: function(el, styles) { if (styles) { if (typeof styles == "function") { styles = styles.call(); } if (typeof styles == "string") { styles = Ext.dom.Element.parseStyles(styles); } if (typeof styles == "object") { Ext.fly(el, '_applyStyles').setStyle(styles); } } }, /** * Alias for {@link #markup}. * @inheritdoc Ext.dom.AbstractHelper#markup */ createHtml: function(spec) { return this.markup(spec); }, doInsert: function(el, o, returnElement, pos, sibling, append) { el = el.dom || Ext.getDom(el); var newNode; if (this.useDom) { newNode = this.createDom(o, null); if (append) { el.appendChild(newNode); } else { (sibling == 'firstChild' ? el : el.parentNode).insertBefore(newNode, el[sibling] || el); } } else { newNode = this.insertHtml(pos, el, this.markup(o)); } return returnElement ? Ext.get(newNode, true) : newNode; }, /** * Creates new DOM element(s) and overwrites the contents of el with them. * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/String} o The DOM object spec (and children) or raw HTML blob * @param {Boolean} [returnElement] true to return an Ext.Element * @return {HTMLElement/Ext.Element} The new node */ overwrite: function(el, html, returnElement) { var newNode; el = Ext.getDom(el); html = this.markup(html); // IE Inserting HTML into a table/tbody/tr requires extra processing: http://www.ericvasilik.com/2006/07/code-karma.html if (Ext.isIE && this.tableRe.test(el.tagName)) { // Clearing table elements requires removal of all elements. while (el.firstChild) { el.removeChild(el.firstChild); } if (html) { newNode = this.insertHtml('afterbegin', el, html); return returnElement ? Ext.get(newNode) : newNode; } return null; } el.innerHTML = html; return returnElement ? Ext.get(el.firstChild) : el.firstChild; }, insertHtml: function(where, el, html) { var hashVal, range, rangeEl, setStart, frag; where = where.toLowerCase(); // Has fast HTML insertion into existing DOM: http://www.w3.org/TR/html5/apis-in-html-documents.html#insertadjacenthtml if (el.insertAdjacentHTML) { // IE's incomplete table implementation: http://www.ericvasilik.com/2006/07/code-karma.html if (Ext.isIE && this.tableRe.test(el.tagName) && (frag = this.insertIntoTable(el.tagName.toLowerCase(), where, el, html))) { return frag; } if ((hashVal = fullPositionHash[where])) { if (Ext.global.MSApp && Ext.global.MSApp.execUnsafeLocalFunction) { //ALLOW MS TO EXECUTE THIS CODE FOR NATIVE WINDOWS 8 DESKTOP APPS MSApp.execUnsafeLocalFunction(function () { el.insertAdjacentHTML(hashVal[0], html); }); } else { el.insertAdjacentHTML(hashVal[0], html); } return el[hashVal[1]]; } // if (not IE and context element is an HTMLElement) or TextNode } else { // we cannot insert anything inside a textnode so... if (el.nodeType === 3) { where = where === 'afterbegin' ? 'beforebegin' : where; where = where === 'beforeend' ? 'afterend' : where; } range = Ext.supports.CreateContextualFragment ? el.ownerDocument.createRange() : undefined; setStart = 'setStart' + (this.endRe.test(where) ? 'After' : 'Before'); if (bb_ae_PositionHash[where]) { if (range) { range[setStart](el); frag = range.createContextualFragment(html); } else { frag = this.createContextualFragment(html); } el.parentNode.insertBefore(frag, where == beforebegin ? el : el.nextSibling); return el[(where == beforebegin ? 'previous' : 'next') + 'Sibling']; } else { rangeEl = (where == afterbegin ? 'first' : 'last') + 'Child'; if (el.firstChild) { if (range) { range[setStart](el[rangeEl]); frag = range.createContextualFragment(html); } else { frag = this.createContextualFragment(html); } if (where == afterbegin) { el.insertBefore(frag, el.firstChild); } else { el.appendChild(frag); } } else { el.innerHTML = html; } return el[rangeEl]; } } Ext.Error.raise({ sourceClass: 'Ext.DomHelper', sourceMethod: 'insertHtml', htmlToInsert: html, targetElement: el, msg: 'Illegal insertion point reached: "' + where + '"' }); }, /** * Creates a new Ext.Template from the DOM object spec. * @param {Object} o The DOM object spec (and children) * @return {Ext.Template} The new template */ createTemplate: function(o) { var html = this.markup(o); return new Ext.Template(html); } }; })(), function() { Ext.ns('Ext.core'); Ext.DomHelper = Ext.core.DomHelper = new this; }); // @tag core /** * Represents an HTML fragment template. Templates may be {@link #compile precompiled} for greater performance. * * An instance of this class may be created by passing to the constructor either a single argument, or multiple * arguments: * * # Single argument: String/Array * * The single argument may be either a String or an Array: * * - String: * * var t = new Ext.Template("
Hello {0}.
"); * t.{@link #append}('some-element', ['foo']); * * - Array: * * An Array will be combined with `join('')`. * * var t = new Ext.Template([ * '
', * '{name:trim} {value:ellipsis(10)}', * '
', * ]); * t.{@link #compile}(); * t.{@link #append}('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'}); * * # Multiple arguments: String, Object, Array, ... * * Multiple arguments will be combined with `join('')`. * * var t = new Ext.Template( * '
', * '{name} {value}', * '
', * // a configuration object: * { * compiled: true, // {@link #compile} immediately * } * ); * * # Notes * * - For a list of available format functions, see {@link Ext.util.Format}. * - `disableFormats` reduces `{@link #apply}` time when no formatting is required. */ Ext.define('Ext.Template', { /* Begin Definitions */ inheritableStatics: { /** * Creates a template from the passed element's value (_display:none_ textarea, preferred) or innerHTML. * @param {String/HTMLElement} el A DOM element or its id * @param {Object} config (optional) Config object * @return {Ext.Template} The created template * @static * @inheritable */ from: function(el, config) { el = Ext.getDom(el); return new this(el.value || el.innerHTML, config || ''); } }, /* End Definitions */ /** * Creates new template. * * @param {String...} html List of strings to be concatenated into template. * Alternatively an array of strings can be given, but then no config object may be passed. * @param {Object} config (optional) Config object */ constructor: function(html) { var me = this, args = arguments, buffer = [], i = 0, length = args.length, value; me.initialConfig = {}; // Allow an array to be passed here so we can // pass an array of strings and an object // at the end if (length === 1 && Ext.isArray(html)) { args = html; length = args.length; } if (length > 1) { for (; i < length; i++) { value = args[i]; if (typeof value == 'object') { Ext.apply(me.initialConfig, value); Ext.apply(me, value); } else { buffer.push(value); } } } else { buffer.push(html); } // @private me.html = buffer.join(''); if (me.compiled) { me.compile(); } }, /** * @property {Boolean} isTemplate * `true` in this class to identify an object as an instantiated Template, or subclass thereof. */ isTemplate: true, /** * @cfg {Boolean} compiled * True to immediately compile the template. Defaults to false. */ /** * @cfg {Boolean} disableFormats * True to disable format functions in the template. If the template doesn't contain * format functions, setting disableFormats to true will reduce apply time. Defaults to false. */ disableFormats: false, re: /\{([\w\-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g, /** * Returns an HTML fragment of this template with the specified values applied. * * @param {Object/Array} values The template values. Can be an array if your params are numeric: * * var tpl = new Ext.Template('Name: {0}, Age: {1}'); * tpl.apply(['John', 25]); * * or an object: * * var tpl = new Ext.Template('Name: {name}, Age: {age}'); * tpl.apply({name: 'John', age: 25}); * * @return {String} The HTML fragment */ apply: function(values) { var me = this, useFormat = me.disableFormats !== true, fm = Ext.util.Format, tpl = me, ret; if (me.compiled) { return me.compiled(values).join(''); } function fn(m, name, format, args) { if (format && useFormat) { if (args) { args = [values[name]].concat(Ext.functionFactory('return ['+ args +'];')()); } else { args = [values[name]]; } if (format.substr(0, 5) == "this.") { return tpl[format.substr(5)].apply(tpl, args); } else { return fm[format].apply(fm, args); } } else { return values[name] !== undefined ? values[name] : ""; } } ret = me.html.replace(me.re, fn); return ret; }, /** * Appends the result of this template to the provided output array. * @param {Object/Array} values The template values. See {@link #apply}. * @param {Array} out The array to which output is pushed. * @return {Array} The given out array. */ applyOut: function(values, out) { var me = this; if (me.compiled) { out.push.apply(out, me.compiled(values)); } else { out.push(me.apply(values)); } return out; }, /** * @method applyTemplate * @member Ext.Template * Alias for {@link #apply}. * @inheritdoc Ext.Template#apply */ applyTemplate: function () { return this.apply.apply(this, arguments); }, /** * Sets the HTML used as the template and optionally compiles it. * @param {String} html * @param {Boolean} compile (optional) True to compile the template. * @return {Ext.Template} this */ set: function(html, compile) { var me = this; me.html = html; me.compiled = null; return compile ? me.compile() : me; }, compileARe: /\\/g, compileBRe: /(\r\n|\n)/g, compileCRe: /'/g, /** * Compiles the template into an internal function, eliminating the RegEx overhead. * @return {Ext.Template} this */ compile: function() { var me = this, fm = Ext.util.Format, useFormat = me.disableFormats !== true, body, bodyReturn; function fn(m, name, format, args) { if (format && useFormat) { args = args ? ',' + args: ""; if (format.substr(0, 5) != "this.") { format = "fm." + format + '('; } else { format = 'this.' + format.substr(5) + '('; } } else { args = ''; format = "(values['" + name + "'] == undefined ? '' : "; } return "'," + format + "values['" + name + "']" + args + ") ,'"; } bodyReturn = me.html.replace(me.compileARe, '\\\\').replace(me.compileBRe, '\\n').replace(me.compileCRe, "\\'").replace(me.re, fn); body = "this.compiled = function(values){ return ['" + bodyReturn + "'];};"; eval(body); return me; }, /** * Applies the supplied values to the template and inserts the new node(s) as the first child of el. * * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/Array} values The template values. See {@link #applyTemplate} for details. * @param {Boolean} returnElement (optional) true to return a Ext.Element. * @return {HTMLElement/Ext.Element} The new node or Element */ insertFirst: function(el, values, returnElement) { return this.doInsert('afterBegin', el, values, returnElement); }, /** * Applies the supplied values to the template and inserts the new node(s) before el. * * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/Array} values The template values. See {@link #applyTemplate} for details. * @param {Boolean} returnElement (optional) true to return a Ext.Element. * @return {HTMLElement/Ext.Element} The new node or Element */ insertBefore: function(el, values, returnElement) { return this.doInsert('beforeBegin', el, values, returnElement); }, /** * Applies the supplied values to the template and inserts the new node(s) after el. * * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/Array} values The template values. See {@link #applyTemplate} for details. * @param {Boolean} returnElement (optional) true to return a Ext.Element. * @return {HTMLElement/Ext.Element} The new node or Element */ insertAfter: function(el, values, returnElement) { return this.doInsert('afterEnd', el, values, returnElement); }, /** * Applies the supplied `values` to the template and appends the new node(s) to the specified `el`. * * For example usage see {@link Ext.Template Ext.Template class docs}. * * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/Array} values The template values. See {@link #applyTemplate} for details. * @param {Boolean} returnElement (optional) true to return an Ext.Element. * @return {HTMLElement/Ext.Element} The new node or Element */ append: function(el, values, returnElement) { return this.doInsert('beforeEnd', el, values, returnElement); }, doInsert: function(where, el, values, returnElement) { var newNode = Ext.DomHelper.insertHtml(where, Ext.getDom(el), this.apply(values)); return returnElement ? Ext.get(newNode) : newNode; }, /** * Applies the supplied values to the template and overwrites the content of el with the new node(s). * * @param {String/HTMLElement/Ext.Element} el The context element * @param {Object/Array} values The template values. See {@link #applyTemplate} for details. * @param {Boolean} returnElement (optional) true to return a Ext.Element. * @return {HTMLElement/Ext.Element} The new node or Element */ overwrite: function(el, values, returnElement) { var newNode = Ext.DomHelper.overwrite(Ext.getDom(el), this.apply(values)); return returnElement ? Ext.get(newNode) : newNode; } }); // @tag core /** * This class parses the XTemplate syntax and calls abstract methods to process the parts. * @private */ Ext.define('Ext.XTemplateParser', { constructor: function (config) { Ext.apply(this, config); }, /** * @property {Number} level The 'for' or 'foreach' loop context level. This is adjusted * up by one prior to calling {@link #doFor} or {@link #doForEach} and down by one after * calling the corresponding {@link #doEnd} that closes the loop. This will be 1 on the * first {@link #doFor} or {@link #doForEach} call. */ /** * This method is called to process a piece of raw text from the tpl. * @param {String} text * @method doText */ // doText: function (text) /** * This method is called to process expressions (like `{[expr]}`). * @param {String} expr The body of the expression (inside "{[" and "]}"). * @method doExpr */ // doExpr: function (expr) /** * This method is called to process simple tags (like `{tag}`). * @method doTag */ // doTag: function (tag) /** * This method is called to process ``. * @method doElse */ // doElse: function () /** * This method is called to process `{% text %}`. * @param {String} text * @method doEval */ // doEval: function (text) /** * This method is called to process ``. If there are other attributes, * these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name (such as 'exec'). * @method doIf */ // doIf: function (action, actions) /** * This method is called to process ``. If there are other attributes, * these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name (such as 'exec'). * @method doElseIf */ // doElseIf: function (action, actions) /** * This method is called to process ``. If there are other attributes, * these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name (such as 'exec'). * @method doSwitch */ // doSwitch: function (action, actions) /** * This method is called to process ``. If there are other attributes, * these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name (such as 'exec'). * @method doCase */ // doCase: function (action, actions) /** * This method is called to process ``. * @method doDefault */ // doDefault: function () /** * This method is called to process ``. It is given the action type that started * the tpl and the set of additional actions. * @param {String} type The type of action that is being ended. * @param {Object} actions The other actions keyed by the attribute name (such as 'exec'). * @method doEnd */ // doEnd: function (type, actions) /** * This method is called to process ``. If there are other attributes, * these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name (such as 'exec'). * @method doFor */ // doFor: function (action, actions) /** * This method is called to process ``. If there are other * attributes, these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name (such as 'exec'). * @method doForEach */ // doForEach: function (action, actions) /** * This method is called to process ``. If there are other attributes, * these are passed in the actions object. * @param {String} action * @param {Object} actions Other actions keyed by the attribute name. * @method doExec */ // doExec: function (action, actions) /** * This method is called to process an empty ``. This is unlikely to need to be * implemented, so a default (do nothing) version is provided. * @method */ doTpl: Ext.emptyFn, parse: function (str) { var me = this, len = str.length, aliases = { elseif: 'elif' }, topRe = me.topRe, actionsRe = me.actionsRe, index, stack, s, m, t, prev, frame, subMatch, begin, end, actions, prop; me.level = 0; me.stack = stack = []; for (index = 0; index < len; index = end) { topRe.lastIndex = index; m = topRe.exec(str); if (!m) { me.doText(str.substring(index, len)); break; } begin = m.index; end = topRe.lastIndex; if (index < begin) { me.doText(str.substring(index, begin)); } if (m[1]) { end = str.indexOf('%}', begin+2); me.doEval(str.substring(begin+2, end)); end += 2; } else if (m[2]) { end = str.indexOf(']}', begin+2); me.doExpr(str.substring(begin+2, end)); end += 2; } else if (m[3]) { // if ('{' token) me.doTag(m[3]); } else if (m[4]) { // content of a tag actions = null; while ((subMatch = actionsRe.exec(m[4])) !== null) { s = subMatch[2] || subMatch[3]; if (s) { s = Ext.String.htmlDecode(s); // decode attr value t = subMatch[1]; t = aliases[t] || t; actions = actions || {}; prev = actions[t]; if (typeof prev == 'string') { actions[t] = [prev, s]; } else if (prev) { actions[t].push(s); } else { actions[t] = s; } } } if (!actions) { if (me.elseRe.test(m[4])) { me.doElse(); } else if (me.defaultRe.test(m[4])) { me.doDefault(); } else { me.doTpl(); stack.push({ type: 'tpl' }); } } else if (actions['if']) { me.doIf(actions['if'], actions); stack.push({ type: 'if' }); } else if (actions['switch']) { me.doSwitch(actions['switch'], actions); stack.push({ type: 'switch' }); } else if (actions['case']) { me.doCase(actions['case'], actions); } else if (actions['elif']) { me.doElseIf(actions['elif'], actions); } else if (actions['for']) { ++me.level; // Extract property name to use from indexed item if (prop = me.propRe.exec(m[4])) { actions.propName = prop[1] || prop[2]; } me.doFor(actions['for'], actions); stack.push({ type: 'for', actions: actions }); } else if (actions['foreach']) { ++me.level; // Extract property name to use from indexed item if (prop = me.propRe.exec(m[4])) { actions.propName = prop[1] || prop[2]; } me.doForEach(actions['foreach'], actions); stack.push({ type: 'foreach', actions: actions }); } else if (actions.exec) { me.doExec(actions.exec, actions); stack.push({ type: 'exec', actions: actions }); } /* else { // todo - error } */ } else if (m[0].length === 5) { // if the length of m[0] is 5, assume that we're dealing with an opening tpl tag with no attributes (e.g. ...) // in this case no action is needed other than pushing it on to the stack stack.push({ type: 'tpl' }); } else { frame = stack.pop(); me.doEnd(frame.type, frame.actions); if (frame.type == 'for' || frame.type == 'foreach') { --me.level; } } } }, // Internal regexes topRe: /(?:(\{\%)|(\{\[)|\{([^{}]+)\})|(?:]*)\>)|(?:<\/tpl>)/g, actionsRe: /\s*(elif|elseif|if|for|foreach|exec|switch|case|eval|between)\s*\=\s*(?:(?:"([^"]*)")|(?:'([^']*)'))\s*/g, propRe: /prop=(?:(?:"([^"]*)")|(?:'([^']*)'))/, defaultRe: /^\s*default\s*$/, elseRe: /^\s*else\s*$/ }); // @tag core /** * This class compiles the XTemplate syntax into a function object. The function is used * like so: * * function (out, values, parent, xindex, xcount) { * // out is the output array to store results * // values, parent, xindex and xcount have their historical meaning * } * * @markdown * @private */ Ext.define('Ext.XTemplateCompiler', { extend: Ext.XTemplateParser , // Chrome really likes "new Function" to realize the code block (as in it is // 2x-3x faster to call it than using eval), but Firefox chokes on it badly. // IE and Opera are also fine with the "new Function" technique. useEval: Ext.isGecko, // See http://jsperf.com/nige-array-append for quickest way to append to an array of unknown length // (Due to arbitrary code execution inside a template, we cannot easily track the length in var) // On IE6 to 8, myArray[myArray.length]='foo' is better. On other browsers myArray.push('foo') is better. useIndex: Ext.isIE8m, useFormat: true, propNameRe: /^[\w\d\$]*$/, compile: function (tpl) { var me = this, code = me.generate(tpl); // When using "new Function", we have to pass our "Ext" variable to it in order to // support sandboxing. If we did not, the generated function would use the global // "Ext", not the "Ext" from our sandbox (scope chain). // return me.useEval ? me.evalTpl(code) : (new Function('Ext', code))(Ext); }, generate: function (tpl) { var me = this, // note: Ext here is properly sandboxed definitions = 'var fm=Ext.util.Format,ts=Object.prototype.toString;', code; // Track how many levels we use, so that we only "var" each level's variables once me.maxLevel = 0; me.body = [ 'var c0=values, a0=' + me.createArrayTest(0) + ', p0=parent, n0=xcount, i0=xindex, k0, v;\n' ]; if (me.definitions) { if (typeof me.definitions === 'string') { me.definitions = [me.definitions, definitions ]; } else { me.definitions.push(definitions); } } else { me.definitions = [ definitions ]; } me.switches = []; me.parse(tpl); me.definitions.push( (me.useEval ? '$=' : 'return') + ' function (' + me.fnArgs + ') {', me.body.join(''), '}' ); code = me.definitions.join('\n'); // Free up the arrays. me.definitions.length = me.body.length = me.switches.length = 0; delete me.definitions; delete me.body; delete me.switches; return code; }, //----------------------------------- // XTemplateParser callouts doText: function (text) { var me = this, out = me.body; text = text.replace(me.aposRe, "\\'").replace(me.newLineRe, '\\n'); if (me.useIndex) { out.push('out[out.length]=\'', text, '\'\n'); } else { out.push('out.push(\'', text, '\')\n'); } }, doExpr: function (expr) { var out = this.body; out.push('if ((v=' + expr + ') != null) out'); // Coerce value to string using concatenation of an empty string literal. // See http://jsperf.com/tostringvscoercion/5 if (this.useIndex) { out.push('[out.length]=v+\'\'\n'); } else { out.push('.push(v+\'\')\n'); } }, doTag: function (tag) { var expr = this.parseTag(tag); if (expr) { this.doExpr(expr); } else { // if we cannot match on tagRe handle as plain text this.doText('{' + tag + '}'); } }, doElse: function () { this.body.push('} else {\n'); }, doEval: function (text) { this.body.push(text, '\n'); }, doIf: function (action, actions) { var me = this; // If it's just a propName, use it directly in the if if (action === '.') { me.body.push('if (values) {\n'); } else if (me.propNameRe.test(action)) { me.body.push('if (', me.parseTag(action), ') {\n'); } // Otherwise, it must be an expression, and needs to be returned from an fn which uses with(values) else { me.body.push('if (', me.addFn(action), me.callFn, ') {\n'); } if (actions.exec) { me.doExec(actions.exec); } }, doElseIf: function (action, actions) { var me = this; // If it's just a propName, use it directly in the else if if (action === '.') { me.body.push('else if (values) {\n'); } else if (me.propNameRe.test(action)) { me.body.push('} else if (', me.parseTag(action), ') {\n'); } // Otherwise, it must be an expression, and needs to be returned from an fn which uses with(values) else { me.body.push('} else if (', me.addFn(action), me.callFn, ') {\n'); } if (actions.exec) { me.doExec(actions.exec); } }, doSwitch: function (action) { var me = this; // If it's just a propName, use it directly in the switch if (action === '.') { me.body.push('switch (values) {\n'); } else if (me.propNameRe.test(action)) { me.body.push('switch (', me.parseTag(action), ') {\n'); } // Otherwise, it must be an expression, and needs to be returned from an fn which uses with(values) else { me.body.push('switch (', me.addFn(action), me.callFn, ') {\n'); } me.switches.push(0); }, doCase: function (action) { var me = this, cases = Ext.isArray(action) ? action : [action], n = me.switches.length - 1, match, i; if (me.switches[n]) { me.body.push('break;\n'); } else { me.switches[n]++; } for (i = 0, n = cases.length; i < n; ++i) { match = me.intRe.exec(cases[i]); cases[i] = match ? match[1] : ("'" + cases[i].replace(me.aposRe,"\\'") + "'"); } me.body.push('case ', cases.join(': case '), ':\n'); }, doDefault: function () { var me = this, n = me.switches.length - 1; if (me.switches[n]) { me.body.push('break;\n'); } else { me.switches[n]++; } me.body.push('default:\n'); }, doEnd: function (type, actions) { var me = this, L = me.level-1; if (type == 'for' || type == 'foreach') { /* To exit a for or foreach loop we must restore the outer loop's context. The code looks like this (which goes with that produced by doFor or doForEach): for (...) { // the part generated by doFor or doForEach ... // the body of the for loop // ... any tpl for exec statement goes here... } parent = p1; values = r2; xcount = n1; xindex = i1 */ if (actions.exec) { me.doExec(actions.exec); } me.body.push('}\n'); me.body.push('parent=p',L,';values=r',L+1,';xcount=n'+L+';xindex=i',L,'+1;xkey=k',L,';\n'); } else if (type == 'if' || type == 'switch') { me.body.push('}\n'); } }, doFor: function (action, actions) { var me = this, s, L = me.level, up = L-1, parentAssignment; // If it's just a propName, use it directly in the switch if (action === '.') { s = 'values'; } else if (me.propNameRe.test(action)) { s = me.parseTag(action); } // Otherwise, it must be an expression, and needs to be returned from an fn which uses with(values) else { s = me.addFn(action) + me.callFn; } /* We are trying to produce a block of code that looks like below. We use the nesting level to uniquely name the control variables. // Omit "var " if we have already been through level 2 var i2 = 0, n2 = 0, c2 = values['propName'], // c2 is the context object for the for loop a2 = Array.isArray(c2); r2 = values, // r2 is the values object p2, // p2 is the parent context (of the outer for loop) k2; // object key - not used by for loop but doEnd needs this to be declared // If iterating over the current data, the parent is always set to c2 p2 = parent = c2; // If iterating over a property in an object, set the parent to the object p2 = parent = a1 ? c1[i1] : c1 // set parent if (c2) { if (a2) { n2 = c2.length; } else if (c2.isMixedCollection) { c2 = c2.items; n2 = c2.length; } else if (c2.isStore) { c2 = c2.data.items; n2 = c2.length; } else { c2 = [ c2 ]; n2 = 1; } } // i2 is the loop index and n2 is the number (xcount) of this for loop for (xcount = n2; i2 < n2; ++i2) { values = c2[i2] // adjust special vars to inner scope xindex = i2 + 1 // xindex is 1-based The body of the loop is whatever comes between the tpl and /tpl statements (which is handled by doEnd). */ // Declare the vars for a particular level only if we have not already declared them. if (me.maxLevel < L) { me.maxLevel = L; me.body.push('var '); } if (action == '.') { parentAssignment = 'c' + L; } else { parentAssignment = 'a' + up + '?c' + up + '[i' + up + ']:c' + up; } me.body.push('i',L,'=0,n', L, '=0,c',L,'=',s,',a',L,'=', me.createArrayTest(L),',r',L,'=values,p',L,',k',L,';\n', 'p',L,'=parent=',parentAssignment,'\n', 'if (c',L,'){if(a',L,'){n', L,'=c', L, '.length;}else if (c', L, '.isMixedCollection){c',L,'=c',L,'.items;n',L,'=c',L,'.length;}else if(c',L,'.isStore){c',L,'=c',L,'.data.items;n',L,'=c',L,'.length;}else{c',L,'=[c',L,'];n',L,'=1;}}\n', 'for (xcount=n',L,';i',L,'1){ out.push("',actions.between,'"); } \n'); } }, doForEach: function (action, actions) { var me = this, s, L = me.level, up = L-1, parentAssignment; // If it's just a propName, use it directly in the switch if (action === '.') { s = 'values'; } else if (me.propNameRe.test(action)) { s = me.parseTag(action); } // Otherwise, it must be an expression, and needs to be returned from an fn which uses with(values) else { s = me.addFn(action) + me.callFn; } /* We are trying to produce a block of code that looks like below. We use the nesting level to uniquely name the control variables. // Omit "var " if we have already been through level 2 var i2 = -1, n2 = 0, c2 = values['propName'], // c2 is the context object for the for loop a2 = Array.isArray(c2); r2 = values, // r2 is the values object p2, // p2 is the parent context (of the outer for loop) k2; // k2 is the object key while looping // If iterating over the current data, the parent is always set to c2 p2 = parent = c2; // If iterating over a property in an object, set the parent to the object p2 = parent = a1 ? c1[i1] : c1 // set parent for(k2 in c2){ xindex = ++i + 1; // xindex is 1-based xkey = k2; values = c2[k2]; // values is the property value The body of the loop is whatever comes between the tpl and /tpl statements (which is handled by doEnd). */ // Declare the vars for a particular level only if we have not already declared them. if (me.maxLevel < L) { me.maxLevel = L; me.body.push('var '); } if (action == '.') { parentAssignment = 'c' + L; } else { parentAssignment = 'a' + up + '?c' + up + '[i' + up + ']:c' + up; } me.body.push('i',L,'=-1,n',L,'=0,c',L,'=',s,',a',L,'=',me.createArrayTest(L),',r',L,'=values,p',L,',k',L,';\n', 'p',L,'=parent=',parentAssignment,'\n', 'for(k',L,' in c',L,'){\n', 'xindex=++i',L,'+1;\n', 'xkey=k',L,';\n', 'values=c',L,'[k',L,'];'); if (actions.propName) { me.body.push('.', actions.propName); } if (actions.between) { me.body.push('if(xindex>1){ out.push("',actions.between,'"); } \n'); } }, createArrayTest: ('isArray' in Array) ? function(L) { return 'Array.isArray(c' + L + ')'; } : function(L) { return 'ts.call(c' + L + ')==="[object Array]"'; }, doExec: function (action, actions) { var me = this, name = 'f' + me.definitions.length; me.definitions.push('function ' + name + '(' + me.fnArgs + ') {', ' try { with(values) {', ' ' + action, ' }} catch(e) {', 'Ext.log("XTemplate Error: " + e.message);', '}', '}'); me.body.push(name + me.callFn + '\n'); }, //----------------------------------- // Internal addFn: function (body) { var me = this, name = 'f' + me.definitions.length; if (body === '.') { me.definitions.push('function ' + name + '(' + me.fnArgs + ') {', ' return values', '}'); } else if (body === '..') { me.definitions.push('function ' + name + '(' + me.fnArgs + ') {', ' return parent', '}'); } else { me.definitions.push('function ' + name + '(' + me.fnArgs + ') {', ' try { with(values) {', ' return(' + body + ')', ' }} catch(e) {', 'Ext.log("XTemplate Error: " + e.message);', '}', '}'); } return name; }, parseTag: function (tag) { var me = this, m = me.tagRe.exec(tag), name, format, args, math, v; if (!m) { return null; } name = m[1]; format = m[2]; args = m[3]; math = m[4]; // name = "." - Just use the values object. if (name == '.') { // filter to not include arrays/objects/nulls if (!me.validTypes) { me.definitions.push('var validTypes={string:1,number:1,boolean:1};'); me.validTypes = true; } v = 'validTypes[typeof values] || ts.call(values) === "[object Date]" ? values : ""'; } // name = "#" - Use the xindex else if (name == '#') { v = 'xindex'; } // name = "$" - Use the xkey else if (name == '$') { v = 'xkey'; } else if (name.substr(0, 7) == "parent.") { v = name; } // compound Javascript property name (e.g., "foo.bar") else if (isNaN(name) && name.indexOf('-') == -1 && name.indexOf('.') != -1) { v = "values." + name; } // number or a '-' in it or a single word (maybe a keyword): use array notation // (http://jsperf.com/string-property-access/4) else { v = "values['" + name + "']"; } if (math) { v = '(' + v + math + ')'; } if (format && me.useFormat) { args = args ? ',' + args : ""; if (format.substr(0, 5) != "this.") { format = "fm." + format + '('; } else { format += '('; } } else { return v; } return format + v + args + ')'; }, // @private evalTpl: function ($) { // We have to use eval to realize the code block and capture the inner func we also // don't want a deep scope chain. We only do this in Firefox and it is also unhappy // with eval containing a return statement, so instead we assign to "$" and return // that. Because we use "eval", we are automatically sandboxed properly. eval($); return $; }, newLineRe: /\r\n|\r|\n/g, aposRe: /[']/g, intRe: /^\s*(\d+)\s*$/, tagRe: /^([\w-\.\#\$]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?(\s?[\+\-\*\/]\s?[\d\.\+\-\*\/\(\)]+)?$/ }, function () { var proto = this.prototype; proto.fnArgs = 'out,values,parent,xindex,xcount,xkey'; proto.callFn = '.call(this,' + proto.fnArgs + ')'; }); // @tag core /** * A template class that supports advanced functionality like: * * - Autofilling arrays using templates and sub-templates * - Conditional processing with basic comparison operators * - Basic math function support * - Execute arbitrary inline code with special built-in template variables * - Custom member functions * - Many special tags and built-in operators that aren't defined as part of the API, but are supported in the templates that can be created * * XTemplate provides the templating mechanism built into {@link Ext.view.View}. * * The {@link Ext.Template} describes the acceptable parameters to pass to the constructor. The following examples * demonstrate all of the supported features. * * # Sample Data * * This is the data object used for reference in each code example: * * var data = { * name: 'Don Griffin', * title: 'Senior Technomage', * company: 'Sencha Inc.', * drinks: ['Coffee', 'Water', 'More Coffee'], * kids: [ * { name: 'Aubrey', age: 17 }, * { name: 'Joshua', age: 13 }, * { name: 'Cale', age: 10 }, * { name: 'Nikol', age: 5 }, * { name: 'Solomon', age: 0 } * ] * }; * * # Auto filling of arrays * * The **tpl** tag and the **for** operator are used to process the provided data object: * * - If the value specified in for is an array, it will auto-fill, repeating the template block inside the tpl * tag for each item in the array. * - If for="." is specified, the data object provided is examined. * - If between="..." is specified, the provided value will be inserted between the items. * This is also supported in the "foreach" looping template. * - While processing an array, the special variable {#} will provide the current array index + 1 (starts at 1, not 0). * * Examples: * * ... // loop through array at root node * ... // loop through array at foo node * ... // loop through array at foo.bar node * ... // loop through array at root node and insert ',' between each item * * Using the sample data above: * * var tpl = new Ext.XTemplate( * '

Kids: ', * '', // process the data.kids node * '

{#}. {name}

', // use current array index to autonumber * '

' * ); * tpl.overwrite(panel.body, data.kids); // pass the kids property of the data object * * An example illustrating how the **for** property can be leveraged to access specified members of the provided data * object to populate the template: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Title: {title}

', * '

Company: {company}

', * '

Kids: ', * '', // interrogate the kids property within the data * '

{name}

', * '

' * ); * tpl.overwrite(panel.body, data); // pass the root node of the data object * * Flat arrays that contain values (and not objects) can be auto-rendered using the special **`{.}`** variable inside a * loop. This variable will represent the value of the array at the current index: * * var tpl = new Ext.XTemplate( * '

{name}\'s favorite beverages:

', * '', * '
- {.}
', * '
' * ); * tpl.overwrite(panel.body, data); * * When processing a sub-template, for example while looping through a child array, you can access the parent object's * members via the **parent** object: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Kids: ', * '', * '', * '

{name}

', * '

Dad: {parent.name}

', * '
', * '

' * ); * tpl.overwrite(panel.body, data); * * The **foreach** operator is used to loop over an object's properties. The following * example demonstrates looping over the main data object's properties: * * var tpl = new Ext.XTemplate( * '
', * '', * '
{$}
', // the special **`{$}`** variable contains the property name * '
{.}
', // within the loop, the **`{.}`** variable is set to the property value * '
', * '
' * ); * tpl.overwrite(panel.body, data); * * # Conditional processing with basic comparison operators * * The **tpl** tag and the **if** operator are used to provide conditional checks for deciding whether or not to render * specific parts of the template. * * Using the sample data above: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Kids: ', * '', * '', * '

{name}

', * '
', * '

' * ); * tpl.overwrite(panel.body, data); * * More advanced conditionals are also supported: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Kids: ', * '', * '

{name} is a ', * '', * '

teenager

', * '', * '

kid

', * '', * '

baby

', * '
', * '

' * ); * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Kids: ', * '', * '

{name} is a ', * '', * '', * '

girl

', * '', * '

boy

', * '
', * '

' * ); * * A `break` is implied between each case and default, however, multiple cases can be listed * in a single <tpl> tag. * * # Using double quotes * * Examples: * * var tpl = new Ext.XTemplate( * "Child", * "Teenager", * "...", * '...', * "", * "Hello" * ); * * # Basic math support * * The following basic math operators may be applied directly on numeric data values: * * + - * / * * For example: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Kids: ', * '', * '', // <-- Note that the > is encoded * '

{#}: {name}

', // <-- Auto-number each item * '

In 5 Years: {age+5}

', // <-- Basic math * '

Dad: {parent.name}

', * '
', * '

' * ); * tpl.overwrite(panel.body, data); * * # Execute arbitrary inline code with special built-in template variables * * Anything between `{[ ... ]}` is considered code to be executed in the scope of the template. * The expression is evaluated and the result is included in the generated result. There are * some special variables available in that code: * * - **out**: The output array into which the template is being appended (using `push` to later * `join`). * - **values**: The values in the current scope. If you are using scope changing sub-templates, * you can change what values is. * - **parent**: The scope (values) of the ancestor template. * - **xindex**: If you are in a "for" or "foreach" looping template, the index of the loop you are in (1-based). * - **xcount**: If you are in a "for" looping template, the total length of the array you are looping. * - **xkey**: If you are in a "foreach" looping template, the key of the current property * being examined. * * This example demonstrates basic row striping using an inline code block and the xindex variable: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Company: {[values.company.toUpperCase() + ", " + values.title]}

', * '

Kids: ', * '', * '

', * '{name}', * '
', * '

' * ); * * Any code contained in "verbatim" blocks (using "{% ... %}") will be inserted directly in * the generated code for the template. These blocks are not included in the output. This * can be used for simple things like break/continue in a loop, or control structures or * method calls (when they don't produce output). The `this` references the template instance. * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Company: {[values.company.toUpperCase() + ", " + values.title]}

', * '

Kids: ', * '', * '{% if (xindex % 2 === 0) continue; %}', * '{name}', * '{% if (xindex > 100) break; %}', * '', * '

' * ); * * # Template member functions * * One or more member functions can be specified in a configuration object passed into the XTemplate constructor for * more complex processing: * * var tpl = new Ext.XTemplate( * '

Name: {name}

', * '

Kids: ', * '', * '', * '

Girl: {name} - {age}

', * '', * '

Boy: {name} - {age}

', * '
', * '', * '

{name} is a baby!

', * '
', * '

', * { * // XTemplate configuration: * disableFormats: true, * // member functions: * isGirl: function(name){ * return name == 'Aubrey' || name == 'Nikol'; * }, * isBaby: function(age){ * return age < 1; * } * } * ); * tpl.overwrite(panel.body, data); */ Ext.define('Ext.XTemplate', { extend: Ext.Template , /** * @private */ emptyObj: {}, /** * @cfg {Boolean} compiled * Only applies to {@link Ext.Template}, XTemplates are compiled automatically on the * first call to {@link #apply} or {@link #applyOut}. * @hide */ /** * @cfg {String/Array} definitions * Optional. A statement, or array of statements which set up `var`s which may then * be accessed within the scope of the generated function. */ apply: function(values, parent) { return this.applyOut(values, [], parent).join(''); }, applyOut: function(values, out, parent) { var me = this, compiler; if (!me.fn) { compiler = new Ext.XTemplateCompiler({ useFormat: me.disableFormats !== true, definitions: me.definitions }); me.fn = compiler.compile(me.html); } try { me.fn(out, values, parent || me.emptyObj, 1, 1); } catch (e) { Ext.log('Error: ' + e.message); } return out; }, /** * Does nothing. XTemplates are compiled automatically, so this function simply returns this. * @return {Ext.XTemplate} this */ compile: function() { return this; }, statics: { /** * Gets an `XTemplate` from an object (an instance of an {@link Ext#define}'d class). * Many times, templates are configured high in the class hierarchy and are to be * shared by all classes that derive from that base. To further complicate matters, * these templates are seldom actual instances but are rather configurations. For * example: * * Ext.define('MyApp.Class', { * extraCls: 'extra-class', * * someTpl: [ * '
', * { * // Member fn - outputs the owing class's extra CSS class * emitClass: function(out) { * out.push(this.owner.extraCls); * } * }] * }); * * The goal being to share that template definition with all instances and even * instances of derived classes, until `someTpl` is overridden. This method will * "upgrade" these configurations to be real `XTemplate` instances *in place* (to * avoid creating one instance per object). * * The resulting XTemplate will have an `owner` reference injected which refers back * to the owning object whether that is an object which has an *own instance*, or a * class prototype. Through this link, XTemplate member functions will be able to access * prototype properties of its owning class. * * @param {Object} instance The object from which to get the `XTemplate` (must be * an instance of an {@link Ext#define}'d class). * @param {String} name The name of the property by which to get the `XTemplate`. * @return {Ext.XTemplate} The `XTemplate` instance or null if not found. * @protected * @static */ getTpl: function (instance, name) { var tpl = instance[name], // go for it! 99% of the time we will get it! owner; if (tpl && !tpl.isTemplate) { // tpl is just a configuration (not an instance) // create the template instance from the configuration: tpl = Ext.ClassManager.dynInstantiate('Ext.XTemplate', tpl); // and replace the reference with the new instance: if (instance.hasOwnProperty(name)) { // the tpl is on the instance owner = instance; } else { // must be somewhere in the prototype chain for (owner = instance.self.prototype; owner && !owner.hasOwnProperty(name); owner = owner.superclass) { } } owner[name] = tpl; tpl.owner = owner; } // else !tpl (no such tpl) or the tpl is an instance already... either way, tpl // is ready to return return tpl || null; } } }); // @tag dom,core // @require Helper.js // @define Ext.dom.Query // @define Ext.core.DomQuery // @define Ext.DomQuery /* * This is code is also distributed under MIT license for use * with jQuery and prototype JavaScript libraries. */ /** * @class Ext.dom.Query * @alternateClassName Ext.DomQuery * @alternateClassName Ext.core.DomQuery * @singleton * * Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes * and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in). * * DomQuery supports most of the [CSS3 selectors spec][1], along with some custom selectors and basic XPath. * * All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example * `div.foo:nth-child(odd)[@foo=bar].bar:first` would be a perfectly valid selector. Node filters are processed * in the order in which they appear, which allows you to optimize your queries for your document structure. * * ## Element Selectors: * * - **`*`** any element * - **`E`** an element with the tag E * - **`E F`** All descendent elements of E that have the tag F * - **`E > F`** or **E/F** all direct children elements of E that have the tag F * - **`E + F`** all elements with the tag F that are immediately preceded by an element with the tag E * - **`E ~ F`** all elements with the tag F that are preceded by a sibling element with the tag E * * ## Attribute Selectors: * * The use of `@` and quotes are optional. For example, `div[@foo='bar']` is also a valid attribute selector. * * - **`E[foo]`** has an attribute "foo" * - **`E[foo=bar]`** has an attribute "foo" that equals "bar" * - **`E[foo^=bar]`** has an attribute "foo" that starts with "bar" * - **`E[foo$=bar]`** has an attribute "foo" that ends with "bar" * - **`E[foo*=bar]`** has an attribute "foo" that contains the substring "bar" * - **`E[foo%=2]`** has an attribute "foo" that is evenly divisible by 2 * - **`E[foo!=bar]`** attribute "foo" does not equal "bar" * * ## Pseudo Classes: * * - **`E:first-child`** E is the first child of its parent * - **`E:last-child`** E is the last child of its parent * - **`E:nth-child(_n_)`** E is the _n_th child of its parent (1 based as per the spec) * - **`E:nth-child(odd)`** E is an odd child of its parent * - **`E:nth-child(even)`** E is an even child of its parent * - **`E:only-child`** E is the only child of its parent * - **`E:checked`** E is an element that is has a checked attribute that is true (e.g. a radio or checkbox) * - **`E:first`** the first E in the resultset * - **`E:last`** the last E in the resultset * - **`E:nth(_n_)`** the _n_th E in the resultset (1 based) * - **`E:odd`** shortcut for :nth-child(odd) * - **`E:even`** shortcut for :nth-child(even) * - **`E:contains(foo)`** E's innerHTML contains the substring "foo" * - **`E:nodeValue(foo)`** E contains a textNode with a nodeValue that equals "foo" * - **`E:not(S)`** an E element that does not match simple selector S * - **`E:has(S)`** an E element that has a descendent that matches simple selector S * - **`E:next(S)`** an E element whose next sibling matches simple selector S * - **`E:prev(S)`** an E element whose previous sibling matches simple selector S * - **`E:any(S1|S2|S2)`** an E element which matches any of the simple selectors S1, S2 or S3 * - **`E:visible(true)`** an E element which is deeply visible according to {@link Ext.dom.Element#isVisible} * * ## CSS Value Selectors: * * - **`E{display=none}`** css value "display" that equals "none" * - **`E{display^=none}`** css value "display" that starts with "none" * - **`E{display$=none}`** css value "display" that ends with "none" * - **`E{display*=none}`** css value "display" that contains the substring "none" * - **`E{display%=2}`** css value "display" that is evenly divisible by 2 * - **`E{display!=none}`** css value "display" that does not equal "none" * * ## XML Namespaces: * - **`ns|E`** an element with tag E and namespace prefix ns * * [1]: http://www.w3.org/TR/2005/WD-css3-selectors-20051215/#selectors */ Ext.ns('Ext.core'); Ext.dom.Query = Ext.core.DomQuery = Ext.DomQuery = (function() { var DQ, doc = document, cache = {}, simpleCache = {}, valueCache = {}, useClassList = !!doc.documentElement.classList, useElementPointer = !!doc.documentElement.firstElementChild, useChildrenCollection = (function() { var d = doc.createElement('div'); d.innerHTML = 'text'; return d.children && (d.children.length === 0); })(), nonSpace = /\S/, trimRe = /^\s+|\s+$/g, tplRe = /\{(\d+)\}/g, modeRe = /^(\s?[\/>+~]\s?|\s|$)/, tagTokenRe = /^(#)?([\w\-\*\|\\]+)/, nthRe = /(\d*)n\+?(\d*)/, nthRe2 = /\D/, startIdRe = /^\s*#/, // This is for IE MSXML which does not support expandos. // IE runs the same speed using setAttribute, however FF slows way down // and Safari completely fails so they need to continue to use expandos. isIE = window.ActiveXObject ? true : false, key = 30803, longHex = /\\([0-9a-fA-F]{6})/g, shortHex = /\\([0-9a-fA-F]{1,6})\s{0,1}/g, nonHex = /\\([^0-9a-fA-F]{1})/g, escapes = /\\/g, num, hasEscapes, // True if the browser supports the following syntax: // document.getElementsByTagName('namespacePrefix:tagName') supportsColonNsSeparator = (function () { var xmlDoc, xmlString = ''; if (window.DOMParser) { xmlDoc = (new DOMParser()).parseFromString(xmlString, "application/xml"); } else { xmlDoc = new ActiveXObject("Microsoft.XMLDOM"); xmlDoc.loadXML(xmlString); } return !!xmlDoc.getElementsByTagName('a:b').length; })(), // replaces a long hex regex match group with the appropriate ascii value // $args indicate regex match pos longHexToChar = function($0, $1) { return String.fromCharCode(parseInt($1, 16)); }, // converts a shortHex regex match to the long form shortToLongHex = function($0, $1) { while ($1.length < 6) { $1 = '0' + $1; } return '\\' + $1; }, // converts a single char escape to long escape form charToLongHex = function($0, $1) { num = $1.charCodeAt(0).toString(16); if (num.length === 1) { num = '0' + num; } return '\\0000' + num; }, // Un-escapes an input selector string. Assumes all escape sequences have been // normalized to the css '\\0000##' 6-hex-digit style escape sequence : // will not handle any other escape formats unescapeCssSelector = function(selector) { return (hasEscapes) ? selector.replace(longHex, longHexToChar) : selector; }, // checks if the path has escaping & does any appropriate replacements setupEscapes = function(path) { hasEscapes = (path.indexOf('\\') > -1); if (hasEscapes) { path = path .replace(shortHex, shortToLongHex) .replace(nonHex, charToLongHex) .replace(escapes, '\\\\'); // double the '\' for js compilation } return path; }; // this eval is stop the compressor from // renaming the variable to something shorter eval("var batch = 30803, child, next, prev, byClassName;"); // Retrieve the child node from a particular // parent at the specified index. child = useChildrenCollection ? function child(parent, index) { return parent.children[index]; } : function child(parent, index) { var i = 0, n = parent.firstChild; while (n) { if (n.nodeType == 1) { if (++i == index) { return n; } } n = n.nextSibling; } return null; }; // retrieve the next element node next = useElementPointer ? function(n) { return n.nextElementSibling; } : function(n) { while ((n = n.nextSibling) && n.nodeType != 1); return n; }; // retrieve the previous element node prev = useElementPointer ? function(n) { return n.previousElementSibling; } : function(n) { while ((n = n.previousSibling) && n.nodeType != 1); return n; }; // Mark each child node with a nodeIndex skipping and // removing empty text nodes. function children(parent) { var n = parent.firstChild, nodeIndex = -1, nextNode; while (n) { nextNode = n.nextSibling; // clean worthless empty nodes. if (n.nodeType == 3 && !nonSpace.test(n.nodeValue)) { parent.removeChild(n); } else { // add an expando nodeIndex n.nodeIndex = ++nodeIndex; } n = nextNode; } return this; } // nodeSet - array of nodes // cls - CSS Class byClassName = useClassList ? // Use classList API where available: http://jsperf.com/classlist-vs-old-school-check/ function (nodeSet, cls) { cls = unescapeCssSelector(cls); if (!cls) { return nodeSet; } var result = [], ri = -1, i, ci, classList; for (i = 0; ci = nodeSet[i]; i++) { classList = ci.classList; if (classList) { if (classList.contains(cls)) { result[++ri] = ci; } } else if ((' ' + ci.className + ' ').indexOf(cls) !== -1) { // Some elements types (SVG) may not always have a classList // in some browsers, so fallback to the old style here result[++ri] = ci; } } return result; } : function (nodeSet, cls) { cls = unescapeCssSelector(cls); if (!cls) { return nodeSet; } var result = [], ri = -1, i, ci; for (i = 0; ci = nodeSet[i]; i++) { if ((' ' + ci.className + ' ').indexOf(cls) !== -1) { result[++ri] = ci; } } return result; }; function attrValue(n, attr) { // if its an array, use the first node. if (!n.tagName && typeof n.length != "undefined") { n = n[0]; } if (!n) { return null; } if (attr == "for") { return n.htmlFor; } if (attr == "class" || attr == "className") { return n.className; } return n.getAttribute(attr) || n[attr]; } // ns - nodes // mode - false, /, >, +, ~ // tagName - defaults to "*" function getNodes(ns, mode, tagName) { var result = [], ri = -1, cs, i, ni, j, ci, cn, utag, n, cj; if (!ns) { return result; } tagName = tagName.replace('|', ':') || "*"; // convert to array if (typeof ns.getElementsByTagName != "undefined") { ns = [ns]; } // no mode specified, grab all elements by tagName // at any depth if (!mode) { tagName = unescapeCssSelector(tagName); if (!supportsColonNsSeparator && DQ.isXml(ns[0]) && tagName.indexOf(':') !== -1) { // Some browsers (e.g. WebKit and Opera do not support the following syntax // in xml documents: getElementsByTagName('ns:tagName'). To work around // this, we remove the namespace prefix from the tagName, get the elements // by tag name only, and then compare each element's tagName property to // the tagName with namespace prefix attached to ensure that the tag is in // the proper namespace. for (i = 0; ni = ns[i]; i++) { cs = ni.getElementsByTagName(tagName.split(':').pop()); for (j = 0; ci = cs[j]; j++) { if (ci.tagName === tagName) { result[++ri] = ci; } } } } else { for (i = 0; ni = ns[i]; i++) { cs = ni.getElementsByTagName(tagName); for (j = 0; ci = cs[j]; j++) { result[++ri] = ci; } } } // Direct Child mode (/ or >) // E > F or E/F all direct children elements of E that have the tag } else if (mode == "/" || mode == ">") { utag = tagName.toUpperCase(); for (i = 0; ni = ns[i]; i++) { cn = ni.childNodes; for (j = 0; cj = cn[j]; j++) { if (cj.nodeName == utag || cj.nodeName == tagName || tagName == '*') { result[++ri] = cj; } } } // Immediately Preceding mode (+) // E + F all elements with the tag F that are immediately preceded by an element with the tag E } else if (mode == "+") { utag = tagName.toUpperCase(); for (i = 0; n = ns[i]; i++) { while ((n = n.nextSibling) && n.nodeType != 1); if (n && (n.nodeName == utag || n.nodeName == tagName || tagName == '*')) { result[++ri] = n; } } // Sibling mode (~) // E ~ F all elements with the tag F that are preceded by a sibling element with the tag E } else if (mode == "~") { utag = tagName.toUpperCase(); for (i = 0; n = ns[i]; i++) { while ((n = n.nextSibling)) { if (n.nodeName == utag || n.nodeName == tagName || tagName == '*') { result[++ri] = n; } } } } return result; } function concat(a, b) { a.push.apply(a, b); return a; } function byTag(cs, tagName) { if (cs.tagName || cs === doc) { cs = [cs]; } if (!tagName) { return cs; } var result = [], ri = -1, i, ci; tagName = tagName.toLowerCase(); for (i = 0; ci = cs[i]; i++) { if (ci.nodeType == 1 && ci.tagName.toLowerCase() == tagName) { result[++ri] = ci; } } return result; } function byId(cs, id) { id = unescapeCssSelector(id); if (cs.tagName || cs === doc) { cs = [cs]; } if (!id) { return cs; } var result = [], ri = -1, i, ci; for (i = 0; ci = cs[i]; i++) { if (ci && ci.id == id) { result[++ri] = ci; return result; } } return result; } // operators are =, !=, ^=, $=, *=, %=, |= and ~= // custom can be "{" function byAttribute(cs, attr, value, op, custom) { var result = [], ri = -1, useGetStyle = custom == "{", fn = DQ.operators[op], a, xml, hasXml, i, ci; value = unescapeCssSelector(value); for (i = 0; ci = cs[i]; i++) { // skip non-element nodes. if (ci.nodeType === 1) { // only need to do this for the first node if (!hasXml) { xml = DQ.isXml(ci); hasXml = true; } // we only need to change the property names if we're dealing with html nodes, not XML if (!xml) { if (useGetStyle) { a = DQ.getStyle(ci, attr); } else if (attr == "class" || attr == "className") { a = ci.className; } else if (attr == "for") { a = ci.htmlFor; } else if (attr == "href") { // getAttribute href bug // http://www.glennjones.net/Post/809/getAttributehrefbug.htm a = ci.getAttribute("href", 2); } else { a = ci.getAttribute(attr); } } else { a = ci.getAttribute(attr); } if ((fn && fn(a, value)) || (!fn && a)) { result[++ri] = ci; } } } return result; } function byPseudo(cs, name, value) { value = unescapeCssSelector(value); return DQ.pseudos[name](cs, value); } function nodupIEXml(cs) { var d = ++key, r, i, len, c; cs[0].setAttribute("_nodup", d); r = [cs[0]]; for (i = 1, len = cs.length; i < len; i++) { c = cs[i]; if (!c.getAttribute("_nodup") != d) { c.setAttribute("_nodup", d); r[r.length] = c; } } for (i = 0, len = cs.length; i < len; i++) { cs[i].removeAttribute("_nodup"); } return r; } function nodup(cs) { if (!cs) { return []; } var len = cs.length, c, i, r = cs, cj, ri = -1, d, j; if (!len || typeof cs.nodeType != "undefined" || len == 1) { return cs; } if (isIE && typeof cs[0].selectSingleNode != "undefined") { return nodupIEXml(cs); } d = ++key; cs[0]._nodup = d; for (i = 1; c = cs[i]; i++) { if (c._nodup != d) { c._nodup = d; } else { r = []; for (j = 0; j < i; j++) { r[++ri] = cs[j]; } for (j = i + 1; cj = cs[j]; j++) { if (cj._nodup != d) { cj._nodup = d; r[++ri] = cj; } } return r; } } return r; } function quickDiffIEXml(c1, c2) { var d = ++key, r = [], i, len; for (i = 0, len = c1.length; i < len; i++) { c1[i].setAttribute("_qdiff", d); } for (i = 0, len = c2.length; i < len; i++) { if (c2[i].getAttribute("_qdiff") != d) { r[r.length] = c2[i]; } } for (i = 0, len = c1.length; i < len; i++) { c1[i].removeAttribute("_qdiff"); } return r; } function quickDiff(c1, c2) { var len1 = c1.length, d = ++key, r = [], i, len; if (!len1) { return c2; } if (isIE && typeof c1[0].selectSingleNode != "undefined") { return quickDiffIEXml(c1, c2); } for (i = 0; i < len1; i++) { c1[i]._qdiff = d; } for (i = 0, len = c2.length; i < len; i++) { if (c2[i]._qdiff != d) { r[r.length] = c2[i]; } } return r; } function quickId(ns, mode, root, id) { if (ns == root) { id = unescapeCssSelector(id); var d = root.ownerDocument || root; return d.getElementById(id); } ns = getNodes(ns, mode, "*"); return byId(ns, id); } return DQ = { getStyle: function(el, name) { return Ext.fly(el, '_DomQuery').getStyle(name); }, /** * Compiles a selector/xpath query into a reusable function. The returned function * takes one parameter "root" (optional), which is the context node from where the query should start. * @param {String} selector The selector/xpath query * @param {String} [type="select"] Either "select" or "simple" for a simple selector match * @return {Function} */ compile: function(path, type) { type = type || "select"; // setup fn preamble var fn = ["var f = function(root) {\n var mode; ++batch; var n = root || document;\n"], lastPath, matchers = DQ.matchers, matchersLn = matchers.length, modeMatch, // accept leading mode switch lmode = path.match(modeRe), tokenMatch, matched, j, t, m; path = setupEscapes(path); if (lmode && lmode[1]) { fn[fn.length] = 'mode="' + lmode[1].replace(trimRe, "") + '";'; path = path.replace(lmode[1], ""); } // strip leading slashes while (path.substr(0, 1) == "/") { path = path.substr(1); } while (path && lastPath != path) { lastPath = path; tokenMatch = path.match(tagTokenRe); if (type == "select") { if (tokenMatch) { // ID Selector if (tokenMatch[1] == "#") { fn[fn.length] = 'n = quickId(n, mode, root, "' + tokenMatch[2] + '");'; } else { fn[fn.length] = 'n = getNodes(n, mode, "' + tokenMatch[2] + '");'; } path = path.replace(tokenMatch[0], ""); } else if (path.substr(0, 1) != '@') { fn[fn.length] = 'n = getNodes(n, mode, "*");'; } // type of "simple" } else { if (tokenMatch) { if (tokenMatch[1] == "#") { fn[fn.length] = 'n = byId(n, "' + tokenMatch[2] + '");'; } else { fn[fn.length] = 'n = byTag(n, "' + tokenMatch[2] + '");'; } path = path.replace(tokenMatch[0], ""); } } while (!(modeMatch = path.match(modeRe))) { matched = false; for (j = 0; j < matchersLn; j++) { t = matchers[j]; m = path.match(t.re); if (m) { fn[fn.length] = t.select.replace(tplRe, function(x, i) { return m[i]; }); path = path.replace(m[0], ""); matched = true; break; } } // prevent infinite loop on bad selector if (!matched) { Ext.Error.raise({ sourceClass:'Ext.DomQuery', sourceMethod:'compile', msg:'Error parsing selector. Parsing failed at "' + path + '"' }); } } if (modeMatch[1]) { fn[fn.length] = 'mode="' + modeMatch[1].replace(trimRe, "") + '";'; path = path.replace(modeMatch[1], ""); } } // close fn out fn[fn.length] = "return nodup(n);\n}"; // eval fn and return it eval(fn.join("")); return f; }, /** * Selects an array of DOM nodes using JavaScript-only implementation. * * Use {@link #select} to take advantage of browsers built-in support for CSS selectors. * @param {String} selector The selector/xpath query (can be a comma separated list of selectors) * @param {HTMLElement/String} [root=document] The start of the query. * @return {HTMLElement[]} An Array of DOM elements which match the selector. If there are * no matches, and empty Array is returned. */ jsSelect: function(path, root, type) { // set root to doc if not specified. root = root || doc; if (typeof root == "string") { root = doc.getElementById(root); } var paths = path.split(","), results = [], i, len, subPath, result; // loop over each selector for (i = 0, len = paths.length; i < len; i++) { subPath = paths[i].replace(trimRe, ""); // compile and place in cache if (!cache[subPath]) { // When we compile, escaping is handled inside the compile method cache[subPath] = DQ.compile(subPath, type); if (!cache[subPath]) { Ext.Error.raise({ sourceClass:'Ext.DomQuery', sourceMethod:'jsSelect', msg:subPath + ' is not a valid selector' }); } } else { // If we've already compiled, we still need to check if the // selector has escaping and setup the appropriate flags setupEscapes(subPath); } result = cache[subPath](root); if (result && result !== doc) { results = results.concat(result); } } // if there were multiple selectors, make sure dups // are eliminated if (paths.length > 1) { return nodup(results); } return results; }, isXml: function(el) { var docEl = (el ? el.ownerDocument || el : 0).documentElement; return docEl ? docEl.nodeName !== "HTML" : false; }, /** * Selects an array of DOM nodes by CSS/XPath selector. * * Uses [document.querySelectorAll][0] if browser supports that, otherwise falls back to * {@link Ext.dom.Query#jsSelect} to do the work. * * Aliased as {@link Ext#query}. * * [0]: https://developer.mozilla.org/en/DOM/document.querySelectorAll * * @param {String} path The selector/xpath query * @param {HTMLElement} [root=document] The start of the query. * @return {HTMLElement[]} An array of DOM elements (not a NodeList as returned by `querySelectorAll`). * @param {String} [type="select"] Either "select" or "simple" for a simple selector match (only valid when * used when the call is deferred to the jsSelect method) * @param {Boolean} [single] Pass `true` to select only the first matching node using `document.querySelector` (where available) * @method */ select : doc.querySelectorAll ? function(path, root, type, single) { root = root || doc; if (!DQ.isXml(root)) { try { /* * This checking here is to "fix" the behaviour of querySelectorAll * for non root document queries. The way qsa works is intentional, * however it's definitely not the expected way it should work. * When descendant selectors are used, only the lowest selector must be inside the root! * More info: http://ejohn.org/blog/thoughts-on-queryselectorall/ * So we create a descendant selector by prepending the root's ID, and query the parent node. * UNLESS the root has no parent in which qsa will work perfectly. * * We only modify the path for single selectors (ie, no multiples), * without a full parser it makes it difficult to do this correctly. */ if (root.parentNode && (root.nodeType !== 9) && path.indexOf(',') === -1 && !startIdRe.test(path)) { path = '#' + Ext.escapeId(Ext.id(root)) + ' ' + path; root = root.parentNode; } return single ? [ root.querySelector(path) ] : Ext.Array.toArray(root.querySelectorAll(path)); } catch (e) { } } return DQ.jsSelect.call(this, path, root, type); } : function(path, root, type) { return DQ.jsSelect.call(this, path, root, type); }, /** * Selects a single element. * @param {String} selector The selector/xpath query * @param {HTMLElement} [root=document] The start of the query. * @return {HTMLElement} The DOM element which matched the selector. */ selectNode : function(path, root){ return Ext.DomQuery.select(path, root, null, true)[0]; }, /** * Selects the value of a node, optionally replacing null with the defaultValue. * @param {String} selector The selector/xpath query * @param {HTMLElement} [root=document] The start of the query. * @param {String} [defaultValue] When specified, this is return as empty value. * @return {String} */ selectValue: function(path, root, defaultValue) { path = path.replace(trimRe, ""); if (!valueCache[path]) { valueCache[path] = DQ.compile(path, "select"); } else { setupEscapes(path); } var n = valueCache[path](root), v; n = n[0] ? n[0] : n; // overcome a limitation of maximum textnode size // Rumored to potentially crash IE6 but has not been confirmed. // http://reference.sitepoint.com/javascript/Node/normalize // https://developer.mozilla.org/En/DOM/Node.normalize if (typeof n.normalize == 'function') { n.normalize(); } v = (n && n.firstChild ? n.firstChild.nodeValue : null); return ((v === null || v === undefined || v === '') ? defaultValue : v); }, /** * Selects the value of a node, parsing integers and floats. * Returns the defaultValue, or 0 if none is specified. * @param {String} selector The selector/xpath query * @param {HTMLElement} [root=document] The start of the query. * @param {Number} [defaultValue] When specified, this is return as empty value. * @return {Number} */ selectNumber: function(path, root, defaultValue) { var v = DQ.selectValue(path, root, defaultValue || 0); return parseFloat(v); }, /** * Returns true if the passed element(s) match the passed simple selector * (e.g. `div.some-class` or `span:first-child`) * @param {String/HTMLElement/HTMLElement[]} el An element id, element or array of elements * @param {String} selector The simple selector to test * @return {Boolean} */ is: function(el, ss) { if (typeof el == "string") { el = doc.getElementById(el); } var isArray = Ext.isArray(el), result = DQ.filter(isArray ? el : [el], ss); return isArray ? (result.length == el.length) : (result.length > 0); }, /** * Filters an array of elements to only include matches of a simple selector * (e.g. `div.some-class` or `span:first-child`) * @param {HTMLElement[]} el An array of elements to filter * @param {String} selector The simple selector to test * @param {Boolean} nonMatches If true, it returns the elements that DON'T match the selector instead of the * ones that match * @return {HTMLElement[]} An Array of DOM elements which match the selector. If there are no matches, and empty * Array is returned. */ filter: function(els, ss, nonMatches) { ss = ss.replace(trimRe, ""); if (!simpleCache[ss]) { simpleCache[ss] = DQ.compile(ss, "simple"); } else { setupEscapes(ss); } var result = simpleCache[ss](els); return nonMatches ? quickDiff(result, els) : result; }, /** * Collection of matching regular expressions and code snippets. * Each capture group within `()` will be replace the `{}` in the select * statement as specified by their index. */ matchers: [{ re: /^\.([\w\-\\]+)/, select: useClassList ? 'n = byClassName(n, "{1}");' : 'n = byClassName(n, " {1} ");' }, { re: /^\:([\w\-]+)(?:\(((?:[^\s>\/]*|.*?))\))?/, select: 'n = byPseudo(n, "{1}", "{2}");' }, { re: /^(?:([\[\{])(?:@)?([\w\-]+)\s?(?:(=|.=)\s?['"]?(.*?)["']?)?[\]\}])/, select: 'n = byAttribute(n, "{2}", "{4}", "{3}", "{1}");' }, { re: /^#([\w\-\\]+)/, select: 'n = byId(n, "{1}");' }, { re: /^@([\w\-\.]+)/, select: 'return {firstChild:{nodeValue:attrValue(n, "{1}")}};' }], /** * Collection of operator comparison functions. * The default operators are `=`, `!=`, `^=`, `$=`, `*=`, `%=`, `|=` and `~=`. * * New operators can be added as long as the match the format *c*`=` where *c* * is any character other than space, `>`, or `<`. * * Operator functions are passed the following parameters: * * * `propValue` : The property value to test. * * `compareTo` : The value to compare to. */ operators: { "=": function(a, v) { return a == v; }, "!=": function(a, v) { return a != v; }, "^=": function(a, v) { return a && a.substr(0, v.length) == v; }, "$=": function(a, v) { return a && a.substr(a.length - v.length) == v; }, "*=": function(a, v) { return a && a.indexOf(v) !== -1; }, "%=": function(a, v) { return (a % v) === 0; }, "|=": function(a, v) { return a && (a == v || a.substr(0, v.length + 1) == v + '-'); }, "~=": function(a, v) { return a && (' ' + a + ' ').indexOf(' ' + v + ' ') != -1; } }, /** * Object hash of "pseudo class" filter functions which are used when filtering selections. * Each function is passed two parameters: * * - **c** : Array * An Array of DOM elements to filter. * * - **v** : String * The argument (if any) supplied in the selector. * * A filter function returns an Array of DOM elements which conform to the pseudo class. * In addition to the provided pseudo classes listed above such as `first-child` and `nth-child`, * developers may add additional, custom psuedo class filters to select elements according to application-specific requirements. * * For example, to filter `a` elements to only return links to __external__ resources: * * Ext.DomQuery.pseudos.external = function(c, v) { * var r = [], ri = -1; * for(var i = 0, ci; ci = c[i]; i++) { * // Include in result set only if it's a link to an external resource * if (ci.hostname != location.hostname) { * r[++ri] = ci; * } * } * return r; * }; * * Then external links could be gathered with the following statement: * * var externalLinks = Ext.select("a:external"); */ pseudos: { "first-child": function(c) { var r = [], ri = -1, n, i, ci; for (i = 0; (ci = n = c[i]); i++) { while ((n = n.previousSibling) && n.nodeType != 1); if (!n) { r[++ri] = ci; } } return r; }, "last-child": function(c) { var r = [], ri = -1, n, i, ci; for (i = 0; (ci = n = c[i]); i++) { while ((n = n.nextSibling) && n.nodeType != 1); if (!n) { r[++ri] = ci; } } return r; }, "nth-child": function(c, a) { var r = [], ri = -1, m = nthRe.exec(a == "even" && "2n" || a == "odd" && "2n+1" || !nthRe2.test(a) && "n+" + a || a), f = (m[1] || 1) - 0, l = m[2] - 0, i, n, j, cn, pn; for (i = 0; n = c[i]; i++) { pn = n.parentNode; if (batch != pn._batch) { j = 0; for (cn = pn.firstChild; cn; cn = cn.nextSibling) { if (cn.nodeType == 1) { cn.nodeIndex = ++j; } } pn._batch = batch; } if (f == 1) { if (l === 0 || n.nodeIndex == l) { r[++ri] = n; } } else if ((n.nodeIndex + l) % f === 0) { r[++ri] = n; } } return r; }, "only-child": function(c) { var r = [], ri = -1, i, ci; for (i = 0; ci = c[i]; i++) { if (!prev(ci) && !next(ci)) { r[++ri] = ci; } } return r; }, "empty": function(c) { var r = [], ri = -1, i, ci, cns, j, cn, empty; for (i = 0; ci = c[i]; i++) { cns = ci.childNodes; j = 0; empty = true; while (cn = cns[j]) { ++j; if (cn.nodeType == 1 || cn.nodeType == 3) { empty = false; break; } } if (empty) { r[++ri] = ci; } } return r; }, "contains": function(c, v) { var r = [], ri = -1, i, ci; for (i = 0; ci = c[i]; i++) { if ((ci.textContent || ci.innerText || ci.text || '').indexOf(v) != -1) { r[++ri] = ci; } } return r; }, "nodeValue": function(c, v) { var r = [], ri = -1, i, ci; for (i = 0; ci = c[i]; i++) { if (ci.firstChild && ci.firstChild.nodeValue == v) { r[++ri] = ci; } } return r; }, "checked": function(c) { var r = [], ri = -1, i, ci; for (i = 0; ci = c[i]; i++) { if (ci.checked === true) { r[++ri] = ci; } } return r; }, "not": function(c, ss) { return DQ.filter(c, ss, true); }, "any": function(c, selectors) { var ss = selectors.split('|'), r = [], ri = -1, s, i, ci, j; for (i = 0; ci = c[i]; i++) { for (j = 0; s = ss[j]; j++) { if (DQ.is(ci, s)) { r[++ri] = ci; break; } } } return r; }, "odd": function(c) { return this["nth-child"](c, "odd"); }, "even": function(c) { return this["nth-child"](c, "even"); }, "nth": function(c, a) { return c[a - 1] || []; }, "first": function(c) { return c[0] || []; }, "last": function(c) { return c[c.length - 1] || []; }, "has": function(c, ss) { var s = DQ.select, r = [], ri = -1, i, ci; for (i = 0; ci = c[i]; i++) { if (s(ss, ci).length > 0) { r[++ri] = ci; } } return r; }, "next": function(c, ss) { var is = DQ.is, r = [], ri = -1, i, ci, n; for (i = 0; ci = c[i]; i++) { n = next(ci); if (n && is(n, ss)) { r[++ri] = ci; } } return r; }, "prev": function(c, ss) { var is = DQ.is, r = [], ri = -1, i, ci, n; for (i = 0; ci = c[i]; i++) { n = prev(ci); if (n && is(n, ss)) { r[++ri] = ci; } } return r; }, focusable: function(candidates) { var len = candidates.length, results = [], i = 0, c; for (; i < len; i++) { c = candidates[i]; if (Ext.fly(c, '_DomQuery').isFocusable()) { results.push(c); } } return results; }, visible: function(candidates, deep) { var len = candidates.length, results = [], i = 0, c; for (; i < len; i++) { c = candidates[i]; if (Ext.fly(c, '_DomQuery').isVisible(deep)) { results.push(c); } } return results; } } }; }()); /** * Shorthand of {@link Ext.dom.Query#select} * @member Ext * @method query * @inheritdoc Ext.dom.Query#select */ Ext.query = Ext.DomQuery.select; // @tag dom,core /* ================================ * A Note About Wrapped Animations * ================================ * A few of the effects below implement two different animations per effect, one wrapping * animation that performs the visual effect and a "no-op" animation on this Element where * no attributes of the element itself actually change. The purpose for this is that the * wrapper is required for the effect to work and so it does the actual animation work, but * we always animate `this` so that the element's events and callbacks work as expected to * the callers of this API. * * Because of this, we always want each wrap animation to complete first (we don't want to * cut off the visual effect early). To ensure that, we arbitrarily increase the duration of * the element's no-op animation, also ensuring that it has a decent minimum value -- on slow * systems, too-low durations can cause race conditions between the wrap animation and the * element animation being removed out of order. Note that in each wrap's `afteranimate` * callback it will explicitly terminate the element animation as soon as the wrap is complete, * so there's no real danger in making the duration too long. * * This applies to all effects that get wrapped, including slideIn, slideOut, switchOff and frame. */ /** */ Ext.define('Ext.dom.Element_anim', { override: 'Ext.dom.Element', /** * Performs custom animation on this Element. * * The following properties may be specified in `from`, `to`, and `keyframe` objects: * * - `x` - The page X position in pixels. * * - `y` - The page Y position in pixels * * - `left` - The element's CSS `left` value. Units must be supplied. * * - `top` - The element's CSS `top` value. Units must be supplied. * * - `width` - The element's CSS `width` value. Units must be supplied. * * - `height` - The element's CSS `height` value. Units must be supplied. * * - `scrollLeft` - The element's `scrollLeft` value. * * - `scrollTop` - The element's `scrollTop` value. * * - `opacity` - The element's `opacity` value. This must be a value between `0` and `1`. * * **Be aware** that animating an Element which is being used by an Ext Component without in some way informing the * Component about the changed element state will result in incorrect Component behaviour. This is because the * Component will be using the old state of the element. To avoid this problem, it is now possible to directly * animate certain properties of Components. * * @param {Object} config Configuration for {@link Ext.fx.Anim}. * Note that the {@link Ext.fx.Anim#to to} config is required. * @return {Ext.dom.Element} this */ animate: function(config) { var me = this, listeners, anim, animId = me.dom.id || Ext.id(me.dom); if (!Ext.fx.Manager.hasFxBlock(animId)) { // Bit of gymnastics here to ensure our internal listeners get bound first if (config.listeners) { listeners = config.listeners; delete config.listeners; } if (config.internalListeners) { config.listeners = config.internalListeners; delete config.internalListeners; } anim = new Ext.fx.Anim(me.anim(config)); if (listeners) { anim.on(listeners); } Ext.fx.Manager.queueFx(anim); } return me; }, // @private - process the passed fx configuration. anim: function(config) { if (!Ext.isObject(config)) { return (config) ? {} : false; } var me = this, duration = config.duration || Ext.fx.Anim.prototype.duration, easing = config.easing || 'ease', animConfig; if (config.stopAnimation) { me.stopAnimation(); } Ext.applyIf(config, Ext.fx.Manager.getFxDefaults(me.id)); // Clear any 'paused' defaults. Ext.fx.Manager.setFxDefaults(me.id, { delay: 0 }); animConfig = { // Pass the DOM reference. That's tested first so will be converted to an Ext.fx.Target fastest. target: me.dom, remove: config.remove, alternate: config.alternate || false, duration: duration, easing: easing, callback: config.callback, listeners: config.listeners, iterations: config.iterations || 1, scope: config.scope, block: config.block, concurrent: config.concurrent, delay: config.delay || 0, paused: true, keyframes: config.keyframes, from: config.from || {}, to: Ext.apply({}, config) }; Ext.apply(animConfig.to, config.to); // Anim API properties - backward compat delete animConfig.to.to; delete animConfig.to.from; delete animConfig.to.remove; delete animConfig.to.alternate; delete animConfig.to.keyframes; delete animConfig.to.iterations; delete animConfig.to.listeners; delete animConfig.to.target; delete animConfig.to.paused; delete animConfig.to.callback; delete animConfig.to.scope; delete animConfig.to.duration; delete animConfig.to.easing; delete animConfig.to.concurrent; delete animConfig.to.block; delete animConfig.to.stopAnimation; delete animConfig.to.delay; return animConfig; }, /** * Slides the element into view. An anchor point can be optionally passed to set the point of origin for the slide * effect. This function automatically handles wrapping the element with a fixed-size container if needed. See the * {@link Ext.fx.Anim} class overview for valid anchor point options. Usage: * * // default: slide the element in from the top * el.slideIn(); * * // custom: slide the element in from the right with a 2-second duration * el.slideIn('r', { duration: 2000 }); * * // common config options shown with default values * el.slideIn('t', { * easing: 'easeOut', * duration: 500 * }); * * @param {String} anchor (optional) One of the valid {@link Ext.fx.Anim} anchor positions (defaults to top: 't') * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @param {Boolean} options.preserveScroll Set to true if preservation of any descendant elements' * `scrollTop` values is required. By default the DOM wrapping operation performed by `slideIn` and * `slideOut` causes the browser to lose all scroll positions. * @return {Ext.dom.Element} The Element */ slideIn: function(anchor, obj, slideOut) { var me = this, dom = me.dom, elStyle = dom.style, beforeAnim, wrapAnim, restoreScroll, wrapDomParentNode; anchor = anchor || "t"; obj = obj || {}; beforeAnim = function() { var animScope = this, listeners = obj.listeners, el = Ext.fly(dom, '_anim'), box, originalStyles, anim, wrap; if (!slideOut) { el.fixDisplay(); } box = el.getBox(); if ((anchor == 't' || anchor == 'b') && box.height === 0) { box.height = dom.scrollHeight; } else if ((anchor == 'l' || anchor == 'r') && box.width === 0) { box.width = dom.scrollWidth; } originalStyles = el.getStyles('width', 'height', 'left', 'right', 'top', 'bottom', 'position', 'z-index', true); el.setSize(box.width, box.height); // Cache all descendants' scrollTop & scrollLeft values if configured to preserve scroll. if (obj.preserveScroll) { restoreScroll = el.cacheScrollValues(); } wrap = el.wrap({ id: Ext.id() + '-anim-wrap-for-' + el.dom.id, style: { visibility: slideOut ? 'visible' : 'hidden' } }); wrapDomParentNode = wrap.dom.parentNode; wrap.setPositioning(el.getPositioning(true)); if (wrap.isStyle('position', 'static')) { wrap.position('relative'); } el.clearPositioning('auto'); wrap.clip(); // The wrap will have reset all descendant scrollTops. Restore them if we cached them. if (restoreScroll) { restoreScroll(); } // This element is temporarily positioned absolute within its wrapper. // Restore to its default, CSS-inherited visibility setting. // We cannot explicitly poke visibility:visible into its style because that overrides the visibility of the wrap. el.setStyle({ visibility: '', position: 'absolute' }); if (slideOut) { wrap.setSize(box.width, box.height); } switch (anchor) { case 't': anim = { from: { width: box.width + 'px', height: '0px' }, to: { width: box.width + 'px', height: box.height + 'px' } }; elStyle.bottom = '0px'; break; case 'l': anim = { from: { width: '0px', height: box.height + 'px' }, to: { width: box.width + 'px', height: box.height + 'px' } }; me.anchorAnimX(anchor); break; case 'r': anim = { from: { x: box.x + box.width, width: '0px', height: box.height + 'px' }, to: { x: box.x, width: box.width + 'px', height: box.height + 'px' } }; me.anchorAnimX(anchor); break; case 'b': anim = { from: { y: box.y + box.height, width: box.width + 'px', height: '0px' }, to: { y: box.y, width: box.width + 'px', height: box.height + 'px' } }; break; case 'tl': anim = { from: { x: box.x, y: box.y, width: '0px', height: '0px' }, to: { width: box.width + 'px', height: box.height + 'px' } }; elStyle.bottom = '0px'; me.anchorAnimX('l'); break; case 'bl': anim = { from: { y: box.y + box.height, width: '0px', height: '0px' }, to: { y: box.y, width: box.width + 'px', height: box.height + 'px' } }; me.anchorAnimX('l'); break; case 'br': anim = { from: { x: box.x + box.width, y: box.y + box.height, width: '0px', height: '0px' }, to: { x: box.x, y: box.y, width: box.width + 'px', height: box.height + 'px' } }; me.anchorAnimX('r'); break; case 'tr': anim = { from: { x: box.x + box.width, width: '0px', height: '0px' }, to: { x: box.x, width: box.width + 'px', height: box.height + 'px' } }; elStyle.bottom = '0px'; me.anchorAnimX('r'); break; } wrap.show(); wrapAnim = Ext.apply({}, obj); delete wrapAnim.listeners; wrapAnim = new Ext.fx.Anim(Ext.applyIf(wrapAnim, { target: wrap, duration: 500, easing: 'ease-out', from: slideOut ? anim.to : anim.from, to: slideOut ? anim.from : anim.to })); // In the absence of a callback, this listener MUST be added first wrapAnim.on('afteranimate', function() { var el = Ext.fly(dom, '_anim'); el.setStyle(originalStyles); if (slideOut) { if (obj.useDisplay) { el.setDisplayed(false); } else { el.hide(); } } if (wrap.dom) { if (wrap.dom.parentNode) { wrap.dom.parentNode.insertBefore(el.dom, wrap.dom); } else { wrapDomParentNode.appendChild(el.dom); } wrap.remove(); } // The unwrap will have reset all descendant scrollTops. Restore them if we cached them. if (restoreScroll) { restoreScroll(); } // kill the no-op element animation created below animScope.end(); }); // Add configured listeners after if (listeners) { wrapAnim.on(listeners); } }; me.animate({ // See "A Note About Wrapped Animations" at the top of this class: duration: obj.duration ? Math.max(obj.duration, 500) * 2 : 1000, listeners: { beforeanimate: beforeAnim // kick off the wrap animation } }); return me; }, /** * Slides the element out of view. An anchor point can be optionally passed to set the end point for the slide * effect. When the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will * still take up space in the document. The element must be removed from the DOM using the 'remove' config option if * desired. This function automatically handles wrapping the element with a fixed-size container if needed. See the * {@link Ext.fx.Anim} class overview for valid anchor point options. Usage: * * // default: slide the element out to the top * el.slideOut(); * * // custom: slide the element out to the right with a 2-second duration * el.slideOut('r', { duration: 2000 }); * * // common config options shown with default values * el.slideOut('t', { * easing: 'easeOut', * duration: 500, * remove: false, * useDisplay: false * }); * * @param {String} anchor (optional) One of the valid {@link Ext.fx.Anim} anchor positions (defaults to top: 't') * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.dom.Element} The Element */ slideOut: function(anchor, o) { return this.slideIn(anchor, o, true); }, /** * Fades the element out while slowly expanding it in all directions. When the effect is completed, the element will * be hidden (visibility = 'hidden') but block elements will still take up space in the document. Usage: * * // default * el.puff(); * * // common config options shown with default values * el.puff({ * easing: 'easeOut', * duration: 500, * useDisplay: false * }); * * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.dom.Element} The Element */ puff: function(obj) { var me = this, dom = me.dom, beforeAnim, box = me.getBox(), originalStyles = me.getStyles('width', 'height', 'left', 'right', 'top', 'bottom', 'position', 'z-index', 'font-size', 'opacity', true); obj = Ext.applyIf(obj || {}, { easing: 'ease-out', duration: 500, useDisplay: false }); beforeAnim = function() { var el = Ext.fly(dom, '_anim'); el.clearOpacity(); el.show(); this.to = { width: box.width * 2, height: box.height * 2, x: box.x - (box.width / 2), y: box.y - (box.height /2), opacity: 0, fontSize: '200%' }; this.on('afteranimate',function() { var el = Ext.fly(dom, '_anim'); if (el) { if (obj.useDisplay) { el.setDisplayed(false); } else { el.hide(); } el.setStyle(originalStyles); Ext.callback(obj.callback, obj.scope); } }); }; me.animate({ duration: obj.duration, easing: obj.easing, listeners: { beforeanimate: { fn: beforeAnim } } }); return me; }, /** * Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television). * When the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still * take up space in the document. The element must be removed from the DOM using the 'remove' config option if * desired. Usage: * * // default * el.switchOff(); * * // all config options shown with default values * el.switchOff({ * easing: 'easeIn', * duration: .3, * remove: false, * useDisplay: false * }); * * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.dom.Element} The Element */ switchOff: function(obj) { var me = this, dom = me.dom, beforeAnim; obj = Ext.applyIf(obj || {}, { easing: 'ease-in', duration: 500, remove: false, useDisplay: false }); beforeAnim = function() { var el = Ext.fly(dom, '_anim'), animScope = this, size = el.getSize(), xy = el.getXY(), keyframe, position; el.clearOpacity(); el.clip(); position = el.getPositioning(); keyframe = new Ext.fx.Animator({ target: dom, duration: obj.duration, easing: obj.easing, keyframes: { 33: { opacity: 0.3 }, 66: { height: 1, y: xy[1] + size.height / 2 }, 100: { width: 1, x: xy[0] + size.width / 2 } } }); keyframe.on('afteranimate', function() { var el = Ext.fly(dom, '_anim'); if (obj.useDisplay) { el.setDisplayed(false); } else { el.hide(); } el.clearOpacity(); el.setPositioning(position); el.setSize(size); // kill the no-op element animation created below animScope.end(); }); }; me.animate({ // See "A Note About Wrapped Animations" at the top of this class: duration: (Math.max(obj.duration, 500) * 2), listeners: { beforeanimate: { fn: beforeAnim } }, callback: obj.callback, scope: obj.scope }); return me; }, /** * Shows a ripple of exploding, attenuating borders to draw attention to an Element. Usage: * * // default: a single light blue ripple * el.frame(); * * // custom: 3 red ripples lasting 3 seconds total * el.frame("#ff0000", 3, { duration: 3000 }); * * // common config options shown with default values * el.frame("#C3DAF9", 1, { * duration: 1000 // duration of each individual ripple. * // Note: Easing is not configurable and will be ignored if included * }); * * @param {String} [color='#C3DAF9'] The hex color value for the border. * @param {Number} [count=1] The number of ripples to display. * @param {Object} [options] Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.dom.Element} The Element */ frame : function(color, count, obj){ var me = this, dom = me.dom, beforeAnim; color = color || '#C3DAF9'; count = count || 1; obj = obj || {}; beforeAnim = function() { var el = Ext.fly(dom, '_anim'), animScope = this, box, proxy, proxyAnim; el.show(); box = el.getBox(); proxy = Ext.getBody().createChild({ id: el.dom.id + '-anim-proxy', style: { position : 'absolute', 'pointer-events': 'none', 'z-index': 35000, border : '0px solid ' + color } }); proxyAnim = new Ext.fx.Anim({ target: proxy, duration: obj.duration || 1000, iterations: count, from: { top: box.y, left: box.x, borderWidth: 0, opacity: 1, height: box.height, width: box.width }, to: { top: box.y - 20, left: box.x - 20, borderWidth: 10, opacity: 0, height: box.height + 40, width: box.width + 40 } }); proxyAnim.on('afteranimate', function() { proxy.remove(); // kill the no-op element animation created below animScope.end(); }); }; me.animate({ // See "A Note About Wrapped Animations" at the top of this class: duration: (Math.max(obj.duration, 500) * 2) || 2000, listeners: { beforeanimate: { fn: beforeAnim } }, callback: obj.callback, scope: obj.scope }); return me; }, /** * Slides the element while fading it out of view. An anchor point can be optionally passed to set the ending point * of the effect. Usage: * * // default: slide the element downward while fading out * el.ghost(); * * // custom: slide the element out to the right with a 2-second duration * el.ghost('r', { duration: 2000 }); * * // common config options shown with default values * el.ghost('b', { * easing: 'easeOut', * duration: 500 * }); * * @param {String} anchor (optional) One of the valid {@link Ext.fx.Anim} anchor positions (defaults to bottom: 'b') * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.dom.Element} The Element */ ghost: function(anchor, obj) { var me = this, dom = me.dom, beforeAnim; anchor = anchor || "b"; beforeAnim = function() { var el = Ext.fly(dom, '_anim'), width = el.getWidth(), height = el.getHeight(), xy = el.getXY(), position = el.getPositioning(), to = { opacity: 0 }; switch (anchor) { case 't': to.y = xy[1] - height; break; case 'l': to.x = xy[0] - width; break; case 'r': to.x = xy[0] + width; break; case 'b': to.y = xy[1] + height; break; case 'tl': to.x = xy[0] - width; to.y = xy[1] - height; break; case 'bl': to.x = xy[0] - width; to.y = xy[1] + height; break; case 'br': to.x = xy[0] + width; to.y = xy[1] + height; break; case 'tr': to.x = xy[0] + width; to.y = xy[1] - height; break; } this.to = to; this.on('afteranimate', function () { var el = Ext.fly(dom, '_anim'); if (el) { el.hide(); el.clearOpacity(); el.setPositioning(position); } }); }; me.animate(Ext.applyIf(obj || {}, { duration: 500, easing: 'ease-out', listeners: { beforeanimate: beforeAnim } })); return me; }, /** * Highlights the Element by setting a color (applies to the background-color by default, but can be changed using * the "attr" config option) and then fading back to the original color. If no original color is available, you * should provide the "endColor" config option which will be cleared after the animation. Usage: * * // default: highlight background to yellow * el.highlight(); * * // custom: highlight foreground text to blue for 2 seconds * el.highlight("0000ff", { attr: 'color', duration: 2000 }); * * // common config options shown with default values * el.highlight("ffff9c", { * attr: "backgroundColor", //can be any valid CSS property (attribute) that supports a color value * endColor: (current color) or "ffffff", * easing: 'easeIn', * duration: 1000 * }); * * @param {String} color (optional) The highlight color. Should be a 6 char hex color without the leading # * (defaults to yellow: 'ffff9c') * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.dom.Element} The Element */ highlight: function(color, o) { var me = this, dom = me.dom, from = {}, restore, to, attr, lns, event, fn; // Cannot set bckground-color on table elements. Find div elements to highlight. if (dom.tagName.match(me.tableTagRe)) { return me.select('div').highlight(color, o); } o = o || {}; lns = o.listeners || {}; attr = o.attr || 'backgroundColor'; from[attr] = color || 'ffff9c'; if (!o.to) { to = {}; to[attr] = o.endColor || me.getColor(attr, 'ffffff', ''); } else { to = o.to; } // Don't apply directly on lns, since we reference it in our own callbacks below o.listeners = Ext.apply(Ext.apply({}, lns), { beforeanimate: function() { restore = dom.style[attr]; var el = Ext.fly(dom, '_anim'); el.clearOpacity(); el.show(); event = lns.beforeanimate; if (event) { fn = event.fn || event; return fn.apply(event.scope || lns.scope || window, arguments); } }, afteranimate: function() { if (dom) { dom.style[attr] = restore; } event = lns.afteranimate; if (event) { fn = event.fn || event; fn.apply(event.scope || lns.scope || window, arguments); } } }); me.animate(Ext.apply({}, o, { duration: 1000, easing: 'ease-in', from: from, to: to })); return me; }, /** * Creates a pause before any subsequent queued effects begin. If there are no effects queued after the pause it will * have no effect. Usage: * * el.pause(1); * * @deprecated 4.0 Use the `delay` config to {@link #animate} instead. * @param {Number} seconds The length of time to pause (in seconds) * @return {Ext.Element} The Element */ pause: function(ms) { var me = this; Ext.fx.Manager.setFxDefaults(me.id, { delay: ms }); return me; }, /** * Fade an element in (from transparent to opaque). The ending opacity can be specified using the `opacity` * config option. Usage: * * // default: fade in from opacity 0 to 100% * el.fadeIn(); * * // custom: fade in from opacity 0 to 75% over 2 seconds * el.fadeIn({ opacity: .75, duration: 2000}); * * // common config options shown with default values * el.fadeIn({ * opacity: 1, //can be any value between 0 and 1 (e.g. .5) * easing: 'easeOut', * duration: 500 * }); * * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.Element} The Element */ fadeIn: function(o) { var me = this, dom = me.dom; me.animate(Ext.apply({}, o, { opacity: 1, internalListeners: { beforeanimate: function(anim){ // restore any visibility/display that may have // been applied by a fadeout animation var el = Ext.fly(dom, '_anim'); if (el.isStyle('display', 'none')) { el.setDisplayed(''); } else { el.show(); } } } })); return this; }, /** * Fade an element out (from opaque to transparent). The ending opacity can be specified using the `opacity` * config option. Note that IE may require `useDisplay:true` in order to redisplay correctly. * Usage: * * // default: fade out from the element's current opacity to 0 * el.fadeOut(); * * // custom: fade out from the element's current opacity to 25% over 2 seconds * el.fadeOut({ opacity: .25, duration: 2000}); * * // common config options shown with default values * el.fadeOut({ * opacity: 0, //can be any value between 0 and 1 (e.g. .5) * easing: 'easeOut', * duration: 500, * remove: false, * useDisplay: false * }); * * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.Element} The Element */ fadeOut: function(o) { var me = this, dom = me.dom; o = Ext.apply({ opacity: 0, internalListeners: { afteranimate: function(anim){ if (dom && anim.to.opacity === 0) { var el = Ext.fly(dom, '_anim'); if (o.useDisplay) { el.setDisplayed(false); } else { el.hide(); } } } } }, o); me.animate(o); return me; }, /** * Animates the transition of an element's dimensions from a starting height/width to an ending height/width. This * method is a convenience implementation of {@link #shift}. Usage: * * // change height and width to 100x100 pixels * el.scale(100, 100); * * // common config options shown with default values. The height and width will default to * // the element's existing values if passed as null. * el.scale( * [element's width], * [element's height], { * easing: 'easeOut', * duration: 350 * } * ); * * @deprecated 4.0 Just use {@link #animate} instead. * @param {Number} width The new width (pass undefined to keep the original width) * @param {Number} height The new height (pass undefined to keep the original height) * @param {Object} options (optional) Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.Element} The Element */ scale: function(w, h, o) { this.animate(Ext.apply({}, o, { width: w, height: h })); return this; }, /** * Animates the transition of any combination of an element's dimensions, xy position and/or opacity. Any of these * properties not specified in the config object will not be changed. This effect requires that at least one new * dimension, position or opacity setting must be passed in on the config object in order for the function to have * any effect. Usage: * * // slide the element horizontally to x position 200 while changing the height and opacity * el.shift({ x: 200, height: 50, opacity: .8 }); * * // common config options shown with default values. * el.shift({ * width: [element's width], * height: [element's height], * x: [element's x position], * y: [element's y position], * opacity: [element's opacity], * easing: 'easeOut', * duration: 350 * }); * * @deprecated 4.0 Just use {@link #animate} instead. * @param {Object} options Object literal with any of the {@link Ext.fx.Anim} config options * @return {Ext.Element} The Element */ shift: function(config) { this.animate(config); return this; }, /** * @private */ anchorAnimX: function(anchor) { var xName = (anchor === 'l') ? 'right' : 'left'; this.dom.style[xName] = '0px'; } }); // @tag dom,core /** */ Ext.define('Ext.dom.Element_dd', { override: 'Ext.dom.Element', /** * Initializes a {@link Ext.dd.DD} drag drop object for this element. * @param {String} group The group the DD object is member of * @param {Object} config The DD config object * @param {Object} overrides An object containing methods to override/implement on the DD object * @return {Ext.dd.DD} The DD object */ initDD : function(group, config, overrides){ var dd = new Ext.dd.DD(Ext.id(this.dom), group, config); return Ext.apply(dd, overrides); }, /** * Initializes a {@link Ext.dd.DDProxy} object for this element. * @param {String} group The group the DDProxy object is member of * @param {Object} config The DDProxy config object * @param {Object} overrides An object containing methods to override/implement on the DDProxy object * @return {Ext.dd.DDProxy} The DDProxy object */ initDDProxy : function(group, config, overrides){ var dd = new Ext.dd.DDProxy(Ext.id(this.dom), group, config); return Ext.apply(dd, overrides); }, /** * Initializes a {@link Ext.dd.DDTarget} object for this element. * @param {String} group The group the DDTarget object is member of * @param {Object} config The DDTarget config object * @param {Object} overrides An object containing methods to override/implement on the DDTarget object * @return {Ext.dd.DDTarget} The DDTarget object */ initDDTarget : function(group, config, overrides){ var dd = new Ext.dd.DDTarget(Ext.id(this.dom), group, config); return Ext.apply(dd, overrides); } }); // @tag dom,core /** */ Ext.define('Ext.dom.Element_fx', { override: 'Ext.dom.Element' }, function() { var Element = Ext.dom.Element, VISIBILITY = "visibility", DISPLAY = "display", NONE = "none", HIDDEN = 'hidden', VISIBLE = 'visible', OFFSETS = "offsets", ASCLASS = "asclass", NOSIZE = 'nosize', ORIGINALDISPLAY = 'originalDisplay', VISMODE = 'visibilityMode', ISVISIBLE = 'isVisible', OFFSETCLASS = Ext.baseCSSPrefix + 'hide-offsets', getDisplay = function(el) { var data = (el.$cache || el.getCache()).data, display = data[ORIGINALDISPLAY]; if (display === undefined) { data[ORIGINALDISPLAY] = display = ''; } return display; }, getVisMode = function(el){ var data = (el.$cache || el.getCache()).data, visMode = data[VISMODE]; if (visMode === undefined) { data[VISMODE] = visMode = Element.VISIBILITY; } return visMode; }; Element.override({ /** * The element's default display mode. */ originalDisplay : "", visibilityMode : 1, /** * Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use * the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property. * @param {Boolean} visible Whether the element is visible * @param {Boolean/Object} [animate] True for the default animation, or a standard Element animation config object * @return {Ext.dom.Element} this */ setVisible : function(visible, animate) { var me = this, dom = me.dom, visMode = getVisMode(me); // hideMode string override if (typeof animate == 'string') { switch (animate) { case DISPLAY: visMode = Element.DISPLAY; break; case VISIBILITY: visMode = Element.VISIBILITY; break; case OFFSETS: visMode = Element.OFFSETS; break; case NOSIZE: case ASCLASS: visMode = Element.ASCLASS; break; } me.setVisibilityMode(visMode); animate = false; } if (!animate || !me.anim) { if (visMode == Element.DISPLAY) { return me.setDisplayed(visible); } else if (visMode == Element.OFFSETS) { me[visible?'removeCls':'addCls'](OFFSETCLASS); } else if (visMode == Element.VISIBILITY) { me.fixDisplay(); // Show by clearing visibility style. Explicitly setting to "visible" overrides parent visibility setting dom.style.visibility = visible ? '' : HIDDEN; } else if (visMode == Element.ASCLASS) { me[visible?'removeCls':'addCls'](me.visibilityCls || Element.visibilityCls); } } else { // closure for composites if (visible) { me.setOpacity(0.01); me.setVisible(true); } if (!Ext.isObject(animate)) { animate = { duration: 350, easing: 'ease-in' }; } me.animate(Ext.applyIf({ callback: function() { if (!visible) { // Grab the dom again, since the reference may have changed if we use fly Ext.fly(dom, '_internal').setVisible(false).setOpacity(1); } }, to: { opacity: (visible) ? 1 : 0 } }, animate)); } (me.$cache || me.getCache()).data[ISVISIBLE] = visible; return me; }, /** * @private * Determine if the Element has a relevant height and width available based * upon current logical visibility state */ hasMetrics : function(){ var visMode = getVisMode(this); return this.isVisible() || (visMode == Element.OFFSETS) || (visMode == Element.VISIBILITY); }, /** * Toggles the element's visibility or display, depending on visibility mode. * @param {Boolean/Object} [animate] True for the default animation, or a standard Element animation config object * @return {Ext.dom.Element} this */ toggle : function(animate){ var me = this; me.setVisible(!me.isVisible(), me.anim(animate)); return me; }, /** * Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true. * @param {Boolean/String} value Boolean value to display the element using its default display, or a string to set the display directly. * @return {Ext.dom.Element} this */ setDisplayed : function(value) { if(typeof value == "boolean"){ value = value ? getDisplay(this) : NONE; } this.setStyle(DISPLAY, value); return this; }, // private fixDisplay : function(){ var me = this; if (me.isStyle(DISPLAY, NONE)) { me.setStyle(VISIBILITY, HIDDEN); me.setStyle(DISPLAY, getDisplay(me)); // first try reverting to default if (me.isStyle(DISPLAY, NONE)) { // if that fails, default to block me.setStyle(DISPLAY, "block"); } } }, /** * Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}. * @param {Boolean/Object} [animate] true for the default animation or a standard Element animation config object * @return {Ext.dom.Element} this */ hide : function(animate){ // hideMode override if (typeof animate == 'string'){ this.setVisible(false, animate); return this; } this.setVisible(false, this.anim(animate)); return this; }, /** * Show this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}. * @param {Boolean/Object} [animate] true for the default animation or a standard Element animation config object * @return {Ext.dom.Element} this */ show : function(animate){ // hideMode override if (typeof animate == 'string'){ this.setVisible(true, animate); return this; } this.setVisible(true, this.anim(animate)); return this; } }); }); // @tag dom,core /** */ Ext.define('Ext.dom.Element_position', { override: 'Ext.dom.Element' }, function() { var flyInstance, Element = this, LEFT = "left", RIGHT = "right", TOP = "top", BOTTOM = "bottom", POSITION = "position", STATIC = "static", RELATIVE = "relative", ZINDEX = "z-index", BODY = 'BODY', PADDING = 'padding', BORDER = 'border', SLEFT = '-left', SRIGHT = '-right', STOP = '-top', SBOTTOM = '-bottom', SWIDTH = '-width', // special markup used throughout Ext when box wrapping elements borders = {l: BORDER + SLEFT + SWIDTH, r: BORDER + SRIGHT + SWIDTH, t: BORDER + STOP + SWIDTH, b: BORDER + SBOTTOM + SWIDTH}, paddings = {l: PADDING + SLEFT, r: PADDING + SRIGHT, t: PADDING + STOP, b: PADDING + SBOTTOM}, paddingsTLRB = [paddings.l, paddings.r, paddings.t, paddings.b], bordersTLRB = [borders.l, borders.r, borders.t, borders.b], round = Math.round, doc = document, fly = function (el) { if (!flyInstance) { flyInstance = new Ext.Element.Fly(); } flyInstance.attach(el); return flyInstance; }; Element.override({ pxRe: /^\d+(?:\.\d*)?px$/i, inheritableStatics: { getX: function(el) { return Element.getXY(el)[0]; }, getXY: function(el) { var bd = doc.body, docEl = doc.documentElement, leftBorder = 0, topBorder = 0, ret = [0,0], box, scroll; el = Ext.getDom(el); if(el != doc && el != bd){ // IE has the potential to throw when getBoundingClientRect // is called on an element not attached to dom if (Ext.isIE) { try { box = el.getBoundingClientRect(); // In some versions of IE, the documentElement (HTML element) // will have a 2px border that gets included, so subtract it off topBorder = docEl.clientTop || bd.clientTop; leftBorder = docEl.clientLeft || bd.clientLeft; } catch (ex) { box = { left: 0, top: 0 }; } } else { box = el.getBoundingClientRect(); } scroll = fly(doc).getScroll(); ret = [ round(box.left + scroll.left - leftBorder), round(box.top + scroll.top - topBorder) ]; } return ret; }, getY: function(el) { return Element.getXY(el)[1]; }, setX: function(el, x) { Element.setXY(el, [x, false]); }, setXY: function(el, xy) { (el = Ext.fly(el, '_setXY')).position(); var pts = el.translatePoints(xy), style = el.dom.style, pos; // right position may have been previously set by rtlSetXY or // rtlSetLocalXY so clear it here just in case. style.right = 'auto'; for (pos in pts) { if (!isNaN(pts[pos])) { style[pos] = pts[pos] + "px"; } } }, setY: function(el, y) { Element.setXY(el, [false, y]); } }, /** * Centers the Element in either the viewport, or another Element. * @param {String/HTMLElement/Ext.dom.Element} centerIn element in * which to center the element. */ center: function(centerIn){ return this.alignTo(centerIn || doc, 'c-c'); }, /** * Clears positioning back to the default when the document was loaded. * @param {String} [value=''] The value to use for the left, right, top, bottom. * You could use 'auto'. * @return {Ext.dom.Element} this */ clearPositioning: function(value) { value = value || ''; return this.setStyle({ left : value, right : value, top : value, bottom : value, 'z-index' : '', position : STATIC }); }, getAnchorToXY: function(el, anchor, local, mySize) { return el.getAnchorXY(anchor, local, mySize); }, /** * Gets the bottom Y coordinate of the element (element Y position + element height) * @param {Boolean} local True to get the local css position instead of page * coordinate * @return {Number} * @deprecated */ getBottom: function(local) { return (local ? this.getLocalY() : this.getY()) + this.getHeight(); }, getBorderPadding: function() { var paddingWidth = this.getStyle(paddingsTLRB), bordersWidth = this.getStyle(bordersTLRB); return { beforeX: (parseFloat(bordersWidth[borders.l]) || 0) + (parseFloat(paddingWidth[paddings.l]) || 0), afterX: (parseFloat(bordersWidth[borders.r]) || 0) + (parseFloat(paddingWidth[paddings.r]) || 0), beforeY: (parseFloat(bordersWidth[borders.t]) || 0) + (parseFloat(paddingWidth[paddings.t]) || 0), afterY: (parseFloat(bordersWidth[borders.b]) || 0) + (parseFloat(paddingWidth[paddings.b]) || 0) }; }, /** * Calculates the x, y to center this element on the screen * @return {Number[]} The x, y values [x, y] * @deprecated */ getCenterXY: function(){ return this.getAlignToXY(doc, 'c-c'); }, /** * Gets the left X coordinate * @param {Boolean} local True to get the local css position instead of * page coordinate * @return {Number} * @deprecated Use {@link #getX} or {@link #getLocalX} */ getLeft: function(local) { return local ? this.getLocalX() : this.getX(); }, /** * Gets the local CSS X position for the element * * @return {Number} */ getLocalX: function() { var me = this, offsetParent = me.dom.offsetParent, x = me.getStyle('left'); if (!x || x === 'auto') { x = 0; } else if (me.pxRe.test(x)) { x = parseFloat(x); } else { x = me.getX(); if (offsetParent) { x -= Element.getX(offsetParent); } } return x; }, /** * Gets the local CSS X and Y position for the element * * @return {Array} [x, y] */ getLocalXY: function() { var me = this, offsetParent = me.dom.offsetParent, style = me.getStyle(['left', 'top']), x = style.left, y = style.top; if (!x || x === 'auto') { x = 0; } else if (me.pxRe.test(x)) { x = parseFloat(x); } else { x = me.getX(); if (offsetParent) { x -= Element.getX(offsetParent); } } if (!y || y === 'auto') { y = 0; } else if (me.pxRe.test(y)) { y = parseFloat(y); } else { y = me.getY(); if (offsetParent) { y -= Element.getY(offsetParent); } } return [x, y]; }, /** * Gets the local CSS Y position for the element * * @return {Number} */ getLocalY: function() { var me = this, offsetParent = me.dom.offsetParent, y = me.getStyle('top'); if (!y || y === 'auto') { y = 0; } else if (me.pxRe.test(y)) { y = parseFloat(y); } else { y = me.getY(); if (offsetParent) { y -= Element.getY(offsetParent); } } return y; }, /** * Returns an object defining the area of this Element which can be passed to * {@link Ext.util.Positionable#setBox} to set another Element's size/location to match this element. * * @param {Boolean} [asRegion] If true an Ext.util.Region will be returned * @return {Object/Ext.util.Region} box An object in the following format: * * { * left: , * top: , * width: , * height: , * bottom: , * right: * } * * The returned object may also be addressed as an Array where index 0 contains * the X position and index 1 contains the Y position. So the result may also be * used for {@link #setXY} * @deprecated use {@link Ext.util.Positionable#getBox} to get a box object, and * {@link Ext.util.Positionable#getRegion} to get a {@link Ext.util.Region Region}. */ getPageBox: function(getRegion) { var me = this, dom = me.dom, isDoc = dom.nodeName == BODY, w = isDoc ? Ext.Element.getViewWidth() : dom.offsetWidth, h = isDoc ? Ext.Element.getViewHeight() : dom.offsetHeight, xy = me.getXY(), t = xy[1], r = xy[0] + w, b = xy[1] + h, l = xy[0]; if (getRegion) { return new Ext.util.Region(t, r, b, l); } else { return { left: l, top: t, width: w, height: h, right: r, bottom: b }; } }, /** * Gets an object with all CSS positioning properties. Useful along with * #setPostioning to get snapshot before performing an update and then restoring * the element. * @param {Boolean} [autoPx=false] true to return pixel values for "auto" styles. * @return {Object} */ getPositioning: function(autoPx){ var styles = this.getStyle(['left', 'top', 'position', 'z-index']), dom = this.dom; if(autoPx) { if(styles.left === 'auto') { styles.left = dom.offsetLeft + 'px'; } if(styles.top === 'auto') { styles.top = dom.offsetTop + 'px'; } } return styles; }, /** * Gets the right X coordinate of the element (element X position + element width) * @param {Boolean} local True to get the local css position instead of page * coordinates * @return {Number} * @deprecated */ getRight: function(local) { return (local ? this.getLocalX() : this.getX()) + this.getWidth(); }, /** * Gets the top Y coordinate * @param {Boolean} local True to get the local css position instead of page * coordinates * @return {Number} * @deprecated Use {@link #getY} or {@link #getLocalY} */ getTop: function(local) { return local ? this.getLocalY() : this.getY(); }, /** * Gets element X position in page coordinates * * @return {Number} */ getX: function() { return Element.getX(this.dom); }, /** * Gets element X and Y positions in page coordinates * * @return {Array} [x, y] */ getXY: function() { return Element.getXY(this.dom); }, /** * Gets element Y position in page coordinates * * @return {Number} */ getY: function() { return Element.getY(this.dom); }, /** * Sets the position of the element in page coordinates. * @param {Number} x X value for new position (coordinates are page-based) * @param {Number} y Y value for new position (coordinates are page-based) * @param {Boolean/Object} [animate] True for the default animation, or a standard * Element animation config object * @return {Ext.dom.Element} this * @deprecated Use {@link #setXY} instead. */ moveTo: function(x, y, animate) { return this.setXY([x, y], animate); }, /** * Initializes positioning on this element. If a desired position is not passed, * it will make the the element positioned relative IF it is not already positioned. * @param {String} [pos] Positioning to use "relative", "absolute" or "fixed" * @param {Number} [zIndex] The zIndex to apply * @param {Number} [x] Set the page X position * @param {Number} [y] Set the page Y position */ position: function(pos, zIndex, x, y) { var me = this; if (!pos && me.isStyle(POSITION, STATIC)) { me.setStyle(POSITION, RELATIVE); } else if (pos) { me.setStyle(POSITION, pos); } if (zIndex) { me.setStyle(ZINDEX, zIndex); } if (x || y) { me.setXY([x || false, y || false]); } }, /** * Sets the element's CSS bottom style. * @param {Number/String} bottom Number of pixels or CSS string value to set as * the bottom CSS property value * @return {Ext.dom.Element} this * @deprecated */ setBottom: function(bottom) { this.dom.style[BOTTOM] = this.addUnits(bottom); return this; }, /** * Sets the element's position and size in one shot. If animation is true then * width, height, x and y will be animated concurrently. * * @param {Number} x X value for new position (coordinates are page-based) * @param {Number} y Y value for new position (coordinates are page-based) * @param {Number/String} width The new width. This may be one of: * * - A Number specifying the new width in this Element's * {@link #defaultUnit}s (by default, pixels) * - A String used to set the CSS width style. Animation may **not** be used. * * @param {Number/String} height The new height. This may be one of: * * - A Number specifying the new height in this Element's * {@link #defaultUnit}s (by default, pixels) * - A String used to set the CSS height style. Animation may **not** be used. * * @param {Boolean/Object} [animate] true for the default animation or * a standard Element animation config object * * @return {Ext.dom.Element} this * @deprecated Use {@link Ext.util.Positionable#setBox} instead. */ setBounds: function(x, y, width, height, animate) { return this.setBox({ x: x, y: y, width: width, height: height }, animate); }, /** * Sets the element's left position directly using CSS style * (instead of {@link #setX}). * @param {Number/String} left Number of pixels or CSS string value to * set as the left CSS property value * @return {Ext.dom.Element} this * @deprecated */ setLeft: function(left) { this.dom.style[LEFT] = this.addUnits(left); return this; }, /** * Sets the element's left and top positions directly using CSS style * @param {Number/String} left Number of pixels or CSS string value to * set as the left CSS property value * @param {Number/String} top Number of pixels or CSS string value to * set as the top CSS property value * @return {Ext.dom.Element} this * @deprecated */ setLeftTop: function(left, top) { var me = this, style = me.dom.style; style.left = me.addUnits(left); style.top = me.addUnits(top); return me; }, setLocalX: function(x) { var style = this.dom.style; // clear right style just in case it was previously set by rtlSetXY/rtlSetLocalXY style.right = 'auto'; style.left = (x === null) ? 'auto' : x + 'px'; }, setLocalXY: function(x, y) { var style = this.dom.style; // clear right style just in case it was previously set by rtlSetXY/rtlSetLocalXY style.right = 'auto'; if (x && x.length) { y = x[1]; x = x[0]; } if (x === null) { style.left = 'auto'; } else if (x !== undefined) { style.left = x + 'px'; } if (y === null) { style.top = 'auto'; } else if (y !== undefined) { style.top = y + 'px'; } }, setLocalY: function(y) { this.dom.style.top = (y === null) ? 'auto' : y + 'px'; }, /** * Sets the position of the element in page coordinates. * @param {Number} x X value for new position * @param {Number} y Y value for new position * @param {Boolean/Object} [animate] True for the default animation, or a standard * Element animation config object * @return {Ext.dom.Element} this * @deprecated Use {@link #setXY} instead. */ setLocation: function(x, y, animate) { return this.setXY([x, y], animate); }, /** * Set positioning with an object returned by #getPositioning. * @param {Object} posCfg * @return {Ext.dom.Element} this */ setPositioning: function(pc) { return this.setStyle(pc); }, /** * Sets the element's CSS right style. * @param {Number/String} right Number of pixels or CSS string value to * set as the right CSS property value * @return {Ext.dom.Element} this * @deprecated */ setRight: function(right) { this.dom.style[RIGHT] = this.addUnits(right); return this; }, /** * Sets the element's top position directly using CSS style * (instead of {@link #setY}). * @param {Number/String} top Number of pixels or CSS string value to * set as the top CSS property value * @return {Ext.dom.Element} this * @deprecated */ setTop: function(top) { this.dom.style[TOP] = this.addUnits(top); return this; }, setX: function(x, animate) { return this.setXY([x, this.getY()], animate); }, setXY: function(xy, animate) { var me = this; if (!animate || !me.anim) { Element.setXY(me.dom, xy); } else { if (!Ext.isObject(animate)) { animate = {}; } me.animate(Ext.applyIf({ to: { x: xy[0], y: xy[1] } }, animate)); } return this; }, setY: function(y, animate) { return this.setXY([this.getX(), y], animate); } }); /** * @private * Returns the `X,Y` position of the passed element in browser document space without regard * to any RTL direction settings. */ Element.getTrueXY = Element.getXY; }); // @tag dom,core /** */ Ext.define('Ext.dom.Element_scroll', { override: 'Ext.dom.Element', /** * Returns true if this element is scrollable. * @return {Boolean} */ isScrollable: function() { var dom = this.dom; return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth; }, /** * Returns the current scroll position of the element. * @return {Object} An object containing the scroll position in the format * `{left: (scrollLeft), top: (scrollTop)}` */ getScroll: function() { var me = this, dom = me.dom, doc = document, body = doc.body, docElement = doc.documentElement, left, top; if (dom === doc || dom === body) { // the scrollLeft/scrollTop may be either on the body or documentElement, // depending on browser. It is possible to use window.pageXOffset/pageYOffset // in most modern browsers but this complicates things when in rtl mode because // pageXOffset does not always behave the same as scrollLeft when direction is // rtl. (e.g. pageXOffset can be an offset from the right, while scrollLeft // is offset from the left, one can be positive and the other negative, etc.) // To avoid adding an extra layer of feature detection in rtl mode to deal with // these differences, it's best just to always use scrollLeft/scrollTop left = docElement.scrollLeft || (body ? body.scrollLeft : 0); top = docElement.scrollTop || (body ? body.scrollTop : 0); } else { left = dom.scrollLeft; top = dom.scrollTop; } return { left: left, top: top }; }, /** * Gets the left scroll position * @return {Number} The left scroll position */ getScrollLeft: function() { var dom = this.dom, doc = document; if (dom === doc || dom === doc.body) { return this.getScroll().left; } else { return dom.scrollLeft; } }, /** * Gets the top scroll position * @return {Number} The top scroll position */ getScrollTop: function(){ var dom = this.dom, doc = document; if (dom === doc || dom === doc.body) { return this.getScroll().top; } else { return dom.scrollTop; } }, /** * Sets the left scroll position * @param {Number} left The left scroll position * @return {Ext.dom.Element} this */ setScrollLeft: function(left){ this.dom.scrollLeft = left; return this; }, /** * Sets the top scroll position * @param {Number} top The top scroll position * @return {Ext.dom.Element} this */ setScrollTop: function(top) { this.dom.scrollTop = top; return this; }, /** * Scrolls this element by the passed delta values, optionally animating. * * All of the following are equivalent: * * el.scrollBy(10, 10, true); * el.scrollBy([10, 10], true); * el.scrollBy({ x: 10, y: 10 }, true); * * @param {Number/Number[]/Object} deltaX Either the x delta, an Array specifying x and y deltas or * an object with "x" and "y" properties. * @param {Number/Boolean/Object} deltaY Either the y delta, or an animate flag or config object. * @param {Boolean/Object} animate Animate flag/config object if the delta values were passed separately. * @return {Ext.Element} this */ scrollBy: function(deltaX, deltaY, animate) { var me = this, dom = me.dom; // Extract args if deltas were passed as an Array. if (deltaX.length) { animate = deltaY; deltaY = deltaX[1]; deltaX = deltaX[0]; } else if (typeof deltaX != 'number') { // or an object animate = deltaY; deltaY = deltaX.y; deltaX = deltaX.x; } if (deltaX) { me.scrollTo('left', me.constrainScrollLeft(dom.scrollLeft + deltaX), animate); } if (deltaY) { me.scrollTo('top', me.constrainScrollTop(dom.scrollTop + deltaY), animate); } return me; }, /** * Scrolls this element the specified scroll point. It does NOT do bounds checking so * if you scroll to a weird value it will try to do it. For auto bounds checking, use #scroll. * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values. * @param {Number} value The new scroll value * @param {Boolean/Object} [animate] true for the default animation or a standard Element * animation config object * @return {Ext.Element} this */ scrollTo: function(side, value, animate) { //check if we're scrolling top or left var top = /top/i.test(side), me = this, prop = top ? 'scrollTop' : 'scrollLeft', dom = me.dom, animCfg; if (!animate || !me.anim) { // just setting the value, so grab the direction dom[prop] = value; // corrects IE, other browsers will ignore dom[prop] = value; } else { animCfg = { to: {} }; animCfg.to[prop] = value; if (Ext.isObject(animate)) { Ext.applyIf(animCfg, animate); } me.animate(animCfg); } return me; }, /** * Scrolls this element into view within the passed container. * @param {String/HTMLElement/Ext.Element} [container=document.body] The container element * to scroll. Should be a string (id), dom node, or Ext.Element. * @param {Boolean} [hscroll=true] False to disable horizontal scroll. * @param {Boolean/Object} [animate] true for the default animation or a standard Element * @param {Boolean} [highlight=false] true to {@link #highlight} the element when it is in view. * animation config object * @return {Ext.dom.Element} this */ scrollIntoView: function(container, hscroll, animate, highlight) { var me = this, dom = me.dom, offsets = me.getOffsetsTo(container = Ext.getDom(container) || Ext.getBody().dom), // el's box left = offsets[0] + container.scrollLeft, top = offsets[1] + container.scrollTop, bottom = top + dom.offsetHeight, right = left + dom.offsetWidth, // ct's box ctClientHeight = container.clientHeight, ctScrollTop = parseInt(container.scrollTop, 10), ctScrollLeft = parseInt(container.scrollLeft, 10), ctBottom = ctScrollTop + ctClientHeight, ctRight = ctScrollLeft + container.clientWidth, newPos; // Highlight upon end of scroll if (highlight) { if (animate) { animate = Ext.apply({ listeners: { afteranimate: function() { me.scrollChildFly.attach(dom).highlight(); } } }, animate); } else { me.scrollChildFly.attach(dom).highlight(); } } if (dom.offsetHeight > ctClientHeight || top < ctScrollTop) { newPos = top; } else if (bottom > ctBottom) { newPos = bottom - ctClientHeight; } if (newPos != null) { me.scrollChildFly.attach(container).scrollTo('top', newPos, animate); } if (hscroll !== false) { newPos = null; if (dom.offsetWidth > container.clientWidth || left < ctScrollLeft) { newPos = left; } else if (right > ctRight) { newPos = right - container.clientWidth; } if (newPos != null) { me.scrollChildFly.attach(container).scrollTo('left', newPos, animate); } } return me; }, // @private scrollChildIntoView: function(child, hscroll) { this.scrollChildFly.attach(Ext.getDom(child)).scrollIntoView(this, hscroll); }, /** * Scrolls this element the specified direction. Does bounds checking to make sure the scroll is * within this element's scrollable range. * @param {String} direction Possible values are: * * - `"l"` (or `"left"`) * - `"r"` (or `"right"`) * - `"t"` (or `"top"`, or `"up"`) * - `"b"` (or `"bottom"`, or `"down"`) * * @param {Number} distance How far to scroll the element in pixels * @param {Boolean/Object} [animate] true for the default animation or a standard Element * animation config object * @return {Boolean} Returns true if a scroll was triggered or false if the element * was scrolled as far as it could go. */ scroll: function(direction, distance, animate) { if (!this.isScrollable()) { return false; } var me = this, dom = me.dom, side = direction === 'r' || direction === 'l' ? 'left' : 'top', scrolled = false, currentScroll, constrainedScroll; if (direction === 'r') { distance = -distance; } if (side === 'left') { currentScroll = dom.scrollLeft; constrainedScroll = me.constrainScrollLeft(currentScroll + distance); } else { currentScroll = dom.scrollTop; constrainedScroll = me.constrainScrollTop(currentScroll + distance); } if (constrainedScroll !== currentScroll) { this.scrollTo(side, constrainedScroll, animate); scrolled = true; } return scrolled; }, constrainScrollLeft: function(left) { var dom = this.dom; return Math.max(Math.min(left, dom.scrollWidth - dom.clientWidth), 0); }, constrainScrollTop: function(top) { var dom = this.dom; return Math.max(Math.min(top, dom.scrollHeight - dom.clientHeight), 0); } }, function() { this.prototype.scrollChildFly = new this.Fly(); this.prototype.scrolltoFly = new this.Fly(); }); // @tag dom,core /** */ Ext.define('Ext.dom.Element_style', { override: 'Ext.dom.Element' }, function() { var Element = this, view = document.defaultView, adjustDirect2DTableRe = /table-row|table-.*-group/, INTERNAL = '_internal', HIDDEN = 'hidden', HEIGHT = 'height', WIDTH = 'width', ISCLIPPED = 'isClipped', OVERFLOW = 'overflow', OVERFLOWX = 'overflow-x', OVERFLOWY = 'overflow-y', ORIGINALCLIP = 'originalClip', DOCORBODYRE = /#document|body/i, // This reduces the lookup of 'me.styleHooks' by one hop in the prototype chain. It is // the same object. styleHooks, verticalStyleHooks90, verticalStyleHooks270, edges, k, edge, borderWidth; if (!view || !view.getComputedStyle) { Element.prototype.getStyle = function (property, inline) { var me = this, dom = me.dom, multiple = typeof property != 'string', hooks = me.styleHooks, prop = property, props = prop, len = 1, isInline = inline, camel, domStyle, values, hook, out, style, i; if (multiple) { values = {}; prop = props[0]; i = 0; if (!(len = props.length)) { return values; } } if (!dom || dom.documentElement) { return values || ''; } domStyle = dom.style; if (inline) { style = domStyle; } else { style = dom.currentStyle; // fallback to inline style if rendering context not available if (!style) { isInline = true; style = domStyle; } } do { hook = hooks[prop]; if (!hook) { hooks[prop] = hook = { name: Element.normalize(prop) }; } if (hook.get) { out = hook.get(dom, me, isInline, style); } else { camel = hook.name; // In some cases, IE6 will throw Invalid Argument exceptions for properties // like fontSize (/examples/tabs/tabs.html in 4.0 used to exhibit this but // no longer does due to font style changes). There is a real cost to a try // block, so we avoid it where possible... if (hook.canThrow) { try { out = style[camel]; } catch (e) { out = ''; } } else { // EXTJSIV-5657 - In IE9 quirks mode there is a chance that VML root element // has neither `currentStyle` nor `style`. Return '' this case. out = style ? style[camel] : ''; } } if (!multiple) { return out; } values[prop] = out; prop = props[++i]; } while (i < len); return values; }; } Element.override({ getHeight: function(contentHeight, preciseHeight) { var me = this, hidden = me.isStyle('display', 'none'), height, floating; if (hidden) { return 0; } height = me.dom.offsetHeight; // IE9/10 Direct2D dimension rounding bug if (Ext.supports.Direct2DBug) { floating = me.adjustDirect2DDimension(HEIGHT); if (preciseHeight) { height += floating; } else if (floating > 0 && floating < 0.5) { height++; } } if (contentHeight) { height -= me.getBorderWidth("tb") + me.getPadding("tb"); } return (height < 0) ? 0 : height; }, getWidth: function(contentWidth, preciseWidth) { var me = this, dom = me.dom, hidden = me.isStyle('display', 'none'), rect, width, floating; if (hidden) { return 0; } // Gecko will in some cases report an offsetWidth that is actually less than the width of the // text contents, because it measures fonts with sub-pixel precision but rounds the calculated // value down. Using getBoundingClientRect instead of offsetWidth allows us to get the precise // subpixel measurements so we can force them to always be rounded up. See // https://bugzilla.mozilla.org/show_bug.cgi?id=458617 // Rounding up ensures that the width includes the full width of the text contents. if (preciseWidth && Ext.supports.BoundingClientRect) { rect = dom.getBoundingClientRect(); // IE9 is the only browser that supports getBoundingClientRect() and // uses a filter to rotate the element vertically. When a filter // is used to rotate the element, the getHeight/getWidth functions // are not inverted (see setVertical). width = (me.vertical && !Ext.isIE9 && !Ext.supports.RotatedBoundingClientRect) ? (rect.bottom - rect.top) : (rect.right - rect.left); } else { width = dom.offsetWidth; } // IE9/10 Direct2D dimension rounding bug: https://sencha.jira.com/browse/EXTJSIV-603 // there is no need make adjustments for this bug when the element is vertically // rotated because the width of a vertical element is its rotated height if (Ext.supports.Direct2DBug && !me.vertical) { // get the fractional portion of the sub-pixel precision width of the element's text contents floating = me.adjustDirect2DDimension(WIDTH); if (preciseWidth) { width += floating; } // IE9 also measures fonts with sub-pixel precision, but unlike Gecko, instead of rounding the offsetWidth down, // it rounds to the nearest integer. This means that in order to ensure that the width includes the full // width of the text contents we need to increment the width by 1 only if the fractional portion is less than 0.5 else if (floating > 0 && floating < 0.5) { width++; } } if (contentWidth) { width -= me.getBorderWidth("lr") + me.getPadding("lr"); } return (width < 0) ? 0 : width; }, setWidth: function(width, animate) { var me = this; width = me.adjustWidth(width); if (!animate || !me.anim) { me.dom.style.width = me.addUnits(width); } else { if (!Ext.isObject(animate)) { animate = {}; } me.animate(Ext.applyIf({ to: { width: width } }, animate)); } return me; }, setHeight : function(height, animate) { var me = this; height = me.adjustHeight(height); if (!animate || !me.anim) { me.dom.style.height = me.addUnits(height); } else { if (!Ext.isObject(animate)) { animate = {}; } me.animate(Ext.applyIf({ to: { height: height } }, animate)); } return me; }, applyStyles: function(style) { Ext.DomHelper.applyStyles(this.dom, style); return this; }, setSize: function(width, height, animate) { var me = this; if (Ext.isObject(width)) { // in case of object from getSize() animate = height; height = width.height; width = width.width; } width = me.adjustWidth(width); height = me.adjustHeight(height); if (!animate || !me.anim) { me.dom.style.width = me.addUnits(width); me.dom.style.height = me.addUnits(height); } else { if (animate === true) { animate = {}; } me.animate(Ext.applyIf({ to: { width: width, height: height } }, animate)); } return me; }, getViewSize : function() { var me = this, dom = me.dom, isDoc = DOCORBODYRE.test(dom.nodeName), ret; // If the body, use static methods if (isDoc) { ret = { width : Element.getViewWidth(), height : Element.getViewHeight() }; } else { ret = { width : dom.clientWidth, height : dom.clientHeight }; } return ret; }, getSize: function(contentSize) { return {width: this.getWidth(contentSize), height: this.getHeight(contentSize)}; }, // TODO: Look at this // private ==> used by Fx adjustWidth : function(width) { var me = this, isNum = (typeof width == 'number'); if (isNum && me.autoBoxAdjust && !me.isBorderBox()) { width -= (me.getBorderWidth("lr") + me.getPadding("lr")); } return (isNum && width < 0) ? 0 : width; }, // private ==> used by Fx adjustHeight : function(height) { var me = this, isNum = (typeof height == "number"); if (isNum && me.autoBoxAdjust && !me.isBorderBox()) { height -= (me.getBorderWidth("tb") + me.getPadding("tb")); } return (isNum && height < 0) ? 0 : height; }, /** * Return the CSS color for the specified CSS attribute. rgb, 3 digit (like `#fff`) and valid values * are convert to standard 6 digit hex color. * @param {String} attr The css attribute * @param {String} defaultValue The default value to use when a valid color isn't found * @param {String} [prefix] defaults to #. Use an empty string when working with * color anims. */ getColor : function(attr, defaultValue, prefix) { var v = this.getStyle(attr), color = prefix || prefix === '' ? prefix : '#', h, len, i=0; if (!v || (/transparent|inherit/.test(v))) { return defaultValue; } if (/^r/.test(v)) { v = v.slice(4, v.length - 1).split(','); len = v.length; for (; i 5 ? color.toLowerCase() : defaultValue); }, /** * Set the opacity of the element * @param {Number} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc * @param {Boolean/Object} [animate] a standard Element animation config object or `true` for * the default animation (`{duration: 350, easing: 'easeIn'}`) * @return {Ext.dom.Element} this */ setOpacity: function(opacity, animate) { var me = this; if (!me.dom) { return me; } if (!animate || !me.anim) { me.setStyle('opacity', opacity); } else { if (typeof animate != 'object') { animate = { duration: 350, easing: 'ease-in' }; } me.animate(Ext.applyIf({ to: { opacity: opacity } }, animate)); } return me; }, /** * Clears any opacity settings from this element. Required in some cases for IE. * @return {Ext.dom.Element} this */ clearOpacity : function() { return this.setOpacity(''); }, /** * @private * Returns 1 if the browser returns the subpixel dimension rounded to the lowest pixel. * @return {Number} 0 or 1 */ adjustDirect2DDimension: function(dimension) { var me = this, dom = me.dom, display = me.getStyle('display'), inlineDisplay = dom.style.display, inlinePosition = dom.style.position, originIndex = dimension === WIDTH ? 0 : 1, currentStyle = dom.currentStyle, floating; if (display === 'inline') { dom.style.display = 'inline-block'; } dom.style.position = display.match(adjustDirect2DTableRe) ? 'absolute' : 'static'; // floating will contain digits that appears after the decimal point // if height or width are set to auto we fallback to msTransformOrigin calculation // Use currentStyle here instead of getStyle. In some difficult to reproduce // instances it resets the scrollWidth of the element floating = (parseFloat(currentStyle[dimension]) || parseFloat(currentStyle.msTransformOrigin.split(' ')[originIndex]) * 2) % 1; dom.style.position = inlinePosition; if (display === 'inline') { dom.style.display = inlineDisplay; } return floating; }, /** * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove * @return {Ext.dom.Element} this */ clip : function() { var me = this, data = (me.$cache || me.getCache()).data, style; if (!data[ISCLIPPED]) { data[ISCLIPPED] = true; style = me.getStyle([OVERFLOW, OVERFLOWX, OVERFLOWY]); data[ORIGINALCLIP] = { o: style[OVERFLOW], x: style[OVERFLOWX], y: style[OVERFLOWY] }; me.setStyle(OVERFLOW, HIDDEN); me.setStyle(OVERFLOWX, HIDDEN); me.setStyle(OVERFLOWY, HIDDEN); } return me; }, /** * Return clipping (overflow) to original clipping before {@link #clip} was called * @return {Ext.dom.Element} this */ unclip : function() { var me = this, data = (me.$cache || me.getCache()).data, clip; if (data[ISCLIPPED]) { data[ISCLIPPED] = false; clip = data[ORIGINALCLIP]; if (clip.o) { me.setStyle(OVERFLOW, clip.o); } if (clip.x) { me.setStyle(OVERFLOWX, clip.x); } if (clip.y) { me.setStyle(OVERFLOWY, clip.y); } } return me; }, /** * Wraps the specified element with a special 9 element markup/CSS block that renders by default as * a gray container with a gradient background, rounded corners and a 4-way shadow. * * This special markup is used throughout Ext when box wrapping elements ({@link Ext.button.Button}, * {@link Ext.panel.Panel} when {@link Ext.panel.Panel#frame frame=true}, {@link Ext.window.Window}). * The markup is of this form: * * Ext.dom.Element.boxMarkup = * '
*
*
'; * * Example usage: * * // Basic box wrap * Ext.get("foo").boxWrap(); * * // You can also add a custom class and use CSS inheritance rules to customize the box look. * // 'x-box-blue' is a built-in alternative -- look at the related CSS definitions as an example * // for how to create a custom box wrap style. * Ext.get("foo").boxWrap().addCls("x-box-blue"); * * @param {String} [class='x-box'] A base CSS class to apply to the containing wrapper element. * Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, * so if you supply an alternate base class, make sure you also supply all of the necessary rules. * @return {Ext.dom.Element} The outermost wrapping element of the created box structure. */ boxWrap : function(cls) { cls = cls || Ext.baseCSSPrefix + 'box'; var el = Ext.get(this.insertHtml("beforeBegin", "
" + Ext.String.format(Element.boxMarkup, cls) + "
")); Ext.DomQuery.selectNode('.' + cls + '-mc', el.dom).appendChild(this.dom); return el; }, /** * Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders * when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements * if a height has not been set using CSS. * @return {Number} */ getComputedHeight : function() { var me = this, h = Math.max(me.dom.offsetHeight, me.dom.clientHeight); if (!h) { h = parseFloat(me.getStyle(HEIGHT)) || 0; if (!me.isBorderBox()) { h += me.getFrameWidth('tb'); } } return h; }, /** * Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders * when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements * if a width has not been set using CSS. * @return {Number} */ getComputedWidth : function() { var me = this, w = Math.max(me.dom.offsetWidth, me.dom.clientWidth); if (!w) { w = parseFloat(me.getStyle(WIDTH)) || 0; if (!me.isBorderBox()) { w += me.getFrameWidth('lr'); } } return w; }, /** * Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() * for more information about the sides. * @param {String} sides * @return {Number} */ getFrameWidth : function(sides, onlyContentBox) { return (onlyContentBox && this.isBorderBox()) ? 0 : (this.getPadding(sides) + this.getBorderWidth(sides)); }, /** * Sets up event handlers to add and remove a css class when the mouse is over this element * @param {String} className The class to add * @param {Function} [testFn] A test function to execute before adding the class. The passed parameter * will be the Element instance. If this functions returns false, the class will not be added. * @param {Object} [scope] The scope to execute the testFn in. * @return {Ext.dom.Element} this */ addClsOnOver : function(className, testFn, scope) { var me = this, dom = me.dom, hasTest = Ext.isFunction(testFn); me.hover( function() { if (hasTest && testFn.call(scope || me, me) === false) { return; } Ext.fly(dom, INTERNAL).addCls(className); }, function() { Ext.fly(dom, INTERNAL).removeCls(className); } ); return me; }, /** * Sets up event handlers to add and remove a css class when this element has the focus * @param {String} className The class to add * @param {Function} [testFn] A test function to execute before adding the class. The passed parameter * will be the Element instance. If this functions returns false, the class will not be added. * @param {Object} [scope] The scope to execute the testFn in. * @return {Ext.dom.Element} this */ addClsOnFocus : function(className, testFn, scope) { var me = this, dom = me.dom, hasTest = Ext.isFunction(testFn); me.on("focus", function() { if (hasTest && testFn.call(scope || me, me) === false) { return false; } Ext.fly(dom, INTERNAL).addCls(className); }); me.on("blur", function() { Ext.fly(dom, INTERNAL).removeCls(className); }); return me; }, /** * Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect) * @param {String} className The class to add * @param {Function} [testFn] A test function to execute before adding the class. The passed parameter * will be the Element instance. If this functions returns false, the class will not be added. * @param {Object} [scope] The scope to execute the testFn in. * @return {Ext.dom.Element} this */ addClsOnClick : function(className, testFn, scope) { var me = this, dom = me.dom, hasTest = Ext.isFunction(testFn); me.on("mousedown", function() { if (hasTest && testFn.call(scope || me, me) === false) { return false; } Ext.fly(dom, INTERNAL).addCls(className); var d = Ext.getDoc(), fn = function() { Ext.fly(dom, INTERNAL).removeCls(className); d.removeListener("mouseup", fn); }; d.on("mouseup", fn); }); return me; }, /** * Returns the dimensions of the element available to lay content out in. * * getStyleSize utilizes prefers style sizing if present, otherwise it chooses the larger of offsetHeight/clientHeight and * offsetWidth/clientWidth. To obtain the size excluding scrollbars, use getViewSize. * * Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc. * * @return {Object} Object describing width and height. * @return {Number} return.width * @return {Number} return.height */ getStyleSize : function() { var me = this, d = this.dom, isDoc = DOCORBODYRE.test(d.nodeName), s , w, h; // If the body, use static methods if (isDoc) { return { width : Element.getViewWidth(), height : Element.getViewHeight() }; } s = me.getStyle([HEIGHT, WIDTH], true); //seek inline // Use Styles if they are set if (s.width && s.width != 'auto') { w = parseFloat(s.width); if (me.isBorderBox()) { w -= me.getFrameWidth('lr'); } } // Use Styles if they are set if (s.height && s.height != 'auto') { h = parseFloat(s.height); if (me.isBorderBox()) { h -= me.getFrameWidth('tb'); } } // Use getWidth/getHeight if style not set. return {width: w || me.getWidth(true), height: h || me.getHeight(true)}; }, statics: { selectableCls: Ext.baseCSSPrefix + 'selectable', unselectableCls: Ext.baseCSSPrefix + 'unselectable' }, /** * Enable text selection for this element (normalized across browsers) * @return {Ext.Element} this */ selectable : function() { var me = this; // We clear this property for all browsers, not just Opera. This is so that rendering templates don't need to // condition on Opera when making elements unselectable. me.dom.unselectable = ''; me.removeCls(Element.unselectableCls); me.addCls(Element.selectableCls); return me; }, /** * Disables text selection for this element (normalized across browsers) * @return {Ext.dom.Element} this */ unselectable : function() { // The approach used to disable text selection combines CSS, HTML attributes and DOM events. Importantly the // strategy is designed to be expressible in markup, so that elements can be rendered unselectable without // needing modifications post-render. e.g.: // //
// // Changes to this method may need to be reflected elsewhere, e.g. ProtoElement. var me = this; // The unselectable property (or similar) is supported by various browsers but Opera is the only browser that // doesn't support any of the other techniques. The problem with it is that it isn't inherited by child // elements. Theoretically we could add it to all children but the performance would be terrible. In certain // key locations (e.g. panel headers) we add unselectable="on" to extra elements during rendering just for // Opera's benefit. if (Ext.isOpera) { me.dom.unselectable = 'on'; } // In Mozilla and WebKit the CSS properties -moz-user-select and -webkit-user-select prevent a selection // originating in an element. These are inherited, which is what we want. // // In IE we rely on a listener for the selectstart event instead. We don't need to register a listener on the // individual element, instead we use a single listener and rely on event propagation to listen for the event at // the document level. That listener will walk up the DOM looking for nodes that have either of the classes // x-selectable or x-unselectable. This simulates the CSS inheritance approach. // // IE 10 is expected to support -ms-user-select so the listener may not be required. me.removeCls(Element.selectableCls); me.addCls(Element.unselectableCls); return me; }, /** * Changes this Element's state to "vertical" (rotated 90 or 270 degrees). * This involves inverting the getters and setters for height and width, * and applying hooks for rotating getters and setters for border/margin/padding. * (getWidth becomes getHeight and vice versa), setStyle and getStyle will * also return the inverse when height or width are being operated on. * * @param {Number} angle the angle of rotation - either 90 or 270 * @param {String} cls an optional css class that contains the required * styles for switching the element to vertical orientation. Omit this if * the element already contains vertical styling. If cls is provided, * it will be removed from the element when {@link #setHorizontal} is called. * @private */ setVertical: function(angle, cls) { var me = this, proto = Element.prototype, hooks; me.vertical = true; if (cls) { me.addCls(me.verticalCls = cls); } me.setWidth = proto.setHeight; me.setHeight = proto.setWidth; if (!Ext.isIE9m) { // In browsers that use CSS3 transforms we must invert getHeight and // get Width. In IE9 and below no adjustment is needed because we use // a BasicImage filter to rotate the element and the element's // offsetWidth and offsetHeight are automatically inverted. me.getWidth = proto.getHeight; me.getHeight = proto.getWidth; } // Switch to using the appropriate vertical style hooks me.styleHooks = (angle === 270) ? Element.prototype.verticalStyleHooks270 : Element.prototype.verticalStyleHooks90; }, /** * Removes "vertical" state from this element (reverses everything done * by {@link #setVertical}). * @private */ setHorizontal: function() { var me = this, cls = me.verticalCls; delete me.vertical; if (cls) { delete me.verticalCls; me.removeCls(cls); } // delete the inverted methods and revert to inheriting from the prototype delete me.setWidth; delete me.setHeight; if (!Ext.isIE9m) { delete me.getWidth; delete me.getHeight; } // revert to inheriting styleHooks from the prototype delete me.styleHooks; } }); Element.prototype.styleHooks = styleHooks = Ext.dom.AbstractElement.prototype.styleHooks; // When elements are rotated 80 or 270 degrees, their border, margin and padding hooks // need to be rotated as well. Element.prototype.verticalStyleHooks90 = verticalStyleHooks90 = Ext.Object.chain(Element.prototype.styleHooks); Element.prototype.verticalStyleHooks270 = verticalStyleHooks270 = Ext.Object.chain(Element.prototype.styleHooks); verticalStyleHooks90.width = { name: 'height' }; verticalStyleHooks90.height = { name: 'width' }; verticalStyleHooks90['margin-top'] = { name: 'marginLeft' }; verticalStyleHooks90['margin-right'] = { name: 'marginTop' }; verticalStyleHooks90['margin-bottom'] = { name: 'marginRight' }; verticalStyleHooks90['margin-left'] = { name: 'marginBottom' }; verticalStyleHooks90['padding-top'] = { name: 'paddingLeft' }; verticalStyleHooks90['padding-right'] = { name: 'paddingTop' }; verticalStyleHooks90['padding-bottom'] = { name: 'paddingRight' }; verticalStyleHooks90['padding-left'] = { name: 'paddingBottom' }; verticalStyleHooks90['border-top'] = { name: 'borderLeft' }; verticalStyleHooks90['border-right'] = { name: 'borderTop' }; verticalStyleHooks90['border-bottom'] = { name: 'borderRight' }; verticalStyleHooks90['border-left'] = { name: 'borderBottom' }; verticalStyleHooks270.width = { name: 'height' }; verticalStyleHooks270.height = { name: 'width' }; verticalStyleHooks270['margin-top'] = { name: 'marginRight' }; verticalStyleHooks270['margin-right'] = { name: 'marginBottom' }; verticalStyleHooks270['margin-bottom'] = { name: 'marginLeft' }; verticalStyleHooks270['margin-left'] = { name: 'marginTop' }; verticalStyleHooks270['padding-top'] = { name: 'paddingRight' }; verticalStyleHooks270['padding-right'] = { name: 'paddingBottom' }; verticalStyleHooks270['padding-bottom'] = { name: 'paddingLeft' }; verticalStyleHooks270['padding-left'] = { name: 'paddingTop' }; verticalStyleHooks270['border-top'] = { name: 'borderRight' }; verticalStyleHooks270['border-right'] = { name: 'borderBottom' }; verticalStyleHooks270['border-bottom'] = { name: 'borderLeft' }; verticalStyleHooks270['border-left'] = { name: 'borderTop' }; if (Ext.isIE7m) { styleHooks.fontSize = styleHooks['font-size'] = { name: 'fontSize', canThrow: true }; styleHooks.fontStyle = styleHooks['font-style'] = { name: 'fontStyle', canThrow: true }; styleHooks.fontFamily = styleHooks['font-family'] = { name: 'fontFamily', canThrow: true }; } // override getStyle for border-*-width if (Ext.isIEQuirks || Ext.isIE && Ext.ieVersion <= 8) { function getBorderWidth (dom, el, inline, style) { if (style[this.styleName] == 'none') { return '0px'; } return style[this.name]; } edges = ['Top','Right','Bottom','Left']; k = edges.length; while (k--) { edge = edges[k]; borderWidth = 'border' + edge + 'Width'; styleHooks['border-'+edge.toLowerCase()+'-width'] = styleHooks[borderWidth] = { name: borderWidth, styleName: 'border' + edge + 'Style', get: getBorderWidth }; } } // The following hack is needed to support padding on dom elements with display:table. // It was added because at one point auto layout's "outerCt" element had padding applied // to it. The padding is now appplied to the innerCt which is display:table-cell, so this // hack is not currently needed. //if (Ext.isIE9 && Ext.isStrict) { // // In IE9, getComputedStyle always returns 0px for padding if the element has // // "display:table", so we use currentStyle instead. // var names = { // padding: 'padding', // paddingTop: 'padding-top', // paddingRight: 'padding-right', // paddingBottom: 'padding-bottom', // paddingLeft: 'padding-left' // }, // createHook = function(name, camelCaseName) { // styleHooks[name] = styleHooks[camelCaseName] = { // name: name, // get: function(dom) { // return dom.currentStyle[name]; // } // } // }, // camelCaseName; // // for (camelCaseName in names) { // createHook(names[camelCaseName], camelCaseName); // } //} // Element.unselectable relies on this listener to prevent selection in IE. Some other browsers support the event too // but it is only strictly required for IE. In WebKit this listener causes subtle differences to how the browser handles // the non-selection, e.g. whether or not the mouse cursor changes when attempting to select text. Ext.getDoc().on('selectstart', function(ev, dom) { var doc = document.documentElement, selectableCls = Element.selectableCls, unselectableCls = Element.unselectableCls, tagName = dom && dom.tagName; tagName = tagName && tagName.toLowerCase(); // Element.unselectable is not really intended to handle selection within text fields and it is important that // fields inside menus or panel headers don't inherit the unselectability. In most browsers this is automatic but in // IE 9 the selectstart event can bubble up from text fields so we have to explicitly handle that case. if (tagName === 'input' || tagName === 'textarea') { return; } // Walk up the DOM checking the nodes. This may be 'slow' but selectstart events don't fire very often while (dom && dom.nodeType === 1 && dom !== doc) { var el = Ext.fly(dom); // If the node has the class x-selectable then stop looking, the text selection is allowed if (el.hasCls(selectableCls)) { return; } // If the node has class x-unselectable then the text selection needs to be stopped if (el.hasCls(unselectableCls)) { ev.stopEvent(); return; } dom = dom.parentNode; } }); }); Ext.onReady(function () { var opacityRe = /alpha\(opacity=(.*)\)/i, trimRe = /^\s+|\s+$/g, hooks = Ext.dom.Element.prototype.styleHooks; // Ext.supports flags are not populated until onReady... hooks.opacity = { name: 'opacity', afterSet: function(dom, value, el) { if (el.isLayer) { el.onOpacitySet(value); } } }; if (!Ext.supports.Opacity && Ext.isIE) { Ext.apply(hooks.opacity, { get: function (dom) { var filter = dom.style.filter, match, opacity; if (filter.match) { match = filter.match(opacityRe); if (match) { opacity = parseFloat(match[1]); if (!isNaN(opacity)) { return opacity ? opacity / 100 : 0; } } } return 1; }, set: function (dom, value) { var style = dom.style, val = style.filter.replace(opacityRe, '').replace(trimRe, ''); style.zoom = 1; // ensure dom.hasLayout // value can be a number or '' or null... so treat falsey as no opacity if (typeof(value) == 'number' && value >= 0 && value < 1) { value *= 100; style.filter = val + (val.length ? ' ' : '') + 'alpha(opacity='+value+')'; } else { style.filter = val; } } }); } // else there is no work around for the lack of opacity support. Should not be a // problem given that this has been supported for a long time now... }); // @tag core /** * This mixin provides a common interface for objects that can be positioned, e.g. * {@link Ext.Component Components} and {@link Ext.dom.Element Elements} */ Ext.define('Ext.util.Positionable', { _positionTopLeft: ['position', 'top', 'left'], _alignRe: /^([a-z]+)-([a-z]+)(\?)?$/, // Stub implementation called after positioning. // May be implemented in subclasses. AbstractComponent has an implementation. afterSetPosition: Ext.emptyFn, // *********************** // Begin Abstract Methods // *********************** /** * Gets the x,y coordinates of an element specified by the anchor position on the * element. * @param {Ext.dom.Element} el The element * @param {String} [anchor='tl'] The specified anchor position. * See {@link #alignTo} for details on supported anchor positions. * @param {Boolean} [local] True to get the local (element top/left-relative) anchor * position instead of page coordinates * @param {Object} [size] An object containing the size to use for calculating anchor * position {width: (target width), height: (target height)} (defaults to the * element's current size) * @return {Number[]} [x, y] An array containing the element's x and y coordinates * @private */ getAnchorToXY: function() { Ext.Error.raise("getAnchorToXY is not implemented in " + this.$className); }, /** * Returns the size of the element's borders and padding. * @return {Object} an object with the following numeric properties * - beforeX * - afterX * - beforeY * - afterY * @private */ getBorderPadding: function() { Ext.Error.raise("getBorderPadding is not implemented in " + this.$className); }, /** * Returns the x coordinate of this element reletive to its `offsetParent`. * @return {Number} The local x coordinate */ getLocalX: function() { Ext.Error.raise("getLocalX is not implemented in " + this.$className); }, /** * Returns the x and y coordinates of this element relative to its `offsetParent`. * @return {Number[]} The local XY position of the element */ getLocalXY: function() { Ext.Error.raise("getLocalXY is not implemented in " + this.$className); }, /** * Returns the y coordinate of this element reletive to its `offsetParent`. * @return {Number} The local y coordinate */ getLocalY: function() { Ext.Error.raise("getLocalY is not implemented in " + this.$className); }, /** * Gets the current X position of the DOM element based on page coordinates. * @return {Number} The X position of the element */ getX: function() { Ext.Error.raise("getX is not implemented in " + this.$className); }, /** * Gets the current position of the DOM element based on page coordinates. * @return {Number[]} The XY position of the element */ getXY: function() { Ext.Error.raise("getXY is not implemented in " + this.$className); }, /** * Gets the current Y position of the DOM element based on page coordinates. * @return {Number} The Y position of the element */ getY: function() { Ext.Error.raise("getY is not implemented in " + this.$className); }, /** * Sets the local x coordinate of this element using CSS style. When used on an * absolute positioned element this method is symmetrical with {@link #getLocalX}, but * may not be symmetrical when used on a relatively positioned element. * @param {Number} x The x coordinate. A value of `null` sets the left style to 'auto'. * @return {Ext.util.Positionable} this */ setLocalX: function() { Ext.Error.raise("setLocalX is not implemented in " + this.$className); }, /** * Sets the local x and y coordinates of this element using CSS style. When used on an * absolute positioned element this method is symmetrical with {@link #getLocalXY}, but * may not be symmetrical when used on a relatively positioned element. * @param {Number/Array} x The x coordinate or an array containing [x, y]. A value of * `null` sets the left style to 'auto' * @param {Number} [y] The y coordinate, required if x is not an array. A value of * `null` sets the top style to 'auto' * @return {Ext.util.Positionable} this */ setLocalXY: function() { Ext.Error.raise("setLocalXY is not implemented in " + this.$className); }, /** * Sets the local y coordinate of this element using CSS style. When used on an * absolute positioned element this method is symmetrical with {@link #getLocalY}, but * may not be symmetrical when used on a relatively positioned element. * @param {Number} y The y coordinate. A value of `null` sets the top style to 'auto'. * @return {Ext.util.Positionable} this */ setLocalY: function() { Ext.Error.raise("setLocalY is not implemented in " + this.$className); }, /** * Sets the X position of the DOM element based on page coordinates. * @param {Number} The X position * @param {Boolean/Object} [animate] True for the default animation, or a standard * Element animation config object * @return {Ext.util.Positionable} this */ setX: function() { Ext.Error.raise("setX is not implemented in " + this.$className); }, /** * Sets the position of the DOM element in page coordinates. * @param {Number[]} pos Contains X & Y [x, y] values for new position (coordinates * are page-based) * @param {Boolean/Object} [animate] True for the default animation, or a standard * Element animation config object * @return {Ext.util.Positionable} this */ setXY: function() { Ext.Error.raise("setXY is not implemented in " + this.$className); }, /** * Sets the Y position of the DOM element based on page coordinates. * @param {Number} The Y position * @param {Boolean/Object} [animate] True for the default animation, or a standard * Element animation config object * @return {Ext.util.Positionable} this */ setY: function() { Ext.Error.raise("setY is not implemented in " + this.$className); }, // *********************** // End Abstract Methods // *********************** // private ==> used outside of core // TODO: currently only used by ToolTip. does this method belong here? adjustForConstraints: function(xy, parent) { var vector = this.getConstrainVector(parent, xy); if (vector) { xy[0] += vector[0]; xy[1] += vector[1]; } return xy; }, /** * Aligns the element with another element relative to the specified anchor points. If * the other element is the document it aligns it to the viewport. The position * parameter is optional, and can be specified in any one of the following formats: * * - **Blank**: Defaults to aligning the element's top-left corner to the target's * bottom-left corner ("tl-bl"). * - **One anchor (deprecated)**: The passed anchor position is used as the target * element's anchor point. The element being aligned will position its top-left * corner (tl) to that point. *This method has been deprecated in favor of the newer * two anchor syntax below*. * - **Two anchors**: If two values from the table below are passed separated by a dash, * the first value is used as the element's anchor point, and the second value is * used as the target's anchor point. * * In addition to the anchor points, the position parameter also supports the "?" * character. If "?" is passed at the end of the position string, the element will * attempt to align as specified, but the position will be adjusted to constrain to * the viewport if necessary. Note that the element being aligned might be swapped to * align to a different position than that specified in order to enforce the viewport * constraints. Following are all of the supported anchor positions: * *
     * Value  Description
     * -----  -----------------------------
     * tl     The top left corner (default)
     * t      The center of the top edge
     * tr     The top right corner
     * l      The center of the left edge
     * c      In the center of the element
     * r      The center of the right edge
     * bl     The bottom left corner
     * b      The center of the bottom edge
     * br     The bottom right corner
     * 
* * Example Usage: * * // align el to other-el using the default positioning * // ("tl-bl", non-constrained) * el.alignTo("other-el"); * * // align the top left corner of el with the top right corner of other-el * // (constrained to viewport) * el.alignTo("other-el", "tr?"); * * // align the bottom right corner of el with the center left edge of other-el * el.alignTo("other-el", "br-l?"); * * // align the center of el with the bottom left corner of other-el and * // adjust the x position by -6 pixels (and the y position by 0) * el.alignTo("other-el", "c-bl", [-6, 0]); * * @param {Ext.util.Positionable/HTMLElement/String} element The Positionable, * HTMLElement, or id of the element to align to. * @param {String} [position="tl-bl?"] The position to align to * @param {Number[]} [offsets] Offset the positioning by [x, y] * @param {Boolean/Object} [animate] true for the default animation or a standard * Element animation config object * @return {Ext.util.Positionable} this */ alignTo: function(element, position, offsets, animate) { var me = this, el = me.el; return me.setXY(me.getAlignToXY(element, position, offsets), el.anim && !!animate ? el.anim(animate) : false); }, /** * Anchors an element to another element and realigns it when the window is resized. * @param {Ext.util.Positionable/HTMLElement/String} element The Positionable, * HTMLElement, or id of the element to align to. * @param {String} [position="tl-bl?"] The position to align to * @param {Number[]} [offsets] Offset the positioning by [x, y] * @param {Boolean/Object} [animate] true for the default animation or a standard * Element animation config object * @param {Boolean/Number} [monitorScroll=50] True to monitor body scroll and * reposition. If this parameter is a number, it is used as the buffer delay in * milliseconds. * @param {Function} [callback] The function to call after the animation finishes * @return {Ext.util.Positionable} this */ anchorTo: function(anchorToEl, alignment, offsets, animate, monitorScroll, callback) { var me = this, scroll = !Ext.isEmpty(monitorScroll), action = function() { me.alignTo(anchorToEl, alignment, offsets, animate); Ext.callback(callback, me); }, anchor = me.getAnchor(); // previous listener anchor, remove it me.removeAnchor(); Ext.apply(anchor, { fn: action, scroll: scroll }); Ext.EventManager.onWindowResize(action, null); if (scroll) { Ext.EventManager.on(window, 'scroll', action, null, {buffer: !isNaN(monitorScroll) ? monitorScroll : 50}); } action(); // align immediately return me; }, /** * Calculates x,y coordinates specified by the anchor position on the element, adding * extraX and extraY values. * @param {String} [anchor='tl'] The specified anchor position. * See {@link #alignTo} for details on supported anchor positions. * @param {Number} [extraX] value to be added to the x coordinate * @param {Number} [extraY] value to be added to the y coordinate * @param {Object} [size] An object containing the size to use for calculating anchor * position {width: (target width), height: (target height)} (defaults to the * element's current size) * @return {Number[]} [x, y] An array containing the element's x and y coordinates * @private */ calculateAnchorXY: function(anchor, extraX, extraY, mySize) { //Passing a different size is useful for pre-calculating anchors, //especially for anchored animations that change the el size. var me = this, el = me.el, doc = document, isViewport = el.dom == doc.body || el.dom == doc, round = Math.round, xy, myWidth, myHeight; anchor = (anchor || "tl").toLowerCase(); mySize = mySize || {}; myWidth = mySize.width || isViewport ? Ext.Element.getViewWidth() : me.getWidth(); myHeight = mySize.height || isViewport ? Ext.Element.getViewHeight() : me.getHeight(); // Calculate anchor position. // Test most common cases for picker alignment first. switch (anchor) { case 'tl' : xy = [0, 0]; break; case 'bl' : xy = [0, myHeight]; break; case 'tr' : xy = [myWidth, 0]; break; case 'c' : xy = [round(myWidth * 0.5), round(myHeight * 0.5)]; break; case 't' : xy = [round(myWidth * 0.5), 0]; break; case 'l' : xy = [0, round(myHeight * 0.5)]; break; case 'r' : xy = [myWidth, round(myHeight * 0.5)]; break; case 'b' : xy = [round(myWidth * 0.5), myHeight]; break; case 'tc' : xy = [round(myWidth * 0.5), 0]; break; case 'bc' : xy = [round(myWidth * 0.5), myHeight]; break; case 'br' : xy = [myWidth, myHeight]; } return [xy[0] + extraX, xy[1] + extraY]; }, /** * By default this method does nothing but return the position spec passed to it. In * rtl mode it is overridden to convert "l" to "r" and vice versa when required. * @private */ convertPositionSpec: Ext.identityFn, /** * Gets the x,y coordinates to align this element with another element. See * {@link #alignTo} for more info on the supported position values. * @param {Ext.util.Positionable/HTMLElement/String} element The Positionable, * HTMLElement, or id of the element to align to. * @param {String} [position="tl-bl?"] The position to align to * @param {Number[]} [offsets] Offset the positioning by [x, y] * @return {Number[]} [x, y] */ getAlignToXY: function(alignToEl, posSpec, offset) { var me = this, viewportWidth = Ext.Element.getViewWidth() - 10, // 10px of margin for ie viewportHeight = Ext.Element.getViewHeight() - 10, // 10px of margin for ie doc = document, docElement = doc.documentElement, docBody = doc.body, scrollX = (docElement.scrollLeft || docBody.scrollLeft || 0), scrollY = (docElement.scrollTop || docBody.scrollTop || 0), alignMatch, myPosition, alignToElPosition, myWidth, myHeight, alignToElRegion, swapY, swapX, constrain, align1, align2, p1y, p1x, p2y, p2x, x, y; alignToEl = Ext.get(alignToEl.el || alignToEl); if (!alignToEl || !alignToEl.dom) { Ext.Error.raise({ sourceClass: 'Ext.util.Positionable', sourceMethod: 'getAlignToXY', msg: 'Attempted to align an element that doesn\'t exist' }); } offset = offset || [0,0]; posSpec = (!posSpec || posSpec == "?" ? "tl-bl?" : (!(/-/).test(posSpec) && posSpec !== "" ? "tl-" + posSpec : posSpec || "tl-bl")).toLowerCase(); posSpec = me.convertPositionSpec(posSpec); alignMatch = posSpec.match(me._alignRe); if (!alignMatch) { Ext.Error.raise({ sourceClass: 'Ext.util.Positionable', sourceMethod: 'getAlignToXY', el: alignToEl, position: posSpec, offset: offset, msg: 'Attemmpted to align an element with an invalid position: "' + posSpec + '"' }); } align1 = alignMatch[1]; align2 = alignMatch[2]; constrain = !!alignMatch[3]; //Subtract the aligned el's internal xy from the target's offset xy //plus custom offset to get this Element's new offset xy myPosition = me.getAnchorXY(align1, true); alignToElPosition = me.getAnchorToXY(alignToEl, align2, false); x = alignToElPosition[0] - myPosition[0] + offset[0]; y = alignToElPosition[1] - myPosition[1] + offset[1]; // If position spec ended with a "?", then constrain to viewport is necessary if (constrain) { myWidth = me.getWidth(); myHeight = me.getHeight(); alignToElRegion = alignToEl.getRegion(); // If we are at a viewport boundary and the aligned el is anchored // on a target border that is perpendicular to the vp border, // allow the aligned el to slide on that border, otherwise swap // the aligned el to the opposite border of the target. p1y = align1.charAt(0); p1x = align1.charAt(align1.length - 1); p2y = align2.charAt(0); p2x = align2.charAt(align2.length - 1); swapY = ((p1y == "t" && p2y == "b") || (p1y == "b" && p2y == "t")); swapX = ((p1x == "r" && p2x == "l") || (p1x == "l" && p2x == "r")); if (x + myWidth > viewportWidth + scrollX) { x = swapX ? alignToElRegion.left - myWidth : viewportWidth + scrollX - myWidth; } if (x < scrollX) { x = swapX ? alignToElRegion.right : scrollX; } if (y + myHeight > viewportHeight + scrollY) { y = swapY ? alignToElRegion.top - myHeight : viewportHeight + scrollY - myHeight; } if (y < scrollY) { y = swapY ? alignToElRegion.bottom : scrollY; } } return [x,y]; }, // private getAnchor: function(){ var el = this.el, data = (el.$cache || el.getCache()).data, anchor; if (!el.dom) { return; } anchor = data._anchor; if(!anchor){ anchor = data._anchor = {}; } return anchor; }, /** * Gets the x,y coordinates specified by the anchor position on the element. * @param {String} [anchor='tl'] The specified anchor position. * See {@link #alignTo} for details on supported anchor positions. * @param {Boolean} [local] True to get the local (element top/left-relative) anchor * position instead of page coordinates * @param {Object} [size] An object containing the size to use for calculating anchor * position {width: (target width), height: (target height)} (defaults to the * element's current size) * @return {Number[]} [x, y] An array containing the element's x and y coordinates */ getAnchorXY: function(anchor, local, mySize) { var me = this, myPos = me.getXY(), el = me.el, doc = document, isViewport = el.dom == doc.body || el.dom == doc, scroll = el.getScroll(), extraX = isViewport ? scroll.left : local ? 0 : myPos[0], extraY = isViewport ? scroll.top : local ? 0 : myPos[1]; return me.calculateAnchorXY(anchor, extraX, extraY, mySize); }, /** * Return an object defining the area of this Element which can be passed to * {@link #setBox} to set another Element's size/location to match this element. * * @param {Boolean} [contentBox] If true a box for the content of the element is * returned. * @param {Boolean} [local] If true the element's left and top relative to its * `offsetParent` are returned instead of page x/y. * @return {Object} box An object in the format: * * { * x: , * y: , * left: , * top: , * width: , * height: , * bottom: , * right: * } * * The returned object may also be addressed as an Array where index 0 contains the X * position and index 1 contains the Y position. The result may also be used for * {@link #setXY} */ getBox: function(contentBox, local) { var me = this, xy = local ? me.getLocalXY() : me.getXY(), x = xy[0], y = xy[1], w = me.getWidth(), h = me.getHeight(), borderPadding, beforeX, beforeY; if (contentBox) { borderPadding = me.getBorderPadding(); beforeX = borderPadding.beforeX; beforeY = borderPadding.beforeY; x += beforeX; y += beforeY; w -= (beforeX + borderPadding.afterX); h -= (beforeY + borderPadding.afterY); } return { x: x, left: x, 0: x, y: y, top: y, 1: y, width: w, height: h, right: x + w, bottom: y + h }; }, /** * Calculates the new [x,y] position to move this Positionable into a constrain region. * * By default, this Positionable is constrained to be within the container it was added to, or the element it was * rendered to. * * Priority is given to constraining the top and left within the constraint. * * An alternative constraint may be passed. * @param {String/HTMLElement/Ext.Element/Ext.util.Region} [constrainTo] The Element or {@link Ext.util.Region Region} * into which this Component is to be constrained. Defaults to the element into which this Positionable * was rendered, or this Component's {@link Ext.Component#constrainTo. * @param {Number[]} [proposedPosition] A proposed `[X, Y]` position to test for validity * and to coerce into constraints instead of using this Positionable's current position. * @param {Boolean} [local] The proposedPosition is local *(relative to floatParent if a floating Component)* * @param {Number[]} [proposedSize] A proposed `[width, height]` size to use when calculating * constraints instead of using this Positionable's current size. * @return {Number[]} **If** the element *needs* to be translated, the new `[X, Y]` position within * constraints if possible, giving priority to keeping the top and left edge in the constrain region. * Otherwise, `false`. */ calculateConstrainedPosition: function(constrainTo, proposedPosition, local, proposedSize) { var me = this, vector, fp = me.floatParent, parentNode = fp ? fp.getTargetEl() : null, parentOffset, borderPadding, proposedConstrainPosition, xy = false; if (local && fp) { parentOffset = parentNode.getXY(); borderPadding = parentNode.getBorderPadding(); parentOffset[0] += borderPadding.beforeX; parentOffset[1] += borderPadding.beforeY; if (proposedPosition) { proposedConstrainPosition = [proposedPosition[0] + parentOffset[0], proposedPosition[1] + parentOffset[1]]; } } else { proposedConstrainPosition = proposedPosition; } // Calculate the constrain vector to coerce our position to within our // constrainTo setting. getConstrainVector will provide a default constraint // region if there is no explicit constrainTo, *and* there is no floatParent owner Component. constrainTo = constrainTo || me.constrainTo || parentNode || me.container || me.el.parent(); vector = (me.constrainHeader ? me.header : me).getConstrainVector(constrainTo, proposedConstrainPosition, proposedSize); // false is returned if no movement is needed if (vector) { xy = proposedPosition || me.getPosition(local); xy[0] += vector[0]; xy[1] += vector[1]; } return xy; }, /** * Returns the `[X, Y]` vector by which this Positionable's element must be translated to make a best * attempt to constrain within the passed constraint. Returns `false` if the element * does not need to be moved. * * Priority is given to constraining the top and left within the constraint. * * The constraint may either be an existing element into which the element is to be * constrained, or a {@link Ext.util.Region Region} into which this element is to be * constrained. * * By default, any extra shadow around the element is **not** included in the constrain calculations - the edges * of the element are used as the element bounds. To constrain the shadow within the constrain region, set the * `constrainShadow` property on this element to `true`. * * @param {Ext.util.Positionable/HTMLElement/String/Ext.util.Region} [constrainTo] The * Positionable, HTMLElement, element id, or Region into which the element is to be * constrained. * @param {Number[]} [proposedPosition] A proposed `[X, Y]` position to test for validity * and to produce a vector for instead of using the element's current position * @param {Number[]} [proposedSize] A proposed `[width, height]` size to constrain * instead of using the element's current size * @return {Number[]/Boolean} **If** the element *needs* to be translated, an `[X, Y]` * vector by which this element must be translated. Otherwise, `false`. */ getConstrainVector: function(constrainTo, proposedPosition, proposedSize) { var thisRegion = this.getRegion(), vector = [0, 0], shadowSize = (this.shadow && this.constrainShadow && !this.shadowDisabled) ? this.shadow.getShadowSize() : undefined, overflowed = false, constraintInsets = this.constraintInsets; if (!(constrainTo instanceof Ext.util.Region)) { constrainTo = Ext.get(constrainTo.el || constrainTo).getViewRegion(); } // Apply constraintInsets if (constraintInsets) { constraintInsets = Ext.isObject(constraintInsets) ? constraintInsets : Ext.Element.parseBox(constraintInsets); constrainTo.adjust(constraintInsets.top, constraintInsets.right, constraintInsets.bottom, constraintInsets.length); } // Shift this region to occupy the proposed position if (proposedPosition) { thisRegion.translateBy(proposedPosition[0] - thisRegion.x, proposedPosition[1] - thisRegion.y); } // Set the size of this region to the proposed size if (proposedSize) { thisRegion.right = thisRegion.left + proposedSize[0]; thisRegion.bottom = thisRegion.top + proposedSize[1]; } // Reduce the constrain region to allow for shadow if (shadowSize) { constrainTo.adjust(shadowSize[0], -shadowSize[1], -shadowSize[2], shadowSize[3]); } // Constrain the X coordinate by however much this Element overflows if (thisRegion.right > constrainTo.right) { overflowed = true; vector[0] = (constrainTo.right - thisRegion.right); // overflowed the right } if (thisRegion.left + vector[0] < constrainTo.left) { overflowed = true; vector[0] = (constrainTo.left - thisRegion.left); // overflowed the left } // Constrain the Y coordinate by however much this Element overflows if (thisRegion.bottom > constrainTo.bottom) { overflowed = true; vector[1] = (constrainTo.bottom - thisRegion.bottom); // overflowed the bottom } if (thisRegion.top + vector[1] < constrainTo.top) { overflowed = true; vector[1] = (constrainTo.top - thisRegion.top); // overflowed the top } return overflowed ? vector : false; }, /** * Returns the offsets of this element from the passed element. The element must both * be part of the DOM tree and not have display:none to have page coordinates. * @param {Ext.util.Positionable/HTMLElement/String} offsetsTo The Positionable, * HTMLElement, or element id to get get the offsets from. * @return {Number[]} The XY page offsets (e.g. `[100, -200]`) */ getOffsetsTo: function(offsetsTo) { var o = this.getXY(), e = Ext.fly(offsetsTo.el || offsetsTo, '_internal').getXY(); return [o[0] - e[0],o[1] - e[1]]; }, /** * Returns a region object that defines the area of this element. * @return {Ext.util.Region} A Region containing "top, left, bottom, right" properties. */ getRegion: function() { var box = this.getBox(); return new Ext.util.Region(box.top, box.right, box.bottom, box.left); }, /** * Returns the **content** region of this element. That is the region within the borders * and padding. * @return {Ext.util.Region} A Region containing "top, left, bottom, right" member data. */ getViewRegion: function() { var me = this, el = me.el, isBody = el.dom.nodeName === 'BODY', borderPadding, scroll, pos, top, left, width, height; // For the body we want to do some special logic if (isBody) { scroll = el.getScroll(); left = scroll.left; top = scroll.top; width = Ext.dom.AbstractElement.getViewportWidth(); height = Ext.dom.AbstractElement.getViewportHeight(); } else { borderPadding = me.getBorderPadding(); pos = me.getXY(); left = pos[0] + borderPadding.beforeX; top = pos[1] + borderPadding.beforeY; width = me.getWidth(true); height = me.getHeight(true); } return new Ext.util.Region(top, left + width, top + height, left); }, /** * Move the element relative to its current position. * @param {String} direction Possible values are: * * - `"l"` (or `"left"`) * - `"r"` (or `"right"`) * - `"t"` (or `"top"`, or `"up"`) * - `"b"` (or `"bottom"`, or `"down"`) * * @param {Number} distance How far to move the element in pixels * @param {Boolean/Object} [animate] true for the default animation or a standard * Element animation config object */ move: function(direction, distance, animate) { var me = this, xy = me.getXY(), x = xy[0], y = xy[1], left = [x - distance, y], right = [x + distance, y], top = [x, y - distance], bottom = [x, y + distance], hash = { l: left, left: left, r: right, right: right, t: top, top: top, up: top, b: bottom, bottom: bottom, down: bottom }; direction = direction.toLowerCase(); me.setXY([hash[direction][0], hash[direction][1]], animate); }, /** * Remove any anchor to this element. See {@link #anchorTo}. * @return {Ext.util.Positionable} this */ removeAnchor: function() { var anchor = this.getAnchor(); if (anchor && anchor.fn) { Ext.EventManager.removeResizeListener(anchor.fn); if (anchor.scroll) { Ext.EventManager.un(window, 'scroll', anchor.fn); } delete anchor.fn; } return this; }, /** * Sets the element's box. If animate is true then x, y, width, and height will be * animated concurrently. * @param {Object} box The box to fill {x, y, width, height} * @param {Boolean/Object} [animate] true for the default animation or a standard * Element animation config object * @return {Ext.util.Positionable} this */ setBox: function(box, animate) { var me = this, el = me.el, x = box.x, y = box.y, xy = [x, y], w = box.width, h = box.height, doConstrain = (me.constrain || me.constrainHeader), constrainedPos = doConstrain && me.calculateConstrainedPosition(null, [x, y], false, [w, h]); // Position to the contrained if (constrainedPos) { x = constrainedPos[0]; y = constrainedPos[1]; } if (!animate || !el.anim) { me.setSize(w, h); me.setXY([x, y]); me.afterSetPosition(x, y); } else { me.animate(Ext.applyIf({ to: { x: x, y: y, width: el.adjustWidth(w), height: el.adjustHeight(h) }, listeners: { afteranimate: Ext.Function.bind(me.afterSetPosition, me, [x, y]) } }, animate)); } return me; }, /** * Sets the element's position and size to the specified region. If animation is true * then width, height, x and y will be animated concurrently. * * @param {Ext.util.Region} region The region to fill * @param {Boolean/Object} [animate] true for the default animation or a standard * Element animation config object * @return {Ext.util.Positionable} this */ setRegion: function(region, animate) { return this.setBox({ x: region.left, y: region.top, width: region.right - region.left, height: region.bottom - region.top }, animate); }, /** * Translates the passed page coordinates into left/top css values for the element * @param {Number/Array} x The page x or an array containing [x, y] * @param {Number} [y] The page y, required if x is not an array * @return {Object} An object with left and top properties. e.g. * {left: (value), top: (value)} */ translatePoints: function(x, y) { var pos = this.translateXY(x, y); return { left: pos.x, top: pos.y }; }, /** * Translates the passed page coordinates into x and y css values for the element * @param {Number/Array} x The page x or an array containing [x, y] * @param {Number} [y] The page y, required if x is not an array * @return {Object} An object with x and y properties. e.g. * {x: (value), y: (value)} * @private */ translateXY: function(x, y) { var me = this, el = me.el, styles = el.getStyle(me._positionTopLeft), relative = styles.position == 'relative', left = parseFloat(styles.left), top = parseFloat(styles.top), xy = me.getXY(); if (Ext.isArray(x)) { y = x[1]; x = x[0]; } if (isNaN(left)) { left = relative ? 0 : el.dom.offsetLeft; } if (isNaN(top)) { top = relative ? 0 : el.dom.offsetTop; } left = (typeof x == 'number') ? x - xy[0] + left : undefined; top = (typeof y == 'number') ? y - xy[1] + top : undefined; return { x: left, y: top }; } }); // @tag dom,core /** * @class Ext.dom.Element * @alternateClassName Ext.Element * @alternateClassName Ext.core.Element * @extends Ext.dom.AbstractElement * * Encapsulates a DOM element, adding simple DOM manipulation facilities, normalizing for browser differences. * * All instances of this class inherit the methods of {@link Ext.fx.Anim} making visual effects easily available to all * DOM elements. * * Note that the events documented in this class are not Ext events, they encapsulate browser events. Some older browsers * may not support the full range of events. Which events are supported is beyond the control of Ext JS. * * Usage: * * // by id * var el = Ext.get("my-div"); * * // by DOM element reference * var el = Ext.get(myDivElement); * * # Animations * * When an element is manipulated, by default there is no animation. * * var el = Ext.get("my-div"); * * // no animation * el.setWidth(100); * * Many of the functions for manipulating an element have an optional "animate" parameter. This parameter can be * specified as boolean (true) for default animation effects. * * // default animation * el.setWidth(100, true); * * To configure the effects, an object literal with animation options to use as the Element animation configuration * object can also be specified. Note that the supported Element animation configuration options are a subset of the * {@link Ext.fx.Anim} animation options specific to Fx effects. The supported Element animation configuration options * are: * * Option Default Description * --------- -------- --------------------------------------------- * {@link Ext.fx.Anim#duration duration} 350 The duration of the animation in milliseconds * {@link Ext.fx.Anim#easing easing} easeOut The easing method * {@link Ext.fx.Anim#callback callback} none A function to execute when the anim completes * {@link Ext.fx.Anim#scope scope} this The scope (this) of the callback function * * Usage: * * // Element animation options object * var opt = { * {@link Ext.fx.Anim#duration duration}: 1000, * {@link Ext.fx.Anim#easing easing}: 'elasticIn', * {@link Ext.fx.Anim#callback callback}: this.foo, * {@link Ext.fx.Anim#scope scope}: this * }; * // animation with some options set * el.setWidth(100, opt); * * The Element animation object being used for the animation will be set on the options object as "anim", which allows * you to stop or manipulate the animation. Here is an example: * * // using the "anim" property to get the Anim object * if(opt.anim.isAnimated()){ * opt.anim.stop(); * } * * # Composite (Collections of) Elements * * For working with collections of Elements, see {@link Ext.CompositeElement} * * @constructor * Creates new Element directly. * @param {String/HTMLElement} element * @param {Boolean} [forceNew] By default the constructor checks to see if there is already an instance of this * element in the cache and if there is it returns the same instance. This will skip that check (useful for extending * this class). * @return {Object} */ Ext.define('Ext.dom.Element', function(Element) { var HIDDEN = 'hidden', DOC = document, VISIBILITY = "visibility", DISPLAY = "display", NONE = "none", XMASKED = Ext.baseCSSPrefix + "masked", XMASKEDRELATIVE = Ext.baseCSSPrefix + "masked-relative", EXTELMASKMSG = Ext.baseCSSPrefix + "mask-msg", bodyRe = /^body/i, visFly, // speedy lookup for elements never to box adjust noBoxAdjust = Ext.isStrict ? { select: 1 }: { input: 1, select: 1, textarea: 1 }, // Pseudo for use by cacheScrollValues isScrolled = function(c) { var r = [], ri = -1, i, ci; for (i = 0; ci = c[i]; i++) { if (ci.scrollTop > 0 || ci.scrollLeft > 0) { r[++ri] = ci; } } return r; }; return { extend: Ext.dom.AbstractElement , alternateClassName: ['Ext.Element', 'Ext.core.Element'], tableTagRe: /^(?:tr|td|table|tbody)$/i, mixins: [ Ext.util.Positionable ], addUnits: function() { return Element.addUnits.apply(Element, arguments); }, /** * Tries to focus the element. Any exceptions are caught and ignored. * @param {Number} [defer] Milliseconds to defer the focus * @return {Ext.dom.Element} this */ focus: function(defer, /* private */ dom) { var me = this; dom = dom || me.dom; try { if (Number(defer)) { Ext.defer(me.focus, defer, me, [null, dom]); } else { dom.focus(); } } catch(e) { } return me; }, /** * Tries to blur the element. Any exceptions are caught and ignored. * @return {Ext.dom.Element} this */ blur: function() { var me = this, dom = me.dom; // In IE, blurring the body can cause the browser window to hide. // Blurring the body is redundant, so instead we just focus it if (dom !== document.body) { try { dom.blur(); } catch(e) { } return me; } else { return me.focus(undefined, dom); } }, /** * Tests various css rules/browsers to determine if this element uses a border box * @return {Boolean} */ isBorderBox: function() { var box = Ext.isBorderBox; // IE6/7 force input elements to content-box even if border-box is set explicitly if (box && Ext.isIE7m) { box = !((this.dom.tagName || "").toLowerCase() in noBoxAdjust); } return box; }, /** * Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element. * @param {Function} overFn The function to call when the mouse enters the Element. * @param {Function} outFn The function to call when the mouse leaves the Element. * @param {Object} [scope] The scope (`this` reference) in which the functions are executed. Defaults * to the Element's DOM element. * @param {Object} [options] Options for the listener. See {@link Ext.util.Observable#addListener the * options parameter}. * @return {Ext.dom.Element} this */ hover: function(overFn, outFn, scope, options) { var me = this; me.on('mouseenter', overFn, scope || me.dom, options); me.on('mouseleave', outFn, scope || me.dom, options); return me; }, /** * Returns the value of a namespaced attribute from the element's underlying DOM node. * @param {String} namespace The namespace in which to look for the attribute * @param {String} name The attribute name * @return {String} The attribute value */ getAttributeNS: function(ns, name) { return this.getAttribute(name, ns); }, getAttribute: (Ext.isIE && !(Ext.isIE9p && DOC.documentMode >= 9)) ? // Essentially all web browsers (Firefox, Internet Explorer, recent versions of Opera, Safari, Konqueror, and iCab, // as a non-exhaustive list) return null when the specified attribute does not exist on the specified element. // The DOM specification says that the correct return value in this case is actually the empty string, and some // DOM implementations implement this behavior. The implementation of getAttribute in XUL (Gecko) actually follows // the specification and returns an empty string. Consequently, you should use hasAttribute to check for an attribute's // existence prior to calling getAttribute() if it is possible that the requested attribute does not exist on the specified element. // // https://developer.mozilla.org/en-US/docs/DOM/element.getAttribute // http://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-745549614 function(name, ns) { var d = this.dom, type; if (ns) { type = typeof d[ns + ":" + name]; if (type != 'undefined' && type != 'unknown') { return d[ns + ":" + name] || null; } return null; } if (name === "for") { name = "htmlFor"; } return d[name] || null; } : function(name, ns) { var d = this.dom; if (ns) { return d.getAttributeNS(ns, name) || d.getAttribute(ns + ":" + name); } return d.getAttribute(name) || d[name] || null; }, /** * When an element is moved around in the DOM, or is hidden using `display:none`, it loses layout, and therefore * all scroll positions of all descendant elements are lost. * * This function caches them, and returns a function, which when run will restore the cached positions. * In the following example, the Panel is moved from one Container to another which will cause it to lose all scroll positions: * * var restoreScroll = myPanel.el.cacheScrollValues(); * myOtherContainer.add(myPanel); * restoreScroll(); * * @return {Function} A function which will restore all descentant elements of this Element to their scroll * positions recorded when this function was executed. Be aware that the returned function is a closure which has * captured the scope of `cacheScrollValues`, so take care to derefence it as soon as not needed - if is it is a `var` * it will drop out of scope, and the reference will be freed. */ cacheScrollValues: function() { var me = this, scrolledDescendants, el, i, scrollValues = [], result = function() { for (i = 0; i < scrolledDescendants.length; i++) { el = scrolledDescendants[i]; el.scrollLeft = scrollValues[i][0]; el.scrollTop = scrollValues[i][1]; } }; if (!Ext.DomQuery.pseudos.isScrolled) { Ext.DomQuery.pseudos.isScrolled = isScrolled; } scrolledDescendants = me.query(':isScrolled'); for (i = 0; i < scrolledDescendants.length; i++) { el = scrolledDescendants[i]; scrollValues[i] = [el.scrollLeft, el.scrollTop]; } return result; }, /** * @property {Boolean} autoBoxAdjust * True to automatically adjust width and height settings for box-model issues. */ autoBoxAdjust: true, /** * Checks whether the element is currently visible using both visibility and display properties. * @param {Boolean} [deep=false] True to walk the dom and see if parent elements are hidden. * If false, the function only checks the visibility of the element itself and it may return * `true` even though a parent is not visible. * @return {Boolean} `true` if the element is currently visible, else `false` */ isVisible : function(deep) { var me = this, dom = me.dom, stopNode = dom.ownerDocument.documentElement; if (!visFly) { visFly = new Element.Fly(); } while (dom !== stopNode) { // We're invisible if we hit a nonexistent parentNode or a document // fragment or computed style visibility:hidden or display:none if (!dom || dom.nodeType === 11 || (visFly.attach(dom)).isStyle(VISIBILITY, HIDDEN) || visFly.isStyle(DISPLAY, NONE)) { return false; } // Quit now unless we are being asked to check parent nodes. if (!deep) { break; } dom = dom.parentNode; } return true; }, /** * Returns true if display is not "none" * @return {Boolean} */ isDisplayed : function() { return !this.isStyle(DISPLAY, NONE); }, /** * Convenience method for setVisibilityMode(Element.DISPLAY) * @param {String} [display] What to set display to when visible * @return {Ext.dom.Element} this */ enableDisplayMode : function(display) { var me = this; me.setVisibilityMode(Element.DISPLAY); if (!Ext.isEmpty(display)) { (me.$cache || me.getCache()).data.originalDisplay = display; } return me; }, /** * Puts a mask over this element to disable user interaction. Requires core.css. * This method can only be applied to elements which accept child nodes. * @param {String} [msg] A message to display in the mask * @param {String} [msgCls] A css class to apply to the msg element * @return {Ext.dom.Element} The mask element */ mask : function(msg, msgCls /* private - passed by AbstractComponent.mask to avoid the need to interrogate the DOM to get the height*/, elHeight) { var me = this, dom = me.dom, // In some cases, setExpression will exist but not be of a function type, // so we check it explicitly here to stop IE throwing errors setExpression = dom.style.setExpression, data = (me.$cache || me.getCache()).data, maskShimEl = data.maskShimEl, maskEl = data.maskEl, maskMsg = data.maskMsg, widthExpression, heightExpression; if (!(bodyRe.test(dom.tagName) && me.getStyle('position') == 'static')) { me.addCls(XMASKEDRELATIVE); } // We always needs to recreate the mask since the DOM element may have been re-created if (maskEl) { maskEl.remove(); } if (maskMsg) { maskMsg.remove(); } if (maskShimEl) { maskShimEl.remove(); } if (Ext.isIE6) { maskShimEl = Ext.DomHelper.append(dom, { tag: 'iframe', cls : Ext.baseCSSPrefix + 'shim ' + Ext.baseCSSPrefix + 'mask-shim' }, true); data.maskShimEl = maskShimEl; maskShimEl.setDisplayed(true); } Ext.DomHelper.append(dom, [{ cls : Ext.baseCSSPrefix + "mask", style: 'top:0;left:0;' }, { cls : msgCls ? EXTELMASKMSG + " " + msgCls : EXTELMASKMSG, cn : { tag: 'div', cls: Ext.baseCSSPrefix + 'mask-msg-inner', cn: { tag: 'div', cls: Ext.baseCSSPrefix + 'mask-msg-text', html: msg || '' } } }]); maskMsg = Ext.get(dom.lastChild); maskEl = Ext.get(maskMsg.dom.previousSibling); data.maskMsg = maskMsg; data.maskEl = maskEl; me.addCls(XMASKED); maskEl.setDisplayed(true); if (typeof msg == 'string') { maskMsg.setDisplayed(true); maskMsg.center(me); } else { maskMsg.setDisplayed(false); } // NOTE: CSS expressions are resource intensive and to be used only as a last resort // These expressions are removed as soon as they are no longer necessary - in the unmask method. // In normal use cases an element will be masked for a limited period of time. // Fix for https://sencha.jira.com/browse/EXTJSIV-19. // IE6 strict mode and IE6-9 quirks mode takes off left+right padding when calculating width! if (!Ext.supports.IncludePaddingInWidthCalculation && setExpression) { // In an occasional case setExpression will throw an exception try { maskEl.dom.style.setExpression('width', 'this.parentNode.clientWidth + "px"'); widthExpression = 'this.parentNode.clientWidth + "px"'; if (maskShimEl) { maskShimEl.dom.style.setExpression('width', widthExpression); } maskEl.dom.style.setExpression('width', widthExpression); } catch (e) {} } // Some versions and modes of IE subtract top+bottom padding when calculating height. // Different versions from those which make the same error for width! if (!Ext.supports.IncludePaddingInHeightCalculation && setExpression) { // In an occasional case setExpression will throw an exception try { heightExpression = 'this.parentNode.' + (dom == DOC.body ? 'scrollHeight' : 'offsetHeight') + ' + "px"'; if (maskShimEl) { maskShimEl.dom.style.setExpression('height', heightExpression); } maskEl.dom.style.setExpression('height', heightExpression); } catch (e) {} } // ie will not expand full height automatically else if (Ext.isIE9m && !(Ext.isIE7 && Ext.isStrict) && me.getStyle('height') == 'auto') { if (maskShimEl) { maskShimEl.setSize(undefined, elHeight || me.getHeight()); } maskEl.setSize(undefined, elHeight || me.getHeight()); } return maskEl; }, /** * Hides a previously applied mask. */ unmask : function() { var me = this, data = (me.$cache || me.getCache()).data, maskEl = data.maskEl, maskShimEl = data.maskShimEl, maskMsg = data.maskMsg, style; if (maskEl) { style = maskEl.dom.style; // Remove resource-intensive CSS expressions as soon as they are not required. if (style.clearExpression) { style.clearExpression('width'); style.clearExpression('height'); } if (maskEl) { maskEl.remove(); delete data.maskEl; } if (maskMsg) { maskMsg.remove(); delete data.maskMsg; } me.removeCls([XMASKED, XMASKEDRELATIVE]); if (maskShimEl) { style = maskShimEl.dom.style; // Remove resource-intensive CSS expressions as soon as they are not required. if (style.clearExpression) { style.clearExpression('width'); style.clearExpression('height'); } maskShimEl.remove(); delete data.maskShimEl; } } }, /** * Returns true if this element is masked. Also re-centers any displayed message within the mask. * @return {Boolean} */ isMasked : function() { var me = this, data = (me.$cache || me.getCache()).data, maskEl = data.maskEl, maskMsg = data.maskMsg, hasMask = false; if (maskEl && maskEl.isVisible()) { if (maskMsg) { maskMsg.center(me); } hasMask = true; } return hasMask; }, /** * Creates an iframe shim for this element to keep selects and other windowed objects from * showing through. * @return {Ext.dom.Element} The new shim element */ createShim : function() { var el = DOC.createElement('iframe'), shim; el.frameBorder = '0'; el.className = Ext.baseCSSPrefix + 'shim'; el.src = Ext.SSL_SECURE_URL; shim = Ext.get(this.dom.parentNode.insertBefore(el, this.dom)); shim.autoBoxAdjust = false; return shim; }, /** * Convenience method for constructing a KeyMap * @param {String/Number/Number[]/Object} key Either a string with the keys to listen for, the numeric key code, * array of key codes or an object with the following options: * @param {Number/Array} key.key * @param {Boolean} key.shift * @param {Boolean} key.ctrl * @param {Boolean} key.alt * @param {Function} fn The function to call * @param {Object} [scope] The scope (`this` reference) in which the specified function is executed. Defaults to this Element. * @return {Ext.util.KeyMap} The KeyMap created */ addKeyListener : function(key, fn, scope){ var config; if(typeof key != 'object' || Ext.isArray(key)){ config = { target: this, key: key, fn: fn, scope: scope }; }else{ config = { target: this, key : key.key, shift : key.shift, ctrl : key.ctrl, alt : key.alt, fn: fn, scope: scope }; } return new Ext.util.KeyMap(config); }, /** * Creates a KeyMap for this element * @param {Object} config The KeyMap config. See {@link Ext.util.KeyMap} for more details * @return {Ext.util.KeyMap} The KeyMap created */ addKeyMap : function(config) { return new Ext.util.KeyMap(Ext.apply({ target: this }, config)); }, // Mouse events /** * @event click * Fires when a mouse click is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event contextmenu * Fires when a right click is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event dblclick * Fires when a mouse double click is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mousedown * Fires when a mousedown is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mouseup * Fires when a mouseup is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mouseover * Fires when a mouseover is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mousemove * Fires when a mousemove is detected with the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mouseout * Fires when a mouseout is detected with the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mouseenter * Fires when the mouse enters the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event mouseleave * Fires when the mouse leaves the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ // Keyboard events /** * @event keypress * Fires when a keypress is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event keydown * Fires when a keydown is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event keyup * Fires when a keyup is detected within the element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ // HTML frame/object events /** * @event load * Fires when the user agent finishes loading all content within the element. Only supported by window, frames, * objects and images. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event unload * Fires when the user agent removes all content from a window or frame. For elements, it fires when the target * element or any of its content has been removed. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event abort * Fires when an object/image is stopped from loading before completely loaded. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event error * Fires when an object/image/frame cannot be loaded properly. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event resize * Fires when a document view is resized. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event scroll * Fires when a document view is scrolled. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ // Form events /** * @event select * Fires when a user selects some text in a text field, including input and textarea. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event change * Fires when a control loses the input focus and its value has been modified since gaining focus. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event submit * Fires when a form is submitted. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event reset * Fires when a form is reset. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event focus * Fires when an element receives focus either via the pointing device or by tab navigation. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event blur * Fires when an element loses focus either via the pointing device or by tabbing navigation. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ // User Interface events /** * @event DOMFocusIn * Where supported. Similar to HTML focus event, but can be applied to any focusable element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMFocusOut * Where supported. Similar to HTML blur event, but can be applied to any focusable element. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMActivate * Where supported. Fires when an element is activated, for instance, through a mouse click or a keypress. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ // DOM Mutation events /** * @event DOMSubtreeModified * Where supported. Fires when the subtree is modified. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMNodeInserted * Where supported. Fires when a node has been added as a child of another node. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMNodeRemoved * Where supported. Fires when a descendant node of the element is removed. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMNodeRemovedFromDocument * Where supported. Fires when a node is being removed from a document. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMNodeInsertedIntoDocument * Where supported. Fires when a node is being inserted into a document. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMAttrModified * Where supported. Fires when an attribute has been modified. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * @event DOMCharacterDataModified * Where supported. Fires when the character data has been modified. * @param {Ext.EventObject} e The {@link Ext.EventObject} encapsulating the DOM event. * @param {HTMLElement} t The target of the event. */ /** * Appends an event handler to this element. * * @param {String} eventName The name of event to handle. * * @param {Function} fn The handler function the event invokes. This function is passed the following parameters: * * - **evt** : EventObject * * The {@link Ext.EventObject EventObject} describing the event. * * - **el** : HtmlElement * * The DOM element which was the target of the event. Note that this may be filtered by using the delegate option. * * - **o** : Object * * The options object from the call that setup the listener. * * @param {Object} scope (optional) The scope (**this** reference) in which the handler function is executed. **If * omitted, defaults to this Element.** * * @param {Object} options (optional) An object containing handler configuration properties. This may contain any of * the following properties: * * - **scope** Object : * * The scope (**this** reference) in which the handler function is executed. **If omitted, defaults to this * Element.** * * - **delegate** String: * * A simple selector to filter the target or look for a descendant of the target. See below for additional details. * * - **stopEvent** Boolean: * * True to stop the event. That is stop propagation, and prevent the default action. * * - **preventDefault** Boolean: * * True to prevent the default action * * - **stopPropagation** Boolean: * * True to prevent event propagation * * - **normalized** Boolean: * * False to pass a browser event to the handler function instead of an Ext.EventObject * * - **target** Ext.dom.Element: * * Only call the handler if the event was fired on the target Element, _not_ if the event was bubbled up from a * child node. * * - **delay** Number: * * The number of milliseconds to delay the invocation of the handler after the event fires. * * - **single** Boolean: * * True to add a handler to handle just the next firing of the event, and then remove itself. * * - **buffer** Number: * * Causes the handler to be scheduled to run in an {@link Ext.util.DelayedTask} delayed by the specified number of * milliseconds. If the event fires again within that time, the original handler is _not_ invoked, but the new * handler is scheduled in its place. * * **Combining Options** * * Using the options argument, it is possible to combine different types of listeners: * * A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options * object. The options object is available as the third parameter in the handler function. * * Code: * * el.on('click', this.onClick, this, { * single: true, * delay: 100, * stopEvent : true, * forumId: 4 * }); * * **Attaching multiple handlers in 1 call** * * The method also allows for a single argument to be passed which is a config object containing properties which * specify multiple handlers. * * Code: * * el.on({ * 'click' : { * fn: this.onClick, * scope: this, * delay: 100 * }, * 'mouseover' : { * fn: this.onMouseOver, * scope: this * }, * 'mouseout' : { * fn: this.onMouseOut, * scope: this * } * }); * * Or a shorthand syntax: * * Code: * * el.on({ * 'click' : this.onClick, * 'mouseover' : this.onMouseOver, * 'mouseout' : this.onMouseOut, * scope: this * }); * * **delegate** * * This is a configuration option that you can pass along when registering a handler for an event to assist with * event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure * to memory-leaks. By registering an event for a container element as opposed to each element within a container. * By setting this configuration option to a simple selector, the target element will be filtered to look for a * descendant of the target. For example: * * // using this markup: *
*

paragraph one

*

paragraph two

*

paragraph three

*
* * // utilize event delegation to registering just one handler on the container element: * el = Ext.get('elId'); * el.on( * 'click', * function(e,t) { * // handle click * console.info(t.id); // 'p2' * }, * this, * { * // filter the target element to be a descendant with the class 'clickable' * delegate: '.clickable' * } * ); * * @return {Ext.dom.Element} this */ on: function(eventName, fn, scope, options) { Ext.EventManager.on(this, eventName, fn, scope || this, options); return this; }, /** * Removes an event handler from this element. * * **Note**: if a *scope* was explicitly specified when {@link #on adding} the listener, * the same scope must be specified here. * * Example: * * el.un('click', this.handlerFn); * // or * el.removeListener('click', this.handlerFn); * * @param {String} eventName The name of the event from which to remove the handler. * @param {Function} fn The handler function to remove. **This must be a reference to the function passed into the * {@link #on} call.** * @param {Object} scope If a scope (**this** reference) was specified when the listener was added, then this must * refer to the same object. * @return {Ext.dom.Element} this */ un: function(eventName, fn, scope) { Ext.EventManager.un(this, eventName, fn, scope || this); return this; }, /** * Removes all previous added listeners from this element * @return {Ext.dom.Element} this */ removeAllListeners: function() { Ext.EventManager.removeAll(this); return this; }, /** * Recursively removes all previous added listeners from this element and its children * @return {Ext.dom.Element} this */ purgeAllListeners: function() { Ext.EventManager.purgeElement(this); return this; }, select: function(selector) { return Element.select(selector, false, this.dom); } }; }, function() { var DOC = document, EC = Ext.cache, Element = this, AbstractElement = Ext.dom.AbstractElement, focusRe = /^a|button|embed|iframe|input|object|select|textarea$/i, nonSpaceRe = /\S/, scriptTagRe = /(?:]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig, replaceScriptTagRe = /(?:)((\n|\r|.)*?)(?:<\/script>)/ig, srcRe = /\ssrc=([\'\"])(.*?)\1/i, typeRe = /\stype=([\'\"])(.*?)\1/i, useDocForId = !Ext.isIE8m, internalFly; Element.boxMarkup = '
'; // // private // Garbage collection - uncache elements/purge listeners on orphaned elements // so we don't hold a reference and cause the browser to retain them function garbageCollect() { if (!Ext.enableGarbageCollector) { clearInterval(Element.collectorThreadId); } else { var eid, d, o, t; for (eid in EC) { if (!EC.hasOwnProperty(eid)) { continue; } o = EC[eid]; // Skip document and window elements if (o.skipGarbageCollection) { continue; } d = o.dom; // Should always have a DOM node if (!d) { Ext.Error.raise('Missing DOM node in element garbage collection: ' + eid); } // Check that document and window elements haven't got through if (d && (d.getElementById || d.navigator)) { Ext.Error.raise('Unexpected document or window element in element garbage collection'); } // ------------------------------------------------------- // Determining what is garbage: // ------------------------------------------------------- // !d.parentNode // no parentNode == direct orphan, definitely garbage // ------------------------------------------------------- // !d.offsetParent && !document.getElementById(eid) // display none elements have no offsetParent so we will // also try to look it up by it's id. However, check // offsetParent first so we don't do unneeded lookups. // This enables collection of elements that are not orphans // directly, but somewhere up the line they have an orphan // parent. // ------------------------------------------------------- if (d && (!d.parentNode || (!d.offsetParent && !Ext.getElementById(eid)))) { if (Ext.enableListenerCollection) { Ext.EventManager.removeAll(d); } delete EC[eid]; } } // Cleanup IE Object leaks if (Ext.isIE) { t = {}; for (eid in EC) { if (!EC.hasOwnProperty(eid)) { continue; } t[eid] = EC[eid]; } EC = Ext.cache = t; } } } Element.collectorThreadId = setInterval(garbageCollect, 30000); //Stuff from Element-more.js Element.addMethods({ /** * Monitors this Element for the mouse leaving. Calls the function after the specified delay only if * the mouse was not moved back into the Element within the delay. If the mouse *was* moved * back in, the function is not called. * @param {Number} delay The delay **in milliseconds** to wait for possible mouse re-entry before calling the handler function. * @param {Function} handler The function to call if the mouse remains outside of this Element for the specified time. * @param {Object} [scope] The scope (`this` reference) in which the handler function executes. Defaults to this Element. * @return {Object} The listeners object which was added to this element so that monitoring can be stopped. Example usage: * * // Hide the menu if the mouse moves out for 250ms or more * this.mouseLeaveMonitor = this.menuEl.monitorMouseLeave(250, this.hideMenu, this); * * ... * // Remove mouseleave monitor on menu destroy * this.menuEl.un(this.mouseLeaveMonitor); * */ monitorMouseLeave: function(delay, handler, scope) { var me = this, timer, listeners = { mouseleave: function(e) { timer = setTimeout(Ext.Function.bind(handler, scope||me, [e]), delay); }, mouseenter: function() { clearTimeout(timer); }, freezeEvent: true }; me.on(listeners); return listeners; }, /** * Stops the specified event(s) from bubbling and optionally prevents the default action * @param {String/String[]} eventName an event / array of events to stop from bubbling * @param {Boolean} [preventDefault] true to prevent the default action too * @return {Ext.dom.Element} this */ swallowEvent : function(eventName, preventDefault) { var me = this, e, eLen, fn = function(e) { e.stopPropagation(); if (preventDefault) { e.preventDefault(); } }; if (Ext.isArray(eventName)) { eLen = eventName.length; for (e = 0; e < eLen; e++) { me.on(eventName[e], fn); } return me; } me.on(eventName, fn); return me; }, /** * Create an event handler on this element such that when the event fires and is handled by this element, * it will be relayed to another object (i.e., fired again as if it originated from that object instead). * @param {String} eventName The type of event to relay * @param {Object} observable Any object that extends {@link Ext.util.Observable} that will provide the context * for firing the relayed event */ relayEvent : function(eventName, observable) { this.on(eventName, function(e) { observable.fireEvent(eventName, e); }); }, /** * Removes Empty, or whitespace filled text nodes. Combines adjacent text nodes. * @param {Boolean} [forceReclean=false] By default the element keeps track if it has been cleaned already * so you can call this over and over. However, if you update the element and need to force a reclean, you * can pass true. */ clean : function(forceReclean) { var me = this, dom = me.dom, data = (me.$cache || me.getCache()).data, n = dom.firstChild, ni = -1, nx; if (data.isCleaned && forceReclean !== true) { return me; } while (n) { nx = n.nextSibling; if (n.nodeType == 3) { // Remove empty/whitespace text nodes if (!(nonSpaceRe.test(n.nodeValue))) { dom.removeChild(n); // Combine adjacent text nodes } else if (nx && nx.nodeType == 3) { n.appendData(Ext.String.trim(nx.data)); dom.removeChild(nx); nx = n.nextSibling; n.nodeIndex = ++ni; } } else { // Recursively clean internalFly.attach(n).clean(); n.nodeIndex = ++ni; } n = nx; } data.isCleaned = true; return me; }, /** * Direct access to the Ext.ElementLoader {@link Ext.ElementLoader#method-load} method. The method takes the same object * parameter as {@link Ext.ElementLoader#method-load} * @return {Ext.dom.Element} this */ load : function(options) { this.getLoader().load(options); return this; }, /** * Gets this element's {@link Ext.ElementLoader ElementLoader} * @return {Ext.ElementLoader} The loader */ getLoader : function() { var me = this, data = (me.$cache || me.getCache()).data, loader = data.loader; if (!loader) { data.loader = loader = new Ext.ElementLoader({ target: me }); } return loader; }, /** * @private. * Currently used for updating grid cells without modifying DOM structure * * Synchronizes content of this Element with the content of the passed element. * * Style and CSS class are copied from source into this Element, and contents are synched * recursively. If a child node is a text node, the textual data is copied. */ syncContent: function(source) { source = Ext.getDom(source); var sourceNodes = source.childNodes, sourceLen = sourceNodes.length, dest = this.dom, destNodes = dest.childNodes, destLen = destNodes.length, i, destNode, sourceNode, nodeType, newAttrs, attLen, attName; // Copy top node's attributes across. Use IE-specific method if possible. // In IE10, there is a problem where the className will not get updated // in the view, even though the className on the dom element is correct. // See EXTJSIV-9462 if (Ext.isIE9m && dest.mergeAttributes) { dest.mergeAttributes(source, true); // EXTJSIV-6803. IE's mergeAttributes appears not to make the source's "src" value available until after the image is ready. // So programatically copy any src attribute. dest.src = source.src; } else { newAttrs = source.attributes; attLen = newAttrs.length; for (i = 0; i < attLen; i++) { attName = newAttrs[i].name; if (attName !== 'id') { dest.setAttribute(attName, newAttrs[i].value); } } } // If the number of child nodes does not match, fall back to replacing innerHTML if (sourceLen !== destLen) { dest.innerHTML = source.innerHTML; return; } // Loop through source nodes. // If there are fewer, we must remove excess for (i = 0; i < sourceLen; i++) { sourceNode = sourceNodes[i]; destNode = destNodes[i]; nodeType = sourceNode.nodeType; // If node structure is out of sync, just drop innerHTML in and return if (nodeType !== destNode.nodeType || (nodeType === 1 && sourceNode.tagName !== destNode.tagName)) { dest.innerHTML = source.innerHTML; return; } // Update text node if (nodeType === 3) { destNode.data = sourceNode.data; } // Sync element content else { if (sourceNode.id && destNode.id !== sourceNode.id) { destNode.id = sourceNode.id; } destNode.style.cssText = sourceNode.style.cssText; destNode.className = sourceNode.className; internalFly.attach(destNode).syncContent(sourceNode); } } }, /** * Updates the innerHTML of this element, optionally searching for and processing scripts. * @param {String} html The new HTML * @param {Boolean} [loadScripts] True to look for and process scripts (defaults to false) * @param {Function} [callback] For async script loading you can be notified when the update completes * @return {Ext.dom.Element} this */ update : function(html, loadScripts, callback) { var me = this, id, dom, interval; if (!me.dom) { return me; } html = html || ''; dom = me.dom; if (loadScripts !== true) { dom.innerHTML = html; Ext.callback(callback, me); return me; } id = Ext.id(); html += ''; interval = setInterval(function() { var hd, match, attrs, srcMatch, typeMatch, el, s; if (!(el = DOC.getElementById(id))) { return false; } clearInterval(interval); Ext.removeNode(el); hd = Ext.getHead().dom; while ((match = scriptTagRe.exec(html))) { attrs = match[1]; srcMatch = attrs ? attrs.match(srcRe) : false; if (srcMatch && srcMatch[2]) { s = DOC.createElement("script"); s.src = srcMatch[2]; typeMatch = attrs.match(typeRe); if (typeMatch && typeMatch[2]) { s.type = typeMatch[2]; } hd.appendChild(s); } else if (match[2] && match[2].length > 0) { if (window.execScript) { window.execScript(match[2]); } else { window.eval(match[2]); } } } Ext.callback(callback, me); }, 20); dom.innerHTML = html.replace(replaceScriptTagRe, ''); return me; }, // inherit docs, overridden so we can add removeAnchor removeAllListeners : function() { this.removeAnchor(); Ext.EventManager.removeAll(this.dom); return this; }, /** * Creates a proxy element of this element * @param {String/Object} config The class name of the proxy element or a DomHelper config object * @param {String/HTMLElement} [renderTo] The element or element id to render the proxy to. Defaults to: document.body. * @param {Boolean} [matchBox=false] True to align and size the proxy to this element now. * @return {Ext.dom.Element} The new proxy element */ createProxy : function(config, renderTo, matchBox) { config = (typeof config == 'object') ? config : {tag : "div", cls: config}; var me = this, proxy = renderTo ? Ext.DomHelper.append(renderTo, config, true) : Ext.DomHelper.insertBefore(me.dom, config, true); proxy.setVisibilityMode(Element.DISPLAY); proxy.hide(); if (matchBox && me.setBox && me.getBox) { // check to make sure Element.position.js is loaded proxy.setBox(me.getBox()); } return proxy; }, /** * Returns true if this element needs an explicit tabIndex to make it focusable. Input fields, text areas, buttons * anchors elements **with an href** etc do not need a tabIndex, but structural elements do. */ needsTabIndex: function() { if (this.dom) { if ((this.dom.nodeName === 'a') && (!this.dom.href)) { return true; } return !focusRe.test(this.dom.nodeName); } }, /** * Checks whether this element can be focused. * @return {Boolean} True if the element is focusable */ isFocusable: function (/* private - assume it's the focusEl of a Component */ asFocusEl) { var dom = this.dom, tabIndexAttr = dom.getAttributeNode('tabIndex'), tabIndex, nodeName = dom.nodeName, canFocus = false; // Certain browsers always report zero in the absence of the tabIndex attribute. // Testing the specified property (Standards: http://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-862529273) // Should filter out these cases. // The exceptions are IE6 to IE8. In these browsers all elements will yield a tabIndex // and therefore all elements will appear to be focusable. // This adversely affects modal Floating components. // These listen for the TAB key, and then test whether the event target === last focusable // or first focusable element, and forcibly to a circular navigation. // We cannot know the true first or last focusable element, so this problem still exists for IE6,7,8 // See Ext.util.Floating if (tabIndexAttr && tabIndexAttr.specified) { tabIndex = tabIndexAttr.value; } if (dom && !dom.disabled) { // A tabIndex of -1 means it has to be programatically focused, so that needs FocusManager, // and it has to be the focus holding el of a Component within the Component tree. if (tabIndex == -1) { // note that the value is a string canFocus = Ext.FocusManager && Ext.FocusManager.enabled && asFocusEl; } else { // See if it's a naturally focusable element if (focusRe.test(nodeName)) { if ((nodeName !== 'a') || dom.href) { canFocus = true; } } // A non naturally focusable element is in the navigation flow if it has a positive numeric tab index. else { canFocus = tabIndex != null && tabIndex >= 0; } } canFocus = canFocus && this.isVisible(true); } return canFocus; } }); if (Ext.isIE) { Element.prototype.getById = function (id, asDom) { var dom = this.dom, cacheItem, el, ret; if (dom) { // for normal elements getElementById is the best solution, but if the el is // not part of the document.body, we need to use all[] el = (useDocForId && DOC.getElementById(id)) || dom.all[id]; if (el) { if (asDom) { ret = el; } else { // calling Element.get here is a real hit (2x slower) because it has to // redetermine that we are giving it a dom el. cacheItem = EC[id]; if (cacheItem && cacheItem.el) { ret = Ext.updateCacheEntry(cacheItem, el).el; } else { ret = new Element(el); } } return ret; } } return asDom ? Ext.getDom(id) : Element.get(id); }; } Element.createAlias({ /** * @method * @inheritdoc Ext.dom.Element#on * Shorthand for {@link #on}. */ addListener: 'on', /** * @method * @inheritdoc Ext.dom.Element#un * Shorthand for {@link #un}. */ removeListener: 'un', /** * @method * @inheritdoc Ext.dom.Element#removeAllListeners * Alias for {@link #removeAllListeners}. */ clearListeners: 'removeAllListeners', /** * @method * @inheritdoc Ext.dom.Element#isFocusable * Alias for {@link #isFocusable}. */ focusable: 'isFocusable' }); Element.Fly = AbstractElement.Fly = new Ext.Class({ extend: Element, isFly: true, constructor: function(dom) { this.dom = dom; // set an "el" property that references "this". This allows // Ext.util.Positionable methods to operate on this.el.dom since it // gets mixed into both Element and Component this.el = this; }, attach: AbstractElement.Fly.prototype.attach }); internalFly = new Element.Fly(); if (Ext.isIE) { Ext.getElementById = function (id) { var el = DOC.getElementById(id), detachedBodyEl; if (!el && (detachedBodyEl = AbstractElement.detachedBodyEl)) { el = detachedBodyEl.dom.all[id]; } return el; }; } else if (!DOC.querySelector) { Ext.getDetachedBody = Ext.getBody; Ext.getElementById = function (id) { return DOC.getElementById(id); }; } }); // @tag dom,core /** * This class encapsulates a *collection* of DOM elements, providing methods to filter members, or to perform collective * actions upon the whole set. * * Although they are not listed, this class supports all of the methods of {@link Ext.dom.Element} and * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection. * * Example: * * var els = Ext.select("#some-el div.some-class"); * // or select directly from an existing element * var el = Ext.get('some-el'); * el.select('div.some-class'); * * els.setWidth(100); // all elements become 100 width * els.hide(true); // all elements fade out and hide * // or * els.setWidth(100).hide(true); */ Ext.define('Ext.dom.CompositeElementLite', { alternateClassName: 'Ext.CompositeElementLite', statics: { /** * @private * Copies all of the functions from Ext.dom.Element's prototype onto CompositeElementLite's prototype. * This is called twice - once immediately below, and once again after additional Ext.dom.Element * are added in Ext JS */ importElementMethods: function() { var name, elementPrototype = Ext.dom.Element.prototype, prototype = this.prototype; for (name in elementPrototype) { if (typeof elementPrototype[name] == 'function'){ (function(key) { prototype[key] = prototype[key] || function() { return this.invoke(key, arguments); }; }).call(prototype, name); } } } }, constructor: function(elements, root) { /** * @property {HTMLElement[]} elements * The Array of DOM elements which this CompositeElement encapsulates. * * This will not *usually* be accessed in developers' code, but developers wishing to augment the capabilities * of the CompositeElementLite class may use it when adding methods to the class. * * For example to add the `nextAll` method to the class to **add** all following siblings of selected elements, * the code would be * * Ext.override(Ext.dom.CompositeElementLite, { * nextAll: function() { * var elements = this.elements, i, l = elements.length, n, r = [], ri = -1; * * // Loop through all elements in this Composite, accumulating * // an Array of all siblings. * for (i = 0; i < l; i++) { * for (n = elements[i].nextSibling; n; n = n.nextSibling) { * r[++ri] = n; * } * } * * // Add all found siblings to this Composite * return this.add(r); * } * }); * * @readonly */ this.elements = []; this.add(elements, root); this.el = new Ext.dom.AbstractElement.Fly(); }, /** * @property {Boolean} isComposite * `true` in this class to identify an object as an instantiated CompositeElement, or subclass thereof. */ isComposite: true, // private getElement: function(el) { // Set the shared flyweight dom property to the current element return this.el.attach(el); }, // private transformElement: function(el) { return Ext.getDom(el); }, /** * Returns the number of elements in this Composite. * @return {Number} */ getCount: function() { return this.elements.length; }, /** * Adds elements to this Composite object. * @param {HTMLElement[]/Ext.dom.CompositeElement} els Either an Array of DOM elements to add, or another Composite * object who's elements should be added. * @return {Ext.dom.CompositeElement} This Composite object. */ add: function(els, root) { var elements = this.elements, i, ln; if (!els) { return this; } if (typeof els == "string") { els = Ext.dom.Element.selectorFunction(els, root); } else if (els.isComposite) { els = els.elements; } else if (!Ext.isIterable(els)) { els = [els]; } for (i = 0, ln = els.length; i < ln; ++i) { elements.push(this.transformElement(els[i])); } return this; }, invoke: function(fn, args) { var elements = this.elements, ln = elements.length, element, i; fn = Ext.dom.Element.prototype[fn]; for (i = 0; i < ln; i++) { element = elements[i]; if (element) { fn.apply(this.getElement(element), args); } } return this; }, /** * Returns a flyweight Element of the dom element object at the specified index * @param {Number} index * @return {Ext.dom.Element} */ item: function(index) { var el = this.elements[index], out = null; if (el) { out = this.getElement(el); } return out; }, /** * Gets a range nodes. * @param {Number} start (optional) The index of the first node in the range * @param {Number} end (optional) The index of the last node in the range * @return {HTMLElement[]} An array of nodes */ slice: function() { return this.elements.slice.apply(this.elements, arguments); }, // fixes scope with flyweight addListener: function(eventName, handler, scope, opt) { var els = this.elements, len = els.length, i, e; for (i = 0; i < len; i++) { e = els[i]; if (e) { Ext.EventManager.on(e, eventName, handler, scope || e, opt); } } return this; }, /** * Calls the passed function for each element in this composite. * @param {Function} fn The function to call. * @param {Ext.dom.Element} fn.el The current Element in the iteration. **This is the flyweight * (shared) Ext.dom.Element instance, so if you require a a reference to the dom node, use el.dom.** * @param {Ext.dom.CompositeElement} fn.c This Composite object. * @param {Number} fn.index The zero-based index in the iteration. * @param {Object} [scope] The scope (this reference) in which the function is executed. * Defaults to the Element. * @return {Ext.dom.CompositeElement} this */ each: function(fn, scope) { var me = this, els = me.elements, len = els.length, i, e; for (i = 0; i < len; i++) { e = els[i]; if (e) { e = this.getElement(e); if (fn.call(scope || e, e, me, i) === false) { break; } } } return me; }, /** * Clears this Composite and adds the elements passed. * @param {HTMLElement[]/Ext.dom.CompositeElement} els Either an array of DOM elements, or another Composite from which * to fill this Composite. * @return {Ext.dom.CompositeElement} this */ fill: function(els) { var me = this; me.elements = []; me.add(els); return me; }, insert: function(index, nodes) { Ext.Array.insert(this.elements, index, nodes); }, /** * Filters this composite to only elements that match the passed selector. * @param {String/Function} selector A string CSS selector or a comparison function. The comparison function will be * called with the following arguments: * @param {Ext.dom.Element} selector.el The current DOM element. * @param {Number} selector.index The current index within the collection. * @return {Ext.dom.CompositeElement} this */ filter: function(selector) { var me = this, els = me.elements, len = els.length, out = [], i = 0, isFunc = typeof selector == 'function', add, el; for (; i < len; i++) { el = els[i]; add = false; if (el) { el = me.getElement(el); if (isFunc) { add = selector.call(el, el, me, i) !== false; } else { add = el.is(selector); } if (add) { out.push(me.transformElement(el)); } } } me.elements = out; return me; }, /** * Find the index of the passed element within the composite collection. * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, or an Ext.dom.Element, or an HtmlElement * to find within the composite collection. * @return {Number} The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ indexOf: function(el) { return Ext.Array.indexOf(this.elements, this.transformElement(el)); }, /** * Replaces the specified element with the passed element. * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, the Element itself, the index of the * element in this composite to replace. * @param {String/Ext.Element} replacement The id of an element or the Element itself. * @param {Boolean} [domReplace] True to remove and replace the element in the document too. * @return {Ext.dom.CompositeElement} this */ replaceElement: function(el, replacement, domReplace) { var index = !isNaN(el) ? el : this.indexOf(el), d; if (index > -1) { replacement = Ext.getDom(replacement); if (domReplace) { d = this.elements[index]; d.parentNode.insertBefore(replacement, d); Ext.removeNode(d); } Ext.Array.splice(this.elements, index, 1, replacement); } return this; }, /** * Removes all elements from this Composite. * @param {Boolean} [removeDom] True to also remove the elements from the document. */ clear: function(removeDom) { var me = this, els = me.elements, i = els.length - 1; if (removeDom) { for (; i >= 0; i--) { Ext.removeNode(els[i]); } } this.elements = []; }, addElements: function(els, root) { if (!els) { return this; } if (typeof els == "string") { els = Ext.dom.Element.selectorFunction(els, root); } var yels = this.elements, eLen = els.length, e; for (e = 0; e < eLen; e++) { yels.push(Ext.get(els[e])); } return this; }, /** * Returns the first Element * @return {Ext.dom.Element} */ first: function() { return this.item(0); }, /** * Returns the last Element * @return {Ext.dom.Element} */ last: function() { return this.item(this.getCount() - 1); }, /** * Returns true if this composite contains the passed element. * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, or an Ext.Element, or an HtmlElement to * find within the composite collection. * @return {Boolean} */ contains: function(el) { return this.indexOf(el) != -1; }, /** * Removes the specified element(s). * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, the Element itself, the index of the * element in this composite or an array of any of those. * @param {Boolean} [removeDom] True to also remove the element from the document. * @return {Ext.dom.CompositeElement} this */ removeElement: function(keys, removeDom) { keys = [].concat(keys); var me = this, elements = me.elements, kLen = keys.length, val, el, k; for (k = 0; k < kLen; k++) { val = keys[k]; if ((el = (elements[val] || elements[val = me.indexOf(val)]))) { if (removeDom) { if (el.dom) { el.remove(); } else { Ext.removeNode(el); } } Ext.Array.erase(elements, val, 1); } } return me; } }, function() { this.importElementMethods(); this.prototype.on = this.prototype.addListener; if (Ext.DomQuery){ Ext.dom.Element.selectorFunction = Ext.DomQuery.select; } /** * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods * to be applied to many related elements in one statement through the returned * {@link Ext.dom.CompositeElement CompositeElement} or * {@link Ext.dom.CompositeElementLite CompositeElementLite} object. * @param {String/HTMLElement[]} selector The CSS selector or an array of elements * @param {HTMLElement/String} [root] The root element of the query or id of the root * @return {Ext.dom.CompositeElementLite/Ext.dom.CompositeElement} * @member Ext.dom.Element * @method select * @static * @ignore */ Ext.dom.Element.select = function(selector, root) { var elements; if (typeof selector == "string") { elements = Ext.dom.Element.selectorFunction(selector, root); } else if (selector.length !== undefined) { elements = selector; } else { throw new Error("[Ext.select] Invalid selector specified: " + selector); } return new Ext.CompositeElementLite(elements); }; /** * @member Ext * @method select * @inheritdoc Ext.dom.Element#select * @ignore */ Ext.select = function() { return Ext.dom.Element.select.apply(Ext.dom.Element, arguments); }; }); // @tag dom,core /** * @class Ext.dom.CompositeElement *

This class encapsulates a collection of DOM elements, providing methods to filter * members, or to perform collective actions upon the whole set.

*

Although they are not listed, this class supports all of the methods of {@link Ext.dom.Element} and * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection.

*

All methods return this and can be chained.

* Usage:

 var els = Ext.select("#some-el div.some-class", true);
 // or select directly from an existing element
 var el = Ext.get('some-el');
 el.select('div.some-class', true);

 els.setWidth(100); // all elements become 100 width
 els.hide(true); // all elements fade out and hide
 // or
 els.setWidth(100).hide(true);
 
*/ Ext.define('Ext.dom.CompositeElement', { alternateClassName: 'Ext.CompositeElement', extend: Ext.dom.CompositeElementLite , // private getElement: function(el) { // In this case just return it, since we already have a reference to it return el; }, // private transformElement: function(el) { return Ext.get(el); } }, function() { /** * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or * {@link Ext.CompositeElementLite CompositeElementLite} object. * @param {String/HTMLElement[]} selector The CSS selector or an array of elements * @param {Boolean} [unique] true to create a unique Ext.Element for each element (defaults to a shared flyweight object) * @param {HTMLElement/String} [root] The root element of the query or id of the root * @return {Ext.CompositeElementLite/Ext.CompositeElement} * @member Ext.dom.Element * @method select * @static */ Ext.dom.Element.select = function(selector, unique, root) { var elements; if (typeof selector == "string") { elements = Ext.dom.Element.selectorFunction(selector, root); } else if (selector.length !== undefined) { elements = selector; } else { throw new Error("[Ext.select] Invalid selector specified: " + selector); } return (unique === true) ? new Ext.CompositeElement(elements) : new Ext.CompositeElementLite(elements); }; }); /** * Shorthand of {@link Ext.Element#method-select}. * @member Ext * @method select * @inheritdoc Ext.Element#select */ Ext.select = Ext.Element.select; /** * Represents a collection of a set of key and value pairs. Each key in the HashMap * must be unique, the same key cannot exist twice. Access to items is provided via * the key only. Sample usage: * * var map = new Ext.util.HashMap(); * map.add('key1', 1); * map.add('key2', 2); * map.add('key3', 3); * * map.each(function(key, value, length){ * console.log(key, value, length); * }); * * The HashMap is an unordered class, * there is no guarantee when iterating over the items that they will be in any particular * order. If this is required, then use a {@link Ext.util.MixedCollection}. */ Ext.define('Ext.util.HashMap', { mixins: { observable: Ext.util.Observable }, /** * @private Mutation counter which is incremented upon add and remove. */ generation: 0, /** * @cfg {Function} keyFn A function that is used to retrieve a default key for a passed object. * A default is provided that returns the `id` property on the object. This function is only used * if the `add` method is called with a single argument. */ /** * Creates new HashMap. * @param {Object} config (optional) Config object. */ constructor: function(config) { config = config || {}; var me = this, keyFn = config.keyFn; me.initialConfig = config; me.addEvents( /** * @event add * Fires when a new item is added to the hash. * @param {Ext.util.HashMap} this * @param {String} key The key of the added item. * @param {Object} value The value of the added item. */ 'add', /** * @event clear * Fires when the hash is cleared. * @param {Ext.util.HashMap} this */ 'clear', /** * @event remove * Fires when an item is removed from the hash. * @param {Ext.util.HashMap} this * @param {String} key The key of the removed item. * @param {Object} value The value of the removed item. */ 'remove', /** * @event replace * Fires when an item is replaced in the hash. * @param {Ext.util.HashMap} this * @param {String} key The key of the replaced item. * @param {Object} value The new value for the item. * @param {Object} old The old value for the item. */ 'replace' ); me.mixins.observable.constructor.call(me, config); me.clear(true); if (keyFn) { me.getKey = keyFn; } }, /** * Gets the number of items in the hash. * @return {Number} The number of items in the hash. */ getCount: function() { return this.length; }, /** * Implementation for being able to extract the key from an object if only * a single argument is passed. * @private * @param {String} key The key * @param {Object} value The value * @return {Array} [key, value] */ getData: function(key, value) { // if we have no value, it means we need to get the key from the object if (value === undefined) { value = key; key = this.getKey(value); } return [key, value]; }, /** * Extracts the key from an object. This is a default implementation, it may be overridden * @param {Object} o The object to get the key from * @return {String} The key to use. */ getKey: function(o) { return o.id; }, /** * Adds an item to the collection. Fires the {@link #event-add} event when complete. * * @param {String/Object} key The key to associate with the item, or the new item. * * If a {@link #getKey} implementation was specified for this HashMap, * or if the key of the stored items is in a property called `id`, * the HashMap will be able to *derive* the key for the new item. * In this case just pass the new item in this parameter. * * @param {Object} [o] The item to add. * * @return {Object} The item added. */ add: function(key, value) { var me = this; // Need to check arguments length here, since we could have called: // map.add('foo', undefined); if (arguments.length === 1) { value = key; key = me.getKey(value); } if (me.containsKey(key)) { return me.replace(key, value); } me.map[key] = value; ++me.length; me.generation++; if (me.hasListeners.add) { me.fireEvent('add', me, key, value); } return value; }, /** * Replaces an item in the hash. If the key doesn't exist, the * {@link #method-add} method will be used. * @param {String} key The key of the item. * @param {Object} value The new value for the item. * @return {Object} The new value of the item. */ replace: function(key, value) { var me = this, map = me.map, old; // Need to check arguments length here, since we could have called: // map.replace('foo', undefined); if (arguments.length === 1) { value = key; key = me.getKey(value); } if (!me.containsKey(key)) { me.add(key, value); } old = map[key]; map[key] = value; me.generation++; if (me.hasListeners.replace) { me.fireEvent('replace', me, key, value, old); } return value; }, /** * Remove an item from the hash. * @param {Object} o The value of the item to remove. * @return {Boolean} True if the item was successfully removed. */ remove: function(o) { var key = this.findKey(o); if (key !== undefined) { return this.removeAtKey(key); } return false; }, /** * Remove an item from the hash. * @param {String} key The key to remove. * @return {Boolean} True if the item was successfully removed. */ removeAtKey: function(key) { var me = this, value; if (me.containsKey(key)) { value = me.map[key]; delete me.map[key]; --me.length; me.generation++; if (me.hasListeners.remove) { me.fireEvent('remove', me, key, value); } return true; } return false; }, /** * Retrieves an item with a particular key. * @param {String} key The key to lookup. * @return {Object} The value at that key. If it doesn't exist, `undefined` is returned. */ get: function(key) { var map = this.map; return map.hasOwnProperty(key) ? map[key] : undefined; }, /** * Removes all items from the hash. * @return {Ext.util.HashMap} this */ clear: function(/* private */ initial) { var me = this; // Only clear if it has ever had any content if (initial || me.generation) { me.map = {}; me.length = 0; me.generation = initial ? 0 : me.generation + 1; } if (initial !== true && me.hasListeners.clear) { me.fireEvent('clear', me); } return me; }, /** * Checks whether a key exists in the hash. * @param {String} key The key to check for. * @return {Boolean} True if they key exists in the hash. */ containsKey: function(key) { var map = this.map; return map.hasOwnProperty(key) && map[key] !== undefined; }, /** * Checks whether a value exists in the hash. * @param {Object} value The value to check for. * @return {Boolean} True if the value exists in the dictionary. */ contains: function(value) { return this.containsKey(this.findKey(value)); }, /** * Return all of the keys in the hash. * @return {Array} An array of keys. */ getKeys: function() { return this.getArray(true); }, /** * Return all of the values in the hash. * @return {Array} An array of values. */ getValues: function() { return this.getArray(false); }, /** * Gets either the keys/values in an array from the hash. * @private * @param {Boolean} isKey True to extract the keys, otherwise, the value * @return {Array} An array of either keys/values from the hash. */ getArray: function(isKey) { var arr = [], key, map = this.map; for (key in map) { if (map.hasOwnProperty(key)) { arr.push(isKey ? key: map[key]); } } return arr; }, /** * Executes the specified function once for each item in the hash. * Returning false from the function will cease iteration. * * @param {Function} fn The function to execute. * @param {String} fn.key The key of the item. * @param {Number} fn.value The value of the item. * @param {Number} fn.length The total number of items in the hash. * @param {Object} [scope] The scope to execute in. Defaults to this. * @return {Ext.util.HashMap} this */ each: function(fn, scope) { // copy items so they may be removed during iteration. var items = Ext.apply({}, this.map), key, length = this.length; scope = scope || this; for (key in items) { if (items.hasOwnProperty(key)) { if (fn.call(scope, key, items[key], length) === false) { break; } } } return this; }, /** * Performs a shallow copy on this hash. * @return {Ext.util.HashMap} The new hash object. */ clone: function() { var hash = new this.self(this.initialConfig), map = this.map, key; hash.suspendEvents(); for (key in map) { if (map.hasOwnProperty(key)) { hash.add(key, map[key]); } } hash.resumeEvents(); return hash; }, /** * @private * Find the key for a value. * @param {Object} value The value to find. * @return {Object} The value of the item. Returns undefined if not found. */ findKey: function(value) { var key, map = this.map; for (key in map) { if (map.hasOwnProperty(key) && map[key] === value) { return key; } } return undefined; } }); /** * Base Manager class */ Ext.define('Ext.AbstractManager', { /* Begin Definitions */ /* End Definitions */ typeName: 'type', constructor: function(config) { Ext.apply(this, config || {}); /** * @property {Ext.util.HashMap} all * Contains all of the items currently managed */ this.all = new Ext.util.HashMap(); this.types = {}; }, /** * Returns an item by id. * For additional details see {@link Ext.util.HashMap#get}. * @param {String} id The id of the item * @return {Object} The item, undefined if not found. */ get : function(id) { return this.all.get(id); }, /** * Registers an item to be managed * @param {Object} item The item to register */ register: function(item) { var all = this.all, key = all.getKey(item); if (all.containsKey(key)) { Ext.Error.raise('Registering duplicate id "' + key + '" with this manager'); } this.all.add(item); }, /** * Unregisters an item by removing it from this manager * @param {Object} item The item to unregister */ unregister: function(item) { this.all.remove(item); }, /** * Registers a new item constructor, keyed by a type key. * @param {String} type The mnemonic string by which the class may be looked up. * @param {Function} cls The new instance class. */ registerType : function(type, cls) { this.types[type] = cls; cls[this.typeName] = type; }, /** * Checks if an item type is registered. * @param {String} type The mnemonic string by which the class may be looked up * @return {Boolean} Whether the type is registered. */ isRegistered : function(type){ return this.types[type] !== undefined; }, /** * Creates and returns an instance of whatever this manager manages, based on the supplied type and * config object. * @param {Object} config The config object * @param {String} defaultType If no type is discovered in the config object, we fall back to this type * @return {Object} The instance of whatever this manager is managing */ create: function(config, defaultType) { var type = config[this.typeName] || config.type || defaultType, Constructor = this.types[type]; if (Constructor === undefined) { Ext.Error.raise("The '" + type + "' type has not been registered with this manager"); } return new Constructor(config); }, /** * Registers a function that will be called when an item with the specified id is added to the manager. * This will happen on instantiation. * @param {String} id The item id * @param {Function} fn The callback function. Called with a single parameter, the item. * @param {Object} scope The scope (this reference) in which the callback is executed. * Defaults to the item. */ onAvailable : function(id, fn, scope){ var all = this.all, item, callback; if (all.containsKey(id)) { item = all.get(id); fn.call(scope || item, item); } else { callback = function(map, key, item){ if (key == id) { fn.call(scope || item, item); all.un('add', callback); } }; all.on('add', callback); } }, /** * Executes the specified function once for each item in the collection. * @param {Function} fn The function to execute. * @param {String} fn.key The key of the item * @param {Number} fn.value The value of the item * @param {Number} fn.length The total number of items in the collection * @param {Boolean} fn.return False to cease iteration. * @param {Object} scope The scope to execute in. Defaults to `this`. */ each: function(fn, scope){ this.all.each(fn, scope || this); }, /** * Gets the number of items in the collection. * @return {Number} The number of items in the collection. */ getCount: function(){ return this.all.getCount(); } }); /** * @class Ext.ComponentManager *

Provides a registry of all Components (instances of {@link Ext.Component} or any subclass * thereof) on a page so that they can be easily accessed by {@link Ext.Component component} * {@link Ext.Component#id id} (see {@link #get}, or the convenience method {@link Ext#getCmp Ext.getCmp}).

*

This object also provides a registry of available Component classes * indexed by a mnemonic code known as the Component's {@link Ext.Component#xtype xtype}. * The xtype provides a way to avoid instantiating child Components * when creating a full, nested config object for a complete Ext page.

*

A child Component may be specified simply as a config object * as long as the correct {@link Ext.Component#xtype xtype} is specified so that if and when the Component * needs rendering, the correct type can be looked up for lazy instantiation.

*

For a list of all available {@link Ext.Component#xtype xtypes}, see {@link Ext.Component}.

* @singleton */ Ext.define('Ext.ComponentManager', { extend: Ext.AbstractManager , alternateClassName: 'Ext.ComponentMgr', singleton: true, typeName: 'xtype', /** * Creates a new Component from the specified config object using the * config object's xtype to determine the class to instantiate. * @param {Object} config A configuration object for the Component you wish to create. * @param {String} defaultType (optional) The xtype to use if the config object does not * contain a xtype. (Optional if the config contains a xtype). * @return {Ext.Component} The newly instantiated Component. */ create: function(component, defaultType){ if (typeof component == 'string') { return Ext.widget(component); } if (component.isComponent) { return component; } return Ext.widget(component.xtype || defaultType, component); }, registerType: function(type, cls) { this.types[type] = cls; cls[this.typeName] = type; cls.prototype[this.typeName] = type; } }, function () { /** * This is shorthand reference to {@link Ext.ComponentManager#get}. * Looks up an existing {@link Ext.Component Component} by {@link Ext.Component#id id} * * @param {String} id The component {@link Ext.Component#id id} * @return Ext.Component The Component, `undefined` if not found, or `null` if a * Class was found. * @member Ext */ Ext.getCmp = function(id) { return Ext.ComponentManager.get(id); }; }); /** * Provides searching of Components within Ext.ComponentManager (globally) or a specific * Ext.container.Container on the document with a similar syntax to a CSS selector. * Returns Array of matching Components, or empty Array. * * ## Basic Component lookup * * Components can be retrieved by using their {@link Ext.Component xtype}: * * - `component` * - `gridpanel` * * Matching by `xtype` matches inherited types, so in the following code, the previous field * *of any type which inherits from `TextField`* will be found: * * prevField = myField.previousNode('textfield'); * * To match only the exact type, pass the "shallow" flag by adding `(true)` to xtype * (See AbstractComponent's {@link Ext.AbstractComponent#isXType isXType} method): * * prevTextField = myField.previousNode('textfield(true)'); * * You can search Components by their `id` or `itemId` property, prefixed with a #: * * #myContainer * * Component `xtype` and `id` or `itemId` can be used together to avoid possible * id collisions between Components of different types: * * panel#myPanel * * ## Traversing Component tree * * Components can be found by their relation to other Components. There are several * relationship operators, mostly taken from CSS selectors: * * - **`E F`** All descendant Components of E that match F * - **`E > F`** All direct children Components of E that match F * - **`E ^ F`** All parent Components of E that match F * * Expressions between relationship operators are matched left to right, i.e. leftmost * selector is applied first, then if one or more matches are found, relationship operator * itself is applied, then next selector expression, etc. It is possible to combine * relationship operators in complex selectors: * * window[title="Input form"] textfield[name=login] ^ form > button[action=submit] * * That selector can be read this way: Find a window with title "Input form", in that * window find a TextField with name "login" at any depth (including subpanels and/or * FieldSets), then find an `Ext.form.Panel` that is a parent of the TextField, and in * that form find a direct child that is a button with custom property `action` set to * value "submit". * * Whitespace on both sides of `^` and `>` operators is non-significant, i.e. can be * omitted, but usually is used for clarity. * * ## Searching by Component attributes * * Components can be searched by their object property values (attributes). To do that, * use attribute matching expression in square brackets: * * - `component[autoScroll]` - matches any Component that has `autoScroll` property with * any truthy (non-empty, not `false`) value. * - `panel[title="Test"]` - matches any Component that has `title` property set to * "Test". Note that if the value does not contain spaces, the quotes are optional. * * Attributes can use any of the operators in {@link Ext.dom.Query DomQuery}'s * {@link Ext.dom.Query#operators operators} to compare values. * * Prefixing the attribute name with an at sign `@` means that the property must be * the object's `ownProperty`, not a property from the prototype chain. * * Specifications like `[propName]` check that the property is a truthy value. To check * that the object has an `ownProperty` of a certain name, regardless of the value use * the form `[?propName]`. * * The specified value is coerced to match the type of the property found in the * candidate Component using {@link Ext#coerce}. * * If you need to find Components by their `itemId` property, use `#id` form; it will * do the same but is easier to read. * * ## Attribute matching operators * * The '=' operator will return the results that **exactly** match the * specified object property (attribute): * * Ext.ComponentQuery.query('panel[cls=my-cls]'); * * Will match the following Component: * * Ext.create('Ext.window.Window', { * cls: 'my-cls' * }); * * But will not match the following Component, because 'my-cls' is one value * among others: * * Ext.create('Ext.panel.Panel', { * cls: 'foo-cls my-cls bar-cls' * }); * * You can use the '~=' operator instead, it will return Components with * the property that **exactly** matches one of the whitespace-separated * values. This is also true for properties that only have *one* value: * * Ext.ComponentQuery.query('panel[cls~=my-cls]'); * * Will match both Components: * * Ext.create('Ext.panel.Panel', { * cls: 'foo-cls my-cls bar-cls' * }); * * Ext.create('Ext.window.Window', { * cls: 'my-cls' * }); * * Generally, '=' operator is more suited for object properties other than * CSS classes, while '~=' operator will work best with properties that * hold lists of whitespace-separated CSS classes. * * The '^=' operator will return Components with specified attribute that * start with the passed value: * * Ext.ComponentQuery.query('panel[title^=Sales]'); * * Will match the following Component: * * Ext.create('Ext.panel.Panel', { * title: 'Sales estimate for Q4' * }); * * The '$=' operator will return Components with specified properties that * end with the passed value: * * Ext.ComponentQuery.query('field[fieldLabel$=name]'); * * Will match the following Component: * * Ext.create('Ext.form.field.Text', { * fieldLabel: 'Enter your name' * }); * * The following test will find panels with their `ownProperty` collapsed being equal to * `false`. It will **not** match a collapsed property from the prototype chain. * * Ext.ComponentQuery.query('panel[@collapsed=false]'); * * Member expressions from candidate Components may be tested. If the expression returns * a *truthy* value, the candidate Component will be included in the query: * * var disabledFields = myFormPanel.query("{isDisabled()}"); * * Such expressions are executed in Component's context, and the above expression is * similar to running this snippet for every Component in your application: * * if (component.isDisabled()) { * matches.push(component); * } * * It is important to use only methods that are available in **every** Component instance * to avoid run time exceptions. If you need to match your Components with a custom * condition formula, you can augment `Ext.Component` to provide custom matcher that * will return `false` by default, and override it in your custom classes: * * Ext.define('My.Component', { * override: 'Ext.Component', * myMatcher: function() { return false; } * }); * * Ext.define('My.Panel', { * extend: 'Ext.panel.Panel', * requires: ['My.Component'], // Ensure that Component override is applied * myMatcher: function(selector) { * return selector === 'myPanel'; * } * }); * * After that you can use a selector with your custom matcher to find all instances * of `My.Panel`: * * Ext.ComponentQuery.query("{myMatcher('myPanel')}"); * * However if you really need to use a custom matcher, you may find it easier to implement * a custom Pseudo class instead (see below). * * ## Conditional matching * * Attribute matchers can be combined to select only Components that match **all** * conditions (logical AND operator): * * Ext.ComponentQuery.query('panel[cls~=my-cls][floating=true][title$="sales data"]'); * * E.g., the query above will match only a Panel-descended Component that has 'my-cls' * CSS class *and* is floating *and* with a title that ends with "sales data". * * Expressions separated with commas will match any Component that satisfies * *either* expression (logical OR operator): * * Ext.ComponentQuery.query('field[fieldLabel^=User], field[fieldLabel*=password]'); * * E.g., the query above will match any field with field label starting with "User", * *or* any field that has "password" in its label. * * ## Pseudo classes * * Pseudo classes may be used to filter results in the same way as in * {@link Ext.dom.Query}. There are five default pseudo classes: * * * `not` Negates a selector. * * `first` Filters out all except the first matching item for a selector. * * `last` Filters out all except the last matching item for a selector. * * `focusable` Filters out all except Components which are currently able to recieve * focus. * * `nth-child` Filters Components by ordinal position in the selection. * * These pseudo classes can be used with other matchers or without them: * * // Select first direct child button in any panel * Ext.ComponentQuery.query('panel > button:first'); * * // Select last field in Profile form * Ext.ComponentQuery.query('form[title=Profile] field:last'); * * // Find first focusable Component in a panel and focus it * panel.down(':focusable').focus(); * * // Select any field that is not hidden in a form * form.query('field:not(hiddenfield)'); * * Pseudo class `nth-child` can be used to find any child Component by its * position relative to its siblings. This class' handler takes one argument * that specifies the selection formula as `Xn` or `Xn+Y`: * * // Find every odd field in a form * form.query('field:nth-child(2n+1)'); // or use shortcut: :nth-child(odd) * * // Find every even field in a form * form.query('field:nth-child(2n)'); // or use shortcut: :nth-child(even) * * // Find every 3rd field in a form * form.query('field:nth-child(3n)'); * * Pseudo classes can be combined to further filter the results, e.g., in the * form example above we can modify the query to exclude hidden fields: * * // Find every 3rd non-hidden field in a form * form.query('field:not(hiddenfield):nth-child(3n)'); * * Note that when combining pseudo classes, whitespace is significant, i.e. * there should be no spaces between pseudo classes. This is a common mistake; * if you accidentally type a space between `field` and `:not`, the query * will not return any result because it will mean "find *field's children * Components* that are not hidden fields...". * * ## Custom pseudo classes * * It is possible to define your own custom pseudo classes. In fact, a * pseudo class is just a property in `Ext.ComponentQuery.pseudos` object * that defines pseudo class name (property name) and pseudo class handler * (property value): * * // Function receives array and returns a filtered array. * Ext.ComponentQuery.pseudos.invalid = function(items) { * var i = 0, l = items.length, c, result = []; * for (; i < l; i++) { * if (!(c = items[i]).isValid()) { * result.push(c); * } * } * return result; * }; * * var invalidFields = myFormPanel.query('field:invalid'); * if (invalidFields.length) { * invalidFields[0].getEl().scrollIntoView(myFormPanel.body); * for (var i = 0, l = invalidFields.length; i < l; i++) { * invalidFields[i].getEl().frame("red"); * } * } * * Pseudo class handlers can be even more flexible, with a selector * argument used to define the logic: * * // Handler receives array of itmes and selector in parentheses * Ext.ComponentQuery.pseudos.titleRegex = function(components, selector) { * var i = 0, l = components.length, c, result = [], regex = new RegExp(selector); * for (; i < l; i++) { * c = components[i]; * if (c.title && regex.test(c.title)) { * result.push(c); * } * } * return result; * } * * var salesTabs = tabPanel.query('panel:titleRegex("sales\\s+for\\s+201[123]")'); * * Be careful when using custom pseudo classes with MVC Controllers: when * you use a pseudo class in Controller's `control` or `listen` component * selectors, the pseudo class' handler function will be called very often * and may slow down your application significantly. A good rule of thumb * is to always specify Component xtype with the pseudo class so that the * handlers are only called on Components that you need, and try to make * the condition checks as cheap in terms of execution time as possible. * Note how in the example above, handler function checks that Component * *has* a title first, before running regex test on it. * * ## Query examples * * Queries return an array of Components. Here are some example queries: * * // retrieve all Ext.Panels in the document by xtype * var panelsArray = Ext.ComponentQuery.query('panel'); * * // retrieve all Ext.Panels within the container with an id myCt * var panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel'); * * // retrieve all direct children which are Ext.Panels within myCt * var directChildPanel = Ext.ComponentQuery.query('#myCt > panel'); * * // retrieve all grids or trees * var gridsAndTrees = Ext.ComponentQuery.query('gridpanel, treepanel'); * * // Focus first Component * myFormPanel.child(':focusable').focus(); * * // Retrieve every odd text field in a form * myFormPanel.query('textfield:nth-child(odd)'); * * // Retrieve every even field in a form, excluding hidden fields * myFormPanel.query('field:not(hiddenfield):nth-child(even)'); * * For easy access to queries based from a particular Container see the * {@link Ext.container.Container#query}, {@link Ext.container.Container#down} and * {@link Ext.container.Container#child} methods. Also see * {@link Ext.Component#up}. */ Ext.define('Ext.ComponentQuery', { singleton: true }, function() { var cq = this, domQueryOperators = Ext.dom.Query.operators, nthRe = /(\d*)n\+?(\d*)/, nthRe2 = /\D/, // A function source code pattern with a placeholder which accepts an expression which yields a truth value when applied // as a member on each item in the passed array. filterFnPattern = [ 'var r = [],', 'i = 0,', 'it = items,', 'l = it.length,', 'c;', 'for (; i < l; i++) {', 'c = it[i];', 'if (c.{0}) {', 'r.push(c);', '}', '}', 'return r;' ].join(''), filterItems = function(items, operation) { // Argument list for the operation is [ itemsArray, operationArg1, operationArg2...] // The operation's method loops over each item in the candidate array and // returns an array of items which match its criteria return operation.method.apply(this, [ items ].concat(operation.args)); }, getItems = function(items, mode) { var result = [], i = 0, length = items.length, candidate, deep = mode !== '>'; for (; i < length; i++) { candidate = items[i]; if (candidate.getRefItems) { result = result.concat(candidate.getRefItems(deep)); } } return result; }, getAncestors = function(items) { var result = [], i = 0, length = items.length, candidate; for (; i < length; i++) { candidate = items[i]; while (!!(candidate = candidate.getRefOwner())) { result.push(candidate); } } return result; }, // Filters the passed candidate array and returns only items which match the passed xtype filterByXType = function(items, xtype, shallow) { if (xtype === '*') { return items.slice(); } else { var result = [], i = 0, length = items.length, candidate; for (; i < length; i++) { candidate = items[i]; if (candidate.isXType(xtype, shallow)) { result.push(candidate); } } return result; } }, // Filters the passed candidate array and returns only items which have the passed className filterByClassName = function(items, className) { var result = [], i = 0, length = items.length, candidate; for (; i < length; i++) { candidate = items[i]; if (candidate.hasCls(className)) { result.push(candidate); } } return result; }, // Filters the passed candidate array and returns only items which have the specified property match filterByAttribute = function(items, property, operator, compareTo) { var result = [], i = 0, length = items.length, mustBeOwnProperty, presenceOnly, candidate, propValue, j, propLen; // Prefixing property name with an @ means that the property must be in the candidate, not in its prototype if (property.charAt(0) === '@') { mustBeOwnProperty = true; property = property.substr(1); } if (property.charAt(0) === '?') { mustBeOwnProperty = true; presenceOnly = true; property = property.substr(1); } for (; i < length; i++) { candidate = items[i]; // Check candidate hasOwnProperty is propName prefixed with a bang. if (!mustBeOwnProperty || candidate.hasOwnProperty(property)) { // pull out property value to test propValue = candidate[property]; if (presenceOnly) { result.push(candidate); } // implies property is an array, and we must compare value against each element. else if (operator === '~=') { if (propValue) { //We need an array if (!Ext.isArray(propValue)) { propValue = propValue.split(' '); } for (j = 0, propLen = propValue.length; j < propLen; j++) { if (domQueryOperators[operator](Ext.coerce(propValue[j], compareTo), compareTo)) { result.push(candidate); break; } } } } else if (!compareTo ? !!candidate[property] : domQueryOperators[operator](Ext.coerce(propValue, compareTo), compareTo)) { result.push(candidate); } } } return result; }, // Filters the passed candidate array and returns only items which have the specified itemId or id filterById = function(items, id) { var result = [], i = 0, length = items.length, candidate; for (; i < length; i++) { candidate = items[i]; if (candidate.getItemId() === id) { result.push(candidate); } } return result; }, // Filters the passed candidate array and returns only items which the named pseudo class matcher filters in filterByPseudo = function(items, name, value) { return cq.pseudos[name](items, value); }, // Determines leading mode // > for direct child, and ^ to switch to ownerCt axis modeRe = /^(\s?([>\^])\s?|\s|$)/, // Matches a token with possibly (true|false) appended for the "shallow" parameter tokenRe = /^(#)?([\w\-]+|\*)(?:\((true|false)\))?/, matchers = [{ // Checks for .xtype with possibly (true|false) appended for the "shallow" parameter re: /^\.([\w\-]+)(?:\((true|false)\))?/, method: filterByXType }, { // checks for [attribute=value], [attribute^=value], [attribute$=value], [attribute*=value], [attribute~=value], [attribute%=value], [attribute!=value] // Allow [@attribute] to check truthy ownProperty // Allow [?attribute] to check for presence of ownProperty re: /^(?:\[((?:@|\?)?[\w\-\$]*[^\^\$\*~%!])\s?(?:(=|.=)\s?['"]?(.*?)["']?)?\])/, method: filterByAttribute }, { // checks for #cmpItemId re: /^#([\w\-]+)/, method: filterById }, { // checks for :() re: /^\:([\w\-]+)(?:\(((?:\{[^\}]+\})|(?:(?!\{)[^\s>\/]*?(?!\})))\))?/, method: filterByPseudo }, { // checks for {} re: /^(?:\{([^\}]+)\})/, method: filterFnPattern }]; // Internal class Ext.ComponentQuery.Query cq.Query = Ext.extend(Object, { constructor: function(cfg) { cfg = cfg || {}; Ext.apply(this, cfg); }, // Executes this Query upon the selected root. // The root provides the initial source of candidate Component matches which are progressively // filtered by iterating through this Query's operations cache. // If no root is provided, all registered Components are searched via the ComponentManager. // root may be a Container who's descendant Components are filtered // root may be a Component with an implementation of getRefItems which provides some nested Components such as the // docked items within a Panel. // root may be an array of candidate Components to filter using this Query. execute : function(root) { var operations = this.operations, i = 0, length = operations.length, operation, workingItems; // no root, use all Components in the document if (!root) { workingItems = Ext.ComponentManager.all.getArray(); } // Root is an iterable object like an Array, or system Collection, eg HtmlCollection else if (Ext.isIterable(root)) { workingItems = root; } // Root is a MixedCollection else if (root.isMixedCollection) { workingItems = root.items; } // We are going to loop over our operations and take care of them // one by one. for (; i < length; i++) { operation = operations[i]; // The mode operation requires some custom handling. // All other operations essentially filter down our current // working items, while mode replaces our current working // items by getting children from each one of our current // working items. The type of mode determines the type of // children we get. (e.g. > only gets direct children) if (operation.mode === '^') { workingItems = getAncestors(workingItems || [root]); } else if (operation.mode) { workingItems = getItems(workingItems || [root], operation.mode); } else { workingItems = filterItems(workingItems || getItems([root]), operation); } // If this is the last operation, it means our current working // items are the final matched items. Thus return them! if (i === length -1) { return workingItems; } } return []; }, is: function(component) { var operations = this.operations, components = Ext.isArray(component) ? component : [component], originalLength = components.length, lastOperation = operations[operations.length-1], ln, i; components = filterItems(components, lastOperation); if (components.length === originalLength) { if (operations.length > 1) { for (i = 0, ln = components.length; i < ln; i++) { if (Ext.Array.indexOf(this.execute(), components[i]) === -1) { return false; } } } return true; } return false; } }); Ext.apply(this, { // private cache of selectors and matching ComponentQuery.Query objects cache: {}, // private cache of pseudo class filter functions pseudos: { not: function(components, selector){ var CQ = Ext.ComponentQuery, i = 0, length = components.length, results = [], index = -1, component; for(; i < length; ++i) { component = components[i]; if (!CQ.is(component, selector)) { results[++index] = component; } } return results; }, first: function(components) { var ret = []; if (components.length > 0) { ret.push(components[0]); } return ret; }, last: function(components) { var len = components.length, ret = []; if (len > 0) { ret.push(components[len - 1]); } return ret; }, focusable: function(cmps) { var len = cmps.length, results = [], i = 0, c; for (; i < len; i++) { c = cmps[i]; // If this is a generally focusable Component (has a focusEl, is rendered, enabled and visible) // then it is currently focusable if focus management is enabled or if it is an input field, a button or a menu item if (c.isFocusable()) { results.push(c); } } return results; }, "nth-child" : function(c, a) { var result = [], m = nthRe.exec(a == "even" && "2n" || a == "odd" && "2n+1" || !nthRe2.test(a) && "n+" + a || a), f = (m[1] || 1) - 0, l = m[2] - 0, i, n, nodeIndex; for (i = 0; n = c[i]; i++) { nodeIndex = i + 1; if (f == 1) { if (l == 0 || nodeIndex == l) { result.push(n); } } else if ((nodeIndex + l) % f == 0){ result.push(n); } } return result; } }, /** * Returns an array of matched Components from within the passed root object. * * This method filters returned Components in a similar way to how CSS selector based DOM * queries work using a textual selector string. * * See class summary for details. * * @param {String} selector The selector string to filter returned Components * @param {Ext.container.Container} [root] The Container within which to perform the query. * If omitted, all Components within the document are included in the search. * * This parameter may also be an array of Components to filter according to the selector. * @returns {Ext.Component[]} The matched Components. * * @member Ext.ComponentQuery */ query: function(selector, root) { var selectors = selector.split(','), length = selectors.length, i = 0, results = [], noDupResults = [], dupMatcher = {}, query, resultsLn, cmp; for (; i < length; i++) { selector = Ext.String.trim(selectors[i]); query = this.cache[selector] || (this.cache[selector] = this.parse(selector)); results = results.concat(query.execute(root)); } // multiple selectors, potential to find duplicates // lets filter them out. if (length > 1) { resultsLn = results.length; for (i = 0; i < resultsLn; i++) { cmp = results[i]; if (!dupMatcher[cmp.id]) { noDupResults.push(cmp); dupMatcher[cmp.id] = true; } } results = noDupResults; } return results; }, /** * Tests whether the passed Component matches the selector string. * @param {Ext.Component} component The Component to test * @param {String} selector The selector string to test against. * @return {Boolean} True if the Component matches the selector. * @member Ext.ComponentQuery */ is: function(component, selector) { if (!selector) { return true; } var selectors = selector.split(','), length = selectors.length, i = 0, query; for (; i < length; i++) { selector = Ext.String.trim(selectors[i]); query = this.cache[selector] || (this.cache[selector] = this.parse(selector)); if (query.is(component)) { return true; } } return false; }, parse: function(selector) { var operations = [], length = matchers.length, lastSelector, tokenMatch, matchedChar, modeMatch, selectorMatch, i, matcher, method; // We are going to parse the beginning of the selector over and // over again, slicing off the selector any portions we converted into an // operation, until it is an empty string. while (selector && lastSelector !== selector) { lastSelector = selector; // First we check if we are dealing with a token like #, * or an xtype tokenMatch = selector.match(tokenRe); if (tokenMatch) { matchedChar = tokenMatch[1]; // If the token is prefixed with a # we push a filterById operation to our stack if (matchedChar === '#') { operations.push({ method: filterById, args: [Ext.String.trim(tokenMatch[2])] }); } // If the token is prefixed with a . we push a filterByClassName operation to our stack // FIXME: Not enabled yet. just needs \. adding to the tokenRe prefix else if (matchedChar === '.') { operations.push({ method: filterByClassName, args: [Ext.String.trim(tokenMatch[2])] }); } // If the token is a * or an xtype string, we push a filterByXType // operation to the stack. else { operations.push({ method: filterByXType, args: [Ext.String.trim(tokenMatch[2]), Boolean(tokenMatch[3])] }); } // Now we slice of the part we just converted into an operation selector = selector.replace(tokenMatch[0], ''); } // If the next part of the query is not a space or > or ^, it means we // are going to check for more things that our current selection // has to comply to. while (!(modeMatch = selector.match(modeRe))) { // Lets loop over each type of matcher and execute it // on our current selector. for (i = 0; selector && i < length; i++) { matcher = matchers[i]; selectorMatch = selector.match(matcher.re); method = matcher.method; // If we have a match, add an operation with the method // associated with this matcher, and pass the regular // expression matches are arguments to the operation. if (selectorMatch) { operations.push({ method: Ext.isString(matcher.method) // Turn a string method into a function by formatting the string with our selector matche expression // A new method is created for different match expressions, eg {id=='textfield-1024'} // Every expression may be different in different selectors. ? Ext.functionFactory('items', Ext.String.format.apply(Ext.String, [method].concat(selectorMatch.slice(1)))) : matcher.method, args: selectorMatch.slice(1) }); selector = selector.replace(selectorMatch[0], ''); break; // Break on match } // Exhausted all matches: It's an error if (i === (length - 1)) { Ext.Error.raise('Invalid ComponentQuery selector: "' + arguments[0] + '"'); } } } // Now we are going to check for a mode change. This means a space // or a > to determine if we are going to select all the children // of the currently matched items, or a ^ if we are going to use the // ownerCt axis as the candidate source. if (modeMatch[1]) { // Assignment, and test for truthiness! operations.push({ mode: modeMatch[2]||modeMatch[1] }); selector = selector.replace(modeMatch[0], ''); } } // Now that we have all our operations in an array, we are going // to create a new Query using these operations. return new cq.Query({ operations: operations }); } }); }); /* * The dirty implementation in this class is quite naive. The reasoning for this is that the dirty state * will only be used in very specific circumstances, specifically, after the render process has begun but * the component is not yet rendered to the DOM. As such, we want it to perform as quickly as possible * so it's not as fully featured as you may expect. */ /** * Manages certain element-like data prior to rendering. These values are passed * on to the render process. This is currently used to manage the "class" and "style" attributes * of a component's primary el as well as the bodyEl of panels. This allows things like * addBodyCls in Panel to share logic with addCls in AbstractComponent. * @private */ Ext.define('Ext.util.ProtoElement', (function () { var splitWords = Ext.String.splitWords, toMap = Ext.Array.toMap; return { isProtoEl: true, /** * The property name for the className on the data object passed to {@link #writeTo}. */ clsProp: 'cls', /** * The property name for the style on the data object passed to {@link #writeTo}. */ styleProp: 'style', /** * The property name for the removed classes on the data object passed to {@link #writeTo}. */ removedProp: 'removed', /** * True if the style must be converted to text during {@link #writeTo}. When used to * populate tpl data, this will be true. When used to populate {@link Ext.DomHelper} * specs, this will be false (the default). */ styleIsText: false, constructor: function (config) { var me = this; Ext.apply(me, config); me.classList = splitWords(me.cls); me.classMap = toMap(me.classList); delete me.cls; if (Ext.isFunction(me.style)) { me.styleFn = me.style; delete me.style; } else if (typeof me.style == 'string') { me.style = Ext.Element.parseStyles(me.style); } else if (me.style) { me.style = Ext.apply({}, me.style); // don't edit the given object } }, /** * Indicates that the current state of the object has been flushed to the DOM, so we need * to track any subsequent changes */ flush: function(){ this.flushClassList = []; this.removedClasses = {}; // clear the style, it will be recreated if we add anything new delete this.style; delete this.unselectableAttr; }, /** * Adds class to the element. * @param {String} cls One or more classnames separated with spaces. * @return {Ext.util.ProtoElement} this */ addCls: function (cls) { var me = this, add = (typeof cls === 'string') ? splitWords(cls) : cls, length = add.length, list = me.classList, map = me.classMap, flushList = me.flushClassList, i = 0, c; for (; i < length; ++i) { c = add[i]; if (!map[c]) { map[c] = true; list.push(c); if (flushList) { flushList.push(c); delete me.removedClasses[c]; } } } return me; }, /** * True if the element has given class. * @param {String} cls * @return {Boolean} */ hasCls: function (cls) { return cls in this.classMap; }, /** * Removes class from the element. * @param {String} cls One or more classnames separated with spaces. * @return {Ext.util.ProtoElement} this */ removeCls: function (cls) { var me = this, list = me.classList, newList = (me.classList = []), remove = toMap(splitWords(cls)), length = list.length, map = me.classMap, removedClasses = me.removedClasses, i, c; for (i = 0; i < length; ++i) { c = list[i]; if (remove[c]) { if (removedClasses) { if (map[c]) { removedClasses[c] = true; Ext.Array.remove(me.flushClassList, c); } } delete map[c]; } else { newList.push(c); } } return me; }, /** * Adds styles to the element. * @param {String/Object} prop The style property to be set, or an object of multiple styles. * @param {String} [value] The value to apply to the given property. * @return {Ext.util.ProtoElement} this */ setStyle: function (prop, value) { var me = this, style = me.style || (me.style = {}); if (typeof prop == 'string') { if (arguments.length === 1) { me.setStyle(Ext.Element.parseStyles(prop)); } else { style[prop] = value; } } else { Ext.apply(style, prop); } return me; }, unselectable: function() { // See Ext.dom.Element.unselectable for an explanation of what is required to make an element unselectable this.addCls(Ext.dom.Element.unselectableCls); if (Ext.isOpera) { this.unselectableAttr = true; } }, /** * Writes style and class properties to given object. * Styles will be written to {@link #styleProp} and class names to {@link #clsProp}. * @param {Object} to * @return {Object} to */ writeTo: function (to) { var me = this, classList = me.flushClassList || me.classList, removedClasses = me.removedClasses, style; if (me.styleFn) { style = Ext.apply({}, me.styleFn()); Ext.apply(style, me.style); } else { style = me.style; } to[me.clsProp] = classList.join(' '); if (style) { to[me.styleProp] = me.styleIsText ? Ext.DomHelper.generateStyles(style) : style; } if (removedClasses) { removedClasses = Ext.Object.getKeys(removedClasses); if (removedClasses.length) { to[me.removedProp] = removedClasses.join(' '); } } if (me.unselectableAttr) { to.unselectable = 'on'; } return to; } }; }())); /** * Provides a registry of available Plugin classes indexed by a mnemonic code known as the Plugin's ptype. * * A plugin may be specified simply as a *config object* as long as the correct `ptype` is specified: * * { * ptype: 'gridviewdragdrop', * dragText: 'Drag and drop to reorganize' * } * * Or just use the ptype on its own: * * 'gridviewdragdrop' * * Alternatively you can instantiate the plugin with Ext.create: * * Ext.create('Ext.grid.plugin.DragDrop', { * dragText: 'Drag and drop to reorganize' * }) */ Ext.define('Ext.PluginManager', { extend: Ext.AbstractManager , alternateClassName: 'Ext.PluginMgr', singleton: true, typeName: 'ptype', /** * Creates a new Plugin from the specified config object using the config object's ptype to determine the class to * instantiate. * @param {Object} config A configuration object for the Plugin you wish to create. * @param {Function} defaultType (optional) The constructor to provide the default Plugin type if the config object does not * contain a `ptype`. (Optional if the config contains a `ptype`). * @return {Ext.Component} The newly instantiated Plugin. */ create : function(config, defaultType, host) { var result; if (config.init) { result = config; } else { // Inject the host into the config is we know the host if (host) { config = Ext.apply({}, config); // copy since we are going to modify config.cmp = host; } // Grab the host ref if it was configured in else { host = config.cmp; } if (config.xclass) { result = Ext.create(config); } else { // Lookup the class from the ptype and instantiate unless its a singleton result = Ext.ClassManager.getByAlias(('plugin.' + (config.ptype || defaultType))); if (typeof result === 'function') { result = new result(config); } } } // If we come out with a non-null plugin, ensure that any setCmp is called once. if (result && host && result.setCmp && !result.setCmpCalled) { result.setCmp(host); result.setCmpCalled = true; } return result; }, /** * Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype. * @param {String} type The type to search for * @param {Boolean} defaultsOnly True to only return plugins of this type where the plugin's isDefault property is * truthy * @return {Ext.AbstractPlugin[]} All matching plugins */ findByType: function(type, defaultsOnly) { var matches = [], types = this.types, name, item; for (name in types) { if (!types.hasOwnProperty(name)) { continue; } item = types[name]; if (item.type == type && (!defaultsOnly || (defaultsOnly === true && item.isDefault))) { matches.push(item); } } return matches; } }, function() { /** * Shorthand for {@link Ext.PluginManager#registerType} * @param {String} ptype The ptype mnemonic string by which the Plugin class * may be looked up. * @param {Function} cls The new Plugin class. * @member Ext * @method preg */ Ext.preg = function() { return Ext.PluginManager.registerType.apply(Ext.PluginManager, arguments); }; }); /** * Represents a filter that can be applied to a {@link Ext.util.MixedCollection MixedCollection}. Can either simply * filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the * context of MixedCollections, though {@link Ext.data.Store Store}s frequently create them when filtering and searching * on their records. Example usage: * * //set up a fictional MixedCollection containing a few people to filter on * var allNames = new Ext.util.MixedCollection(); * allNames.addAll([ * {id: 1, name: 'Ed', age: 25}, * {id: 2, name: 'Jamie', age: 37}, * {id: 3, name: 'Abe', age: 32}, * {id: 4, name: 'Aaron', age: 26}, * {id: 5, name: 'David', age: 32} * ]); * * var ageFilter = new Ext.util.Filter({ * property: 'age', * value : 32 * }); * * var longNameFilter = new Ext.util.Filter({ * filterFn: function(item) { * return item.name.length > 4; * } * }); * * //a new MixedCollection with the 3 names longer than 4 characters * var longNames = allNames.filter(longNameFilter); * * //a new MixedCollection with the 2 people of age 32: * var youngFolk = allNames.filter(ageFilter); * */ Ext.define('Ext.util.Filter', { /** * @cfg {String} property * The property to filter on. Required unless a {@link #filterFn} is passed */ /** * @cfg {Mixed} value * The value to filter on. Required unless a {@link #filterFn} is passed. */ /** * @cfg {Function} filterFn * A custom filter function which is passed each item in the {@link Ext.util.MixedCollection} in turn. Should return * `true` to accept each item or `false` to reject it. */ /** * @cfg {String} [id] * An identifier by which this Filter is indexed in a {@link Ext.data.Store#property-filters Store's filters collection} * * Identified Filters may be individually removed from a Store's filter set by using {@link Ext.data.Store#removeFilter}. * * Anonymous Filters may be removed en masse by passing `null` to {@link Ext.data.Store#removeFilter}. */ id: null, /** * @cfg {Boolean} anyMatch * True to allow any match - no regex start/end line anchors will be added. */ anyMatch: false, /** * @cfg {Boolean} exactMatch * True to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true. */ exactMatch: false, /** * @cfg {Boolean} caseSensitive * True to make the regex case sensitive (adds 'i' switch to regex). */ caseSensitive: false, /** * @property {Boolean} disabled * Setting this property to `true` disables this individual Filter so that it no longer contributes to a {@link Ext.data.Store#property-filters Store's filter set} * * When disabled, the next time the store is filtered, the Filter plays no part in filtering and records eliminated by it may rejoin the dataset. * */ disabled: false, /** * @cfg {String} [operator] * The operator to use to compare the {@link #cfg-property} to this Filter's {@link #cfg-value} * * Possible values are: * * < * * <= * * = * * >= * * > * * != */ operator: null, /** * @cfg {String} root * Optional root property. This is mostly useful when filtering a Store, in which case we set the root to 'data' to * make the filter pull the {@link #property} out of the data object of each item */ statics: { /** * Creates a single filter function which encapsulates the passed Filter array. * @param {Ext.util.Filter[]} filters The filter set for which to create a filter function * @return {Function} a function, which when passed a candidate object returns `true` if * the candidate passes all the specified Filters. */ createFilterFn: function(filters) { return filters && filters.length ? function(candidate) { var isMatch = true, length = filters.length, i, filter; for (i = 0; isMatch && i < length; i++) { filter = filters[i]; // Disabling a filter stops it from contributing to the overall filter function. if (!filter.disabled) { isMatch = isMatch && filter.filterFn.call(filter.scope || filter, candidate); } } return isMatch; } : function() { return true; }; } }, operatorFns: { "<": function(candidate) { return Ext.coerce(this.getRoot(candidate)[this.property], this.value) < this.value; }, "<=": function(candidate) { return Ext.coerce(this.getRoot(candidate)[this.property], this.value) <= this.value; }, "=": function(candidate) { return Ext.coerce(this.getRoot(candidate)[this.property], this.value) == this.value; }, ">=": function(candidate) { return Ext.coerce(this.getRoot(candidate)[this.property], this.value) >= this.value; }, ">": function(candidate) { return Ext.coerce(this.getRoot(candidate)[this.property], this.value) > this.value; }, "!=": function(candidate) { return Ext.coerce(this.getRoot(candidate)[this.property], this.value) != this.value; } }, /** * Creates new Filter. * @param {Object} [config] Config object */ constructor: function(config) { var me = this; me.initialConfig = config; Ext.apply(me, config); //we're aliasing filter to filterFn mostly for API cleanliness reasons, despite the fact it dirties the code here. //Ext.util.Sorter takes a sorterFn property but allows .sort to be called - we do the same here me.filter = me.filter || me.filterFn; if (me.filter === undefined) { me.setValue(config.value); } }, /** * Changes the value that this filter tests its configured (@link #cfg-property} with. * @param {Mixed} value The new value to compare the property with. */ setValue: function(value) { var me = this; me.value = value; if (me.property === undefined || me.value === undefined) { // Commented this out temporarily because it stops us using string ids in models. TODO: Remove this once // Model has been updated to allow string ids // Ext.Error.raise("A Filter requires either a property or a filterFn to be set"); } else { me.filter = me.createFilterFn(); } me.filterFn = me.filter; }, /** * Changes the filtering function which this Filter uses to choose items to include. * * This replaces any configured {@link #cfg-filterFn} and overrides any {@link #cfg-property} and {@link #cfg-value) settings. * @param {Function} filterFn A function which returns `true` or `false` to either include or exclude the passed object. * @param {Object} filterFn.value The value for consideration to be included or excluded. * */ setFilterFn: function(filterFn) { this.filterFn = this.filter = filterFn; }, /** * @private * Creates a filter function for the configured property/value/anyMatch/caseSensitive options for this Filter */ createFilterFn: function() { var me = this, matcher = me.createValueMatcher(), property = me.property; if (me.operator) { return me.operatorFns[me.operator]; } else { return function(item) { var value = me.getRoot(item)[property]; return matcher === null ? value === null : matcher.test(value); }; } }, /** * @private * Returns the root property of the given item, based on the configured {@link #root} property * @param {Object} item The item * @return {Object} The root property of the object */ getRoot: function(item) { var root = this.root; return root === undefined ? item : item[root]; }, /** * @private * Returns a regular expression based on the given value and matching options */ createValueMatcher : function() { var me = this, value = me.value, anyMatch = me.anyMatch, exactMatch = me.exactMatch, caseSensitive = me.caseSensitive, escapeRe = Ext.String.escapeRegex; if (value === null) { return value; } if (!value.exec) { // not a regex value = String(value); if (anyMatch === true) { value = escapeRe(value); } else { value = '^' + escapeRe(value); if (exactMatch === true) { value += '$'; } } value = new RegExp(value, caseSensitive ? '' : 'i'); } return value; }, serialize: function() { var me = this, result = Ext.apply({}, me.initialConfig); result.value = me.value; return result; } }, function() { // Operator type '==' is the same as operator type '=' this.prototype.operatorFns['=='] = this.prototype.operatorFns['=']; }); /** * @class Ext.util.AbstractMixedCollection * @private */ Ext.define('Ext.util.AbstractMixedCollection', { mixins: { observable: Ext.util.Observable }, /** * @property {Boolean} isMixedCollection * `true` in this class to identify an object as an instantiated MixedCollection, or subclass thereof. */ isMixedCollection: true, /** * @private Mutation counter which is incremented upon add and remove. */ generation: 0, /** * @private Mutation counter for the index map which is synchronized with the collection's mutation counter * when the index map is interrogated and found to be out of sync and needed a rebuild. */ indexGeneration: 0, constructor: function(allowFunctions, keyFn) { var me = this; // Modern constructor signature using a config object if (arguments.length === 1 && Ext.isObject(allowFunctions)) { me.initialConfig = allowFunctions; Ext.apply(me, allowFunctions); } // Old constructor signature else { me.allowFunctions = allowFunctions === true; if (keyFn) { me.getKey = keyFn; } me.initialConfig = { allowFunctions: me.allowFunctions, getKey: me.getKey }; } me.items = []; me.map = {}; me.keys = []; me.indexMap = {}; me.length = 0; /** * @event clear * Fires when the collection is cleared. * @since 1.1.0 */ /** * @event add * Fires when an item is added to the collection. * @param {Number} index The index at which the item was added. * @param {Object} o The item added. * @param {String} key The key associated with the added item. * @since 1.1.0 */ /** * @event replace * Fires when an item is replaced in the collection. * @param {String} key he key associated with the new added. * @param {Object} old The item being replaced. * @param {Object} new The new item. * @since 1.1.0 */ /** * @event remove * Fires when an item is removed from the collection. * @param {Object} o The item being removed. * @param {String} key (optional) The key associated with the removed item. * @since 1.1.0 */ me.mixins.observable.constructor.call(me); }, /** * @cfg {Boolean} allowFunctions Specify true if the {@link #addAll} * function should add function references to the collection. Defaults to * false. * @since 3.4.0 */ allowFunctions : false, /** * Adds an item to the collection. Fires the {@link #event-add} event when complete. * * @param {String/Object} key The key to associate with the item, or the new item. * * If a {@link #getKey} implementation was specified for this MixedCollection, * or if the key of the stored items is in a property called `id`, * the MixedCollection will be able to *derive* the key for the new item. * In this case just pass the new item in this parameter. * * @param {Object} [obj] The item to add. * * @return {Object} The item added. * @since 1.1.0 */ add : function(key, obj) { var len = this.length, out; if (arguments.length === 1) { out = this.insert(len, key); } else { out = this.insert(len, key, obj); } return out; }, /** * A function which will be called, passing a newly added object * when the object is added without a separate id. The function * should yield the key by which that object will be indexed. * * If no key is yielded, then the object will be added, but it * cannot be accessed or removed quickly. Finding it in this * collection for interrogation or removal will require a linear * scan of this collection's items. * * The default implementation simply returns `item.id` but you can * provide your own implementation to return a different value as * in the following examples: * * // normal way * var mc = new Ext.util.MixedCollection(); * mc.add(someEl.dom.id, someEl); * mc.add(otherEl.dom.id, otherEl); * //and so on * * // using getKey * var mc = new Ext.util.MixedCollection({ * getKey: function(el){ * return el.dom.id; * } * }); * mc.add(someEl); * mc.add(otherEl); * * @param {Object} item The item for which to find the key. * @return {Object} The key for the passed item. * @since 1.1.0 * @template */ getKey : function(o) { return o.id; }, /** * Replaces an item in the collection. Fires the {@link #event-replace} event when complete. * @param {String} key The key associated with the item to replace, or the replacement item. * * If you supplied a {@link #getKey} implementation for this MixedCollection, or if the key * of your stored items is in a property called *`id`*, then the MixedCollection * will be able to derive the key of the replacement item. If you want to replace an item * with one having the same key value, then just pass the replacement item in this parameter. * * @param o {Object} o (optional) If the first parameter passed was a key, the item to associate * with that key. * @return {Object} The new item. * @since 1.1.0 */ replace : function(key, o) { var me = this, old, index; if (arguments.length == 1) { o = arguments[0]; key = me.getKey(o); } old = me.map[key]; if (typeof key == 'undefined' || key === null || typeof old == 'undefined') { return me.add(key, o); } me.generation++; index = me.indexOfKey(key); me.items[index] = o; me.map[key] = o; if (me.hasListeners.replace) { me.fireEvent('replace', key, old, o); } return o; }, /** * Change the key for an existing item in the collection. If the old key * does not exist this is a no-op. * @param {Object} oldKey The old key * @param {Object} newKey The new key */ updateKey: function(oldKey, newKey) { var me = this, map = me.map, indexMap = me.indexMap, index = me.indexOfKey(oldKey), item; if (index > -1) { item = map[oldKey]; delete map[oldKey]; delete indexMap[oldKey]; map[newKey] = item; indexMap[newKey] = index; me.keys[index] = newKey; me.generation++; } }, /** * Adds all elements of an Array or an Object to the collection. * @param {Object/Array} objs An Object containing properties which will be added * to the collection, or an Array of values, each of which are added to the collection. * Functions references will be added to the collection if `{@link #allowFunctions}` * has been set to `true`. * @since 1.1.0 */ addAll : function(objs) { var me = this, key; if (arguments.length > 1 || Ext.isArray(objs)) { me.insert(me.length, arguments.length > 1 ? arguments : objs); } else { for (key in objs) { if (objs.hasOwnProperty(key)) { if (me.allowFunctions || typeof objs[key] != 'function') { me.add(key, objs[key]); } } } } }, /** * Executes the specified function once for every item in the collection. * The function should return a boolean value. * Returning false from the function will stop the iteration. * * @param {Function} fn The function to execute for each item. * @param {Mixed} fn.item The collection item. * @param {Number} fn.index The index of item. * @param {Number} fn.len Total length of collection. * @param {Object} scope (optional) The scope (this reference) * in which the function is executed. Defaults to the current item in the iteration. * * @since 1.1.0 */ each : function(fn, scope){ var items = Ext.Array.push([], this.items), // each safe for removal i = 0, len = items.length, item; for (; i < len; i++) { item = items[i]; if (fn.call(scope || item, item, i, len) === false) { break; } } }, /** * Executes the specified function once for every key in the collection, passing each * key, and its associated item as the first two parameters. * @param {Function} fn The function to execute for each item. * @param {String} fn.key The key of collection item. * @param {Mixed} fn.item The collection item. * @param {Number} fn.index The index of item. * @param {Number} fn.len Total length of collection. * @param {Object} scope (optional) The scope (this reference) in which the * function is executed. Defaults to the browser window. * * @since 1.1.0 */ eachKey : function(fn, scope){ var keys = this.keys, items = this.items, i = 0, len = keys.length; for (; i < len; i++) { fn.call(scope || window, keys[i], items[i], i, len); } }, /** * Returns the first item in the collection which elicits a true return value from the * passed selection function. * @param {Function} fn The selection function to execute for each item. * @param {Mixed} fn.item The collection item. * @param {String} fn.key The key of collection item. * @param {Object} scope (optional) The scope (this reference) in which the * function is executed. Defaults to the browser window. * @return {Object} The first item in the collection which returned true from the selection * function, or null if none was found. */ findBy : function(fn, scope) { var keys = this.keys, items = this.items, i = 0, len = items.length; for (; i < len; i++) { if (fn.call(scope || window, items[i], keys[i])) { return items[i]; } } return null; }, /** * Returns the first item in the collection which elicits a true return value from the passed selection function. * @deprecated 4.0 Use {@link #findBy} instead. * @since 1.1.0 */ find : function() { if (Ext.isDefined(Ext.global.console)) { Ext.global.console.warn('Ext.util.MixedCollection: find has been deprecated. Use findBy instead.'); } return this.findBy.apply(this, arguments); }, /** * Inserts an item at the specified index in the collection. Fires the {@link #event-add} event when complete. * @param {Number} index The index to insert the item at. * @param {String/Object/String[]/Object[]} key The key to associate with the new item, or the item itself. * May also be an array of either to insert multiple items at once. * @param {Object/Object[]} o (optional) If the second parameter was a key, the new item. * May also be an array to insert multiple items at once. * @return {Object} The item inserted or an array of items inserted. * @since 1.1.0 */ insert : function(index, key, obj) { var out; if (Ext.isIterable(key)) { out = this.doInsert(index, key, obj); } else { if (arguments.length > 2) { out = this.doInsert(index, [key], [obj]); } else { out = this.doInsert(index, [key]); } out = out[0]; } return out; }, // Private multi insert implementation. doInsert : function(index, keys, objects) { var me = this, itemKey, removeIndex, i, len = keys.length, deDupedLen = len, fireAdd = me.hasListeners.add, syncIndices, newKeys = {}, passedDuplicates, oldKeys, oldObjects; // External key(s) passed. We cannot reliably find an object's index using the key extraction fn. // Set a flag for use by contains, indexOf and remove if (objects != null) { me.useLinearSearch = true; } // No external keys: calculate keys array if not passed else { objects = keys; keys = new Array(len); for (i = 0; i < len; i++) { keys[i] = this.getKey(objects[i]); } } // First, remove duplicates of the keys. If a removal point is less than insertion index, decr insertion index me.suspendEvents(); for (i = 0; i < len; i++) { itemKey = keys[i]; // Must use indexOf - map might be out of sync removeIndex = me.indexOfKey(itemKey); if (removeIndex !== -1) { if (removeIndex < index) { index--; } me.removeAt(removeIndex); } if (itemKey != null) { // If a previous new item used this key, we will have to rebuild the input arrays from the newKeys map. if (newKeys[itemKey] != null) { passedDuplicates = true; deDupedLen--; } newKeys[itemKey] = i; } } me.resumeEvents(); // Duplicate keys were detected - rebuild the objects and keys arrays from the last values associated with each unique key if (passedDuplicates) { oldKeys = keys; oldObjects = objects; keys = new Array(deDupedLen); objects = new Array(deDupedLen); i = 0; // Loop through unique key hash, properties of which point to last encountered index for that key. // Rebuild deduped objects and keys arrays. for (itemKey in newKeys) { keys[i] = oldKeys[newKeys[itemKey]]; objects[i] = oldObjects[newKeys[itemKey]]; i++; } len = deDupedLen; } // If we are appending and the indices are in sync, its cheap to kep them that way syncIndices = index === me.length && me.indexGeneration === me.generation; // Insert the new items and new keys in at the insertion point Ext.Array.insert(me.items, index, objects); Ext.Array.insert(me.keys, index, keys); me.length += len; me.generation++; if (syncIndices) { me.indexGeneration = me.generation; } for (i = 0; i < len; i++, index++) { itemKey = keys[i]; if (itemKey != null) { me.map[itemKey] = objects[i]; // If the index is still in sync, keep it that way if (syncIndices) { me.indexMap[itemKey] = index; } } if (fireAdd) { me.fireEvent('add', index, objects[i], itemKey); } } return objects; }, /** * Remove an item from the collection. * @param {Object} o The item to remove. * @return {Object} The item removed or false if no item was removed. * @since 1.1.0 */ remove : function(o) { var me = this, removeKey, index; // If // We have not been forced into using linear lookup by a usage of the 2 arg form of add // and // The key extraction function yields a key // Then use indexOfKey. This will use the indexMap - rebuilding it if necessary. if (!me.useLinearSearch && (removeKey = me.getKey(o))) { index = me.indexOfKey(removeKey); } // Otherwise we have to do it the slow way with a linear search. else { index = Ext.Array.indexOf(me.items, o); } return (index === -1) ? false : me.removeAt(index); }, /** * Remove all items in the collection. Can also be used * to remove only the items in the passed array. * @param {Array} [items] An array of items to be removed. * @return {Ext.util.MixedCollection} this object */ removeAll : function(items) { var me = this, i; if (items || me.hasListeners.remove) { // Only perform expensive item-by-item removal if there's a listener or specific items if (items) { for (i = items.length - 1; i >= 0; --i) { me.remove(items[i]); } } else { while (me.length) { me.removeAt(0); } } } else { me.length = me.items.length = me.keys.length = 0; me.map = {}; me.indexMap = {}; me.generation++; me.indexGeneration = me.generation; } }, /** * Remove an item from a specified index in the collection. Fires the {@link #event-remove} event when complete. * @param {Number} index The index within the collection of the item to remove. * @return {Object} The item removed or false if no item was removed. * @since 1.1.0 */ removeAt : function(index) { var me = this, o, key; if (index < me.length && index >= 0) { me.length--; o = me.items[index]; Ext.Array.erase(me.items, index, 1); key = me.keys[index]; if (typeof key != 'undefined') { delete me.map[key]; } Ext.Array.erase(me.keys, index, 1); if (me.hasListeners.remove) { me.fireEvent('remove', o, key); } me.generation++; return o; } return false; }, /** * Remove a range of items starting at a specified index in the collection. * Does not fire the remove event. * @param {Number} index The index within the collection of the item to remove. * @param {Number} [removeCount=1] The nuber of items to remove beginning at the specified index. * @return {Object} The last item removed or false if no item was removed. */ removeRange : function(index, removeCount) { var me = this, o, key, i, limit, syncIndices, trimming; if (index < me.length && index >= 0) { if (!removeCount) { removeCount = 1; } limit = Math.min(index + removeCount, me.length); removeCount = limit - index; // If we are removing from end and the indices are in sync, its cheap to kep them that way trimming = limit === me.length; syncIndices = trimming && me.indexGeneration === me.generation; // Loop through the to remove indices deleting from the key hashes for (i = index; i < limit; i++) { key = me.keys[i]; if (key != null) { delete me.map[key]; if (syncIndices) { delete me.indexMap[key]; } } } // Last item encountered o = me.items[i - 1]; me.length -= removeCount; me.generation++; if (syncIndices) { me.indexGeneration = me.generation; } // Chop items and keys arrays. // If trimming the trailing end, we can just truncate the array. // We can use splice directly. The IE8 bug which Ext.Array works around only affects *insertion* // http://social.msdn.microsoft.com/Forums/en-US/iewebdevelopment/thread/6e946d03-e09f-4b22-a4dd-cd5e276bf05a/ if (trimming) { me.items.length = me.keys.length = me.length; } else { me.items.splice(index, removeCount); me.keys.splice(index, removeCount); } // Return last object removed return o; } return false; }, /** * Removes an item associated with the passed key fom the collection. * @param {String} key The key of the item to remove. If `null` is passed, * all objects which yielded no key from the configured {@link #getKey} function are removed. * @return {Object} Only returned if removing at a specified key. The item removed or false if no item was removed. */ removeAtKey : function(key) { var me = this, keys = me.keys, i; // Remove objects which yielded no key from our configured getKey function if (key == null) { for (i = keys.length - 1; i >=0; i--) { if (keys[i] == null) { me.removeAt(i); } } } // Remove object at the passed key else { return me.removeAt(me.indexOfKey(key)); } }, /** * Returns the number of items in the collection. * @return {Number} the number of items in the collection. * @since 1.1.0 */ getCount : function() { return this.length; }, /** * Returns index within the collection of the passed Object. * @param {Object} o The item to find the index of. * @return {Number} index of the item. Returns -1 if not found. * @since 1.1.0 */ indexOf : function(o) { var me = this, key; if (o != null) { // If // We have not been forced into using linear lookup by a usage of the 2 arg form of add // and // The key extraction function yields a key // Then use indexOfKey. This will use the indexMap - rebuilding it if necessary. if (!me.useLinearSearch && (key = me.getKey(o))) { return this.indexOfKey(key); } // Fallback: Use linear search return Ext.Array.indexOf(me.items, o); } // No object passed return -1; }, /** * Returns index within the collection of the passed key. * @param {String} key The key to find the index of. * @return {Number} index of the key. * @since 1.1.0 */ indexOfKey : function(key) { if (!this.map.hasOwnProperty(key)) { return -1; } if (this.indexGeneration !== this.generation) { this.rebuildIndexMap(); } return this.indexMap[key]; }, rebuildIndexMap: function() { var me = this, indexMap = me.indexMap = {}, keys = me.keys, len = keys.length, i; for (i = 0; i < len; i++) { indexMap[keys[i]] = i; } me.indexGeneration = me.generation; }, /** * Returns the item associated with the passed key OR index. * Key has priority over index. This is the equivalent * of calling {@link #getByKey} first, then if nothing matched calling {@link #getAt}. * @param {String/Number} key The key or index of the item. * @return {Object} If the item is found, returns the item. If the item was not found, returns undefined. * If an item was found, but is a Class, returns null. * @since 1.1.0 */ get : function(key) { var me = this, mk = me.map[key], item = mk !== undefined ? mk : (typeof key == 'number') ? me.items[key] : undefined; return typeof item != 'function' || me.allowFunctions ? item : null; // for prototype! }, /** * Returns the item at the specified index. * @param {Number} index The index of the item. * @return {Object} The item at the specified index. */ getAt : function(index) { return this.items[index]; }, /** * Returns the item associated with the passed key. * @param {String/Number} key The key of the item. * @return {Object} The item associated with the passed key. */ getByKey : function(key) { return this.map[key]; }, /** * Returns true if the collection contains the passed Object as an item. * @param {Object} o The Object to look for in the collection. * @return {Boolean} True if the collection contains the Object as an item. * @since 1.1.0 */ contains : function(o) { var me = this, key; if (o != null) { // If // We have not been forced into using linear lookup by a usage of the 2 arg form of add // and // The key extraction function yields a key // Then use the map to determine object presence. if (!me.useLinearSearch && (key = me.getKey(o))) { return this.map[key] != null; } // Fallback: Use linear search return Ext.Array.indexOf(this.items, o) !== -1; } return false; }, /** * Returns true if the collection contains the passed Object as a key. * @param {String} key The key to look for in the collection. * @return {Boolean} True if the collection contains the Object as a key. * @since 1.1.0 */ containsKey : function(key) { return this.map.hasOwnProperty(key); }, /** * Removes all items from the collection. Fires the {@link #event-clear} event when complete. * @since 1.1.0 */ clear : function() { var me = this; // Only clear if it has ever had any content if (me.generation) { me.length = 0; me.items = []; me.keys = []; me.map = {}; me.indexMap = {}; me.generation++; me.indexGeneration = me.generation; } if (me.hasListeners.clear) { me.fireEvent('clear'); } }, /** * Returns the first item in the collection. * @return {Object} the first item in the collection.. * @since 1.1.0 */ first : function() { return this.items[0]; }, /** * Returns the last item in the collection. * @return {Object} the last item in the collection.. * @since 1.1.0 */ last : function() { return this.items[this.length - 1]; }, /** * Collects all of the values of the given property and returns their sum * @param {String} property The property to sum by * @param {String} [root] 'root' property to extract the first argument from. This is used mainly when * summing fields in records, where the fields are all stored inside the 'data' object * @param {Number} [start=0] The record index to start at * @param {Number} [end=-1] The record index to end at * @return {Number} The total */ sum: function(property, root, start, end) { var values = this.extractValues(property, root), length = values.length, sum = 0, i; start = start || 0; end = (end || end === 0) ? end : length - 1; for (i = start; i <= end; i++) { sum += values[i]; } return sum; }, /** * Collects unique values of a particular property in this MixedCollection * @param {String} property The property to collect on * @param {String} root (optional) 'root' property to extract the first argument from. This is used mainly when * summing fields in records, where the fields are all stored inside the 'data' object * @param {Boolean} allowBlank (optional) Pass true to allow null, undefined or empty string values * @return {Array} The unique values */ collect: function(property, root, allowNull) { var values = this.extractValues(property, root), length = values.length, hits = {}, unique = [], value, strValue, i; for (i = 0; i < length; i++) { value = values[i]; strValue = String(value); if ((allowNull || !Ext.isEmpty(value)) && !hits[strValue]) { hits[strValue] = true; unique.push(value); } } return unique; }, /** * @private * Extracts all of the given property values from the items in the MC. Mainly used as a supporting method for * functions like sum and collect. * @param {String} property The property to extract * @param {String} root (optional) 'root' property to extract the first argument from. This is used mainly when * extracting field data from Model instances, where the fields are stored inside the 'data' object * @return {Array} The extracted values */ extractValues: function(property, root) { var values = this.items; if (root) { values = Ext.Array.pluck(values, root); } return Ext.Array.pluck(values, property); }, /** * @private * For API parity with Store's PageMap class. Buffered rendering checks if the Store has the range * required to render. The Store delegates this question to its backing data object which may be an instance * of its private PageMap class, or a MixedCollection. */ hasRange: function(start, end) { return (end < this.length); }, /** * Returns a range of items in this collection * @param {Number} startIndex (optional) The starting index. Defaults to 0. * @param {Number} endIndex (optional) The ending index. Defaults to the last item. * @return {Array} An array of items * @since 1.1.0 */ getRange : function(start, end){ var me = this, items = me.items, range = [], len = items.length, tmp, reverse; if (len < 1) { return range; } if (start > end) { reverse = true; tmp = start; start = end; end = tmp; } if (start < 0) { start = 0; } if (end == null || end >= len) { end = len - 1; } range = items.slice(start, end + 1); if (reverse && range.length) { range.reverse(); } return range; }, /** *

Filters the objects in this collection by a set of {@link Ext.util.Filter Filter}s, or by a single * property/value pair with optional parameters for substring matching and case sensitivity. See * {@link Ext.util.Filter Filter} for an example of using Filter objects (preferred). Alternatively, * MixedCollection can be easily filtered by property like this:

* * //create a simple store with a few people defined * var people = new Ext.util.MixedCollection(); * people.addAll([ * {id: 1, age: 25, name: 'Ed'}, * {id: 2, age: 24, name: 'Tommy'}, * {id: 3, age: 24, name: 'Arne'}, * {id: 4, age: 26, name: 'Aaron'} * ]); * * //a new MixedCollection containing only the items where age == 24 * var middleAged = people.filter('age', 24); * * @param {Ext.util.Filter[]/String} property A property on your objects, or an array of {@link Ext.util.Filter Filter} objects * @param {String/RegExp} value Either string that the property values * should start with or a RegExp to test against the property * @param {Boolean} [anyMatch=false] True to match any part of the string, not just the beginning * @param {Boolean} [caseSensitive=false] True for case sensitive comparison. * @return {Ext.util.MixedCollection} The new filtered collection * @since 1.1.0 */ filter : function(property, value, anyMatch, caseSensitive) { var filters = []; //support for the simple case of filtering by property/value if (Ext.isString(property)) { filters.push(new Ext.util.Filter({ property : property, value : value, anyMatch : anyMatch, caseSensitive: caseSensitive })); } else if (Ext.isArray(property) || property instanceof Ext.util.Filter) { filters = filters.concat(property); } // At this point we have an array of zero or more Ext.util.Filter objects to filter with, // so here we construct a function that combines these filters by ANDing them together // and filter by that. return this.filterBy(Ext.util.Filter.createFilterFn(filters)); }, /** * Filter by a function. Returns a new collection that has been filtered. * The passed function will be called with each object in the collection. * If the function returns true, the value is included otherwise it is filtered. * @param {Function} fn The function to be called. * @param {Mixed} fn.item The collection item. * @param {String} fn.key The key of collection item. * @param {Object} scope (optional) The scope (this reference) in * which the function is executed. Defaults to this MixedCollection. * @return {Ext.util.MixedCollection} The new filtered collection * @since 1.1.0 */ filterBy : function(fn, scope) { var me = this, newMC = new me.self(me.initialConfig), keys = me.keys, items = me.items, length = items.length, i; newMC.getKey = me.getKey; for (i = 0; i < length; i++) { if (fn.call(scope || me, items[i], keys[i])) { newMC.add(keys[i], items[i]); } } return newMC; }, /** * Finds the index of the first matching object in this collection by a specific property/value. * @param {String} property The name of a property on your objects. * @param {String/RegExp} value A string that the property values * should start with or a RegExp to test against the property. * @param {Number} [start=0] The index to start searching at. * @param {Boolean} [anyMatch=false] True to match any part of the string, not just the beginning. * @param {Boolean} [caseSensitive=false] True for case sensitive comparison. * @return {Number} The matched index or -1 * @since 2.3.0 */ findIndex : function(property, value, start, anyMatch, caseSensitive){ if(Ext.isEmpty(value, false)){ return -1; } value = this.createValueMatcher(value, anyMatch, caseSensitive); return this.findIndexBy(function(o){ return o && value.test(o[property]); }, null, start); }, /** * Find the index of the first matching object in this collection by a function. * If the function returns true it is considered a match. * @param {Function} fn The function to be called. * @param {Mixed} fn.item The collection item. * @param {String} fn.key The key of collection item. * @param {Object} [scope] The scope (this reference) in which the function is executed. Defaults to this MixedCollection. * @param {Number} [start=0] The index to start searching at. * @return {Number} The matched index or -1 * @since 2.3.0 */ findIndexBy : function(fn, scope, start){ var me = this, keys = me.keys, items = me.items, i = start || 0, len = items.length; for (; i < len; i++) { if (fn.call(scope || me, items[i], keys[i])) { return i; } } return -1; }, /** * Returns a regular expression based on the given value and matching options. This is used internally for finding and filtering, * and by Ext.data.Store#filter * @private * @param {String} value The value to create the regex for. This is escaped using Ext.escapeRe * @param {Boolean} anyMatch True to allow any match - no regex start/end line anchors will be added. Defaults to false * @param {Boolean} caseSensitive True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false. * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true. * @since 3.4.0 */ createValueMatcher : function(value, anyMatch, caseSensitive, exactMatch) { if (!value.exec) { // not a regex var er = Ext.String.escapeRegex; value = String(value); if (anyMatch === true) { value = er(value); } else { value = '^' + er(value); if (exactMatch === true) { value += '$'; } } value = new RegExp(value, caseSensitive ? '' : 'i'); } return value; }, /** * Creates a shallow copy of this collection * @return {Ext.util.MixedCollection} * @since 1.1.0 */ clone : function() { var me = this, copy = new this.self(me.initialConfig); copy.add(me.keys, me.items); return copy; } }); /** * Represents a single sorter that can be applied to a Store. The sorter is used * to compare two values against each other for the purpose of ordering them. Ordering * is achieved by specifying either: * * - {@link #property A sorting property} * - {@link #sorterFn A sorting function} * * As a contrived example, we can specify a custom sorter that sorts by rank: * * Ext.define('Person', { * extend: 'Ext.data.Model', * fields: ['name', 'rank'] * }); * * Ext.create('Ext.data.Store', { * model: 'Person', * proxy: 'memory', * sorters: [{ * sorterFn: function(o1, o2){ * var getRank = function(o){ * var name = o.get('rank'); * if (name === 'first') { * return 1; * } else if (name === 'second') { * return 2; * } else { * return 3; * } * }, * rank1 = getRank(o1), * rank2 = getRank(o2); * * if (rank1 === rank2) { * return 0; * } * * return rank1 < rank2 ? -1 : 1; * } * }], * data: [{ * name: 'Person1', * rank: 'second' * }, { * name: 'Person2', * rank: 'third' * }, { * name: 'Person3', * rank: 'first' * }] * }); */ Ext.define('Ext.util.Sorter', { /** * @cfg {String} property * The property to sort by. Required unless {@link #sorterFn} is provided. The property is extracted from the object * directly and compared for sorting using the built in comparison operators. */ /** * @cfg {Function} sorterFn * A specific sorter function to execute. Can be passed instead of {@link #property}. This sorter function allows * for any kind of custom/complex comparisons. The sorterFn receives two arguments, the objects being compared. The * function should return: * * - -1 if o1 is "less than" o2 * - 0 if o1 is "equal" to o2 * - 1 if o1 is "greater than" o2 */ /** * @cfg {String} root * Optional root property. This is mostly useful when sorting a Store, in which case we set the root to 'data' to * make the filter pull the {@link #property} out of the data object of each item */ /** * @cfg {Function} transform * A function that will be run on each value before it is compared in the sorter. The function will receive a single * argument, the value. */ /** * @cfg {String} direction * The direction to sort by. */ direction: "ASC", constructor: function(config) { var me = this; Ext.apply(me, config); if (me.property === undefined && me.sorterFn === undefined) { Ext.Error.raise("A Sorter requires either a property or a sorter function"); } me.updateSortFunction(); }, /** * @private * Creates and returns a function which sorts an array by the given property and direction * @return {Function} A function which sorts by the property/direction combination provided */ createSortFunction: function(sorterFn) { var me = this, direction = me.direction || "ASC", modifier = direction.toUpperCase() == "DESC" ? -1 : 1; //create a comparison function. Takes 2 objects, returns 1 if object 1 is greater, //-1 if object 2 is greater or 0 if they are equal return function(o1, o2) { return modifier * sorterFn.call(me, o1, o2); }; }, /** * @private * Basic default sorter function that just compares the defined property of each object */ defaultSorterFn: function(o1, o2) { var me = this, transform = me.transform, v1 = me.getRoot(o1)[me.property], v2 = me.getRoot(o2)[me.property]; if (transform) { v1 = transform(v1); v2 = transform(v2); } return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0); }, /** * @private * Returns the root property of the given item, based on the configured {@link #root} property * @param {Object} item The item * @return {Object} The root property of the object */ getRoot: function(item) { return this.root === undefined ? item : item[this.root]; }, /** * Set the sorting direction for this sorter. * @param {String} direction The direction to sort in. Should be either 'ASC' or 'DESC'. */ setDirection: function(direction) { var me = this; me.direction = direction ? direction.toUpperCase() : direction; me.updateSortFunction(); }, /** * Toggles the sorting direction for this sorter. */ toggle: function() { var me = this; me.direction = Ext.String.toggle(me.direction, "ASC", "DESC"); me.updateSortFunction(); }, /** * Update the sort function for this sorter. * @param {Function} [fn] A new sorter function for this sorter. If not specified it will use the default * sorting function. */ updateSortFunction: function(fn) { var me = this; fn = fn || me.sorterFn || me.defaultSorterFn; me.sort = me.createSortFunction(fn); }, serialize: function() { return { root: this.root, property: this.property, direction: this.direction }; } }); /** * @docauthor Tommy Maintz * * A mixin which allows a data component to be sorted. This is used by e.g. {@link Ext.data.Store} and {@link Ext.data.TreeStore}. * * **NOTE**: This mixin is mainly for internal use and most users should not need to use it directly. It * is more likely you will want to use one of the component classes that import this mixin, such as * {@link Ext.data.Store} or {@link Ext.data.TreeStore}. */ Ext.define("Ext.util.Sortable", { /** * @property {Boolean} isSortable * `true` in this class to identify an object as an instantiated Sortable, or subclass thereof. */ isSortable: true, /** * @cfg {String} defaultSortDirection * The default sort direction to use if one is not specified. */ defaultSortDirection: "ASC", statics: { /** * Creates a single comparator function which encapsulates the passed Sorter array. * @param {Ext.util.Sorter[]} sorters The sorter set for which to create a comparator function * @return {Function} a function, which when passed two comparable objects returns the result * of the whole sorter comparator functions. */ createComparator: function(sorters) { return sorters && sorters.length ? function(r1, r2) { var result = sorters[0].sort(r1, r2), length = sorters.length, i = 1; // if we have more than one sorter, OR any additional sorter functions together for (; i < length; i++) { result = result || sorters[i].sort.call(this, r1, r2); } return result; }: function() { return 0; }; } }, /** * @cfg {String} sortRoot * The property in each item that contains the data to sort. */ /** * @cfg {Ext.util.Sorter[]/Object[]} sorters * The initial set of {@link Ext.util.Sorter Sorters} */ /** * Performs initialization of this mixin. Component classes using this mixin should call this method during their * own initialization. */ initSortable: function() { var me = this, sorters = me.sorters; /** * @property {Ext.util.MixedCollection} sorters * The collection of {@link Ext.util.Sorter Sorters} currently applied to this Store */ me.sorters = new Ext.util.AbstractMixedCollection(false, function(item) { return item.id || item.property; }); if (sorters) { me.sorters.addAll(me.decodeSorters(sorters)); } }, /** * Sorts the data in the Store by one or more of its properties. Example usage: * * //sort by a single field * myStore.sort('myField', 'DESC'); * * //sorting by multiple fields * myStore.sort([ * { * property : 'age', * direction: 'ASC' * }, * { * property : 'name', * direction: 'DESC' * } * ]); * * Internally, Store converts the passed arguments into an array of {@link Ext.util.Sorter} instances, and delegates * the actual sorting to its internal {@link Ext.util.MixedCollection}. * * When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code: * * store.sort('myField'); * store.sort('myField'); * * Is equivalent to this code, because Store handles the toggling automatically: * * store.sort('myField', 'ASC'); * store.sort('myField', 'DESC'); * * @param {String/Ext.util.Sorter[]} [sorters] Either a string name of one of the fields in this Store's configured * {@link Ext.data.Model Model}, or an array of sorter configurations. * @param {String} [direction="ASC"] The overall direction to sort the data by. * @return {Ext.util.Sorter[]} */ sort: function(sorters, direction, where, doSort) { var me = this, sorter, newSorters; if (Ext.isArray(sorters)) { doSort = where; where = direction; newSorters = sorters; } else if (Ext.isObject(sorters)) { doSort = where; where = direction; newSorters = [sorters]; } else if (Ext.isString(sorters)) { sorter = me.sorters.get(sorters); if (!sorter) { sorter = { property : sorters, direction: direction }; newSorters = [sorter]; } else if (direction === undefined) { sorter.toggle(); } else { sorter.setDirection(direction); } } if (newSorters && newSorters.length) { newSorters = me.decodeSorters(newSorters); if (Ext.isString(where)) { if (where === 'prepend') { me.sorters.insert(0, newSorters); } else { me.sorters.addAll(newSorters); } } else { me.sorters.clear(); me.sorters.addAll(newSorters); } } if (doSort !== false) { me.fireEvent('beforesort', me, newSorters); me.onBeforeSort(newSorters); sorters = me.sorters.items; if (sorters.length) { // Sort using a generated sorter function which combines all of the Sorters passed me.doSort(me.generateComparator()); } } return sorters; }, /** * Returns a comparator function which compares two items and returns -1, 0, or 1 depending * on the currently defined set of {@link #cfg-sorters}. * * If there are no {@link #cfg-sorters} defined, it returns a function which returns `0` meaning * that no sorting will occur. */ generateComparator: function() { var sorters = this.sorters.getRange(); return sorters.length ? this.createComparator(sorters) : this.emptyComparator; }, emptyComparator: function(){ return 0; }, onBeforeSort: Ext.emptyFn, /** * @private * Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances * @param {Object[]} sorters The sorters array * @return {Ext.util.Sorter[]} Array of Ext.util.Sorter objects */ decodeSorters: function(sorters) { if (!Ext.isArray(sorters)) { if (sorters === undefined) { sorters = []; } else { sorters = [sorters]; } } var length = sorters.length, Sorter = Ext.util.Sorter, fields = this.model ? this.model.prototype.fields : null, field, config, i; for (i = 0; i < length; i++) { config = sorters[i]; if (!(config instanceof Sorter)) { if (Ext.isString(config)) { config = { property: config }; } Ext.applyIf(config, { root : this.sortRoot, direction: "ASC" }); //support for 3.x style sorters where a function can be defined as 'fn' if (config.fn) { config.sorterFn = config.fn; } //support a function to be passed as a sorter definition if (typeof config == 'function') { config = { sorterFn: config }; } // ensure sortType gets pushed on if necessary if (fields && !config.transform) { field = fields.get(config.property); config.transform = field && field.sortType !== Ext.identityFn ? field.sortType : undefined; } sorters[i] = new Ext.util.Sorter(config); } } return sorters; }, getSorters: function() { return this.sorters.items; }, /** * Gets the first sorter from the sorters collection, excluding * any groupers that may be in place * @protected * @return {Ext.util.Sorter} The sorter, null if none exist */ getFirstSorter: function(){ var sorters = this.sorters.items, len = sorters.length, i = 0, sorter; for (; i < len; ++i) { sorter = sorters[i]; if (!sorter.isGrouper) { return sorter; } } return null; } }, function() { // Reference the static implementation in prototype this.prototype.createComparator = this.createComparator; }); /** * Represents a collection of a set of key and value pairs. Each key in the MixedCollection * must be unique, the same key cannot exist twice. This collection is ordered, items in the * collection can be accessed by index or via the key. Newly added items are added to * the end of the collection. This class is similar to {@link Ext.util.HashMap} however it * is heavier and provides more functionality. Sample usage: * * var coll = new Ext.util.MixedCollection(); * coll.add('key1', 'val1'); * coll.add('key2', 'val2'); * coll.add('key3', 'val3'); * * console.log(coll.get('key1')); // prints 'val1' * console.log(coll.indexOfKey('key3')); // prints 2 * * The MixedCollection also has support for sorting and filtering of the values in the collection. * * var coll = new Ext.util.MixedCollection(); * coll.add('key1', 100); * coll.add('key2', -100); * coll.add('key3', 17); * coll.add('key4', 0); * var biggerThanZero = coll.filterBy(function(value){ * return value > 0; * }); * console.log(biggerThanZero.getCount()); // prints 2 * */ Ext.define('Ext.util.MixedCollection', { extend: Ext.util.AbstractMixedCollection , mixins: { sortable: Ext.util.Sortable }, /** * @cfg {Boolean} allowFunctions * Configure as `true` if the {@link #addAll} function should add function references to the collection. */ /** * Creates new MixedCollection. * @param {Object} config A configuration object. * @param {Boolean} [config.allowFunctions=false] Specify `true` if the {@link #addAll} * function should add function references to the collection. * @param {Function} [config.getKey] A function that can accept an item of the type(s) stored in this MixedCollection * and return the key value for that item. This is used when available to look up the key on items that * were passed without an explicit key parameter to a MixedCollection method. Passing this parameter is * equivalent to overriding the {@link #method-getKey} method. */ constructor: function() { var me = this; me.callParent(arguments); me.addEvents('sort'); me.mixins.sortable.initSortable.call(me); }, doSort: function(sorterFn) { this.sortBy(sorterFn); }, /** * @private * Performs the actual sorting based on a direction and a sorting function. Internally, * this creates a temporary array of all items in the MixedCollection, sorts it and then writes * the sorted array data back into this.items and this.keys * @param {String} property Property to sort by ('key', 'value', or 'index') * @param {String} dir (optional) Direction to sort 'ASC' or 'DESC'. Defaults to 'ASC'. * @param {Function} fn (optional) Comparison function that defines the sort order. * Defaults to sorting by numeric value. */ _sort : function(property, dir, fn) { var me = this, i, len, dsc = String(dir).toUpperCase() == 'DESC' ? -1 : 1, //this is a temporary array used to apply the sorting function c = [], keys = me.keys, items = me.items, o; //default to a simple sorter function if one is not provided fn = fn || function(a, b) { return a - b; }; //copy all the items into a temporary array, which we will sort for (i = 0, len = items.length; i < len; i++) { c[c.length] = { key : keys[i], value: items[i], index: i }; } //sort the temporary array Ext.Array.sort(c, function(a, b) { return fn(a[property], b[property]) * dsc || // In case of equality, ensure stable sort by comparing collection index (a.index < b.index ? -1 : 1); }); // Copy the temporary array back into the main this.items and this.keys objects // Repopulate the indexMap hash if configured to do so. for (i = 0, len = c.length; i < len; i++) { o = c[i]; items[i] = o.value; keys[i] = o.key; me.indexMap[o.key] = i; } me.generation++; me.indexGeneration = me.generation; me.fireEvent('sort', me); }, /** * Sorts the collection by a single sorter function * @param {Function} sorterFn The function to sort by */ sortBy: function(sorterFn) { var me = this, items = me.items, item, keys = me.keys, key, length = items.length, i; // Stamp the collection index into each item so that we can implement stable sort for (i = 0; i < length; i++) { items[i].$extCollectionIndex = i; } Ext.Array.sort(items, function(a, b) { return sorterFn(a, b) || // In case of equality, ensure stable sort by comparing collection index (a.$extCollectionIndex < b.$extCollectionIndex ? -1 : 1); }); // Update the keys array, and remove the index for (i = 0; i < length; i++) { item = items[i]; key = me.getKey(item); keys[i] = key; me.indexMap[key] = i; delete items.$extCollectionIndex; } me.generation++; me.indexGeneration = me.generation; me.fireEvent('sort', me, items, keys); }, /** * Calculates the insertion index of the new item based upon the comparison function passed, or the current sort order. * @param {Object} newItem The new object to find the insertion position of. * @param {Function} [sorterFn] The function to sort by. This is the same as the sorting function * passed to {@link #sortBy}. It accepts 2 items from this MixedCollection, and returns -1 0, or 1 * depending on the relative sort positions of the 2 compared items. * * If omitted, a function {@link #generateComparator generated} from the currently defined set of * {@link #cfg-sorters} will be used. * * @return {Number} The insertion point to add the new item into this MixedCollection at using {@link #insert} */ findInsertionIndex: function(newItem, sorterFn) { var me = this, items = me.items, start = 0, end = items.length - 1, middle, comparison; if (!sorterFn) { sorterFn = me.generateComparator(); } while (start <= end) { middle = (start + end) >> 1; comparison = sorterFn(newItem, items[middle]); if (comparison >= 0) { start = middle + 1; } else if (comparison < 0) { end = middle - 1; } } return start; }, /** * Reorders each of the items based on a mapping from old index to new index. Internally this * just translates into a sort. The 'sort' event is fired whenever reordering has occured. * @param {Object} mapping Mapping from old item index to new item index */ reorder: function(mapping) { var me = this, items = me.items, index = 0, length = items.length, order = [], remaining = [], oldIndex; me.suspendEvents(); //object of {oldPosition: newPosition} reversed to {newPosition: oldPosition} for (oldIndex in mapping) { order[mapping[oldIndex]] = items[oldIndex]; } for (index = 0; index < length; index++) { if (mapping[index] == undefined) { remaining.push(items[index]); } } for (index = 0; index < length; index++) { if (order[index] == undefined) { order[index] = remaining.shift(); } } me.clear(); me.addAll(order); me.resumeEvents(); me.fireEvent('sort', me); }, /** * Sorts this collection by keys. * @param {String} direction (optional) 'ASC' or 'DESC'. Defaults to 'ASC'. * @param {Function} fn (optional) Comparison function that defines the sort order. * Defaults to sorting by case insensitive string. */ sortByKey : function(dir, fn){ this._sort('key', dir, fn || function(a, b){ var v1 = String(a).toUpperCase(), v2 = String(b).toUpperCase(); return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0); }); } }); /** * @class Ext.fx.target.Target This class specifies a generic target for an animation. It provides a wrapper around a series of different types of objects to allow for a generic animation API. A target can be a single object or a Composite object containing other objects that are to be animated. This class and it's subclasses are generally not created directly, the underlying animation will create the appropriate Ext.fx.target.Target object by passing the instance to be animated. The following types of objects can be animated: - {@link Ext.fx.target.Component Components} - {@link Ext.fx.target.Element Elements} - {@link Ext.fx.target.Sprite Sprites} * @markdown * @abstract */ Ext.define('Ext.fx.target.Target', { isAnimTarget: true, /** * Creates new Target. * @param {Ext.Component/Ext.Element/Ext.draw.Sprite} target The object to be animated */ constructor: function(target) { this.target = target; this.id = this.getId(); }, getId: function() { return this.target.id; } }); /** * @class Ext.fx.target.Element * * This class represents a animation target for an {@link Ext.Element}. In general this class will not be * created directly, the {@link Ext.Element} will be passed to the animation and * and the appropriate target will be created. */ Ext.define('Ext.fx.target.Element', { /* Begin Definitions */ extend: Ext.fx.target.Target , /* End Definitions */ type: 'element', getElVal: function(el, attr, val) { if (val == undefined) { if (attr === 'x') { val = el.getX(); } else if (attr === 'y') { val = el.getY(); } else if (attr === 'scrollTop') { val = el.getScroll().top; } else if (attr === 'scrollLeft') { val = el.getScroll().left; } else if (attr === 'height') { val = el.getHeight(); } else if (attr === 'width') { val = el.getWidth(); } else { val = el.getStyle(attr); } } return val; }, getAttr: function(attr, val) { var el = this.target; return [[ el, this.getElVal(el, attr, val)]]; }, setAttr: function(targetData) { var target = this.target, ln = targetData.length, attrs, attr, o, i, j, ln2; for (i = 0; i < ln; i++) { attrs = targetData[i].attrs; for (attr in attrs) { if (attrs.hasOwnProperty(attr)) { ln2 = attrs[attr].length; for (j = 0; j < ln2; j++) { o = attrs[attr][j]; this.setElVal(o[0], attr, o[1]); } } } } }, setElVal: function(element, attr, value){ if (attr === 'x') { element.setX(value); } else if (attr === 'y') { element.setY(value); } else if (attr === 'scrollTop') { element.scrollTo('top', value); } else if (attr === 'scrollLeft') { element.scrollTo('left',value); } else if (attr === 'width') { element.setWidth(value); } else if (attr === 'height') { element.setHeight(value); } else { element.setStyle(attr, value); } } }); /** * @class Ext.fx.target.ElementCSS * * This class represents a animation target for an {@link Ext.Element} that supports CSS * based animation. In general this class will not be created directly, the {@link Ext.Element} * will be passed to the animation and the appropriate target will be created. */ Ext.define('Ext.fx.target.ElementCSS', { /* Begin Definitions */ extend: Ext.fx.target.Element , /* End Definitions */ setAttr: function(targetData, isFirstFrame) { var cssArr = { attrs: [], duration: [], easing: [] }, ln = targetData.length, attributes, attrs, attr, easing, duration, o, i, j, ln2; for (i = 0; i < ln; i++) { attrs = targetData[i]; duration = attrs.duration; easing = attrs.easing; attrs = attrs.attrs; for (attr in attrs) { if (Ext.Array.indexOf(cssArr.attrs, attr) == -1) { cssArr.attrs.push(attr.replace(/[A-Z]/g, function(v) { return '-' + v.toLowerCase(); })); cssArr.duration.push(duration + 'ms'); cssArr.easing.push(easing); } } } attributes = cssArr.attrs.join(','); duration = cssArr.duration.join(','); easing = cssArr.easing.join(', '); for (i = 0; i < ln; i++) { attrs = targetData[i].attrs; for (attr in attrs) { ln2 = attrs[attr].length; for (j = 0; j < ln2; j++) { o = attrs[attr][j]; o[0].setStyle(Ext.supports.CSS3Prefix + 'TransitionProperty', isFirstFrame ? '' : attributes); o[0].setStyle(Ext.supports.CSS3Prefix + 'TransitionDuration', isFirstFrame ? '' : duration); o[0].setStyle(Ext.supports.CSS3Prefix + 'TransitionTimingFunction', isFirstFrame ? '' : easing); o[0].setStyle(attr, o[1]); // Must trigger reflow to make this get used as the start point for the transition that follows if (isFirstFrame) { o = o[0].dom.offsetWidth; } else { // Remove transition properties when completed. o[0].on(Ext.supports.CSS3TransitionEnd, function() { this.setStyle(Ext.supports.CSS3Prefix + 'TransitionProperty', null); this.setStyle(Ext.supports.CSS3Prefix + 'TransitionDuration', null); this.setStyle(Ext.supports.CSS3Prefix + 'TransitionTimingFunction', null); }, o[0], { single: true }); } } } } } }); /** * @class Ext.fx.target.CompositeElement * * This class represents a animation target for a {@link Ext.CompositeElement}. It allows * each {@link Ext.Element} in the group to be animated as a whole. In general this class will not be * created directly, the {@link Ext.CompositeElement} will be passed to the animation and * and the appropriate target will be created. */ Ext.define('Ext.fx.target.CompositeElement', { /* Begin Definitions */ extend: Ext.fx.target.Element , /* End Definitions */ /** * @property {Boolean} isComposite * `true` in this class to identify an object as an instantiated CompositeElement, or subclass thereof. */ isComposite: true, constructor: function(target) { target.id = target.id || Ext.id(null, 'ext-composite-'); this.callParent([target]); }, getAttr: function(attr, val) { var out = [], target = this.target, elements = target.elements, length = elements.length, i, el; for (i = 0; i < length; i++) { el = elements[i]; if (el) { el = target.getElement(el); out.push([el, this.getElVal(el, attr, val)]); } } return out; }, setAttr: function(targetData){ var target = this.target, ln = targetData.length, elements = target.elements, ln3 = elements.length, value, k, attrs, attr, o, i, j, ln2; for (i = 0; i < ln; i++) { attrs = targetData[i].attrs; for (attr in attrs) { if (attrs.hasOwnProperty(attr)) { ln2 = attrs[attr].length; for (j = 0; j < ln2; j++) { value = attrs[attr][j][1]; for (k = 0; k < ln3; ++k) { el = elements[k]; if (el) { el = target.getElement(el); this.setElVal(el, attr, value); } } } } } } } }); /** * @class Ext.fx.target.CompositeElementCSS * * This class represents a animation target for a {@link Ext.CompositeElement}, where the * constituent elements support CSS based animation. It allows each {@link Ext.Element} in * the group to be animated as a whole. In general this class will not be created directly, * the {@link Ext.CompositeElement} will be passed to the animation and the appropriate target * will be created. */ Ext.define('Ext.fx.target.CompositeElementCSS', { /* Begin Definitions */ extend: Ext.fx.target.CompositeElement , /* End Definitions */ setAttr: function() { return Ext.fx.target.ElementCSS.prototype.setAttr.apply(this, arguments); } }); /** * @class Ext.fx.target.Sprite This class represents an animation target for a {@link Ext.draw.Sprite}. In general this class will not be created directly, the {@link Ext.draw.Sprite} will be passed to the animation and and the appropriate target will be created. * @markdown */ Ext.define('Ext.fx.target.Sprite', { /* Begin Definitions */ extend: Ext.fx.target.Target , /* End Definitions */ type: 'draw', getFromPrim: function (sprite, attr) { var obj; switch (attr) { case 'rotate': case 'rotation': obj = sprite.attr.rotation; return { x: obj.x || 0, y: obj.y || 0, degrees: obj.degrees || 0 }; case 'scale': case 'scaling': obj = sprite.attr.scaling; return { x: obj.x || 1, y: obj.y || 1, cx: obj.cx || 0, cy: obj.cy || 0 }; case 'translate': case 'translation': obj = sprite.attr.translation; return { x: obj.x || 0, y: obj.y || 0 }; default: return sprite.attr[attr]; } }, getAttr: function (attr, val) { return [ [this.target, val != undefined ? val : this.getFromPrim(this.target, attr)] ]; }, setAttr: function (targetData) { var ln = targetData.length, spriteArr = [], attrsConf, attr, attrArr, attrs, sprite, idx, value, i, j, x, y, ln2; for (i = 0; i < ln; i++) { attrsConf = targetData[i].attrs; for (attr in attrsConf) { attrArr = attrsConf[attr]; ln2 = attrArr.length; for (j = 0; j < ln2; j++) { sprite = attrArr[j][0]; attrs = attrArr[j][1]; if (attr === 'translate' || attr === 'translation') { value = { x: attrs.x, y: attrs.y }; } else if (attr === 'rotate' || attr === 'rotation') { x = attrs.x; if (isNaN(x)) { x = null; } y = attrs.y; if (isNaN(y)) { y = null; } value = { degrees: attrs.degrees, x: x, y: y }; } else if (attr === 'scale' || attr === 'scaling') { x = attrs.x; if (isNaN(x)) { x = null; } y = attrs.y; if (isNaN(y)) { y = null; } value = { x: x, y: y, cx: attrs.cx, cy: attrs.cy }; } else if (attr === 'width' || attr === 'height' || attr === 'x' || attr === 'y') { value = parseFloat(attrs); } else { value = attrs; } idx = Ext.Array.indexOf(spriteArr, sprite); if (idx == -1) { spriteArr.push([sprite, {}]); idx = spriteArr.length - 1; } spriteArr[idx][1][attr] = value; } } } ln = spriteArr.length; for (i = 0; i < ln; i++) { spriteArr[i][0].setAttributes(spriteArr[i][1]); } this.target.redraw(); } }); /** * @class Ext.fx.target.CompositeSprite This class represents a animation target for a {@link Ext.draw.CompositeSprite}. It allows each {@link Ext.draw.Sprite} in the group to be animated as a whole. In general this class will not be created directly, the {@link Ext.draw.CompositeSprite} will be passed to the animation and and the appropriate target will be created. * @markdown */ Ext.define('Ext.fx.target.CompositeSprite', { /* Begin Definitions */ extend: Ext.fx.target.Sprite , /* End Definitions */ getAttr: function(attr, val) { var out = [], sprites = [].concat(this.target.items), length = sprites.length, i, sprite; for (i = 0; i < length; i++) { sprite = sprites[i]; out.push([sprite, val != undefined ? val : this.getFromPrim(sprite, attr)]); } return out; } }); /** * @class Ext.fx.target.Component * * This class represents a animation target for a {@link Ext.Component}. In general this class will not be * created directly, the {@link Ext.Component} will be passed to the animation and * and the appropriate target will be created. */ Ext.define('Ext.fx.target.Component', { /* Begin Definitions */ extend: Ext.fx.target.Target , /* End Definitions */ type: 'component', // Methods to call to retrieve unspecified "from" values from a target Component getPropMethod: { top: function() { return this.getPosition(true)[1]; }, left: function() { return this.getPosition(true)[0]; }, x: function() { return this.getPosition()[0]; }, y: function() { return this.getPosition()[1]; }, height: function() { return this.getHeight(); }, width: function() { return this.getWidth(); }, opacity: function() { return this.el.getStyle('opacity'); } }, setMethods: { top: 'setPosition', left: 'setPosition', x: 'setPagePosition', y: 'setPagePosition', height: 'setSize', width: 'setSize', opacity: 'setOpacity' }, // Read the named attribute from the target Component. Use the defined getter for the attribute getAttr: function(attr, val) { return [[this.target, val !== undefined ? val : this.getPropMethod[attr].call(this.target)]]; }, setAttr: function(targetData, isFirstFrame, isLastFrame) { var me = this, ln = targetData.length, attrs, attr, o, i, j, targets, left, top, w, h, methodsToCall = {}, methodProps; for (i = 0; i < ln; i++) { attrs = targetData[i].attrs; for (attr in attrs) { targets = attrs[attr].length; for (j = 0; j < targets; j++) { o = attrs[attr][j]; methodProps = methodsToCall[me.setMethods[attr]] || (methodsToCall[me.setMethods[attr]] = {}); methodProps.target = o[0]; methodProps[attr] = o[1]; // debugging code: Ext.log('Setting ' + o[0].id + "'s " + attr + ' to ' + o[1]); } } if (methodsToCall.setPosition) { o = methodsToCall.setPosition; left = (o.left === undefined) ? undefined : parseFloat(o.left); top = (o.top === undefined) ? undefined : parseFloat(o.top); o.target.setPosition(left, top); } if (methodsToCall.setPagePosition) { o = methodsToCall.setPagePosition; o.target.setPagePosition(o.x, o.y); } if (methodsToCall.setSize) { o = methodsToCall.setSize; // Dimensions not being animated MUST NOT be autosized. They must remain at current value. w = (o.width === undefined) ? o.target.getWidth() : parseFloat(o.width); h = (o.height === undefined) ? o.target.getHeight() : parseFloat(o.height); // Only set the size of the Component on the last frame, or if the animation was // configured with dynamic: true. // In other cases, we just set the target element size. // This will result in either clipping if animating a reduction in size, or the revealing of // the inner elements of the Component if animating an increase in size. // Component's animate function initially resizes to the larger size before resizing the // outer element to clip the contents. o.target.el.setSize(w, h); if (isLastFrame || me.dynamic) { // Defer the final sizing & layout until we are outside of this frame. // In case anything in the resulting layout calls animation. // If it does, *this* frame will fire again... recursively Ext.globalEvents.on({ idle: Ext.Function.bind(o.target.setSize, o.target, [w, h]), single: true }); } } if (methodsToCall.setOpacity) { o = methodsToCall.setOpacity; o.target.el.setStyle('opacity', o.opacity); } } } }); /** * @class Ext.fx.Queue * Animation Queue mixin to handle chaining and queueing by target. * @private */ Ext.define('Ext.fx.Queue', { constructor: function() { this.targets = new Ext.util.HashMap(); this.fxQueue = {}; }, // @private getFxDefaults: function(targetId) { var target = this.targets.get(targetId); if (target) { return target.fxDefaults; } return {}; }, // @private setFxDefaults: function(targetId, obj) { var target = this.targets.get(targetId); if (target) { target.fxDefaults = Ext.apply(target.fxDefaults || {}, obj); } }, // @private stopAnimation: function(targetId) { var me = this, queue = me.getFxQueue(targetId), ln = queue.length; while (ln) { queue[ln - 1].end(); ln--; } }, /** * @private * Returns current animation object if the element has any effects actively running or queued, else returns false. */ getActiveAnimation: function(targetId) { var queue = this.getFxQueue(targetId); return (queue && !!queue.length) ? queue[0] : false; }, // @private hasFxBlock: function(targetId) { var queue = this.getFxQueue(targetId); return queue && queue[0] && queue[0].block; }, // @private get fx queue for passed target, create if needed. getFxQueue: function(targetId) { if (!targetId) { return false; } var me = this, queue = me.fxQueue[targetId], target = me.targets.get(targetId); if (!target) { return false; } if (!queue) { me.fxQueue[targetId] = []; // GarbageCollector will need to clean up Elements since they aren't currently observable if (target.type != 'element') { target.target.on('destroy', function() { me.fxQueue[targetId] = []; }); } } return me.fxQueue[targetId]; }, // @private queueFx: function(anim) { var me = this, target = anim.target, queue, ln; if (!target) { return; } queue = me.getFxQueue(target.getId()); ln = queue.length; if (ln) { if (anim.concurrent) { anim.paused = false; } else { queue[ln - 1].on('afteranimate', function() { anim.paused = false; }); } } else { anim.paused = false; } anim.on('afteranimate', function() { Ext.Array.remove(queue, anim); if (queue.length === 0) { me.targets.remove(anim.target); } if (anim.remove) { if (target.type == 'element') { var el = Ext.get(target.id); if (el) { el.remove(); } } } }, me, { single: true }); queue.push(anim); } }); /** * @class Ext.fx.Manager * Animation Manager which keeps track of all current animations and manages them on a frame by frame basis. * @private * @singleton */ Ext.define('Ext.fx.Manager', { /* Begin Definitions */ singleton: true, mixins: { queue: Ext.fx.Queue }, /* End Definitions */ constructor: function() { var me = this; me.items = new Ext.util.MixedCollection(); me.mixins.queue.constructor.call(me); // Do not use fireIdleEvent: false. Each tick of the TaskRunner needs to fire the idleEvent // in case an animation callback/listener adds a listener. me.taskRunner = new Ext.util.TaskRunner(); // this.requestAnimFrame = (function() { // var raf = window.requestAnimationFrame || // window.webkitRequestAnimationFrame || // window.mozRequestAnimationFrame || // window.oRequestAnimationFrame || // window.msRequestAnimationFrame; // if (raf) { // return function(callback, element) { // raf(callback); // }; // } // else { // return function(callback, element) { // window.setTimeout(callback, Ext.fx.Manager.interval); // }; // } // })(); }, /** * @cfg {Number} interval Default interval in miliseconds to calculate each frame. Defaults to 16ms (~60fps) */ interval: 16, /** * @cfg {Boolean} forceJS Force the use of JavaScript-based animation instead of CSS3 animation, even when CSS3 * animation is supported by the browser. This defaults to true currently, as CSS3 animation support is still * considered experimental at this time, and if used should be thouroughly tested across all targeted browsers. * @protected */ forceJS: true, // @private Target factory createTarget: function(target) { var me = this, useCSS3 = !me.forceJS && Ext.supports.Transitions, targetObj; me.useCSS3 = useCSS3; if (target) { // dom element, string or fly if (target.tagName || Ext.isString(target) || target.isFly) { target = Ext.get(target); targetObj = new Ext.fx.target['Element' + (useCSS3 ? 'CSS' : '')](target); } // Element else if (target.dom) { targetObj = new Ext.fx.target['Element' + (useCSS3 ? 'CSS' : '')](target); } // Element Composite else if (target.isComposite) { targetObj = new Ext.fx.target['CompositeElement' + (useCSS3 ? 'CSS' : '')](target); } // Draw Sprite else if (target.isSprite) { targetObj = new Ext.fx.target.Sprite(target); } // Draw Sprite Composite else if (target.isCompositeSprite) { targetObj = new Ext.fx.target.CompositeSprite(target); } // Component else if (target.isComponent) { targetObj = new Ext.fx.target.Component(target); } else if (target.isAnimTarget) { return target; } else { return null; } me.targets.add(targetObj); return targetObj; } else { return null; } }, /** * Add an Anim to the manager. This is done automatically when an Anim instance is created. * @param {Ext.fx.Anim} anim */ addAnim: function(anim) { var me = this, items = me.items, task = me.task; // Make sure we use the anim's id, not the anim target's id here. The anim id will be unique on // each call to addAnim. `anim.target` is the DOM element being targeted, and since multiple animations // can target a single DOM node concurrently, the target id cannot be assumned to be unique. items.add(anim.id, anim); //Ext.log('+ added anim ', anim.id, ', target: ', anim.target.getId(), ', duration: ', anim.duration); // Start the timer if not already running if (!task && items.length) { task = me.task = { run: me.runner, interval: me.interval, scope: me }; //Ext.log('--->> Starting task'); me.taskRunner.start(task); } }, /** * Remove an Anim from the manager. This is done automatically when an Anim ends. * @param {Ext.fx.Anim} anim */ removeAnim: function(anim) { var me = this, items = me.items, task = me.task; items.removeAtKey(anim.id); //Ext.log(' X removed anim ', anim.id, ', target: ', anim.target.getId(), ', frames: ', anim.frameCount, ', item count: ', items.length); // Stop the timer if there are no more managed Anims if (task && !items.length) { //Ext.log('[]--- Stopping task'); me.taskRunner.stop(task); delete me.task; } }, /** * @private * Runner function being called each frame */ runner: function() { var me = this, items = me.items.getRange(), i = 0, len = items.length, anim; //Ext.log(' executing anim runner task with ', len, ' items'); me.targetArr = {}; // Single timestamp for all animations this interval me.timestamp = new Date(); // Loop to start any new animations first before looping to // execute running animations (which will also include all animations // started in this loop). This is a subtle difference from simply // iterating in one loop and starting then running each animation, // but separating the loops is necessary to ensure that all new animations // actually kick off prior to existing ones regardless of array order. // Otherwise in edge cases when there is excess latency in overall // performance, allowing existing animations to run before new ones can // lead to dropped frames and subtle race conditions when they are // interdependent, which is often the case with certain Element fx. for (; i < len; i++) { anim = items[i]; if (anim.isReady()) { //Ext.log(' starting anim ', anim.id, ', target: ', anim.target.id); me.startAnim(anim); } } for (i = 0; i < len; i++) { anim = items[i]; if (anim.isRunning()) { //Ext.log(' running anim ', anim.target.id); me.runAnim(anim); } else if (!me.useCSS3) { // When using CSS3 transitions the animations get paused since they are not // needed once the transition is handed over to the browser, so we can // ignore this case. However if we are doing JS animations and something is // paused here it's possibly unintentional. //Ext.log(' (i) anim ', anim.id, ' is active but not running...'); } } // Apply all the pending changes to their targets me.applyPendingAttrs(); }, /** * @private * Start the individual animation (initialization) */ startAnim: function(anim) { anim.start(this.timestamp); }, /** * @private * Run the individual animation for this frame */ runAnim: function(anim) { if (!anim) { return; } var me = this, useCSS3 = me.useCSS3 && anim.target.type == 'element', elapsedTime = me.timestamp - anim.startTime, lastFrame = (elapsedTime >= anim.duration), target, o; target = this.collectTargetData(anim, elapsedTime, useCSS3, lastFrame); // For CSS3 animation, we need to immediately set the first frame's attributes without any transition // to get a good initial state, then add the transition properties and set the final attributes. if (useCSS3) { //Ext.log(' (i) using CSS3 transitions'); // Flush the collected attributes, without transition anim.target.setAttr(target.anims[anim.id].attributes, true); // Add the end frame data me.collectTargetData(anim, anim.duration, useCSS3, lastFrame); // Pause the animation so runAnim doesn't keep getting called anim.paused = true; target = anim.target.target; // We only want to attach an event on the last element in a composite if (anim.target.isComposite) { target = anim.target.target.last(); } // Listen for the transitionend event o = {}; o[Ext.supports.CSS3TransitionEnd] = anim.lastFrame; o.scope = anim; o.single = true; target.on(o); } }, /** * @private * Collect target attributes for the given Anim object at the given timestamp * @param {Ext.fx.Anim} anim The Anim instance * @param {Number} timestamp Time after the anim's start time * @param {Boolean} [useCSS3=false] True if using CSS3-based animation, else false * @param {Boolean} [isLastFrame=false] True if this is the last frame of animation to be run, else false * @return {Object} The animation target wrapper object containing the passed animation along with the * new attributes to set on the target's element in the next animation frame. */ collectTargetData: function(anim, elapsedTime, useCSS3, isLastFrame) { var targetId = anim.target.getId(), target = this.targetArr[targetId]; if (!target) { // Create a thin wrapper around the target so that we can create a link between the // target element and its associated animations. This is important later when applying // attributes to the target so that each animation can be independently run with its own // duration and stopped at any point without affecting other animations for the same target. target = this.targetArr[targetId] = { id: targetId, el: anim.target, anims: {} }; } // This is a wrapper for the animation so that we can also save state along with it, // including the current elapsed time and lastFrame status. Even though this method only // adds a single anim object per call, each target element could have multiple animations // associated with it, which is why the anim is added to the target's `anims` hash by id. target.anims[anim.id] = { id: anim.id, anim: anim, elapsed: elapsedTime, isLastFrame: isLastFrame, // This is the object that gets applied to the target element below in applyPendingAttrs(): attributes: [{ duration: anim.duration, easing: (useCSS3 && anim.reverse) ? anim.easingFn.reverse().toCSS3() : anim.easing, // This is where the magic happens. The anim calculates what its new attributes should // be based on the current frame and returns those as a hash of values. attrs: anim.runAnim(elapsedTime) }] }; return target; }, /** * @private * Apply all pending attribute changes to their targets */ applyPendingAttrs: function() { var targetArr = this.targetArr, target, targetId, animWrap, anim, animId; // Loop through each target for (targetId in targetArr) { if (targetArr.hasOwnProperty(targetId)) { target = targetArr[targetId]; // Each target could have multiple associated animations, so iterate those for (animId in target.anims) { if (target.anims.hasOwnProperty(animId)) { animWrap = target.anims[animId]; anim = animWrap.anim; // If the animation has valid attributes, set them on the target if (animWrap.attributes && anim.isRunning()) { //Ext.log(' > applying attributes for anim ', animWrap.id, ', target: ', target.id, ', elapsed: ', animWrap.elapsed); target.el.setAttr(animWrap.attributes, false, animWrap.isLastFrame); // If this particular anim is at the last frame end it if (animWrap.isLastFrame) { //Ext.log(' running last frame for ', animWrap.id, ', target: ', targetId); anim.lastFrame(); } } } } } } } }); /** * @class Ext.fx.Animator * * This class is used to run keyframe based animations, which follows the CSS3 based animation structure. * Keyframe animations differ from typical from/to animations in that they offer the ability to specify values * at various points throughout the animation. * * ## Using Keyframes * * The {@link #keyframes} option is the most important part of specifying an animation when using this * class. A key frame is a point in a particular animation. We represent this as a percentage of the * total animation duration. At each key frame, we can specify the target values at that time. Note that * you *must* specify the values at 0% and 100%, the start and ending values. There is also a {@link #keyframe} * event that fires after each key frame is reached. * * ## Example * * In the example below, we modify the values of the element at each fifth throughout the animation. * * @example * Ext.create('Ext.fx.Animator', { * target: Ext.getBody().createChild({ * style: { * width: '100px', * height: '100px', * 'background-color': 'red' * } * }), * duration: 10000, // 10 seconds * keyframes: { * 0: { * opacity: 1, * backgroundColor: 'FF0000' * }, * 20: { * x: 30, * opacity: 0.5 * }, * 40: { * x: 130, * backgroundColor: '0000FF' * }, * 60: { * y: 80, * opacity: 0.3 * }, * 80: { * width: 200, * y: 200 * }, * 100: { * opacity: 1, * backgroundColor: '00FF00' * } * } * }); */ Ext.define('Ext.fx.Animator', { /* Begin Definitions */ mixins: { observable: Ext.util.Observable }, /* End Definitions */ /** * @property {Boolean} isAnimator * `true` in this class to identify an object as an instantiated Animator, or subclass thereof. */ isAnimator: true, /** * @cfg {Number} duration * Time in milliseconds for the animation to last. Defaults to 250. */ duration: 250, /** * @cfg {Number} delay * Time to delay before starting the animation. Defaults to 0. */ delay: 0, /* private used to track a delayed starting time */ delayStart: 0, /** * @cfg {Boolean} dynamic * Currently only for Component Animation: Only set a component's outer element size bypassing layouts. Set to true to do full layouts for every frame of the animation. Defaults to false. */ dynamic: false, /** * @cfg {String} easing * * This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change * speed over its duration. * * - backIn * - backOut * - bounceIn * - bounceOut * - ease * - easeIn * - easeOut * - easeInOut * - elasticIn * - elasticOut * - cubic-bezier(x1, y1, x2, y2) * * Note that cubic-bezier will create a custom easing curve following the CSS3 [transition-timing-function][0] * specification. The four values specify points P1 and P2 of the curve as (x1, y1, x2, y2). All values must * be in the range [0, 1] or the definition is invalid. * * [0]: http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag */ easing: 'ease', /** * Flag to determine if the animation has started * @property running * @type Boolean */ running: false, /** * Flag to determine if the animation is paused. Only set this to true if you need to * keep the Anim instance around to be unpaused later; otherwise call {@link #end}. * @property paused * @type Boolean */ paused: false, /** * @private */ damper: 1, /** * @cfg {Number} iterations * Number of times to execute the animation. Defaults to 1. */ iterations: 1, /** * Current iteration the animation is running. * @property currentIteration * @type Number */ currentIteration: 0, /** * Current keyframe step of the animation. * @property keyframeStep * @type Number */ keyframeStep: 0, /** * @private */ animKeyFramesRE: /^(from|to|\d+%?)$/, /** * @cfg {Ext.fx.target.Target} target * The Ext.fx.target to apply the animation to. If not specified during initialization, this can be passed to the applyAnimator * method to apply the same animation to many targets. */ /** * @cfg {Object} keyframes * Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to' * is considered '100%'.Every keyframe declaration must have a keyframe rule for 0% and 100%, possibly defined using * "from" or "to". A keyframe declaration without these keyframe selectors is invalid and will not be available for * animation. The keyframe declaration for a keyframe rule consists of properties and values. Properties that are unable to * be animated are ignored in these rules, with the exception of 'easing' which can be changed at each keyframe. For example:

keyframes : {
    '0%': {
        left: 100
    },
    '40%': {
        left: 150
    },
    '60%': {
        left: 75
    },
    '100%': {
        left: 100
    }
}
 
*/ constructor: function(config) { var me = this; config = Ext.apply(me, config || {}); me.config = config; me.id = Ext.id(null, 'ext-animator-'); me.addEvents( /** * @event beforeanimate * Fires before the animation starts. A handler can return false to cancel the animation. * @param {Ext.fx.Animator} this */ 'beforeanimate', /** * @event keyframe * Fires at each keyframe. * @param {Ext.fx.Animator} this * @param {Number} keyframe step number */ 'keyframe', /** * @event afteranimate * Fires when the animation is complete. * @param {Ext.fx.Animator} this * @param {Date} startTime */ 'afteranimate' ); me.mixins.observable.constructor.call(me, config); me.timeline = []; me.createTimeline(me.keyframes); if (me.target) { me.applyAnimator(me.target); Ext.fx.Manager.addAnim(me); } }, /** * @private */ sorter: function (a, b) { return a.pct - b.pct; }, /** * @private * Takes the given keyframe configuration object and converts it into an ordered array with the passed attributes per keyframe * or applying the 'to' configuration to all keyframes. Also calculates the proper animation duration per keyframe. */ createTimeline: function(keyframes) { var me = this, attrs = [], to = me.to || {}, duration = me.duration, prevMs, ms, i, ln, pct, attr; for (pct in keyframes) { if (keyframes.hasOwnProperty(pct) && me.animKeyFramesRE.test(pct)) { attr = {attrs: Ext.apply(keyframes[pct], to)}; // CSS3 spec allow for from/to to be specified. if (pct == "from") { pct = 0; } else if (pct == "to") { pct = 100; } // convert % values into integers attr.pct = parseInt(pct, 10); attrs.push(attr); } } // Sort by pct property Ext.Array.sort(attrs, me.sorter); // Only an end //if (attrs[0].pct) { // attrs.unshift({pct: 0, attrs: element.attrs}); //} ln = attrs.length; for (i = 0; i < ln; i++) { prevMs = (attrs[i - 1]) ? duration * (attrs[i - 1].pct / 100) : 0; ms = duration * (attrs[i].pct / 100); me.timeline.push({ duration: ms - prevMs, attrs: attrs[i].attrs }); } }, /** * Applies animation to the Ext.fx.target * @private * @param target * @type String/Object */ applyAnimator: function(target) { var me = this, anims = [], timeline = me.timeline, ln = timeline.length, anim, easing, damper, attrs, i; if (me.fireEvent('beforeanimate', me) !== false) { for (i = 0; i < ln; i++) { anim = timeline[i]; attrs = anim.attrs; easing = attrs.easing || me.easing; damper = attrs.damper || me.damper; delete attrs.easing; delete attrs.damper; anim = new Ext.fx.Anim({ target: target, easing: easing, damper: damper, duration: anim.duration, paused: true, to: attrs }); anims.push(anim); } me.animations = anims; me.target = anim.target; for (i = 0; i < ln - 1; i++) { anim = anims[i]; anim.nextAnim = anims[i + 1]; anim.on('afteranimate', function() { this.nextAnim.paused = false; }); anim.on('afteranimate', function() { this.fireEvent('keyframe', this, ++this.keyframeStep); }, me); } anims[ln - 1].on('afteranimate', function() { this.lastFrame(); }, me); } }, /** * @private * Fires beforeanimate and sets the running flag. */ start: function(startTime) { var me = this, delay = me.delay, delayStart = me.delayStart, delayDelta; if (delay) { if (!delayStart) { me.delayStart = startTime; return; } else { delayDelta = startTime - delayStart; if (delayDelta < delay) { return; } else { // Compensate for frame delay; startTime = new Date(delayStart.getTime() + delay); } } } if (me.fireEvent('beforeanimate', me) !== false) { me.startTime = startTime; me.running = true; me.animations[me.keyframeStep].paused = false; } }, /** * @private * Perform lastFrame cleanup and handle iterations * @returns a hash of the new attributes. */ lastFrame: function() { var me = this, iter = me.iterations, iterCount = me.currentIteration; iterCount++; if (iterCount < iter) { me.startTime = new Date(); me.currentIteration = iterCount; me.keyframeStep = 0; me.applyAnimator(me.target); me.animations[me.keyframeStep].paused = false; } else { me.currentIteration = 0; me.end(); } }, /** * Fire afteranimate event and end the animation. Usually called automatically when the * animation reaches its final frame, but can also be called manually to pre-emptively * stop and destroy the running animation. */ end: function() { var me = this; me.fireEvent('afteranimate', me, me.startTime, new Date() - me.startTime); }, isReady: function() { return this.paused === false && this.running === false && this.iterations > 0; }, isRunning: function() { // Explicitly return false, we don't want to be run continuously by the manager return false; } }); /** * @private */ Ext.define('Ext.fx.CubicBezier', { /* Begin Definitions */ singleton: true, /* End Definitions */ cubicBezierAtTime: function(t, p1x, p1y, p2x, p2y, duration) { var cx = 3 * p1x, bx = 3 * (p2x - p1x) - cx, ax = 1 - cx - bx, cy = 3 * p1y, by = 3 * (p2y - p1y) - cy, ay = 1 - cy - by; function sampleCurveX(t) { return ((ax * t + bx) * t + cx) * t; } function solve(x, epsilon) { var t = solveCurveX(x, epsilon); return ((ay * t + by) * t + cy) * t; } function solveCurveX(x, epsilon) { var t0, t1, t2, x2, d2, i; for (t2 = x, i = 0; i < 8; i++) { x2 = sampleCurveX(t2) - x; if (Math.abs(x2) < epsilon) { return t2; } d2 = (3 * ax * t2 + 2 * bx) * t2 + cx; if (Math.abs(d2) < 1e-6) { break; } t2 = t2 - x2 / d2; } t0 = 0; t1 = 1; t2 = x; if (t2 < t0) { return t0; } if (t2 > t1) { return t1; } while (t0 < t1) { x2 = sampleCurveX(t2); if (Math.abs(x2 - x) < epsilon) { return t2; } if (x > x2) { t0 = t2; } else { t1 = t2; } t2 = (t1 - t0) / 2 + t0; } return t2; } return solve(t, 1 / (200 * duration)); }, cubicBezier: function(x1, y1, x2, y2) { var fn = function(pos) { return Ext.fx.CubicBezier.cubicBezierAtTime(pos, x1, y1, x2, y2, 1); }; fn.toCSS3 = function() { return 'cubic-bezier(' + [x1, y1, x2, y2].join(',') + ')'; }; fn.reverse = function() { return Ext.fx.CubicBezier.cubicBezier(1 - x2, 1 - y2, 1 - x1, 1 - y1); }; return fn; } }); // @define Ext.fx.Easing /** * @class Ext.fx.Easing * * This class contains a series of function definitions used to modify values during an animation. * They describe how the intermediate values used during a transition will be calculated. It allows for a transition to change * speed over its duration. The following options are available: * * - linear The default easing type * - backIn * - backOut * - bounceIn * - bounceOut * - ease * - easeIn * - easeOut * - easeInOut * - elasticIn * - elasticOut * - cubic-bezier(x1, y1, x2, y2) * * Note that cubic-bezier will create a custom easing curve following the CSS3 [transition-timing-function][0] * specification. The four values specify points P1 and P2 of the curve as (x1, y1, x2, y2). All values must * be in the range [0, 1] or the definition is invalid. * * [0]: http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag * * @singleton */ Ext.require('Ext.fx.CubicBezier', function() { var math = Math, pi = math.PI, pow = math.pow, sin = math.sin, sqrt = math.sqrt, abs = math.abs, backInSeed = 1.70158; Ext.define('Ext.fx.Easing', { singleton: true, linear: Ext.identityFn, ease: function(n) { var q = 0.07813 - n / 2, alpha = -0.25, Q = sqrt(0.0066 + q * q), x = Q - q, X = pow(abs(x), 1/3) * (x < 0 ? -1 : 1), y = -Q - q, Y = pow(abs(y), 1/3) * (y < 0 ? -1 : 1), t = X + Y + 0.25; return pow(1 - t, 2) * 3 * t * 0.1 + (1 - t) * 3 * t * t + t * t * t; }, easeIn: function (n) { return pow(n, 1.7); }, easeOut: function (n) { return pow(n, 0.48); }, easeInOut: function(n) { var q = 0.48 - n / 1.04, Q = sqrt(0.1734 + q * q), x = Q - q, X = pow(abs(x), 1/3) * (x < 0 ? -1 : 1), y = -Q - q, Y = pow(abs(y), 1/3) * (y < 0 ? -1 : 1), t = X + Y + 0.5; return (1 - t) * 3 * t * t + t * t * t; }, backIn: function (n) { return n * n * ((backInSeed + 1) * n - backInSeed); }, backOut: function (n) { n = n - 1; return n * n * ((backInSeed + 1) * n + backInSeed) + 1; }, elasticIn: function (n) { if (n === 0 || n === 1) { return n; } var p = 0.3, s = p / 4; return pow(2, -10 * n) * sin((n - s) * (2 * pi) / p) + 1; }, elasticOut: function (n) { return 1 - Ext.fx.Easing.elasticIn(1 - n); }, bounceIn: function (n) { return 1 - Ext.fx.Easing.bounceOut(1 - n); }, bounceOut: function (n) { var s = 7.5625, p = 2.75, l; if (n < (1 / p)) { l = s * n * n; } else { if (n < (2 / p)) { n -= (1.5 / p); l = s * n * n + 0.75; } else { if (n < (2.5 / p)) { n -= (2.25 / p); l = s * n * n + 0.9375; } else { n -= (2.625 / p); l = s * n * n + 0.984375; } } } return l; } }, function(){ var easing = Ext.fx.Easing.self, proto = easing.prototype; easing.implement({ 'back-in': proto.backIn, 'back-out': proto.backOut, 'ease-in': proto.easeIn, 'ease-out': proto.easeOut, 'elastic-in': proto.elasticIn, 'elastic-out': proto.elasticOut, 'bounce-in': proto.bounceIn, 'bounce-out': proto.bounceOut, 'ease-in-out': proto.easeInOut }); }); }); /** * Represents an RGB color and provides helper functions get * color components in HSL color space. */ Ext.define('Ext.draw.Color', { /* Begin Definitions */ /* End Definitions */ colorToHexRe: /(.*?)rgb\((\d+),\s*(\d+),\s*(\d+)\)/, rgbRe: /\s*rgb\s*\(\s*([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)\s*\)\s*/, hexRe: /\s*#([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)([0-9a-fA-F][0-9a-fA-F]?)\s*/, /** * @cfg {Number} lightnessFactor * * The default factor to compute the lighter or darker color. Defaults to 0.2. */ lightnessFactor: 0.2, /** * Creates new Color. * @param {Number} red Red component (0..255) * @param {Number} green Green component (0..255) * @param {Number} blue Blue component (0..255) */ constructor : function(red, green, blue) { var me = this, clamp = Ext.Number.constrain; me.r = clamp(red, 0, 255); me.g = clamp(green, 0, 255); me.b = clamp(blue, 0, 255); }, /** * Get the red component of the color, in the range 0..255. * @return {Number} */ getRed: function() { return this.r; }, /** * Get the green component of the color, in the range 0..255. * @return {Number} */ getGreen: function() { return this.g; }, /** * Get the blue component of the color, in the range 0..255. * @return {Number} */ getBlue: function() { return this.b; }, /** * Get the RGB values. * @return {Number[]} */ getRGB: function() { var me = this; return [me.r, me.g, me.b]; }, /** * Get the equivalent HSL components of the color. * @return {Number[]} */ getHSL: function() { var me = this, r = me.r / 255, g = me.g / 255, b = me.b / 255, max = Math.max(r, g, b), min = Math.min(r, g, b), delta = max - min, h, s = 0, l = 0.5 * (max + min); // min==max means achromatic (hue is undefined) if (min != max) { s = (l < 0.5) ? delta / (max + min) : delta / (2 - max - min); if (r == max) { h = 60 * (g - b) / delta; } else if (g == max) { h = 120 + 60 * (b - r) / delta; } else { h = 240 + 60 * (r - g) / delta; } if (h < 0) { h += 360; } if (h >= 360) { h -= 360; } } return [h, s, l]; }, /** * Return a new color that is lighter than this color. * @param {Number} factor Lighter factor (0..1), default to 0.2 * @return Ext.draw.Color */ getLighter: function(factor) { var hsl = this.getHSL(); factor = factor || this.lightnessFactor; hsl[2] = Ext.Number.constrain(hsl[2] + factor, 0, 1); return this.fromHSL(hsl[0], hsl[1], hsl[2]); }, /** * Return a new color that is darker than this color. * @param {Number} factor Darker factor (0..1), default to 0.2 * @return Ext.draw.Color */ getDarker: function(factor) { factor = factor || this.lightnessFactor; return this.getLighter(-factor); }, /** * Return the color in the hex format, i.e. '#rrggbb'. * @return {String} */ toString: function() { var me = this, round = Math.round, r = round(me.r).toString(16), g = round(me.g).toString(16), b = round(me.b).toString(16); r = (r.length == 1) ? '0' + r : r; g = (g.length == 1) ? '0' + g : g; b = (b.length == 1) ? '0' + b : b; return ['#', r, g, b].join(''); }, /** * Convert a color to hexadecimal format. * * **Note:** This method is both static and instance. * * @param {String/String[]} color The color value (i.e 'rgb(255, 255, 255)', 'color: #ffffff'). * Can also be an Array, in this case the function handles the first member. * @returns {String} The color in hexadecimal format. * @static */ toHex: function(color) { if (Ext.isArray(color)) { color = color[0]; } if (!Ext.isString(color)) { return ''; } if (color.substr(0, 1) === '#') { return color; } var digits = this.colorToHexRe.exec(color), red, green, blue, rgb; if (Ext.isArray(digits)) { red = parseInt(digits[2], 10); green = parseInt(digits[3], 10); blue = parseInt(digits[4], 10); rgb = blue | (green << 8) | (red << 16); return digits[1] + '#' + ("000000" + rgb.toString(16)).slice(-6); } else { return color; } }, /** * Parse the string and create a new color. * * Supported formats: '#rrggbb', '#rgb', and 'rgb(r,g,b)'. * * If the string is not recognized, an undefined will be returned instead. * * **Note:** This method is both static and instance. * * @param {String} str Color in string. * @returns Ext.draw.Color * @static */ fromString: function(str) { var values, r, g, b, parse = parseInt; if ((str.length == 4 || str.length == 7) && str.substr(0, 1) === '#') { values = str.match(this.hexRe); if (values) { r = parse(values[1], 16) >> 0; g = parse(values[2], 16) >> 0; b = parse(values[3], 16) >> 0; if (str.length == 4) { r += (r * 16); g += (g * 16); b += (b * 16); } } } else { values = str.match(this.rgbRe); if (values) { r = values[1]; g = values[2]; b = values[3]; } } return (typeof r == 'undefined') ? undefined : new Ext.draw.Color(r, g, b); }, /** * Returns the gray value (0 to 255) of the color. * * The gray value is calculated using the formula r*0.3 + g*0.59 + b*0.11. * * @returns {Number} */ getGrayscale: function() { // http://en.wikipedia.org/wiki/Grayscale#Converting_color_to_grayscale return this.r * 0.3 + this.g * 0.59 + this.b * 0.11; }, /** * Create a new color based on the specified HSL values. * * **Note:** This method is both static and instance. * * @param {Number} h Hue component (0..359) * @param {Number} s Saturation component (0..1) * @param {Number} l Lightness component (0..1) * @returns Ext.draw.Color * @static */ fromHSL: function(h, s, l) { var C, X, m, i, rgb = [], abs = Math.abs, floor = Math.floor; if (s == 0 || h == null) { // achromatic rgb = [l, l, l]; } else { // http://en.wikipedia.org/wiki/HSL_and_HSV#From_HSL // C is the chroma // X is the second largest component // m is the lightness adjustment h /= 60; C = s * (1 - abs(2 * l - 1)); X = C * (1 - abs(h - 2 * floor(h / 2) - 1)); m = l - C / 2; switch (floor(h)) { case 0: rgb = [C, X, 0]; break; case 1: rgb = [X, C, 0]; break; case 2: rgb = [0, C, X]; break; case 3: rgb = [0, X, C]; break; case 4: rgb = [X, 0, C]; break; case 5: rgb = [C, 0, X]; break; } rgb = [rgb[0] + m, rgb[1] + m, rgb[2] + m]; } return new Ext.draw.Color(rgb[0] * 255, rgb[1] * 255, rgb[2] * 255); } }, function() { var prototype = this.prototype; //These functions are both static and instance. TODO: find a more elegant way of copying them this.addStatics({ fromHSL: function() { return prototype.fromHSL.apply(prototype, arguments); }, fromString: function() { return prototype.fromString.apply(prototype, arguments); }, toHex: function() { return prototype.toHex.apply(prototype, arguments); } }); }); /** * @class Ext.draw.Draw * Base Drawing class. Provides base drawing functions. * @private */ Ext.define('Ext.draw.Draw', { /* Begin Definitions */ singleton: true, /* End Definitions */ pathToStringRE: /,?([achlmqrstvxz]),?/gi, pathCommandRE: /([achlmqstvz])[\s,]*((-?\d*\.?\d*(?:e[-+]?\d+)?\s*,?\s*)+)/ig, pathValuesRE: /(-?\d*\.?\d*(?:e[-+]?\d+)?)\s*,?\s*/ig, stopsRE: /^(\d+%?)$/, radian: Math.PI / 180, availableAnimAttrs: { along: "along", blur: null, "clip-rect": "csv", cx: null, cy: null, fill: "color", "fill-opacity": null, "font-size": null, height: null, opacity: null, path: "path", r: null, rotation: "csv", rx: null, ry: null, scale: "csv", stroke: "color", "stroke-opacity": null, "stroke-width": null, translation: "csv", width: null, x: null, y: null }, is: function(o, type) { type = String(type).toLowerCase(); return (type == "object" && o === Object(o)) || (type == "undefined" && typeof o == type) || (type == "null" && o === null) || (type == "array" && Array.isArray && Array.isArray(o)) || (Object.prototype.toString.call(o).toLowerCase().slice(8, -1)) == type; }, ellipsePath: function(sprite) { var attr = sprite.attr; return Ext.String.format("M{0},{1}A{2},{3},0,1,1,{0},{4}A{2},{3},0,1,1,{0},{1}z", attr.x, attr.y - attr.ry, attr.rx, attr.ry, attr.y + attr.ry); }, rectPath: function(sprite) { var attr = sprite.attr; if (attr.radius) { return Ext.String.format("M{0},{1}l{2},0a{3},{3},0,0,1,{3},{3}l0,{5}a{3},{3},0,0,1,{4},{3}l{6},0a{3},{3},0,0,1,{4},{4}l0,{7}a{3},{3},0,0,1,{3},{4}z", attr.x + attr.radius, attr.y, attr.width - attr.radius * 2, attr.radius, -attr.radius, attr.height - attr.radius * 2, attr.radius * 2 - attr.width, attr.radius * 2 - attr.height); } else { return Ext.String.format("M{0},{1}L{2},{1},{2},{3},{0},{3}z", attr.x, attr.y, attr.width + attr.x, attr.height + attr.y); } }, // To be deprecated, converts itself (an arrayPath) to a proper SVG path string path2string: function () { return this.join(",").replace(Ext.draw.Draw.pathToStringRE, "$1"); }, // Convert the passed arrayPath to a proper SVG path string (d attribute) pathToString: function(arrayPath) { return arrayPath.join(",").replace(Ext.draw.Draw.pathToStringRE, "$1"); }, parsePathString: function (pathString) { if (!pathString) { return null; } var paramCounts = {a: 7, c: 6, h: 1, l: 2, m: 2, q: 4, s: 4, t: 2, v: 1, z: 0}, data = [], me = this; if (me.is(pathString, "array") && me.is(pathString[0], "array")) { // rough assumption data = me.pathClone(pathString); } if (!data.length) { String(pathString).replace(me.pathCommandRE, function (a, b, c) { var params = [], name = b.toLowerCase(); c.replace(me.pathValuesRE, function (a, b) { b && params.push(+b); }); if (name == "m" && params.length > 2) { data.push([b].concat(Ext.Array.splice(params, 0, 2))); name = "l"; b = (b == "m") ? "l" : "L"; } while (params.length >= paramCounts[name]) { data.push([b].concat(Ext.Array.splice(params, 0, paramCounts[name]))); if (!paramCounts[name]) { break; } } }); } data.toString = me.path2string; return data; }, mapPath: function (path, matrix) { if (!matrix) { return path; } var x, y, i, ii, j, jj, pathi; path = this.path2curve(path); for (i = 0, ii = path.length; i < ii; i++) { pathi = path[i]; for (j = 1, jj = pathi.length; j < jj-1; j += 2) { x = matrix.x(pathi[j], pathi[j + 1]); y = matrix.y(pathi[j], pathi[j + 1]); pathi[j] = x; pathi[j + 1] = y; } } return path; }, pathClone: function(pathArray) { var res = [], j, jj, i, ii; if (!this.is(pathArray, "array") || !this.is(pathArray && pathArray[0], "array")) { // rough assumption pathArray = this.parsePathString(pathArray); } for (i = 0, ii = pathArray.length; i < ii; i++) { res[i] = []; for (j = 0, jj = pathArray[i].length; j < jj; j++) { res[i][j] = pathArray[i][j]; } } res.toString = this.path2string; return res; }, pathToAbsolute: function (pathArray) { if (!this.is(pathArray, "array") || !this.is(pathArray && pathArray[0], "array")) { // rough assumption pathArray = this.parsePathString(pathArray); } var res = [], x = 0, y = 0, mx = 0, my = 0, i = 0, ln = pathArray.length, r, pathSegment, j, ln2; // MoveTo initial x/y position if (ln && pathArray[0][0] == "M") { x = +pathArray[0][1]; y = +pathArray[0][2]; mx = x; my = y; i++; res[0] = ["M", x, y]; } for (; i < ln; i++) { r = res[i] = []; pathSegment = pathArray[i]; if (pathSegment[0] != pathSegment[0].toUpperCase()) { r[0] = pathSegment[0].toUpperCase(); switch (r[0]) { // Elliptical Arc case "A": r[1] = pathSegment[1]; r[2] = pathSegment[2]; r[3] = pathSegment[3]; r[4] = pathSegment[4]; r[5] = pathSegment[5]; r[6] = +(pathSegment[6] + x); r[7] = +(pathSegment[7] + y); break; // Vertical LineTo case "V": r[1] = +pathSegment[1] + y; break; // Horizontal LineTo case "H": r[1] = +pathSegment[1] + x; break; case "M": // MoveTo mx = +pathSegment[1] + x; my = +pathSegment[2] + y; default: j = 1; ln2 = pathSegment.length; for (; j < ln2; j++) { r[j] = +pathSegment[j] + ((j % 2) ? x : y); } } } else { j = 0; ln2 = pathSegment.length; for (; j < ln2; j++) { res[i][j] = pathSegment[j]; } } switch (r[0]) { // ClosePath case "Z": x = mx; y = my; break; // Horizontal LineTo case "H": x = r[1]; break; // Vertical LineTo case "V": y = r[1]; break; // MoveTo case "M": pathSegment = res[i]; ln2 = pathSegment.length; mx = pathSegment[ln2 - 2]; my = pathSegment[ln2 - 1]; default: pathSegment = res[i]; ln2 = pathSegment.length; x = pathSegment[ln2 - 2]; y = pathSegment[ln2 - 1]; } } res.toString = this.path2string; return res; }, // TO BE DEPRECATED pathToRelative: function (pathArray) { if (!this.is(pathArray, "array") || !this.is(pathArray && pathArray[0], "array")) { pathArray = this.parsePathString(pathArray); } var res = [], x = 0, y = 0, mx = 0, my = 0, start = 0, r, pa, i, j, k, len, ii, jj, kk; if (pathArray[0][0] == "M") { x = pathArray[0][1]; y = pathArray[0][2]; mx = x; my = y; start++; res.push(["M", x, y]); } for (i = start, ii = pathArray.length; i < ii; i++) { r = res[i] = []; pa = pathArray[i]; if (pa[0] != pa[0].toLowerCase()) { r[0] = pa[0].toLowerCase(); switch (r[0]) { case "a": r[1] = pa[1]; r[2] = pa[2]; r[3] = pa[3]; r[4] = pa[4]; r[5] = pa[5]; r[6] = +(pa[6] - x).toFixed(3); r[7] = +(pa[7] - y).toFixed(3); break; case "v": r[1] = +(pa[1] - y).toFixed(3); break; case "m": mx = pa[1]; my = pa[2]; default: for (j = 1, jj = pa.length; j < jj; j++) { r[j] = +(pa[j] - ((j % 2) ? x : y)).toFixed(3); } } } else { r = res[i] = []; if (pa[0] == "m") { mx = pa[1] + x; my = pa[2] + y; } for (k = 0, kk = pa.length; k < kk; k++) { res[i][k] = pa[k]; } } len = res[i].length; switch (res[i][0]) { case "z": x = mx; y = my; break; case "h": x += +res[i][len - 1]; break; case "v": y += +res[i][len - 1]; break; default: x += +res[i][len - 2]; y += +res[i][len - 1]; } } res.toString = this.path2string; return res; }, // Returns a path converted to a set of curveto commands path2curve: function (path) { var me = this, points = me.pathToAbsolute(path), ln = points.length, attrs = {x: 0, y: 0, bx: 0, by: 0, X: 0, Y: 0, qx: null, qy: null}, i, seg, segLn, point; for (i = 0; i < ln; i++) { points[i] = me.command2curve(points[i], attrs); if (points[i].length > 7) { points[i].shift(); point = points[i]; while (point.length) { Ext.Array.splice(points, i++, 0, ["C"].concat(Ext.Array.splice(point, 0, 6))); } Ext.Array.erase(points, i, 1); ln = points.length; i--; } seg = points[i]; segLn = seg.length; attrs.x = seg[segLn - 2]; attrs.y = seg[segLn - 1]; attrs.bx = parseFloat(seg[segLn - 4]) || attrs.x; attrs.by = parseFloat(seg[segLn - 3]) || attrs.y; } return points; }, interpolatePaths: function (path, path2) { var me = this, p = me.pathToAbsolute(path), p2 = me.pathToAbsolute(path2), attrs = {x: 0, y: 0, bx: 0, by: 0, X: 0, Y: 0, qx: null, qy: null}, attrs2 = {x: 0, y: 0, bx: 0, by: 0, X: 0, Y: 0, qx: null, qy: null}, fixArc = function (pp, i) { if (pp[i].length > 7) { pp[i].shift(); var pi = pp[i]; while (pi.length) { Ext.Array.splice(pp, i++, 0, ["C"].concat(Ext.Array.splice(pi, 0, 6))); } Ext.Array.erase(pp, i, 1); ii = Math.max(p.length, p2.length || 0); } }, fixM = function (path1, path2, a1, a2, i) { if (path1 && path2 && path1[i][0] == "M" && path2[i][0] != "M") { Ext.Array.splice(path2, i, 0, ["M", a2.x, a2.y]); a1.bx = 0; a1.by = 0; a1.x = path1[i][1]; a1.y = path1[i][2]; ii = Math.max(p.length, p2.length || 0); } }, i, ii, seg, seg2, seglen, seg2len; for (i = 0, ii = Math.max(p.length, p2.length || 0); i < ii; i++) { p[i] = me.command2curve(p[i], attrs); fixArc(p, i); (p2[i] = me.command2curve(p2[i], attrs2)); fixArc(p2, i); fixM(p, p2, attrs, attrs2, i); fixM(p2, p, attrs2, attrs, i); seg = p[i]; seg2 = p2[i]; seglen = seg.length; seg2len = seg2.length; attrs.x = seg[seglen - 2]; attrs.y = seg[seglen - 1]; attrs.bx = parseFloat(seg[seglen - 4]) || attrs.x; attrs.by = parseFloat(seg[seglen - 3]) || attrs.y; attrs2.bx = (parseFloat(seg2[seg2len - 4]) || attrs2.x); attrs2.by = (parseFloat(seg2[seg2len - 3]) || attrs2.y); attrs2.x = seg2[seg2len - 2]; attrs2.y = seg2[seg2len - 1]; } return [p, p2]; }, //Returns any path command as a curveto command based on the attrs passed command2curve: function (pathCommand, d) { var me = this; if (!pathCommand) { return ["C", d.x, d.y, d.x, d.y, d.x, d.y]; } if (pathCommand[0] != "T" && pathCommand[0] != "Q") { d.qx = d.qy = null; } switch (pathCommand[0]) { case "M": d.X = pathCommand[1]; d.Y = pathCommand[2]; break; case "A": pathCommand = ["C"].concat(me.arc2curve.apply(me, [d.x, d.y].concat(pathCommand.slice(1)))); break; case "S": pathCommand = ["C", d.x + (d.x - (d.bx || d.x)), d.y + (d.y - (d.by || d.y))].concat(pathCommand.slice(1)); break; case "T": d.qx = d.x + (d.x - (d.qx || d.x)); d.qy = d.y + (d.y - (d.qy || d.y)); pathCommand = ["C"].concat(me.quadratic2curve(d.x, d.y, d.qx, d.qy, pathCommand[1], pathCommand[2])); break; case "Q": d.qx = pathCommand[1]; d.qy = pathCommand[2]; pathCommand = ["C"].concat(me.quadratic2curve(d.x, d.y, pathCommand[1], pathCommand[2], pathCommand[3], pathCommand[4])); break; case "L": pathCommand = ["C"].concat(d.x, d.y, pathCommand[1], pathCommand[2], pathCommand[1], pathCommand[2]); break; case "H": pathCommand = ["C"].concat(d.x, d.y, pathCommand[1], d.y, pathCommand[1], d.y); break; case "V": pathCommand = ["C"].concat(d.x, d.y, d.x, pathCommand[1], d.x, pathCommand[1]); break; case "Z": pathCommand = ["C"].concat(d.x, d.y, d.X, d.Y, d.X, d.Y); break; } return pathCommand; }, quadratic2curve: function (x1, y1, ax, ay, x2, y2) { var _13 = 1 / 3, _23 = 2 / 3; return [ _13 * x1 + _23 * ax, _13 * y1 + _23 * ay, _13 * x2 + _23 * ax, _13 * y2 + _23 * ay, x2, y2 ]; }, rotate: function (x, y, rad) { var cos = Math.cos(rad), sin = Math.sin(rad), X = x * cos - y * sin, Y = x * sin + y * cos; return {x: X, y: Y}; }, arc2curve: function (x1, y1, rx, ry, angle, large_arc_flag, sweep_flag, x2, y2, recursive) { // for more information of where this Math came from visit: // http://www.w3.org/TR/SVG11/implnote.html#ArcImplementationNotes var me = this, PI = Math.PI, radian = me.radian, _120 = PI * 120 / 180, rad = radian * (+angle || 0), res = [], math = Math, mcos = math.cos, msin = math.sin, msqrt = math.sqrt, mabs = math.abs, masin = math.asin, xy, x, y, h, rx2, ry2, k, cx, cy, f1, f2, df, c1, s1, c2, s2, t, hx, hy, m1, m2, m3, m4, newres, i, ln, f2old, x2old, y2old; if (!recursive) { xy = me.rotate(x1, y1, -rad); x1 = xy.x; y1 = xy.y; xy = me.rotate(x2, y2, -rad); x2 = xy.x; y2 = xy.y; x = (x1 - x2) / 2; y = (y1 - y2) / 2; h = (x * x) / (rx * rx) + (y * y) / (ry * ry); if (h > 1) { h = msqrt(h); rx = h * rx; ry = h * ry; } rx2 = rx * rx; ry2 = ry * ry; k = (large_arc_flag == sweep_flag ? -1 : 1) * msqrt(mabs((rx2 * ry2 - rx2 * y * y - ry2 * x * x) / (rx2 * y * y + ry2 * x * x))); cx = k * rx * y / ry + (x1 + x2) / 2; cy = k * -ry * x / rx + (y1 + y2) / 2; f1 = masin(((y1 - cy) / ry).toFixed(7)); f2 = masin(((y2 - cy) / ry).toFixed(7)); f1 = x1 < cx ? PI - f1 : f1; f2 = x2 < cx ? PI - f2 : f2; if (f1 < 0) { f1 = PI * 2 + f1; } if (f2 < 0) { f2 = PI * 2 + f2; } if (sweep_flag && f1 > f2) { f1 = f1 - PI * 2; } if (!sweep_flag && f2 > f1) { f2 = f2 - PI * 2; } } else { f1 = recursive[0]; f2 = recursive[1]; cx = recursive[2]; cy = recursive[3]; } df = f2 - f1; if (mabs(df) > _120) { f2old = f2; x2old = x2; y2old = y2; f2 = f1 + _120 * (sweep_flag && f2 > f1 ? 1 : -1); x2 = cx + rx * mcos(f2); y2 = cy + ry * msin(f2); res = me.arc2curve(x2, y2, rx, ry, angle, 0, sweep_flag, x2old, y2old, [f2, f2old, cx, cy]); } df = f2 - f1; c1 = mcos(f1); s1 = msin(f1); c2 = mcos(f2); s2 = msin(f2); t = math.tan(df / 4); hx = 4 / 3 * rx * t; hy = 4 / 3 * ry * t; m1 = [x1, y1]; m2 = [x1 + hx * s1, y1 - hy * c1]; m3 = [x2 + hx * s2, y2 - hy * c2]; m4 = [x2, y2]; m2[0] = 2 * m1[0] - m2[0]; m2[1] = 2 * m1[1] - m2[1]; if (recursive) { return [m2, m3, m4].concat(res); } else { res = [m2, m3, m4].concat(res).join().split(","); newres = []; ln = res.length; for (i = 0; i < ln; i++) { newres[i] = i % 2 ? me.rotate(res[i - 1], res[i], rad).y : me.rotate(res[i], res[i + 1], rad).x; } return newres; } }, // TO BE DEPRECATED rotateAndTranslatePath: function (sprite) { var alpha = sprite.rotation.degrees, cx = sprite.rotation.x, cy = sprite.rotation.y, dx = sprite.translation.x, dy = sprite.translation.y, path, i, p, xy, j, res = []; if (!alpha && !dx && !dy) { return this.pathToAbsolute(sprite.attr.path); } dx = dx || 0; dy = dy || 0; path = this.pathToAbsolute(sprite.attr.path); for (i = path.length; i--;) { p = res[i] = path[i].slice(); if (p[0] == "A") { xy = this.rotatePoint(p[6], p[7], alpha, cx, cy); p[6] = xy.x + dx; p[7] = xy.y + dy; } else { j = 1; while (p[j + 1] != null) { xy = this.rotatePoint(p[j], p[j + 1], alpha, cx, cy); p[j] = xy.x + dx; p[j + 1] = xy.y + dy; j += 2; } } } return res; }, // TO BE DEPRECATED rotatePoint: function (x, y, alpha, cx, cy) { if (!alpha) { return { x: x, y: y }; } cx = cx || 0; cy = cy || 0; x = x - cx; y = y - cy; alpha = alpha * this.radian; var cos = Math.cos(alpha), sin = Math.sin(alpha); return { x: x * cos - y * sin + cx, y: x * sin + y * cos + cy }; }, pathDimensions: function (path) { if (!path || !(path + "")) { return {x: 0, y: 0, width: 0, height: 0}; } path = this.path2curve(path); var x = 0, y = 0, X = [], Y = [], i = 0, ln = path.length, p, xmin, ymin, xmax, ymax, dim; for (; i < ln; i++) { p = path[i]; if (p[0] == "M") { x = p[1]; y = p[2]; X.push(x); Y.push(y); } else { dim = this.curveDim(x, y, p[1], p[2], p[3], p[4], p[5], p[6]); X = X.concat(dim.min.x, dim.max.x); Y = Y.concat(dim.min.y, dim.max.y); x = p[5]; y = p[6]; } } xmin = Math.min.apply(0, X); ymin = Math.min.apply(0, Y); xmax = Math.max.apply(0, X); ymax = Math.max.apply(0, Y); return { x: Math.round(xmin), y: Math.round(ymin), path: path, width: Math.round(xmax - xmin), height: Math.round(ymax - ymin) }; }, intersectInside: function(path, cp1, cp2) { return (cp2[0] - cp1[0]) * (path[1] - cp1[1]) > (cp2[1] - cp1[1]) * (path[0] - cp1[0]); }, intersectIntersection: function(s, e, cp1, cp2) { var p = [], dcx = cp1[0] - cp2[0], dcy = cp1[1] - cp2[1], dpx = s[0] - e[0], dpy = s[1] - e[1], n1 = cp1[0] * cp2[1] - cp1[1] * cp2[0], n2 = s[0] * e[1] - s[1] * e[0], n3 = 1 / (dcx * dpy - dcy * dpx); p[0] = (n1 * dpx - n2 * dcx) * n3; p[1] = (n1 * dpy - n2 * dcy) * n3; return p; }, intersect: function(subjectPolygon, clipPolygon) { var me = this, i = 0, ln = clipPolygon.length, cp1 = clipPolygon[ln - 1], outputList = subjectPolygon, cp2, s, e, ln2, inputList, j; for (; i < ln; ++i) { cp2 = clipPolygon[i]; inputList = outputList; outputList = []; s = inputList[inputList.length - 1]; j = 0; ln2 = inputList.length; for (; j < ln2; j++) { e = inputList[j]; if (me.intersectInside(e, cp1, cp2)) { if (!me.intersectInside(s, cp1, cp2)) { outputList.push(me.intersectIntersection(s, e, cp1, cp2)); } outputList.push(e); } else if (me.intersectInside(s, cp1, cp2)) { outputList.push(me.intersectIntersection(s, e, cp1, cp2)); } s = e; } cp1 = cp2; } return outputList; }, bezier : function (a, b, c, d, x) { if (x === 0) { return a; } else if (x === 1) { return d; } var du = 1 - x, d3 = du * du * du, r = x / du; return d3 * (a + r * (3 * b + r * (3 * c + d * r))); }, bezierDim : function (a, b, c, d) { var points = [], r, A, top, C, delta, bottom, s, min, max, i; // The min and max happens on boundary or b' == 0 if (a + 3 * c == d + 3 * b) { r = a - b; r /= 2 * (a - b - b + c); if ( r < 1 && r > 0) { points.push(r); } } else { // b'(x) / -3 = (a-3b+3c-d)x^2+ (-2a+4b-2c)x + (a-b) // delta = -4 (-b^2+a c+b c-c^2-a d+b d) A = a - 3 * b + 3 * c - d; top = 2 * (a - b - b + c); C = a - b; delta = top * top - 4 * A * C; bottom = A + A; if (delta === 0) { r = top / bottom; if (r < 1 && r > 0) { points.push(r); } } else if (delta > 0) { s = Math.sqrt(delta); r = (s + top) / bottom; if (r < 1 && r > 0) { points.push(r); } r = (top - s) / bottom; if (r < 1 && r > 0) { points.push(r); } } } min = Math.min(a, d); max = Math.max(a, d); for (i = 0; i < points.length; i++) { min = Math.min(min, this.bezier(a, b, c, d, points[i])); max = Math.max(max, this.bezier(a, b, c, d, points[i])); } return [min, max]; }, curveDim: function (p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y) { var x = this.bezierDim(p1x, c1x, c2x, p2x), y = this.bezierDim(p1y, c1y, c2y, p2y); return { min: { x: x[0], y: y[0] }, max: { x: x[1], y: y[1] } }; }, /** * @private * * Calculates bezier curve control anchor points for a particular point in a path, with a * smoothing curve applied. The smoothness of the curve is controlled by the 'value' parameter. * Note that this algorithm assumes that the line being smoothed is normalized going from left * to right; it makes special adjustments assuming this orientation. * * @param {Number} prevX X coordinate of the previous point in the path * @param {Number} prevY Y coordinate of the previous point in the path * @param {Number} curX X coordinate of the current point in the path * @param {Number} curY Y coordinate of the current point in the path * @param {Number} nextX X coordinate of the next point in the path * @param {Number} nextY Y coordinate of the next point in the path * @param {Number} value A value to control the smoothness of the curve; this is used to * divide the distance between points, so a value of 2 corresponds to * half the distance between points (a very smooth line) while higher values * result in less smooth curves. Defaults to 4. * @return {Object} Object containing x1, y1, x2, y2 bezier control anchor points; x1 and y1 * are the control point for the curve toward the previous path point, and * x2 and y2 are the control point for the curve toward the next path point. */ getAnchors: function (prevX, prevY, curX, curY, nextX, nextY, value) { value = value || 4; var M = Math, PI = M.PI, halfPI = PI / 2, abs = M.abs, sin = M.sin, cos = M.cos, atan = M.atan, control1Length, control2Length, control1Angle, control2Angle, control1X, control1Y, control2X, control2Y, alpha; // Find the length of each control anchor line, by dividing the horizontal distance // between points by the value parameter. control1Length = (curX - prevX) / value; control2Length = (nextX - curX) / value; // Determine the angle of each control anchor line. If the middle point is a vertical // turnaround then we force it to a flat horizontal angle to prevent the curve from // dipping above or below the middle point. Otherwise we use an angle that points // toward the previous/next target point. if ((curY >= prevY && curY >= nextY) || (curY <= prevY && curY <= nextY)) { control1Angle = control2Angle = halfPI; } else { control1Angle = atan((curX - prevX) / abs(curY - prevY)); if (prevY < curY) { control1Angle = PI - control1Angle; } control2Angle = atan((nextX - curX) / abs(curY - nextY)); if (nextY < curY) { control2Angle = PI - control2Angle; } } // Adjust the calculated angles so they point away from each other on the same line alpha = halfPI - ((control1Angle + control2Angle) % (PI * 2)) / 2; if (alpha > halfPI) { alpha -= PI; } control1Angle += alpha; control2Angle += alpha; // Find the control anchor points from the angles and length control1X = curX - control1Length * sin(control1Angle); control1Y = curY + control1Length * cos(control1Angle); control2X = curX + control2Length * sin(control2Angle); control2Y = curY + control2Length * cos(control2Angle); // One last adjustment, make sure that no control anchor point extends vertically past // its target prev/next point, as that results in curves dipping above or below and // bending back strangely. If we find this happening we keep the control angle but // reduce the length of the control line so it stays within bounds. if ((curY > prevY && control1Y < prevY) || (curY < prevY && control1Y > prevY)) { control1X += abs(prevY - control1Y) * (control1X - curX) / (control1Y - curY); control1Y = prevY; } if ((curY > nextY && control2Y < nextY) || (curY < nextY && control2Y > nextY)) { control2X -= abs(nextY - control2Y) * (control2X - curX) / (control2Y - curY); control2Y = nextY; } return { x1: control1X, y1: control1Y, x2: control2X, y2: control2Y }; }, /* Smoothing function for a path. Converts a path into cubic beziers. Value defines the divider of the distance between points. * Defaults to a value of 4. */ smooth: function (originalPath, value) { var path = this.path2curve(originalPath), newp = [path[0]], x = path[0][1], y = path[0][2], j, points, i = 1, ii = path.length, beg = 1, mx = x, my = y, pathi, pathil, pathim, pathiml, pathip, pathipl, begl; for (; i < ii; i++) { pathi = path[i]; pathil = pathi.length; pathim = path[i - 1]; pathiml = pathim.length; pathip = path[i + 1]; pathipl = pathip && pathip.length; if (pathi[0] == "M") { mx = pathi[1]; my = pathi[2]; j = i + 1; while (path[j][0] != "C") { j++; } newp.push(["M", mx, my]); beg = newp.length; x = mx; y = my; continue; } if (pathi[pathil - 2] == mx && pathi[pathil - 1] == my && (!pathip || pathip[0] == "M")) { begl = newp[beg].length; points = this.getAnchors(pathim[pathiml - 2], pathim[pathiml - 1], mx, my, newp[beg][begl - 2], newp[beg][begl - 1], value); newp[beg][1] = points.x2; newp[beg][2] = points.y2; } else if (!pathip || pathip[0] == "M") { points = { x1: pathi[pathil - 2], y1: pathi[pathil - 1] }; } else { points = this.getAnchors(pathim[pathiml - 2], pathim[pathiml - 1], pathi[pathil - 2], pathi[pathil - 1], pathip[pathipl - 2], pathip[pathipl - 1], value); } newp.push(["C", x, y, points.x1, points.y1, pathi[pathil - 2], pathi[pathil - 1]]); x = points.x2; y = points.y2; } return newp; }, findDotAtSegment: function (p1x, p1y, c1x, c1y, c2x, c2y, p2x, p2y, t) { var t1 = 1 - t; return { x: Math.pow(t1, 3) * p1x + Math.pow(t1, 2) * 3 * t * c1x + t1 * 3 * t * t * c2x + Math.pow(t, 3) * p2x, y: Math.pow(t1, 3) * p1y + Math.pow(t1, 2) * 3 * t * c1y + t1 * 3 * t * t * c2y + Math.pow(t, 3) * p2y }; }, /** * @private */ snapEnds: function (from, to, stepsMax, prettyNumbers) { if (Ext.isDate(from)) { return this.snapEndsByDate(from, to, stepsMax); } var step = (to - from) / stepsMax, level = Math.floor(Math.log(step) / Math.LN10) + 1, m = Math.pow(10, level), cur, floor, modulo = Math.round((step % m) * Math.pow(10, 2 - level)), interval = [[0, 15], [10, 1], [20, 4], [25, 2], [50, 9], [100, 15]], stepCount = 0, value, weight, i, topValue, topWeight = 1e9, ln = interval.length; floor = Math.floor(from / m) * m; if (from == floor && floor > 0) { floor = Math.floor((from - (m/10)) / m) * m; } if (prettyNumbers) { for (i = 0; i < ln; i++) { value = interval[i][0]; weight = (value - modulo) < 0 ? 1e6 : (value - modulo) / interval[i][1]; if (weight < topWeight) { topValue = value; topWeight = weight; } } step = Math.floor(step * Math.pow(10, -level)) * Math.pow(10, level) + topValue * Math.pow(10, level - 2); if (from < 0 && to >= 0) { cur = 0; while (cur > from) { cur -= step; stepCount++; } from = +cur.toFixed(10); cur = 0; while (cur < to) { cur += step; stepCount++; } to = +cur.toFixed(10); } else { cur = from = floor; while (cur < to) { cur += step; stepCount++; } } to = +cur.toFixed(10); } else { from = floor; stepCount = stepsMax; } return { from: from, to: to, power: level, step: step, steps: stepCount }; }, /** * snapEndsByDate is a utility method to deduce an appropriate tick configuration for the data set of given * feature. Refer to {@link #snapEnds}. * * @param {Date} from The minimum value in the data * @param {Date} to The maximum value in the data * @param {Number} stepsMax The maximum number of ticks * @param {Boolean} lockEnds If true, the 'from' and 'to' parameters will be used as fixed end values and will not be adjusted * * @return {Object} The calculated step and ends info; properties are: * - from: The result start value, which may be lower than the original start value * - to: The result end value, which may be higher than the original end value * - step: The fixed value size of each step, or undefined if the steps are not fixed. * - steps: The number of steps if the steps are fixed, or an array of step values. * NOTE: Even when the steps have a fixed value, they may not divide the from/to range perfectly evenly; * there may be a smaller distance between the last step and the end value than between prior * steps, particularly when the `endsLocked` param is true. Therefore it is best to not use * the `steps` result when finding the axis tick points, instead use the `step`, `to`, and * `from` to find the correct point for each tick. */ snapEndsByDate: function (from, to, stepsMax, lockEnds) { var selectedStep = false, scales = [ [Ext.Date.MILLI, [1, 2, 5, 10, 20, 50, 100, 200, 250, 500]], [Ext.Date.SECOND, [1, 2, 5, 10, 15, 30]], [Ext.Date.MINUTE, [1, 2, 5, 10, 15, 30]], [Ext.Date.HOUR, [1, 2, 3, 4, 6, 12]], [Ext.Date.DAY, [1, 2, 7, 14]], [Ext.Date.MONTH, [1, 2, 3, 6]] ], sLen = scales.length, stop = false, scale, j, yearDiff, s; // Find the most desirable scale for (s = 0; s < sLen; s++) { scale = scales[s]; if (!stop) { for (j = 0; j < scale[1].length; j++) { if (to < Ext.Date.add(from, scale[0], scale[1][j] * stepsMax)) { selectedStep = [scale[0], scale[1][j]]; stop = true; break; } } } } if (!selectedStep) { yearDiff = this.snapEnds(from.getFullYear(), to.getFullYear() + 1, stepsMax, lockEnds); selectedStep = [Date.YEAR, Math.round(yearDiff.step)]; } return this.snapEndsByDateAndStep(from, to, selectedStep, lockEnds); }, /** * snapEndsByDateAndStep is a utility method to deduce an appropriate tick configuration for the data set of given * feature and specific step size. * * @param {Date} from The minimum value in the data * @param {Date} to The maximum value in the data * @param {Array} step An array with two components: The first is the unit of the step (day, month, year, etc). * The second is the number of units for the step (1, 2, etc.). * If the number is an integer, it represents the number of units for the step ([Ext.Date.DAY, 2] means "Every other day"). * If the number is a fraction, it represents the number of steps per unit ([Ext.Date.DAY, 1/2] means "Twice a day"). * If the unit is the month, the steps may be adjusted depending on the month. For instance [Ext.Date.MONTH, 1/3], which means "Three times a month", * generates steps on the 1st, the 10th and the 20th of every month regardless of whether a month has 28 days or 31 days. The steps are generated * as follows: * - [Ext.Date.MONTH, n]: on the current date every 'n' months, maxed to the number of days in the month. * - [Ext.Date.MONTH, 1/2]: on the 1st and 15th of every month. * - [Ext.Date.MONTH, 1/3]: on the 1st, 10th and 20th of every month. * - [Ext.Date.MONTH, 1/4]: on the 1st, 8th, 15th and 22nd of every month. * @param {Boolean} lockEnds If true, the 'from' and 'to' parameters will be used as fixed end values * and will not be adjusted * * @return {Object} The calculated step and ends info; properties are: * - from: The result start value, which may be lower than the original start value * - to: The result end value, which may be higher than the original end value * - step: The fixed value size of each step, or undefined if the steps are not fixed. * - steps: The number of steps if the steps are fixed, or an array of step values. * NOTE: Even when the steps have a fixed value, they may not divide the from/to range perfectly evenly; * there may be a smaller distance between the last step and the end value than between prior * steps, particularly when the `endsLocked` param is true. Therefore it is best to not use * the `steps` result when finding the axis tick points, instead use the `step`, `to`, and * `from` to find the correct point for each tick. */ snapEndsByDateAndStep: function(from, to, step, lockEnds) { var fromStat = [from.getFullYear(), from.getMonth(), from.getDate(), from.getHours(), from.getMinutes(), from.getSeconds(), from.getMilliseconds()], steps, testFrom, testTo, date, year, month, day, fractionalMonth, stepUnit = step[0], stepValue = step[1]; if (lockEnds) { testFrom = from; } else { switch (stepUnit) { case Ext.Date.MILLI: testFrom = new Date(fromStat[0], fromStat[1], fromStat[2], fromStat[3], fromStat[4], fromStat[5], Math.floor(fromStat[6] / stepValue) * stepValue); break; case Ext.Date.SECOND: testFrom = new Date(fromStat[0], fromStat[1], fromStat[2], fromStat[3], fromStat[4], Math.floor(fromStat[5] / stepValue) * stepValue, 0); break; case Ext.Date.MINUTE: testFrom = new Date(fromStat[0], fromStat[1], fromStat[2], fromStat[3], Math.floor(fromStat[4] / stepValue) * stepValue, 0, 0); break; case Ext.Date.HOUR: testFrom = new Date(fromStat[0], fromStat[1], fromStat[2], Math.floor(fromStat[3] / stepValue) * stepValue, 0, 0, 0); break; case Ext.Date.DAY: testFrom = new Date(fromStat[0], fromStat[1], Math.floor((fromStat[2] - 1) / stepValue) * stepValue + 1, 0, 0, 0, 0); break; case Ext.Date.MONTH: testFrom = new Date(fromStat[0], Math.floor(fromStat[1] / stepValue) * stepValue, 1, 0, 0, 0, 0); break; default: // Ext.Date.YEAR testFrom = new Date(Math.floor(fromStat[0] / stepValue) * stepValue, 0, 1, 0, 0, 0, 0); break; } } fractionalMonth = ((stepUnit === Ext.Date.MONTH) && (stepValue == 1/2 || stepValue == 1/3 || stepValue == 1/4)); steps = (fractionalMonth ? [] : 0); // TODO(zhangbei) : We can do it better somehow... testTo = new Date(testFrom); while (testTo < to) { if (fractionalMonth) { date = new Date(testTo); year = date.getFullYear(); month = date.getMonth(); day = date.getDate(); switch(stepValue) { case 1/2: // the 1st and 15th of every month if (day >= 15) { day = 1; if (++month > 11) { year++; } } else { day = 15; } break; case 1/3: // the 1st, 10th and 20th of every month if (day >= 20) { day = 1; if (++month > 11) { year++; } } else { if (day >= 10) { day = 20 } else { day = 10; } } break; case 1/4: // the 1st, 8th, 15th and 22nd of every month if (day >= 22) { day = 1; if (++month > 11) { year++; } } else { if (day >= 15) { day = 22 } else { if (day >= 8) { day = 15 } else { day = 8; } } } break; } testTo.setYear(year); testTo.setMonth(month); testTo.setDate(day); steps.push(new Date(testTo)); } else { testTo = Ext.Date.add(testTo, stepUnit, stepValue); steps++; } } if (lockEnds) { testTo = to; } if (fractionalMonth) { return { from : +testFrom, to : +testTo, steps : steps // array of steps }; } else { return { from : +testFrom, to : +testTo, step : (testTo - testFrom) / steps, steps : steps // number of steps }; } }, sorter: function (a, b) { return a.offset - b.offset; }, rad: function(degrees) { return degrees % 360 * Math.PI / 180; }, degrees: function(radian) { return radian * 180 / Math.PI % 360; }, withinBox: function(x, y, bbox) { bbox = bbox || {}; return (x >= bbox.x && x <= (bbox.x + bbox.width) && y >= bbox.y && y <= (bbox.y + bbox.height)); }, parseGradient: function(gradient) { var me = this, type = gradient.type || 'linear', angle = gradient.angle || 0, radian = me.radian, stops = gradient.stops, stopsArr = [], stop, vector, max, stopObj; if (type == 'linear') { vector = [0, 0, Math.cos(angle * radian), Math.sin(angle * radian)]; max = 1 / (Math.max(Math.abs(vector[2]), Math.abs(vector[3])) || 1); vector[2] *= max; vector[3] *= max; if (vector[2] < 0) { vector[0] = -vector[2]; vector[2] = 0; } if (vector[3] < 0) { vector[1] = -vector[3]; vector[3] = 0; } } for (stop in stops) { if (stops.hasOwnProperty(stop) && me.stopsRE.test(stop)) { stopObj = { offset: parseInt(stop, 10), color: Ext.draw.Color.toHex(stops[stop].color) || '#ffffff', opacity: stops[stop].opacity || 1 }; stopsArr.push(stopObj); } } // Sort by pct property Ext.Array.sort(stopsArr, me.sorter); if (type == 'linear') { return { id: gradient.id, type: type, vector: vector, stops: stopsArr }; } else { return { id: gradient.id, type: type, centerX: gradient.centerX, centerY: gradient.centerY, focalX: gradient.focalX, focalY: gradient.focalY, radius: gradient.radius, vector: vector, stops: stopsArr }; } } }); /** * @private */ Ext.define('Ext.fx.PropertyHandler', { /* Begin Definitions */ statics: { defaultHandler: { pixelDefaultsRE: /width|height|top$|bottom$|left$|right$/i, unitRE: /^(-?\d*\.?\d*){1}(em|ex|px|in|cm|mm|pt|pc|%)*$/, scrollRE: /^scroll/i, computeDelta: function(from, end, damper, initial, attr) { damper = (typeof damper == 'number') ? damper : 1; var unitRE = this.unitRE, match = unitRE.exec(from), start, units; if (match) { from = match[1]; units = match[2]; if (!this.scrollRE.test(attr) && !units && this.pixelDefaultsRE.test(attr)) { units = 'px'; } } from = +from || 0; match = unitRE.exec(end); if (match) { end = match[1]; units = match[2] || units; } end = +end || 0; start = (initial != null) ? initial : from; return { from: from, delta: (end - start) * damper, units: units }; }, get: function(from, end, damper, initialFrom, attr) { var ln = from.length, out = [], i, initial, res, j, len; for (i = 0; i < ln; i++) { if (initialFrom) { initial = initialFrom[i][1].from; } if (Ext.isArray(from[i][1]) && Ext.isArray(end)) { res = []; j = 0; len = from[i][1].length; for (; j < len; j++) { res.push(this.computeDelta(from[i][1][j], end[j], damper, initial, attr)); } out.push([from[i][0], res]); } else { out.push([from[i][0], this.computeDelta(from[i][1], end, damper, initial, attr)]); } } return out; }, set: function(values, easing) { var ln = values.length, out = [], i, val, res, len, j; for (i = 0; i < ln; i++) { val = values[i][1]; if (Ext.isArray(val)) { res = []; j = 0; len = val.length; for (; j < len; j++) { res.push(val[j].from + val[j].delta * easing + (val[j].units || 0)); } out.push([values[i][0], res]); } else { out.push([values[i][0], val.from + val.delta * easing + (val.units || 0)]); } } return out; } }, stringHandler: { computeDelta: function(from, end, damper, initial, attr) { return { from: from, delta: end }; }, get: function(from, end, damper, initialFrom, attr) { var ln = from.length, out = [], i, initial, res, j, len; for (i = 0; i < ln; i++) { out.push([from[i][0], this.computeDelta(from[i][1], end, damper, initial, attr)]); } return out; }, set: function(values, easing) { var ln = values.length, out = [], i, val, res, len, j; for (i = 0; i < ln; i++) { val = values[i][1]; out.push([values[i][0], val.delta]); } return out; } }, color: { rgbRE: /^rgb\(([0-9]+)\s*,\s*([0-9]+)\s*,\s*([0-9]+)\)$/i, hexRE: /^#?([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})$/i, hex3RE: /^#?([0-9A-F]{1})([0-9A-F]{1})([0-9A-F]{1})$/i, parseColor : function(color, damper) { damper = (typeof damper == 'number') ? damper : 1; var out = false, reList = [this.hexRE, this.rgbRE, this.hex3RE], length = reList.length, match, base, re, i; for (i = 0; i < length; i++) { re = reList[i]; base = (i % 2 === 0) ? 16 : 10; match = re.exec(color); if (match && match.length === 4) { if (i === 2) { match[1] += match[1]; match[2] += match[2]; match[3] += match[3]; } out = { red: parseInt(match[1], base), green: parseInt(match[2], base), blue: parseInt(match[3], base) }; break; } } return out || color; }, computeDelta: function(from, end, damper, initial) { from = this.parseColor(from); end = this.parseColor(end, damper); var start = initial ? initial : from, tfrom = typeof start, tend = typeof end; //Extra check for when the color string is not recognized. if (tfrom == 'string' || tfrom == 'undefined' || tend == 'string' || tend == 'undefined') { return end || start; } return { from: from, delta: { red: Math.round((end.red - start.red) * damper), green: Math.round((end.green - start.green) * damper), blue: Math.round((end.blue - start.blue) * damper) } }; }, get: function(start, end, damper, initialFrom) { var ln = start.length, out = [], i, initial; for (i = 0; i < ln; i++) { if (initialFrom) { initial = initialFrom[i][1].from; } out.push([start[i][0], this.computeDelta(start[i][1], end, damper, initial)]); } return out; }, set: function(values, easing) { var ln = values.length, out = [], i, val, parsedString, from, delta; for (i = 0; i < ln; i++) { val = values[i][1]; if (val) { from = val.from; delta = val.delta; //multiple checks to reformat the color if it can't recognized by computeDelta. val = (typeof val == 'object' && 'red' in val)? 'rgb(' + val.red + ', ' + val.green + ', ' + val.blue + ')' : val; val = (typeof val == 'object' && val.length)? val[0] : val; if (typeof val == 'undefined') { return []; } parsedString = typeof val == 'string'? val : 'rgb(' + [ (from.red + Math.round(delta.red * easing)) % 256, (from.green + Math.round(delta.green * easing)) % 256, (from.blue + Math.round(delta.blue * easing)) % 256 ].join(',') + ')'; out.push([ values[i][0], parsedString ]); } } return out; } }, object: { interpolate: function(prop, damper) { damper = (typeof damper == 'number') ? damper : 1; var out = {}, p; for(p in prop) { out[p] = parseFloat(prop[p]) * damper; } return out; }, computeDelta: function(from, end, damper, initial) { from = this.interpolate(from); end = this.interpolate(end, damper); var start = initial ? initial : from, delta = {}, p; for(p in end) { delta[p] = end[p] - start[p]; } return { from: from, delta: delta }; }, get: function(start, end, damper, initialFrom) { var ln = start.length, out = [], i, initial; for (i = 0; i < ln; i++) { if (initialFrom) { initial = initialFrom[i][1].from; } out.push([start[i][0], this.computeDelta(start[i][1], end, damper, initial)]); } return out; }, set: function(values, easing) { var ln = values.length, out = [], outObject = {}, i, from, delta, val, p; for (i = 0; i < ln; i++) { val = values[i][1]; from = val.from; delta = val.delta; for (p in from) { outObject[p] = from[p] + delta[p] * easing; } out.push([ values[i][0], outObject ]); } return out; } }, path: { computeDelta: function(from, end, damper, initial) { damper = (typeof damper == 'number') ? damper : 1; var start; from = +from || 0; end = +end || 0; start = (initial != null) ? initial : from; return { from: from, delta: (end - start) * damper }; }, forcePath: function(path) { if (!Ext.isArray(path) && !Ext.isArray(path[0])) { path = Ext.draw.Draw.parsePathString(path); } return path; }, get: function(start, end, damper, initialFrom) { var endPath = this.forcePath(end), out = [], startLn = start.length, startPathLn, pointsLn, i, deltaPath, initial, j, k, path, startPath; for (i = 0; i < startLn; i++) { startPath = this.forcePath(start[i][1]); deltaPath = Ext.draw.Draw.interpolatePaths(startPath, endPath); startPath = deltaPath[0]; endPath = deltaPath[1]; startPathLn = startPath.length; path = []; for (j = 0; j < startPathLn; j++) { deltaPath = [startPath[j][0]]; pointsLn = startPath[j].length; for (k = 1; k < pointsLn; k++) { initial = initialFrom && initialFrom[0][1][j][k].from; deltaPath.push(this.computeDelta(startPath[j][k], endPath[j][k], damper, initial)); } path.push(deltaPath); } out.push([start[i][0], path]); } return out; }, set: function(values, easing) { var ln = values.length, out = [], i, j, k, newPath, calcPath, deltaPath, deltaPathLn, pointsLn; for (i = 0; i < ln; i++) { deltaPath = values[i][1]; newPath = []; deltaPathLn = deltaPath.length; for (j = 0; j < deltaPathLn; j++) { calcPath = [deltaPath[j][0]]; pointsLn = deltaPath[j].length; for (k = 1; k < pointsLn; k++) { calcPath.push(deltaPath[j][k].from + deltaPath[j][k].delta * easing); } newPath.push(calcPath.join(',')); } out.push([values[i][0], newPath.join(',')]); } return out; } } /* End Definitions */ } }, function() { //set color properties to color interpolator var props = [ 'outlineColor', 'backgroundColor', 'borderColor', 'borderTopColor', 'borderRightColor', 'borderBottomColor', 'borderLeftColor', 'fill', 'stroke' ], length = props.length, i = 0, prop; for (; i= duration) { elapsedTime = duration; lastFrame = true; } if (me.reverse) { elapsedTime = duration - elapsedTime; } for (attr in attrs) { if (attrs.hasOwnProperty(attr)) { values = attrs[attr]; easing = lastFrame ? 1 : easingFn(elapsedTime / duration); ret[attr] = propHandlers[attr].set(values, easing); } } me.frameCount++; return ret; }, /** * @private * Perform lastFrame cleanup and handle iterations * @returns a hash of the new attributes. */ lastFrame: function() { var me = this, iter = me.iterations, iterCount = me.currentIteration; iterCount++; if (iterCount < iter) { if (me.alternate) { me.reverse = !me.reverse; } me.startTime = new Date(); me.currentIteration = iterCount; // Turn off paused for CSS3 Transitions me.paused = false; } else { me.currentIteration = 0; me.end(); me.fireEvent('lastframe', me, me.startTime); } }, endWasCalled: 0, /** * Fire afteranimate event and end the animation. Usually called automatically when the * animation reaches its final frame, but can also be called manually to pre-emptively * stop and destroy the running animation. */ end: function() { if (this.endWasCalled++) { return; } var me = this; me.startTime = 0; me.paused = false; me.running = false; Ext.fx.Manager.removeAnim(me); me.fireEvent('afteranimate', me, me.startTime); Ext.callback(me.callback, me.scope, [me, me.startTime]); }, isReady: function() { return this.paused === false && this.running === false && this.iterations > 0; }, isRunning: function() { return this.paused === false && this.running === true && this.isAnimator !== true; } }); // Set flag to indicate that Fx is available. Class might not be available immediately. Ext.enableFx = true; /** * This animation class is a mixin. * * Ext.util.Animate provides an API for the creation of animated transitions of properties and styles. * This class is used as a mixin and currently applied to {@link Ext.Element}, {@link Ext.CompositeElement}, * {@link Ext.draw.Sprite}, {@link Ext.draw.CompositeSprite}, and {@link Ext.Component}. Note that Components * have a limited subset of what attributes can be animated such as top, left, x, y, height, width, and * opacity (color, paddings, and margins can not be animated). * * ## Animation Basics * * All animations require three things - `easing`, `duration`, and `to` (the final end value for each property) * you wish to animate. Easing and duration are defaulted values specified below. * Easing describes how the intermediate values used during a transition will be calculated. * {@link Ext.fx.Anim#easing Easing} allows for a transition to change speed over its duration. * You may use the defaults for easing and duration, but you must always set a * {@link Ext.fx.Anim#to to} property which is the end value for all animations. * * Popular element 'to' configurations are: * * - opacity * - x * - y * - color * - height * - width * * Popular sprite 'to' configurations are: * * - translation * - path * - scale * - stroke * - rotation * * The default duration for animations is 250 (which is a 1/4 of a second). Duration is denoted in * milliseconds. Therefore 1 second is 1000, 1 minute would be 60000, and so on. The default easing curve * used for all animations is 'ease'. Popular easing functions are included and can be found in {@link Ext.fx.Anim#easing Easing}. * * For example, a simple animation to fade out an element with a default easing and duration: * * var p1 = Ext.get('myElementId'); * * p1.animate({ * to: { * opacity: 0 * } * }); * * To make this animation fade out in a tenth of a second: * * var p1 = Ext.get('myElementId'); * * p1.animate({ * duration: 100, * to: { * opacity: 0 * } * }); * * ## Animation Queues * * By default all animations are added to a queue which allows for animation via a chain-style API. * For example, the following code will queue 4 animations which occur sequentially (one right after the other): * * p1.animate({ * to: { * x: 500 * } * }).animate({ * to: { * y: 150 * } * }).animate({ * to: { * backgroundColor: '#f00' //red * } * }).animate({ * to: { * opacity: 0 * } * }); * * You can change this behavior by calling the {@link Ext.util.Animate#syncFx syncFx} method and all * subsequent animations for the specified target will be run concurrently (at the same time). * * p1.syncFx(); //this will make all animations run at the same time * * p1.animate({ * to: { * x: 500 * } * }).animate({ * to: { * y: 150 * } * }).animate({ * to: { * backgroundColor: '#f00' //red * } * }).animate({ * to: { * opacity: 0 * } * }); * * This works the same as: * * p1.animate({ * to: { * x: 500, * y: 150, * backgroundColor: '#f00' //red * opacity: 0 * } * }); * * The {@link Ext.util.Animate#stopAnimation stopAnimation} method can be used to stop any * currently running animations and clear any queued animations. * * ## Animation Keyframes * * You can also set up complex animations with {@link Ext.fx.Anim#keyframes keyframes} which follow the * CSS3 Animation configuration pattern. Note rotation, translation, and scaling can only be done for sprites. * The previous example can be written with the following syntax: * * p1.animate({ * duration: 1000, //one second total * keyframes: { * 25: { //from 0 to 250ms (25%) * x: 0 * }, * 50: { //from 250ms to 500ms (50%) * y: 0 * }, * 75: { //from 500ms to 750ms (75%) * backgroundColor: '#f00' //red * }, * 100: { //from 750ms to 1sec * opacity: 0 * } * } * }); * * ## Animation Events * * Each animation you create has events for {@link Ext.fx.Anim#beforeanimate beforeanimate}, * {@link Ext.fx.Anim#afteranimate afteranimate}, and {@link Ext.fx.Anim#lastframe lastframe}. * Keyframed animations adds an additional {@link Ext.fx.Animator#keyframe keyframe} event which * fires for each keyframe in your animation. * * All animations support the {@link Ext.util.Observable#listeners listeners} configuration to attact functions to these events. * * startAnimate: function() { * var p1 = Ext.get('myElementId'); * p1.animate({ * duration: 100, * to: { * opacity: 0 * }, * listeners: { * beforeanimate: function() { * // Execute my custom method before the animation * this.myBeforeAnimateFn(); * }, * afteranimate: function() { * // Execute my custom method after the animation * this.myAfterAnimateFn(); * }, * scope: this * }); * }, * myBeforeAnimateFn: function() { * // My custom logic * }, * myAfterAnimateFn: function() { * // My custom logic * } * * Due to the fact that animations run asynchronously, you can determine if an animation is currently * running on any target by using the {@link Ext.util.Animate#getActiveAnimation getActiveAnimation} * method. This method will return false if there are no active animations or return the currently * running {@link Ext.fx.Anim} instance. * * In this example, we're going to wait for the current animation to finish, then stop any other * queued animations before we fade our element's opacity to 0: * * var curAnim = p1.getActiveAnimation(); * if (curAnim) { * curAnim.on('afteranimate', function() { * p1.stopAnimation(); * p1.animate({ * to: { * opacity: 0 * } * }); * }); * } */ Ext.define('Ext.util.Animate', { isAnimate: true, /** * Performs custom animation on this object. * * This method is applicable to both the {@link Ext.Component Component} class and the {@link Ext.draw.Sprite Sprite} * class. It performs animated transitions of certain properties of this object over a specified timeline. * * ### Animating a {@link Ext.Component Component} * * When animating a Component, the following properties may be specified in `from`, `to`, and `keyframe` objects: * * - `x` - The Component's page X position in pixels. * * - `y` - The Component's page Y position in pixels * * - `left` - The Component's `left` value in pixels. * * - `top` - The Component's `top` value in pixels. * * - `width` - The Component's `width` value in pixels. * * - `height` - The Component's `height` value in pixels. * * - `dynamic` - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. * *Use sparingly as laying out on every intermediate size change is an expensive operation.* * * For example, to animate a Window to a new size, ensuring that its internal layout and any shadow is correct: * * myWindow = Ext.create('Ext.window.Window', { * title: 'Test Component animation', * width: 500, * height: 300, * layout: { * type: 'hbox', * align: 'stretch' * }, * items: [{ * title: 'Left: 33%', * margins: '5 0 5 5', * flex: 1 * }, { * title: 'Left: 66%', * margins: '5 5 5 5', * flex: 2 * }] * }); * myWindow.show(); * myWindow.header.el.on('click', function() { * myWindow.animate({ * to: { * width: (myWindow.getWidth() == 500) ? 700 : 500, * height: (myWindow.getHeight() == 300) ? 400 : 300 * } * }); * }); * * For performance reasons, by default, the internal layout is only updated when the Window reaches its final `"to"` * size. If dynamic updating of the Window's child Components is required, then configure the animation with * `dynamic: true` and the two child items will maintain their proportions during the animation. * * @param {Object} config Configuration for {@link Ext.fx.Anim}. * Note that the {@link Ext.fx.Anim#to to} config is required. * @return {Object} this */ animate: function(animObj) { var me = this; if (Ext.fx.Manager.hasFxBlock(me.id)) { return me; } Ext.fx.Manager.queueFx(new Ext.fx.Anim(me.anim(animObj))); return this; }, // @private - process the passed fx configuration. anim: function(config) { if (!Ext.isObject(config)) { return (config) ? {} : false; } var me = this; if (config.stopAnimation) { me.stopAnimation(); } Ext.applyIf(config, Ext.fx.Manager.getFxDefaults(me.id)); return Ext.apply({ target: me, paused: true }, config); }, /** * Stops any running effects and clears this object's internal effects queue if it contains any additional effects * that haven't started yet. * @deprecated 4.0 Replaced by {@link #stopAnimation} * @return {Ext.Element} The Element * @method */ stopFx: Ext.Function.alias(Ext.util.Animate, 'stopAnimation'), /** * Stops any running effects and clears this object's internal effects queue if it contains any additional effects * that haven't started yet. * @return {Ext.Element} The Element */ stopAnimation: function() { Ext.fx.Manager.stopAnimation(this.id); return this; }, /** * Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite * of {@link #sequenceFx}. * @return {Object} this */ syncFx: function() { Ext.fx.Manager.setFxDefaults(this.id, { concurrent: true }); return this; }, /** * Ensures that all effects queued after sequenceFx is called on this object are run in sequence. This is the * opposite of {@link #syncFx}. * @return {Object} this */ sequenceFx: function() { Ext.fx.Manager.setFxDefaults(this.id, { concurrent: false }); return this; }, /** * @deprecated 4.0 Replaced by {@link #getActiveAnimation} * @inheritdoc Ext.util.Animate#getActiveAnimation * @method */ hasActiveFx: Ext.Function.alias(Ext.util.Animate, 'getActiveAnimation'), /** * Returns the current animation if this object has any effects actively running or queued, else returns false. * @return {Ext.fx.Anim/Boolean} Anim if element has active effects, else false */ getActiveAnimation: function() { return Ext.fx.Manager.getActiveAnimation(this.id); } }, function(){ // Apply Animate mixin manually until Element is defined in the proper 4.x way Ext.applyIf(Ext.Element.prototype, this.prototype); // We need to call this again so the animation methods get copied over to CE Ext.CompositeElementLite.importElementMethods(); }); /** * This mixin enables classes to declare relationships to child elements and provides the * mechanics for acquiring the {@link Ext.Element elements} and storing them on an object * instance as properties. * * This class is used by {@link Ext.Component components} and {@link Ext.layout.container.Container container layouts} to * manage their child elements. * * A typical component that uses these features might look something like this: * * Ext.define('Ext.ux.SomeComponent', { * extend: 'Ext.Component', * * childEls: [ * 'bodyEl' * ], * * renderTpl: [ * '
' * ], * * // ... * }); * * The `childEls` array lists one or more relationships to child elements managed by the * component. The items in this array can be either of the following types: * * - String: the id suffix and property name in one. For example, "bodyEl" in the above * example means a "bodyEl" property will be added to the instance with the result of * {@link Ext#get} given "componentId-bodyEl" where "componentId" is the component instance's * id. * - Object: with a `name` property that names the instance property for the element, and * one of the following additional properties: * - `id`: The full id of the child element. * - `itemId`: The suffix part of the id to which "componentId-" is prepended. * - `select`: A selector that will be passed to {@link Ext#select}. * - `selectNode`: A selector that will be passed to {@link Ext.DomQuery#selectNode}. * * The example above could have used this instead to achieve the same result: * * childEls: [ * { name: 'bodyEl', itemId: 'bodyEl' } * ] * * When using `select`, the property will be an instance of {@link Ext.CompositeElement}. In * all other cases, the property will be an {@link Ext.Element} or `null` if not found. * * Care should be taken when using `select` or `selectNode` to find child elements. The * following issues should be considered: * * - Performance: using selectors can be slower than id lookup by a factor 10x or more. * - Over-selecting: selectors are applied after the DOM elements for all children have * been rendered, so selectors can match elements from child components (including nested * versions of the same component) accidentally. * * This above issues are most important when using `select` since it returns multiple * elements. * * **IMPORTANT** * Unlike a `renderTpl` where there is a single value for an instance, `childEls` are aggregated * up the class hierarchy so that they are effectively inherited. In other words, if a * class where to derive from `Ext.ux.SomeComponent` in the example above, it could also * have a `childEls` property in the same way as `Ext.ux.SomeComponent`. * * Ext.define('Ext.ux.AnotherComponent', { * extend: 'Ext.ux.SomeComponent', * * childEls: [ * // 'bodyEl' is inherited * 'innerEl' * ], * * renderTpl: [ * '
' * '
' * '
' * ], * * // ... * }); * * The `renderTpl` contains both child elements and unites them in the desired markup, but * the `childEls` only contains the new child element. The {@link #applyChildEls} method * takes care of looking up all `childEls` for an instance and considers `childEls` * properties on all the super classes and mixins. * * @private */ Ext.define('Ext.util.ElementContainer', { childEls: [ // empty - this solves a couple problems: // 1. It ensures that all classes have a childEls (avoid null ptr) // 2. It prevents mixins from smashing on their own childEls (these are gathered // specifically) ], constructor: function () { var me = this, childEls; // if we have configured childEls, we need to merge them with those from this // class, its bases and the set of mixins... if (me.hasOwnProperty('childEls')) { childEls = me.childEls; delete me.childEls; me.addChildEls.apply(me, childEls); } }, destroy: function () { var me = this, childEls = me.getChildEls(), child, childName, i, k; for (i = childEls.length; i--; ) { childName = childEls[i]; if (typeof childName != 'string') { childName = childName.name; } child = me[childName]; if (child) { me[childName] = null; // better than delete since that changes the "shape" child.remove(); } } }, /** * Adds each argument passed to this method to the {@link Ext.AbstractComponent#cfg-childEls childEls} array. */ addChildEls: function () { var me = this, args = arguments; if (me.hasOwnProperty('childEls')) { me.childEls.push.apply(me.childEls, args); } else { me.childEls = me.getChildEls().concat(Array.prototype.slice.call(args)); } me.prune(me.childEls, false); }, /** * Sets references to elements inside the component. * @private */ applyChildEls: function(el, id) { var me = this, childEls = me.getChildEls(), baseId, childName, i, selector, value; baseId = (id || me.id) + '-'; for (i = childEls.length; i--; ) { childName = childEls[i]; if (typeof childName == 'string') { // We don't use Ext.get because that is 3x (or more) slower on IE6-8. Since // we know the el's are children of our el we use getById instead: value = el.getById(baseId + childName); } else { if ((selector = childName.select)) { value = Ext.select(selector, true, el.dom); // a CompositeElement } else if ((selector = childName.selectNode)) { value = Ext.get(Ext.DomQuery.selectNode(selector, el.dom)); } else { // see above re:getById... value = el.getById(childName.id || (baseId + childName.itemId)); } childName = childName.name; } me[childName] = value; } }, getChildEls: function () { var me = this, self; // If an instance has its own childEls, that is the complete set: if (me.hasOwnProperty('childEls')) { return me.childEls; } // Typically, however, the childEls is a class-level concept, so check to see if // we have cached the complete set on the class: self = me.self; return self.$childEls || me.getClassChildEls(self); }, getClassChildEls: function (cls) { var me = this, result = cls.$childEls, childEls, i, length, forked, mixin, mixins, name, parts, proto, supr, superMixins; if (!result) { // We put the various childEls arrays into parts in the order of superclass, // new mixins and finally from cls. These parts can be null or undefined and // we will skip them later. supr = cls.superclass; if (supr) { supr = supr.self; parts = [supr.$childEls || me.getClassChildEls(supr)]; // super+mixins superMixins = supr.prototype.mixins || {}; } else { parts = []; superMixins = {}; } proto = cls.prototype; mixins = proto.mixins; // since we are a mixin, there will be at least us for (name in mixins) { if (mixins.hasOwnProperty(name) && !superMixins.hasOwnProperty(name)) { mixin = mixins[name].self; parts.push(mixin.$childEls || me.getClassChildEls(mixin)); } } parts.push(proto.hasOwnProperty('childEls') && proto.childEls); for (i = 0, length = parts.length; i < length; ++i) { childEls = parts[i]; if (childEls && childEls.length) { if (!result) { result = childEls; } else { if (!forked) { forked = true; result = result.slice(0); } result.push.apply(result, childEls); } } } cls.$childEls = result = (result ? me.prune(result, !forked) : []); } return result; }, prune: function (childEls, shared) { var index = childEls.length, map = {}, name; while (index--) { name = childEls[index]; if (typeof name != 'string') { name = name.name; } if (!map[name]) { map[name] = 1; } else { if (shared) { shared = false; childEls = childEls.slice(0); } Ext.Array.erase(childEls, index, 1); } } return childEls; }, /** * Removes items in the childEls array based on the return value of a supplied test * function. The function is called with a entry in childEls and if the test function * return true, that entry is removed. If false, that entry is kept. * * @param {Function} testFn The test function. */ removeChildEls: function (testFn) { var me = this, old = me.getChildEls(), keepers = (me.childEls = []), n, i, cel; for (i = 0, n = old.length; i < n; ++i) { cel = old[i]; if (!testFn(cel)) { keepers.push(cel); } } } }); /** * Given a component hierarchy of this: * * { * xtype: 'panel', * id: 'ContainerA', * layout: 'hbox', * renderTo: Ext.getBody(), * items: [ * { * id: 'ContainerB', * xtype: 'container', * items: [ * { id: 'ComponentA' } * ] * } * ] * } * * The rendering of the above proceeds roughly like this: * * - ContainerA's initComponent calls #render passing the `renderTo` property as the * container argument. * - `render` calls the `getRenderTree` method to get a complete {@link Ext.DomHelper} spec. * - `getRenderTree` fires the "beforerender" event and calls the #beforeRender * method. Its result is obtained by calling #getElConfig. * - The #getElConfig method uses the `renderTpl` and its render data as the content * of the `autoEl` described element. * - The result of `getRenderTree` is passed to {@link Ext.DomHelper#append}. * - The `renderTpl` contains calls to render things like docked items, container items * and raw markup (such as the `html` or `tpl` config properties). These calls are to * methods added to the {@link Ext.XTemplate} instance by #setupRenderTpl. * - The #setupRenderTpl method adds methods such as `renderItems`, `renderContent`, etc. * to the template. These are directed to "doRenderItems", "doRenderContent" etc.. * - The #setupRenderTpl calls traverse from components to their {@link Ext.layout.Layout} * object. * - When a container is rendered, it also has a `renderTpl`. This is processed when the * `renderContainer` method is called in the component's `renderTpl`. This call goes to * Ext.layout.container.Container#doRenderContainer. This method repeats this * process for all components in the container. * - After the top-most component's markup is generated and placed in to the DOM, the next * step is to link elements to their components and finish calling the component methods * `onRender` and `afterRender` as well as fire the corresponding events. * - The first step in this is to call #finishRender. This method descends the * component hierarchy and calls `onRender` and fires the `render` event. These calls * are delivered top-down to approximate the timing of these calls/events from previous * versions. * - During the pass, the component's `el` is set. Likewise, the `renderSelectors` and * `childEls` are applied to capture references to the component's elements. * - These calls are also made on the {@link Ext.layout.container.Container} layout to * capture its elements. Both of these classes use {@link Ext.util.ElementContainer} to * handle `childEls` processing. * - Once this is complete, a similar pass is made by calling #finishAfterRender. * This call also descends the component hierarchy, but this time the calls are made in * a bottom-up order to `afterRender`. * * @private */ Ext.define('Ext.util.Renderable', { frameCls: Ext.baseCSSPrefix + 'frame', frameIdRegex: /[\-]frame\d+[TMB][LCR]$/, frameElNames: ['TL','TC','TR','ML','MC','MR','BL','BC','BR'], frameTpl: [ '{%this.renderDockedItems(out,values,0);%}', '', '
{parent.baseCls}-{parent.ui}-{.}-tl{frameElCls}" role="presentation">', '
{parent.baseCls}-{parent.ui}-{.}-tr{frameElCls}" role="presentation">', '
{parent.baseCls}-{parent.ui}-{.}-tc{frameElCls}" role="presentation">
', '
', '
', '
', '
{parent.baseCls}-{parent.ui}-{.}-ml{frameElCls}" role="presentation">', '
{parent.baseCls}-{parent.ui}-{.}-mr{frameElCls}" role="presentation">', '
{parent.baseCls}-{parent.ui}-{.}-mc{frameElCls}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', '
', '
', '
', '', '
{parent.baseCls}-{parent.ui}-{.}-bl{frameElCls}" role="presentation">', '
{parent.baseCls}-{parent.ui}-{.}-br{frameElCls}" role="presentation">', '
{parent.baseCls}-{parent.ui}-{.}-bc{frameElCls}" role="presentation">
', '
', '
', '
', '{%this.renderDockedItems(out,values,1);%}' ], frameTableTpl: [ '{%this.renderDockedItems(out,values,0);%}', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '
{parent.baseCls}-{parent.ui}-{.}-tl{frameElCls}" role="presentation"> {parent.baseCls}-{parent.ui}-{.}-tc{frameElCls}" role="presentation"> {parent.baseCls}-{parent.ui}-{.}-tr{frameElCls}" role="presentation">
{parent.baseCls}-{parent.ui}-{.}-ml{frameElCls}" role="presentation"> {parent.baseCls}-{parent.ui}-{.}-mc{frameElCls}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', ' {parent.baseCls}-{parent.ui}-{.}-mr{frameElCls}" role="presentation">
{parent.baseCls}-{parent.ui}-{.}-bl{frameElCls}" role="presentation"> {parent.baseCls}-{parent.ui}-{.}-bc{frameElCls}" role="presentation"> {parent.baseCls}-{parent.ui}-{.}-br{frameElCls}" role="presentation">
', '{%this.renderDockedItems(out,values,1);%}' ], /** * Allows addition of behavior after rendering is complete. At this stage the Component’s Element * will have been styled according to the configuration, will have had any configured CSS class * names added, and will be in the configured visibility and the configured enable state. * * @template * @protected */ afterRender : function() { var me = this, data = {}, protoEl = me.protoEl, target = me.el, item, pre, hide, contentEl; me.finishRenderChildren(); // We need to do the contentEl here because it depends on the layout items (inner/outerCt) // to be rendered before we can put it in if (me.contentEl) { pre = Ext.baseCSSPrefix; hide = pre + 'hide-'; contentEl = Ext.get(me.contentEl); contentEl.removeCls([pre+'hidden', hide+'display', hide+'offsets', hide+'nosize']); me.getContentTarget().appendChild(contentEl.dom); } protoEl.writeTo(data); // Here we apply any styles that were set on the protoEl during the rendering phase // A majority of times this will not happen, but we still need to handle it item = data.removed; if (item) { target.removeCls(item); } item = data.cls; if (item.length) { target.addCls(item); } item = data.style; if (data.style) { target.setStyle(item); } me.protoEl = null; // If this is the outermost Container, lay it out as soon as it is rendered. if (!me.ownerCt) { me.updateLayout(); } }, afterFirstLayout : function(width, height) { var me = this, x = me.x, y = me.y, hasX, hasY, pos, xy; // We only have to set absolute position here if there is no ownerlayout which should take responsibility. // Consider the example of rendered components outside of a viewport - these might need their positions setting. if (!me.ownerLayout) { hasX = Ext.isDefined(x); hasY = Ext.isDefined(y); } // For floaters, calculate x and y if they aren't defined by aligning // the sized element to the center of either the container or the ownerCt if (me.floating && (!hasX || !hasY)) { if (me.floatParent) { pos = me.floatParent.getTargetEl().getViewRegion(); xy = me.el.getAlignToXY(me.floatParent.getTargetEl(), 'c-c'); pos.x = xy[0] - pos.x; pos.y = xy[1] - pos.y; } else { xy = me.el.getAlignToXY(me.container, 'c-c'); pos = me.container.translateXY(xy[0], xy[1]); } x = hasX ? x : pos.x; y = hasY ? y : pos.y; hasX = hasY = true; } if (hasX || hasY) { me.setPosition(x, y); } me.onBoxReady(width, height); }, /** * Sets references to elements inside the component. This applies {@link Ext.AbstractComponent#cfg-renderSelectors renderSelectors} * as well as {@link Ext.AbstractComponent#cfg-childEls childEls}. * @private */ applyRenderSelectors: function() { var me = this, selectors = me.renderSelectors, el = me.el, dom = el.dom, selector; me.applyChildEls(el); // We still support renderSelectors. There are a few places in the framework that // need them and they are a documented part of the API. In fact, we support mixing // childEls and renderSelectors (no reason not to). if (selectors) { for (selector in selectors) { if (selectors.hasOwnProperty(selector) && selectors[selector]) { me[selector] = Ext.get(Ext.DomQuery.selectNode(selectors[selector], dom)); } } } }, beforeRender: function () { var me = this, target = me.getTargetEl(), overflowEl = me.getOverflowEl(), layout = me.getComponentLayout(), // Call the style calculation early which sets the public scrollFlags property overflowStyle = me.getOverflowStyle(); // Just before rendering, set the frame flag if we are an always-framed component like Window or Tip. me.frame = me.frame || me.alwaysFramed; if (!layout.initialized) { layout.initLayout(); } // Attempt to set overflow style prior to render if the targetEl can be accessed. // If the targetEl does not exist yet, this will take place in finishRender if (overflowEl) { overflowEl.setStyle(overflowStyle); me.overflowStyleSet = true; } me.setUI(me.ui); if (me.disabled) { // pass silent so the event doesn't fire the first time. me.disable(true); } }, /** * @private * Called from the selected frame generation template to insert this Component's inner structure inside the framing structure. * * When framing is used, a selected frame generation template is used as the primary template of the #getElConfig instead * of the configured {@link Ext.AbstractComponent#renderTpl renderTpl}. The renderTpl is invoked by this method which is injected into the framing template. */ doApplyRenderTpl: function(out, values) { // Careful! This method is bolted on to the frameTpl so all we get for context is // the renderData! The "this" pointer is the frameTpl instance! var me = values.$comp, tpl; // Don't do this if the component is already rendered: if (!me.rendered) { tpl = me.initRenderTpl(); tpl.applyOut(values.renderData, out); } }, /** * Handles autoRender. * Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that * ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body */ doAutoRender: function() { var me = this; if (!me.rendered) { if (me.floating) { me.render(document.body); } else { me.render(Ext.isBoolean(me.autoRender) ? Ext.getBody() : me.autoRender); } } }, doRenderContent: function (out, renderData) { // Careful! This method is bolted on to the renderTpl so all we get for context is // the renderData! The "this" pointer is the renderTpl instance! var me = renderData.$comp; if (me.html) { Ext.DomHelper.generateMarkup(me.html, out); delete me.html; } if (me.tpl) { // Make sure this.tpl is an instantiated XTemplate if (!me.tpl.isTemplate) { me.tpl = new Ext.XTemplate(me.tpl); } if (me.data) { //me.tpl[me.tplWriteMode](target, me.data); me.tpl.applyOut(me.data, out); delete me.data; } } }, doRenderFramingDockedItems: function (out, renderData, after) { // Careful! This method is bolted on to the frameTpl so all we get for context is // the renderData! The "this" pointer is the frameTpl instance! var me = renderData.$comp; // Most components don't have dockedItems, so check for doRenderDockedItems on the // component (also, don't do this if the component is already rendered): if (!me.rendered && me.doRenderDockedItems) { // The "renderData" property is placed in scope for the renderTpl, but we don't // want to render docked items at that level in addition to the framing level: renderData.renderData.$skipDockedItems = true; // doRenderDockedItems requires the $comp property on renderData, but this is // set on the frameTpl's renderData as well: me.doRenderDockedItems.call(this, out, renderData, after); } }, /** * This method visits the rendered component tree in a "top-down" order. That is, this * code runs on a parent component before running on a child. This method calls the * {@link #onRender} method of each component. * @param {Number} containerIdx The index into the Container items of this Component. * * @private */ finishRender: function(containerIdx) { var me = this, tpl, data, el; // We are typically called w/me.el==null as a child of some ownerCt that is being // rendered. We are also called by render for a normal component (w/o a configured // me.el). In this case, render sets me.el and me.rendering (indirectly). Lastly // we are also called on a component (like a Viewport) that has a configured me.el // (body for a Viewport) when render is called. In this case, it is not flagged as // "me.rendering" yet becasue it does not produce a renderTree. We use this to know // not to regen the renderTpl. if (!me.el || me.$pid) { if (me.container) { el = me.container.getById(me.id, true); } else { el = Ext.getDom(me.id); } if (!me.el) { // Typical case: we produced the el during render me.wrapPrimaryEl(el); } else { // We were configured with an el and created a proxy, so now we can swap // the proxy for me.el: delete me.$pid; if (!me.el.dom) { // make sure me.el is an Element me.wrapPrimaryEl(me.el); } el.parentNode.insertBefore(me.el.dom, el); Ext.removeNode(el); // remove placeholder el // TODO - what about class/style? } } else if (!me.rendering) { // We were configured with an el and then told to render (e.g., Viewport). We // need to generate the proper DOM. Insert first because the layout system // insists that child Component elements indices match the Component indices. tpl = me.initRenderTpl(); if (tpl) { data = me.initRenderData(); tpl.insertFirst(me.getTargetEl(), data); } } // else we are rendering if (!me.container) { // top-level rendered components will already have me.container set up me.container = Ext.get(me.el.dom.parentNode); } if (me.ctCls) { me.container.addCls(me.ctCls); } // Sets the rendered flag and clears the rendering flag me.onRender(me.container, containerIdx); // If we could not access a target protoEl in beforeRender, we have to set the overflow styles here. if (!me.overflowStyleSet) { me.getOverflowEl().setStyle(me.getOverflowStyle()); } // Tell the encapsulating element to hide itself in the way the Component is configured to hide // This means DISPLAY, VISIBILITY or OFFSETS. me.el.setVisibilityMode(Ext.Element[me.hideMode.toUpperCase()]); if (me.overCls) { me.el.hover(me.addOverCls, me.removeOverCls, me); } if (me.hasListeners.render) { me.fireEvent('render', me); } me.afterRender(); // this can cause a layout if (me.hasListeners.afterrender) { me.fireEvent('afterrender', me); } me.initEvents(); if (me.hidden) { // Hiding during the render process should not perform any ancillary // actions that the full hide process does; It is not hiding, it begins in a hidden state.' // So just make the element hidden according to the configured hideMode me.el.hide(); } }, finishRenderChildren: function () { var layout = this.getComponentLayout(); layout.finishRender(); }, getElConfig : function() { var me = this, autoEl = me.autoEl, frameInfo = me.getFrameInfo(), config = { tag: 'div', tpl: frameInfo ? me.initFramingTpl(frameInfo.table) : me.initRenderTpl() }, protoEl = me.protoEl, i, frameElNames, len, suffix, frameGenId, frameData; me.initStyles(protoEl); protoEl.writeTo(config); protoEl.flush(); if (Ext.isString(autoEl)) { config.tag = autoEl; } else { Ext.apply(config, autoEl); // harmless if !autoEl } // It's important to assign the id here as an autoEl.id could have been (wrongly) applied and this would get things out of sync config.id = me.id; if (config.tpl) { // Use the framingTpl as the main content creating template. It will call out to this.applyRenderTpl(out, values) if (frameInfo) { frameElNames = me.frameElNames; len = frameElNames.length; config.tplData = frameData = me.getFrameRenderData(); frameData.renderData = me.initRenderData(); frameGenId = frameData.fgid; // Add the childEls for each of the frame elements for (i = 0; i < len; i++) { suffix = frameElNames[i]; me.addChildEls({ name: 'frame' + suffix, id: frameGenId + suffix }); } // Panel must have a frameBody me.addChildEls({ name: 'frameBody', id: frameGenId + 'MC' }); } else { config.tplData = me.initRenderData(); } } return config; }, // Create the framingTpl from the string. // Poke in a reference to applyRenderTpl(frameInfo, out) initFramingTpl: function(table) { var tpl = this.getFrameTpl(table); if (tpl && !tpl.applyRenderTpl) { this.setupFramingTpl(tpl); } return tpl; }, /** * @private * Inject a reference to the function which applies the render template into the framing template. The framing template * wraps the content. */ setupFramingTpl: function(frameTpl) { frameTpl.applyRenderTpl = this.doApplyRenderTpl; frameTpl.renderDockedItems = this.doRenderFramingDockedItems; }, /** * This function takes the position argument passed to onRender and returns a * DOM element that you can use in the insertBefore. * @param {String/Number/Ext.dom.Element/HTMLElement} position Index, element id or element you want * to put this component before. * @return {HTMLElement} DOM element that you can use in the insertBefore */ getInsertPosition: function(position) { // Convert the position to an element to insert before if (position !== undefined) { if (Ext.isNumber(position)) { position = this.container.dom.childNodes[position]; } else { position = Ext.getDom(position); } } return position; }, getRenderTree: function() { var me = this; if (!me.hasListeners.beforerender || me.fireEvent('beforerender', me) !== false) { me.beforeRender(); // Flag to let the layout's finishRenderItems and afterFinishRenderItems // know which items to process me.rendering = true; if (me.el) { // Since we are producing a render tree, we produce a "proxy el" that will // sit in the rendered DOM precisely where me.el belongs. We replace the // proxy el in the finishRender phase. return { tag: 'div', id: (me.$pid = Ext.id()) }; } return me.getElConfig(); } return null; }, initContainer: function(container) { var me = this; // If you render a component specifying the el, we get the container // of the el, and make sure we dont move the el around in the dom // during the render if (!container && me.el) { container = me.el.dom.parentNode; me.allowDomMove = false; } me.container = container.dom ? container : Ext.get(container); return me.container; }, /** * Initialized the renderData to be used when rendering the renderTpl. * @return {Object} Object with keys and values that are going to be applied to the renderTpl * @protected */ initRenderData: function() { var me = this; return Ext.apply({ $comp: me, id: me.id, ui: me.ui, uiCls: me.uiCls, baseCls: me.baseCls, componentCls: me.componentCls, frame: me.frame, childElCls: '' // overridden in RTL }, me.renderData); }, /** * Initializes the renderTpl. * @return {Ext.XTemplate} The renderTpl XTemplate instance. * @private */ initRenderTpl: function() { var tpl = this.getTpl('renderTpl'); if (tpl && !tpl.renderContent) { this.setupRenderTpl(tpl); } return tpl; }, /** * Template method called when this Component's DOM structure is created. * * At this point, this Component's (and all descendants') DOM structure *exists* but it has not * been layed out (positioned and sized). * * Subclasses which override this to gain access to the structure at render time should * call the parent class's method before attempting to access any child elements of the Component. * * @param {Ext.core.Element} parentNode The parent Element in which this Component's encapsulating element is contained. * @param {Number} containerIdx The index within the parent Container's child collection of this Component. * * @template * @protected */ onRender: function(parentNode, containerIdx) { var me = this, x = me.x, y = me.y, lastBox = null, width, height, el = me.el; me.applyRenderSelectors(); // Flag set on getRenderTree to flag to the layout's postprocessing routine that // the Component is in the process of being rendered and needs postprocessing. me.rendering = null; me.rendered = true; // We need to remember these to avoid writing them during the initial layout: if (x != null) { lastBox = {x:x}; } if (y != null) { (lastBox = lastBox || {}).y = y; } // Framed components need their width/height to apply to the frame, which is // best handled in layout at present. // If we're using the content box model, we also cannot assign initial sizes since we do not know the border widths to subtract if (!me.getFrameInfo() && Ext.isBorderBox) { width = me.width; height = me.height; if (typeof width === 'number') { lastBox = lastBox || {}; lastBox.width = width; } if (typeof height === 'number') { lastBox = lastBox || {}; lastBox.height = height; } } me.lastBox = el.lastBox = lastBox; }, /** * Renders the Component into the passed HTML element. * * **If you are using a {@link Ext.container.Container Container} object to house this * Component, then do not use the render method.** * * A Container's child Components are rendered by that Container's * {@link Ext.container.Container#layout layout} manager when the Container is first rendered. * * If the Container is already rendered when a new child Component is added, you may need to call * the Container's {@link Ext.container.Container#doLayout doLayout} to refresh the view which * causes any unrendered child Components to be rendered. This is required so that you can add * multiple child components if needed while only refreshing the layout once. * * When creating complex UIs, it is important to remember that sizing and positioning * of child items is the responsibility of the Container's {@link Ext.container.Container#layout layout} * manager. If you expect child items to be sized in response to user interactions, you must * configure the Container with a layout manager which creates and manages the type of layout you * have in mind. * * **Omitting the Container's {@link Ext.Container#layout layout} config means that a basic * layout manager is used which does nothing but render child components sequentially into the * Container. No sizing or positioning will be performed in this situation.** * * @param {Ext.Element/HTMLElement/String} [container] The element this Component should be * rendered into. If it is being created from existing markup, this should be omitted. * @param {String/Number} [position] The element ID or DOM node index within the container **before** * which this component will be inserted (defaults to appending to the end of the container) */ render: function(container, position) { var me = this, el = me.el && (me.el = Ext.get(me.el)), // ensure me.el is wrapped vetoed, tree, nextSibling; Ext.suspendLayouts(); container = me.initContainer(container); nextSibling = me.getInsertPosition(position); if (!el) { tree = me.getRenderTree(); if (me.ownerLayout && me.ownerLayout.transformItemRenderTree) { tree = me.ownerLayout.transformItemRenderTree(tree); } // tree will be null if a beforerender listener returns false if (tree) { if (nextSibling) { el = Ext.DomHelper.insertBefore(nextSibling, tree); } else { el = Ext.DomHelper.append(container, tree); } me.wrapPrimaryEl(el); } } else { if (!me.hasListeners.beforerender || me.fireEvent('beforerender', me) !== false) { me.beforeRender(); // Set configured styles on pre-rendered Component's element me.initStyles(el); if (me.allowDomMove !== false) { if (nextSibling) { container.dom.insertBefore(el.dom, nextSibling); } else { container.dom.appendChild(el.dom); } } } else { vetoed = true; } } if (el && !vetoed) { me.finishRender(position); } Ext.resumeLayouts(!me.hidden && !container.isDetachedBody); }, /** * Ensures that this component is attached to `document.body`. If the component was * rendered to {@link Ext#getDetachedBody}, then it will be appended to `document.body`. * Any configured position is also restored. * @param {Boolean} [runLayout=false] True to run the component's layout. */ ensureAttachedToBody: function (runLayout) { var comp = this, body; while (comp.ownerCt) { comp = comp.ownerCt; } if (comp.container.isDetachedBody) { comp.container = body = Ext.getBody(); body.appendChild(comp.el.dom); if (runLayout) { comp.updateLayout(); } if (typeof comp.x == 'number' || typeof comp.y == 'number') { comp.setPosition(comp.x, comp.y); } } }, setupRenderTpl: function (renderTpl) { renderTpl.renderBody = renderTpl.renderContent = this.doRenderContent; }, wrapPrimaryEl: function (dom) { this.el = Ext.get(dom, true); }, /** * @private */ initFrame : function() { if (Ext.supports.CSS3BorderRadius || !this.frame) { return; } var me = this, frameInfo = me.getFrameInfo(), frameTpl, frameGenId, frameElNames = me.frameElNames, len = frameElNames.length, i, frameData, suffix; if (frameInfo) { frameTpl = me.getFrameTpl(frameInfo.table); frameData = me.getFrameRenderData(); frameGenId = frameData.fgid; // Here we render the frameTpl to this component. This inserts the 9point div // or the table framing. frameTpl.insertFirst(me.el, frameData); // The frameBody is returned in getTargetEl, so that layouts render items to // the correct target. me.frameBody = me.el.down('.' + me.frameCls + '-mc'); // Clean out the childEls for the old frame elements (the majority of the els) me.removeChildEls(function (c) { return c.id && me.frameIdRegex.test(c.id); }); // Grab references to the childEls for each of the new frame elements for (i = 0; i < len; i++) { suffix = frameElNames[i]; me['frame' + suffix] = me.el.getById(frameGenId + suffix); } } }, getFrameRenderData: function () { var me = this, // we are only called if framing so this has already been determined: frameInfo = me.frameSize, frameGenId = (me.frameGenId || 0) + 1; // since we render id's into the markup and id's NEED to be unique, we have a // simple strategy for numbering their generations. me.frameGenId = frameGenId; return { $comp: me, fgid: me.id + '-frame' + frameGenId, ui: me.ui, uiCls: me.uiCls, frameCls: me.frameCls, baseCls: me.baseCls, top: !!frameInfo.top, left: !!frameInfo.left, right: !!frameInfo.right, bottom: !!frameInfo.bottom, // can be optionally set by a subclass or override to be an extra class to // be applied to all framing elements (used by RTL) frameElCls: '' }; }, updateFrame: function() { if (Ext.supports.CSS3BorderRadius || !this.frame) { return; } var me = this, wasTable = me.frameSize && me.frameSize.table, oldFrameTL = me.frameTL, oldFrameBL = me.frameBL, oldFrameML = me.frameML, oldFrameMC = me.frameMC, newMCClassName; me.initFrame(); if (oldFrameMC) { if (me.frame) { // Store the class names set on the new MC newMCClassName = me.frameMC.dom.className; // Framing elements have been selected in initFrame, no need to run applyRenderSelectors // Replace the new mc with the old mc oldFrameMC.insertAfter(me.frameMC); me.frameMC.remove(); // Restore the reference to the old frame mc as the framebody me.frameBody = me.frameMC = oldFrameMC; // Apply the new mc classes to the old mc element oldFrameMC.dom.className = newMCClassName; // Remove the old framing if (wasTable) { me.el.query('> table')[1].remove(); } else { if (oldFrameTL) { oldFrameTL.remove(); } if (oldFrameBL) { oldFrameBL.remove(); } if (oldFrameML) { oldFrameML.remove(); } } } } else if (me.frame) { me.applyRenderSelectors(); } }, /** * @private * On render, reads an encoded style attribute, "filter" from the style of this Component's element. * This information is memoized based upon the CSS class name of this Component's element. * Because child Components are rendered as textual HTML as part of the topmost Container, a dummy div is inserted * into the document to receive the document element's CSS class name, and therefore style attributes. */ getFrameInfo: function() { // If native framing can be used, or this component is not going to be framed, then do not attempt to read CSS framing info. if (Ext.supports.CSS3BorderRadius || !this.frame) { return false; } var me = this, frameInfoCache = me.frameInfoCache, cls = me.getFramingInfoCls() + '-frameInfo', frameInfo = frameInfoCache[cls], max = Math.max, styleEl, match, info, frameTop, frameRight, frameBottom, frameLeft, borderWidthT, borderWidthR, borderWidthB, borderWidthL, paddingT, paddingR, paddingB, paddingL, borderRadiusTL, borderRadiusTR, borderRadiusBR, borderRadiusBL; if (frameInfo == null) { // Get the singleton frame style proxy with our el class name stamped into it. styleEl = Ext.fly(me.getStyleProxy(cls), 'frame-style-el'); info = styleEl.getStyle('font-family'); if (info) { // The framing data is encoded as // // D=div|T=table // | H=horz|V=vert // | | // | | // [DT][HV]-[T-R-B-L]-[T-R-B-L]-[T-R-B-L] // / / | | \ \ // / / | | \ \ // / / / \ \ \ // / / border-width \ \ // border-radius padding // // The first 2 chars hold the div/table and horizontal/vertical flags. // The 3 sets of TRBL 4-tuples are the CSS3 values for border-radius, // border-width and padding, respectively. // info = info.split('-'); borderRadiusTL = parseInt(info[1], 10); borderRadiusTR = parseInt(info[2], 10); borderRadiusBR = parseInt(info[3], 10); borderRadiusBL = parseInt(info[4], 10); borderWidthT = parseInt(info[5], 10); borderWidthR = parseInt(info[6], 10); borderWidthB = parseInt(info[7], 10); borderWidthL = parseInt(info[8], 10); paddingT = parseInt(info[9], 10); paddingR = parseInt(info[10], 10); paddingB = parseInt(info[11], 10); paddingL = parseInt(info[12], 10); // This calculation should follow ext-theme-base/etc/mixins/frame.css // with respect to the CSS3 equivalent formulation: frameTop = max(borderWidthT, max(borderRadiusTL, borderRadiusTR)); frameRight = max(borderWidthR, max(borderRadiusTR, borderRadiusBR)); frameBottom = max(borderWidthB, max(borderRadiusBL, borderRadiusBR)); frameLeft = max(borderWidthL, max(borderRadiusTL, borderRadiusBL)); frameInfo = { table: info[0].charAt(0) === 't', vertical: info[0].charAt(1) === 'v', top: frameTop, right: frameRight, bottom: frameBottom, left: frameLeft, width: frameLeft + frameRight, height: frameTop + frameBottom, maxWidth: max(frameTop, frameRight, frameBottom, frameLeft), border: { top: borderWidthT, right: borderWidthR, bottom: borderWidthB, left: borderWidthL, width: borderWidthL + borderWidthR, height: borderWidthT + borderWidthB }, padding: { top: paddingT, right: paddingR, bottom: paddingB, left: paddingL, width: paddingL + paddingR, height: paddingT + paddingB }, radius: { tl: borderRadiusTL, tr: borderRadiusTR, br: borderRadiusBR, bl: borderRadiusBL } }; } else { frameInfo = false; } // This happens when you set frame: true explicitly without using the x-frame mixin in sass. // This way IE can't figure out what sizes to use and thus framing can't work. if (me.frame === true && !frameInfo) { Ext.log.error('You have set frame: true explicity on this component (' + me.getXType() + ') and it ' + 'does not have any framing defined in the CSS template. In this case IE cannot figure out ' + 'what sizes to use and thus framing on this component will be disabled.'); } frameInfoCache[cls] = frameInfo; } me.frame = !!frameInfo; me.frameSize = frameInfo; return frameInfo; }, getFramingInfoCls: function(){ return this.baseCls + '-' + this.ui; }, /** * @private * Returns an offscreen div with the same class name as the element this is being rendered. * This is because child item rendering takes place in a detached div which, being not * part of the document, has no styling. */ getStyleProxy: function(cls) { var result = this.styleProxyEl || (Ext.AbstractComponent.prototype.styleProxyEl = Ext.getBody().createChild({ style: { position: 'absolute', top: '-10000px' } }, null, true)); result.className = cls; return result; }, /** * @private */ getFrameTpl : function(table) { return this.getTpl(table ? 'frameTableTpl' : 'frameTpl'); }, // Cache the frame information object so as not to cause style recalculations frameInfoCache: {} }); /** * @class Ext.state.Provider *

Abstract base class for state provider implementations. The provider is responsible * for setting values and extracting values to/from the underlying storage source. The * storage source can vary and the details should be implemented in a subclass. For example * a provider could use a server side database or the browser localstorage where supported.

* *

This class provides methods for encoding and decoding typed variables including * dates and defines the Provider interface. By default these methods put the value and the * type information into a delimited string that can be stored. These should be overridden in * a subclass if you want to change the format of the encoded value and subsequent decoding.

*/ Ext.define('Ext.state.Provider', { mixins: { observable: Ext.util.Observable }, /** * @cfg {String} prefix A string to prefix to items stored in the underlying state store. * Defaults to 'ext-' */ prefix: 'ext-', constructor : function(config){ config = config || {}; var me = this; Ext.apply(me, config); /** * @event statechange * Fires when a state change occurs. * @param {Ext.state.Provider} this This state provider * @param {String} key The state key which was changed * @param {String} value The encoded value for the state */ me.addEvents("statechange"); me.state = {}; me.mixins.observable.constructor.call(me); }, /** * Returns the current value for a key * @param {String} name The key name * @param {Object} defaultValue A default value to return if the key's value is not found * @return {Object} The state data */ get : function(name, defaultValue){ return typeof this.state[name] == "undefined" ? defaultValue : this.state[name]; }, /** * Clears a value from the state * @param {String} name The key name */ clear : function(name){ var me = this; delete me.state[name]; me.fireEvent("statechange", me, name, null); }, /** * Sets the value for a key * @param {String} name The key name * @param {Object} value The value to set */ set : function(name, value){ var me = this; me.state[name] = value; me.fireEvent("statechange", me, name, value); }, /** * Decodes a string previously encoded with {@link #encodeValue}. * @param {String} value The value to decode * @return {Object} The decoded value */ decodeValue : function(value){ // a -> Array // n -> Number // d -> Date // b -> Boolean // s -> String // o -> Object // -> Empty (null) var me = this, re = /^(a|n|d|b|s|o|e)\:(.*)$/, matches = re.exec(unescape(value)), all, type, keyValue, values, vLen, v; if(!matches || !matches[1]){ return; // non state } type = matches[1]; value = matches[2]; switch (type) { case 'e': return null; case 'n': return parseFloat(value); case 'd': return new Date(Date.parse(value)); case 'b': return (value == '1'); case 'a': all = []; if(value != ''){ values = value.split('^'); vLen = values.length; for (v = 0; v < vLen; v++) { value = values[v]; all.push(me.decodeValue(value)); } } return all; case 'o': all = {}; if(value != ''){ values = value.split('^'); vLen = values.length; for (v = 0; v < vLen; v++) { value = values[v]; keyValue = value.split('='); all[keyValue[0]] = me.decodeValue(keyValue[1]); } } return all; default: return value; } }, /** * Encodes a value including type information. Decode with {@link #decodeValue}. * @param {Object} value The value to encode * @return {String} The encoded value */ encodeValue : function(value){ var flat = '', i = 0, enc, len, key; if (value == null) { return 'e:1'; } else if(typeof value == 'number') { enc = 'n:' + value; } else if(typeof value == 'boolean') { enc = 'b:' + (value ? '1' : '0'); } else if(Ext.isDate(value)) { enc = 'd:' + value.toGMTString(); } else if(Ext.isArray(value)) { for (len = value.length; i < len; i++) { flat += this.encodeValue(value[i]); if (i != len - 1) { flat += '^'; } } enc = 'a:' + flat; } else if (typeof value == 'object') { for (key in value) { if (typeof value[key] != 'function' && value[key] !== undefined) { flat += key + '=' + this.encodeValue(value[key]) + '^'; } } enc = 'o:' + flat.substring(0, flat.length-1); } else { enc = 's:' + value; } return escape(enc); } }); /** * @class Ext.state.Manager * This is the global state manager. By default all components that are "state aware" check this class * for state information if you don't pass them a custom state provider. In order for this class * to be useful, it must be initialized with a provider when your application initializes. Example usage:

// in your initialization function
init : function(){
   Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
}
 
* This class passes on calls from components to the underlying {@link Ext.state.Provider} so that * there is a common interface that can be used without needing to refer to a specific provider instance * in every component. * @singleton * @docauthor Evan Trimboli */ Ext.define('Ext.state.Manager', { singleton: true, constructor: function() { this.provider = new Ext.state.Provider(); }, /** * Configures the default state provider for your application * @param {Ext.state.Provider} stateProvider The state provider to set */ setProvider : function(stateProvider){ this.provider = stateProvider; }, /** * Returns the current value for a key * @param {String} name The key name * @param {Object} defaultValue The default value to return if the key lookup does not match * @return {Object} The state data */ get : function(key, defaultValue){ return this.provider.get(key, defaultValue); }, /** * Sets the value for a key * @param {String} name The key name * @param {Object} value The state data */ set : function(key, value){ this.provider.set(key, value); }, /** * Clears a value from the state * @param {String} name The key name */ clear : function(key){ this.provider.clear(key); }, /** * Gets the currently configured state provider * @return {Ext.state.Provider} The state provider */ getProvider : function(){ return this.provider; } }); /** * @class Ext.state.Stateful * A mixin for being able to save the state of an object to an underlying * {@link Ext.state.Provider}. */ Ext.define('Ext.state.Stateful', { /* Begin Definitions */ mixins: { observable: Ext.util.Observable }, /* End Definitions */ /** * @cfg {Boolean} stateful * A flag which causes the object to attempt to restore the state of * internal properties from a saved state on startup. The object must have * a {@link #stateId} for state to be managed. * * Auto-generated ids are not guaranteed to be stable across page loads and * cannot be relied upon to save and restore the same state for a object. * * For state saving to work, the state manager's provider must have been * set to an implementation of {@link Ext.state.Provider} which overrides the * {@link Ext.state.Provider#set set} and {@link Ext.state.Provider#get get} * methods to save and recall name/value pairs. A built-in implementation, * {@link Ext.state.CookieProvider} is available. * * To set the state provider for the current page: * * Ext.state.Manager.setProvider(new Ext.state.CookieProvider({ * expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now * })); * * A stateful object attempts to save state when one of the events * listed in the {@link #stateEvents} configuration fires. * * To save state, a stateful object first serializes its state by * calling *{@link #getState}*. * * The Component base class implements {@link #getState} to save its width and height within the state * only if they were initially configured, and have changed from the configured value. * * The Panel class saves its collapsed state in addition to that. * * The Grid class saves its column state in addition to its superclass state. * * If there is more application state to be save, the developer must provide an implementation which * first calls the superclass method to inherit the above behaviour, and then injects new properties * into the returned object. * * The value yielded by getState is passed to {@link Ext.state.Manager#set} * which uses the configured {@link Ext.state.Provider} to save the object * keyed by the {@link #stateId}. * * During construction, a stateful object attempts to *restore* its state by calling * {@link Ext.state.Manager#get} passing the {@link #stateId} * * The resulting object is passed to {@link #applyState}*. The default implementation of * {@link #applyState} simply copies properties into the object, but a developer may * override this to support restoration of more complex application state. * * You can perform extra processing on state save and restore by attaching * handlers to the {@link #beforestaterestore}, {@link #staterestore}, * {@link #beforestatesave} and {@link #statesave} events. */ stateful: false, /** * @cfg {String} stateId * The unique id for this object to use for state management purposes. *

See {@link #stateful} for an explanation of saving and restoring state.

*/ /** * @cfg {String[]} stateEvents *

An array of events that, when fired, should trigger this object to * save its state. Defaults to none. stateEvents may be any type * of event supported by this object, including browser or custom events * (e.g., ['click', 'customerchange']).

*

See {@link #stateful} for an explanation of saving and * restoring object state.

*/ /** * @cfg {Number} saveDelay * A buffer to be applied if many state events are fired within a short period. */ saveDelay: 100, constructor: function(config) { var me = this; config = config || {}; if (config.stateful !== undefined) { me.stateful = config.stateful; } if (config.saveDelay !== undefined) { me.saveDelay = config.saveDelay; } me.stateId = me.stateId || config.stateId; if (!me.stateEvents) { me.stateEvents = []; } if (config.stateEvents) { me.stateEvents.concat(config.stateEvents); } this.addEvents( /** * @event beforestaterestore * Fires before the state of the object is restored. Return false from an event handler to stop the restore. * @param {Ext.state.Stateful} this * @param {Object} state The hash of state values returned from the StateProvider. If this * event is not vetoed, then the state object is passed to applyState. By default, * that simply copies property values into this object. The method maybe overriden to * provide custom state restoration. */ 'beforestaterestore', /** * @event staterestore * Fires after the state of the object is restored. * @param {Ext.state.Stateful} this * @param {Object} state The hash of state values returned from the StateProvider. This is passed * to applyState. By default, that simply copies property values into this * object. The method maybe overriden to provide custom state restoration. */ 'staterestore', /** * @event beforestatesave * Fires before the state of the object is saved to the configured state provider. Return false to stop the save. * @param {Ext.state.Stateful} this * @param {Object} state The hash of state values. This is determined by calling * getState() on the object. This method must be provided by the * developer to return whetever representation of state is required, by default, Ext.state.Stateful * has a null implementation. */ 'beforestatesave', /** * @event statesave * Fires after the state of the object is saved to the configured state provider. * @param {Ext.state.Stateful} this * @param {Object} state The hash of state values. This is determined by calling * getState() on the object. This method must be provided by the * developer to return whetever representation of state is required, by default, Ext.state.Stateful * has a null implementation. */ 'statesave' ); me.mixins.observable.constructor.call(me); if (me.stateful !== false) { me.addStateEvents(me.stateEvents); me.initState(); } }, /** * Add events that will trigger the state to be saved. If the first argument is an * array, each element of that array is the name of a state event. Otherwise, each * argument passed to this method is the name of a state event. * * @param {String/String[]} events The event name or an array of event names. */ addStateEvents: function (events) { var me = this, i, event, stateEventsByName; if (me.stateful && me.getStateId()) { if (typeof events == 'string') { events = Array.prototype.slice.call(arguments, 0); } stateEventsByName = me.stateEventsByName || (me.stateEventsByName = {}); for (i = events.length; i--; ) { event = events[i]; if (!stateEventsByName[event]) { stateEventsByName[event] = 1; me.on(event, me.onStateChange, me); } } } }, /** * This method is called when any of the {@link #stateEvents} are fired. * @private */ onStateChange: function(){ var me = this, delay = me.saveDelay, statics, runner; if (!me.stateful) { return; } if (delay) { if (!me.stateTask) { statics = Ext.state.Stateful; runner = statics.runner || (statics.runner = new Ext.util.TaskRunner()); me.stateTask = runner.newTask({ run: me.saveState, scope: me, interval: delay, repeat: 1 }); } me.stateTask.start(); } else { me.saveState(); } }, /** * Saves the state of the object to the persistence store. */ saveState: function() { var me = this, id = me.stateful && me.getStateId(), hasListeners = me.hasListeners, state; if (id) { state = me.getState() || {}; //pass along for custom interactions if (!hasListeners.beforestatesave || me.fireEvent('beforestatesave', me, state) !== false) { Ext.state.Manager.set(id, state); if (hasListeners.statesave) { me.fireEvent('statesave', me, state); } } } }, /** * Gets the current state of the object. By default this function returns null, * it should be overridden in subclasses to implement methods for getting the state. * @return {Object} The current state */ getState: function(){ return null; }, /** * Applies the state to the object. This should be overridden in subclasses to do * more complex state operations. By default it applies the state properties onto * the current object. * @param {Object} state The state */ applyState: function(state) { if (state) { Ext.apply(this, state); } }, /** * Gets the state id for this object. * @return {String} The 'stateId' or the implicit 'id' specified by component configuration. * @private */ getStateId: function() { var me = this; return me.stateId || (me.autoGenId ? null : me.id); }, /** * Initializes the state of the object upon construction. * @private */ initState: function(){ var me = this, id = me.stateful && me.getStateId(), hasListeners = me.hasListeners, state; if (id) { state = Ext.state.Manager.get(id); if (state) { state = Ext.apply({}, state); if (!hasListeners.beforestaterestore || me.fireEvent('beforestaterestore', me, state) !== false) { me.applyState(state); if (hasListeners.staterestore) { me.fireEvent('staterestore', me, state); } } } } }, /** * Conditionally saves a single property from this object to the given state object. * The idea is to only save state which has changed from the initial state so that * current software settings do not override future software settings. Only those * values that are user-changed state should be saved. * * @param {String} propName The name of the property to save. * @param {Object} state The state object in to which to save the property. * @param {String} stateName (optional) The name to use for the property in state. * @return {Boolean} True if the property was saved, false if not. */ savePropToState: function (propName, state, stateName) { var me = this, value = me[propName], config = me.initialConfig; if (me.hasOwnProperty(propName)) { if (!config || config[propName] !== value) { if (state) { state[stateName || propName] = value; } return true; } } return false; }, /** * Gathers additional named properties of the instance and adds their current values * to the passed state object. * @param {String/String[]} propNames The name (or array of names) of the property to save. * @param {Object} state The state object in to which to save the property values. * @return {Object} state */ savePropsToState: function (propNames, state) { var me = this, i, n; if (typeof propNames == 'string') { me.savePropToState(propNames, state); } else { for (i = 0, n = propNames.length; i < n; ++i) { me.savePropToState(propNames[i], state); } } return state; }, /** * Destroys this stateful object. */ destroy: function(){ var me = this, task = me.stateTask; if (task) { task.destroy(); me.stateTask = null; } me.clearListeners(); } }); /** * An abstract base class which provides shared methods for Components across the Sencha product line. * * Please refer to sub class's documentation. * @private */ Ext.define('Ext.AbstractComponent', { /* Begin Definitions */ mixins: { positionable: Ext.util.Positionable , observable: Ext.util.Observable , animate: Ext.util.Animate , elementCt: Ext.util.ElementContainer , renderable: Ext.util.Renderable , state: Ext.state.Stateful }, // The "uses" property specifies class which are used in an instantiated AbstractComponent. // They do *not* have to be loaded before this class may be defined - that is what "requires" is for. statics: { AUTO_ID: 1000, pendingLayouts: null, layoutSuspendCount: 0, /** * Cancels layout of a component. * @param {Ext.Component} comp */ cancelLayout: function(comp, isDestroying) { var context = this.runningLayoutContext || this.pendingLayouts; if (context) { context.cancelComponent(comp, false, isDestroying); } }, /** * Performs all pending layouts that were scheduled while * {@link Ext.AbstractComponent#suspendLayouts suspendLayouts} was in effect. * @static */ flushLayouts: function () { var me = this, context = me.pendingLayouts; if (context && context.invalidQueue.length) { me.pendingLayouts = null; me.runningLayoutContext = context; Ext.override(context, { runComplete: function () { // we need to release the layout queue before running any of the // finishedLayout calls because they call afterComponentLayout // which can re-enter by calling doLayout/doComponentLayout. me.runningLayoutContext = null; var result = this.callParent(); // not "me" here! if (Ext.globalEvents.hasListeners.afterlayout) { Ext.globalEvents.fireEvent('afterlayout'); } return result; } }); context.run(); } }, /** * Resumes layout activity in the whole framework. * * {@link Ext#suspendLayouts} is alias of {@link Ext.AbstractComponent#suspendLayouts}. * * @param {Boolean} [flush=false] `true` to perform all the pending layouts. This can also be * achieved by calling {@link Ext.AbstractComponent#flushLayouts flushLayouts} directly. * @static */ resumeLayouts: function (flush) { if (this.layoutSuspendCount && ! --this.layoutSuspendCount) { if (flush) { this.flushLayouts(); } if (Ext.globalEvents.hasListeners.resumelayouts) { Ext.globalEvents.fireEvent('resumelayouts'); } } }, /** * Stops layouts from happening in the whole framework. * * It's useful to suspend the layout activity while updating multiple components and * containers: * * Ext.suspendLayouts(); * // batch of updates... * Ext.resumeLayouts(true); * * {@link Ext#suspendLayouts} is alias of {@link Ext.AbstractComponent#suspendLayouts}. * * See also {@link Ext#batchLayouts} for more abstract way of doing this. * * @static */ suspendLayouts: function () { ++this.layoutSuspendCount; }, /** * Updates layout of a component. * * @param {Ext.Component} comp The component to update. * @param {Boolean} [defer=false] `true` to just queue the layout if this component. * @static */ updateLayout: function (comp, defer) { var me = this, running = me.runningLayoutContext, pending; if (running) { running.queueInvalidate(comp); } else { pending = me.pendingLayouts || (me.pendingLayouts = new Ext.layout.Context()); pending.queueInvalidate(comp); if (!defer && !me.layoutSuspendCount && !comp.isLayoutSuspended()) { me.flushLayouts(); } } } }, /* End Definitions */ /** * @property {Boolean} isComponent * `true` in this class to identify an object as an instantiated Component, or subclass thereof. */ isComponent: true, /** * @private */ getAutoId: function() { this.autoGenId = true; return ++Ext.AbstractComponent.AUTO_ID; }, deferLayouts: false, /** * @cfg {String} id * The **unique id of this component instance.** * * It should not be necessary to use this configuration except for singleton objects in your application. Components * created with an `id` may be accessed globally using {@link Ext#getCmp Ext.getCmp}. * * Instead of using assigned ids, use the {@link #itemId} config, and {@link Ext.ComponentQuery ComponentQuery} * which provides selector-based searching for Sencha Components analogous to DOM querying. The {@link * Ext.container.Container Container} class contains {@link Ext.container.Container#down shortcut methods} to query * its descendant Components by selector. * * Note that this `id` will also be used as the element id for the containing HTML element that is rendered to the * page for this component. This allows you to write id-based CSS rules to style the specific instance of this * component uniquely, and also to select sub-elements using this component's `id` as the parent. * * **Note:** To avoid complications imposed by a unique `id` also see `{@link #itemId}`. * * **Note:** To access the container of a Component see `{@link #ownerCt}`. * * Defaults to an {@link #getId auto-assigned id}. * * @since 1.1.0 */ /** * @property {Boolean} autoGenId * `true` indicates an `id` was auto-generated rather than provided by configuration. * @private */ autoGenId: false, /** * @cfg {String} itemId * An `itemId` can be used as an alternative way to get a reference to a component when no object reference is * available. Instead of using an `{@link #id}` with {@link Ext}.{@link Ext#getCmp getCmp}, use `itemId` with * {@link Ext.container.Container}.{@link Ext.container.Container#getComponent getComponent} which will retrieve * `itemId`'s or {@link #id}'s. Since `itemId`'s are an index to the container's internal MixedCollection, the * `itemId` is scoped locally to the container -- avoiding potential conflicts with {@link Ext.ComponentManager} * which requires a **unique** `{@link #id}`. * * var c = new Ext.panel.Panel({ // * {@link Ext.Component#height height}: 300, * {@link #renderTo}: document.body, * {@link Ext.container.Container#layout layout}: 'auto', * {@link Ext.container.Container#cfg-items items}: [ * { * itemId: 'p1', * {@link Ext.panel.Panel#title title}: 'Panel 1', * {@link Ext.Component#height height}: 150 * }, * { * itemId: 'p2', * {@link Ext.panel.Panel#title title}: 'Panel 2', * {@link Ext.Component#height height}: 150 * } * ] * }) * p1 = c.{@link Ext.container.Container#getComponent getComponent}('p1'); // not the same as {@link Ext#getCmp Ext.getCmp()} * p2 = p1.{@link #ownerCt}.{@link Ext.container.Container#getComponent getComponent}('p2'); // reference via a sibling * * Also see {@link #id}, `{@link Ext.container.Container#query}`, `{@link Ext.container.Container#down}` and * `{@link Ext.container.Container#child}`. * * **Note**: to access the container of an item see {@link #ownerCt}. * * @since 3.4.0 */ /** * @property {Ext.Container} ownerCt * This Component's owner {@link Ext.container.Container Container} (is set automatically * when this Component is added to a Container). * * *Important.* This is not a universal upwards navigation pointer. It indicates the Container which owns and manages * this Component if any. There are other similar relationships such as the {@link Ext.button.Button button} which activates a {@link Ext.button.Button#cfg-menu menu}, or the * {@link Ext.menu.Item menu item} which activated a {@link Ext.menu.Item#cfg-menu submenu}, or the * {@link Ext.grid.column.Column column header} which activated the column menu. * * These differences are abstracted away by the {@link #up} method. * * **Note**: to access items within the Container see {@link #itemId}. * @readonly * @since 2.3.0 */ /** * @cfg {String/Object} autoEl * A tag name or {@link Ext.DomHelper DomHelper} spec used to create the {@link #getEl Element} which will * encapsulate this Component. * * You do not normally need to specify this. For the base classes {@link Ext.Component} and * {@link Ext.container.Container}, this defaults to **'div'**. The more complex Sencha classes use a more * complex DOM structure specified by their own {@link #renderTpl}s. * * This is intended to allow the developer to create application-specific utility Components encapsulated by * different DOM elements. Example usage: * * { * xtype: 'component', * autoEl: { * tag: 'img', * src: 'http://www.example.com/example.jpg' * } * }, { * xtype: 'component', * autoEl: { * tag: 'blockquote', * html: 'autoEl is cool!' * } * }, { * xtype: 'container', * autoEl: 'ul', * cls: 'ux-unordered-list', * items: { * xtype: 'component', * autoEl: 'li', * html: 'First list item' * } * } * * @since 2.3.0 */ /** * @cfg {Ext.XTemplate/String/String[]} renderTpl * An {@link Ext.XTemplate XTemplate} used to create the internal structure inside this Component's encapsulating * {@link #getEl Element}. * * You do not normally need to specify this. For the base classes {@link Ext.Component} and * {@link Ext.container.Container}, this defaults to **`null`** which means that they will be initially rendered * with no internal structure; they render their {@link #getEl Element} empty. The more specialized Ext JS and Sencha Touch * classes which use a more complex DOM structure, provide their own template definitions. * * This is intended to allow the developer to create application-specific utility Components with customized * internal structure. * * Upon rendering, any created child elements may be automatically imported into object properties using the * {@link #renderSelectors} and {@link #cfg-childEls} options. * @protected */ renderTpl: '{%this.renderContent(out,values)%}', /** * @cfg {Object} renderData * * The data used by {@link #renderTpl} in addition to the following property values of the component: * * - id * - ui * - uiCls * - baseCls * - componentCls * - frame * * See {@link #renderSelectors} and {@link #cfg-childEls} for usage examples. */ /** * @cfg {Object} renderSelectors * An object containing properties specifying {@link Ext.DomQuery DomQuery} selectors which identify child elements * created by the render process. * * After the Component's internal structure is rendered according to the {@link #renderTpl}, this object is iterated through, * and the found Elements are added as properties to the Component using the `renderSelector` property name. * * For example, a Component which renders a title and description into its element: * * Ext.create('Ext.Component', { * renderTo: Ext.getBody(), * renderTpl: [ * '

{title}

', * '

{desc}

' * ], * renderData: { * title: "Error", * desc: "Something went wrong" * }, * renderSelectors: { * titleEl: 'h1.title', * descEl: 'p' * }, * listeners: { * afterrender: function(cmp){ * // After rendering the component will have a titleEl and descEl properties * cmp.titleEl.setStyle({color: "red"}); * } * } * }); * * For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the * Component after render), see {@link #cfg-childEls} and {@link #addChildEls}. */ /** * @cfg {Object[]} childEls * An array describing the child elements of the Component. Each member of the array * is an object with these properties: * * - `name` - The property name on the Component for the child element. * - `itemId` - The id to combine with the Component's id that is the id of the child element. * - `id` - The id of the child element. * * If the array member is a string, it is equivalent to `{ name: m, itemId: m }`. * * For example, a Component which renders a title and body text: * * @example * Ext.create('Ext.Component', { * renderTo: Ext.getBody(), * renderTpl: [ * '

{title}

', * '

{msg}

', * ], * renderData: { * title: "Error", * msg: "Something went wrong" * }, * childEls: ["title"], * listeners: { * afterrender: function(cmp){ * // After rendering the component will have a title property * cmp.title.setStyle({color: "red"}); * } * } * }); * * A more flexible, but somewhat slower, approach is {@link #renderSelectors}. */ /** * @cfg {String/HTMLElement/Ext.Element} renderTo * Specify the `id` of the element, a DOM element or an existing Element that this component will be rendered into. * * **Notes:** * * Do *not* use this option if the Component is to be a child item of a {@link Ext.container.Container Container}. * It is the responsibility of the {@link Ext.container.Container Container}'s * {@link Ext.container.Container#layout layout manager} to render and manage its child items. * * When using this config, a call to `render()` is not required. * * See also: {@link #method-render}. * * @since 2.3.0 */ /** * @cfg {Boolean} frame * Specify as `true` to have the Component inject framing elements within the Component at render time to provide a * graphical rounded frame around the Component content. * * This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet * Explorer prior to version 9 which do not support rounded corners natively. * * The extra space taken up by this framing is available from the read only property {@link #frameSize}. */ /** * @property {Object} frameSize * @readonly * Indicates the width of any framing elements which were added within the encapsulating * element to provide graphical, rounded borders. See the {@link #frame} config. This * property is `null` if the component is not framed. * * This is an object containing the frame width in pixels for all four sides of the * Component containing the following properties: * * @property {Number} [frameSize.top=0] The width of the top framing element in pixels. * @property {Number} [frameSize.right=0] The width of the right framing element in pixels. * @property {Number} [frameSize.bottom=0] The width of the bottom framing element in pixels. * @property {Number} [frameSize.left=0] The width of the left framing element in pixels. * @property {Number} [frameSize.width=0] The total width of the left and right framing elements in pixels. * @property {Number} [frameSize.height=0] The total height of the top and right bottom elements in pixels. */ frameSize: null, /** * @cfg {String/Object} componentLayout * The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout * manager which sizes a Component's internal structure in response to the Component being sized. * * Generally, developers will not use this configuration as all provided Components which need their internal * elements sizing (Such as {@link Ext.form.field.Base input fields}) come with their own componentLayout managers. * * The {@link Ext.layout.container.Auto default layout manager} will be used on instances of the base Ext.Component * class which simply sizes the Component's encapsulating element to the height and width specified in the * {@link #setSize} method. */ /** * @cfg {Ext.XTemplate/Ext.Template/String/String[]} tpl * An {@link Ext.Template}, {@link Ext.XTemplate} or an array of strings to form an Ext.XTemplate. Used in * conjunction with the `{@link #data}` and `{@link #tplWriteMode}` configurations. * * @since 3.4.0 */ /** * @cfg {Object} data * The initial set of data to apply to the `{@link #tpl}` to update the content area of the Component. * * @since 3.4.0 */ /** * @cfg {Ext.enums.Widget} xtype * This property provides a shorter alternative to creating objects than using a full * class name. Using `xtype` is the most common way to define component instances, * especially in a container. For example, the items in a form containing text fields * could be created explicitly like so: * * items: [ * Ext.create('Ext.form.field.Text', { * fieldLabel: 'Foo' * }), * Ext.create('Ext.form.field.Text', { * fieldLabel: 'Bar' * }), * Ext.create('Ext.form.field.Number', { * fieldLabel: 'Num' * }) * ] * * But by using `xtype`, the above becomes: * * items: [ * { * xtype: 'textfield', * fieldLabel: 'Foo' * }, * { * xtype: 'textfield', * fieldLabel: 'Bar' * }, * { * xtype: 'numberfield', * fieldLabel: 'Num' * } * ] * * When the `xtype` is common to many items, {@link Ext.container.AbstractContainer#defaultType} * is another way to specify the `xtype` for all items that don't have an explicit `xtype`: * * defaultType: 'textfield', * items: [ * { fieldLabel: 'Foo' }, * { fieldLabel: 'Bar' }, * { fieldLabel: 'Num', xtype: 'numberfield' } * ] * * Each member of the `items` array is now just a "configuration object". These objects * are used to create and configure component instances. A configuration object can be * manually used to instantiate a component using {@link Ext#widget}: * * var text1 = Ext.create('Ext.form.field.Text', { * fieldLabel: 'Foo' * }); * * // or alternatively: * * var text1 = Ext.widget({ * xtype: 'textfield', * fieldLabel: 'Foo' * }); * * This conversion of configuration objects into instantiated components is done when * a container is created as part of its {Ext.container.AbstractContainer#initComponent} * process. As part of the same process, the `items` array is converted from its raw * array form into a {@link Ext.util.MixedCollection} instance. * * You can define your own `xtype` on a custom {@link Ext.Component component} by specifying * the `xtype` property in {@link Ext#define}. For example: * * Ext.define('MyApp.PressMeButton', { * extend: 'Ext.button.Button', * xtype: 'pressmebutton', * text: 'Press Me' * }); * * Care should be taken when naming an `xtype` in a custom component because there is * a single, shared scope for all xtypes. Third part components should consider using * a prefix to avoid collisions. * * Ext.define('Foo.form.CoolButton', { * extend: 'Ext.button.Button', * xtype: 'ux-coolbutton', * text: 'Cool!' * }); * * See {@link Ext.enums.Widget} for list of all available xtypes. * * @since 2.3.0 */ /** * @cfg {String} tplWriteMode * The Ext.(X)Template method to use when updating the content area of the Component. * See `{@link Ext.XTemplate#overwrite}` for information on default mode. * * @since 3.4.0 */ tplWriteMode: 'overwrite', /** * @cfg {String} [baseCls='x-component'] * The base CSS class to apply to this component's element. This will also be prepended to elements within this * component like Panel's body will get a class `x-panel-body`. This means that if you create a subclass of Panel, and * you want it to get all the Panels styling for the element and the body, you leave the `baseCls` `x-panel` and use * `componentCls` to add specific styling for this component. */ baseCls: Ext.baseCSSPrefix + 'component', /** * @cfg {String} componentCls * CSS Class to be added to a components root level element to give distinction to it via styling. */ /** * @cfg {String} [cls=''] * An optional extra CSS class that will be added to this component's Element. This can be useful * for adding customized styles to the component or any of its children using standard CSS rules. * * @since 1.1.0 */ /** * @cfg {String} [overCls=''] * An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, * and removed when the mouse moves out. This can be useful for adding customized 'active' or 'hover' styles to the * component or any of its children using standard CSS rules. * * @since 2.3.0 */ /** * @cfg {String} [disabledCls='x-item-disabled'] * CSS class to add when the Component is disabled. */ disabledCls: Ext.baseCSSPrefix + 'item-disabled', /** * @cfg {String} ui * A UI style for a component. */ ui: 'default', /** * @cfg {String[]} uiCls * An array of of `classNames` which are currently applied to this component. * @private */ uiCls: [], /** * @cfg {String/Object} style * A custom style specification to be applied to this component's Element. Should be a valid argument to * {@link Ext.Element#applyStyles}. * * new Ext.panel.Panel({ * title: 'Some Title', * renderTo: Ext.getBody(), * width: 400, height: 300, * layout: 'form', * items: [{ * xtype: 'textarea', * style: { * width: '95%', * marginBottom: '10px' * } * }, * new Ext.button.Button({ * text: 'Send', * minWidth: '100', * style: { * marginBottom: '10px' * } * }) * ] * }); * * @since 1.1.0 */ /** * @cfg {Number} width * The width of this component in pixels. */ /** * @cfg {Number} height * The height of this component in pixels. */ /** * @cfg {Number/String/Boolean} border * Specifies the border size for this component. The border can be a single numeric value to apply to all sides or it can * be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left). * * For components that have no border by default, setting this won't make the border appear by itself. * You also need to specify border color and style: * * border: 5, * style: { * borderColor: 'red', * borderStyle: 'solid' * } * * To turn off the border, use `border: false`. */ /** * @cfg {Number/String} padding * Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it * can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left). */ /** * @cfg {Number/String} margin * Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can * be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left). */ /** * @cfg {Boolean} hidden * `true` to hide the component. * @since 2.3.0 */ hidden: false, /** * @cfg {Boolean} disabled * `true` to disable the component. * @since 2.3.0 */ disabled: false, /** * @cfg {Boolean} [draggable=false] * Allows the component to be dragged. */ /** * @property {Boolean} draggable * Indicates whether or not the component can be dragged. * @readonly */ draggable: false, /** * @cfg {Boolean} floating * Create the Component as a floating and use absolute positioning. * * The z-index of floating Components is handled by a ZIndexManager. If you simply render a floating Component into the DOM, it will be managed * by the global {@link Ext.WindowManager WindowManager}. * * If you include a floating Component as a child item of a Container, then upon render, Ext JS will seek an ancestor floating Component to house a new * ZIndexManager instance to manage its descendant floaters. If no floating ancestor can be found, the global WindowManager will be used. * * When a floating Component which has a ZindexManager managing descendant floaters is destroyed, those descendant floaters will also be destroyed. */ floating: false, /** * @cfg {String} hideMode * A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be: * * - `'display'` : The Component will be hidden using the `display: none` style. * - `'visibility'` : The Component will be hidden using the `visibility: hidden` style. * - `'offsets'` : The Component will be hidden by absolutely positioning it out of the visible area of the document. * This is useful when a hidden Component must maintain measurable dimensions. Hiding using `display` results in a * Component having zero dimensions. * * @since 1.1.0 */ hideMode: 'display', /** * @cfg {String} contentEl * Specify an existing HTML element, or the `id` of an existing HTML element to use as the content for this component. * * This config option is used to take an existing HTML element and place it in the layout element of a new component * (it simply moves the specified DOM element _after the Component is rendered_ to use as the content. * * **Notes:** * * The specified HTML element is appended to the layout element of the component _after any configured * {@link #html HTML} has been inserted_, and so the document will not contain this element at the time * the {@link #event-render} event is fired. * * The specified HTML element used will not participate in any **`{@link Ext.container.Container#layout layout}`** * scheme that the Component may use. It is just HTML. Layouts operate on child * **`{@link Ext.container.Container#cfg-items items}`**. * * Add either the `x-hidden` or the `x-hide-display` CSS class to prevent a brief flicker of the content before it * is rendered to the panel. * * @since 3.4.0 */ /** * @cfg {String/Object} [html=''] * An HTML fragment, or a {@link Ext.DomHelper DomHelper} specification to use as the layout element content. * The HTML content is added after the component is rendered, so the document will not contain this HTML at the time * the {@link #event-render} event is fired. This content is inserted into the body _before_ any configured {@link #contentEl} * is appended. * * @since 3.4.0 */ /** * @cfg {Number} minHeight * The minimum value in pixels which this Component will set its height to. * * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Number} minWidth * The minimum value in pixels which this Component will set its width to. * * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Number} maxHeight * The maximum value in pixels which this Component will set its height to. * * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Number} maxWidth * The maximum value in pixels which this Component will set its width to. * * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Ext.ComponentLoader/Object} loader * A configuration object or an instance of a {@link Ext.ComponentLoader} to load remote content * for this Component. * * Ext.create('Ext.Component', { * loader: { * url: 'content.html', * autoLoad: true * }, * renderTo: Ext.getBody() * }); */ /** * @cfg {Ext.ComponentLoader/Object/String/Boolean} autoLoad * An alias for {@link #loader} config which also allows to specify just a string which will be * used as the url that's automatically loaded: * * Ext.create('Ext.Component', { * autoLoad: 'content.html', * renderTo: Ext.getBody() * }); * * The above is the same as: * * Ext.create('Ext.Component', { * loader: { * url: 'content.html', * autoLoad: true * }, * renderTo: Ext.getBody() * }); * * Don't use it together with {@link #loader} config. * * @deprecated 4.1.1 Use {@link #loader} config instead. */ /** * @cfg {Boolean} autoShow * `true` to automatically show the component upon creation. This config option may only be used for * {@link #floating} components or components that use {@link #autoRender}. * * @since 2.3.0 */ autoShow: false, /** * @cfg {Boolean/String/HTMLElement/Ext.Element} autoRender * This config is intended mainly for non-{@link #cfg-floating} Components which may or may not be shown. Instead of using * {@link #renderTo} in the configuration, and rendering upon construction, this allows a Component to render itself * upon first _{@link Ext.Component#method-show show}_. If {@link #cfg-floating} is `true`, the value of this config is omitted as if it is `true`. * * Specify as `true` to have this Component render to the document body upon first show. * * Specify as an element, or the ID of an element to have this Component render to a specific element upon first * show. */ autoRender: false, // @private allowDomMove: true, /** * @cfg {Ext.AbstractPlugin[]/Ext.AbstractPlugin/Object[]/Object/Ext.enums.Plugin[]/Ext.enums.Plugin} plugins * An array of plugins to be added to this component. Can also be just a single plugin instead of array. * * Plugins provide custom functionality for a component. The only requirement for * a valid plugin is that it contain an `init` method that accepts a reference of type Ext.Component. When a component * is created, if any plugins are available, the component will call the init method on each plugin, passing a * reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide * its functionality. * * Plugins can be added to component by either directly referencing the plugin instance: * * plugins: [Ext.create('Ext.grid.plugin.CellEditing', {clicksToEdit: 1})], * * By using config object with ptype: * * plugins: [{ptype: 'cellediting', clicksToEdit: 1}], * * Or with just a ptype: * * plugins: ['cellediting', 'gridviewdragdrop'], * * See {@link Ext.enums.Plugin} for list of all ptypes. * * @since 2.3.0 */ /** * @property {Boolean} rendered * Indicates whether or not the component has been rendered. * @readonly * @since 1.1.0 */ rendered: false, /** * @property {Number} componentLayoutCounter * @private * The number of component layout calls made on this object. */ componentLayoutCounter: 0, /** * @cfg {Boolean/Number} [shrinkWrap=2] * * If this property is a number, it is interpreted as follows: * * - 0: Neither width nor height depend on content. This is equivalent to `false`. * - 1: Width depends on content (shrink wraps), but height does not. * - 2: Height depends on content (shrink wraps), but width does not. The default. * - 3: Both width and height depend on content (shrink wrap). This is equivalent to `true`. * * In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed * to a block-level element. Some container layouts always shrink-wrap their children, * effectively ignoring this property (e.g., {@link Ext.layout.container.HBox}, * {@link Ext.layout.container.VBox}, {@link Ext.layout.component.Dock}). */ shrinkWrap: 2, weight: 0, /** * @property {Boolean} maskOnDisable * This is an internal flag that you use when creating custom components. By default this is set to `true` which means * that every component gets a mask when it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab * override this property to `false` since they want to implement custom disable logic. */ maskOnDisable: true, /** * @property {Boolean} [_isLayoutRoot=false] * Setting this property to `true` causes the {@link #isLayoutRoot} method to return * `true` and stop the search for the top-most component for a layout. * @protected */ _isLayoutRoot: false, /** * @property {String} [contentPaddingProperty='padding'] * The name of the padding property that is used by the layout to manage * padding. See {@link Ext.layout.container.Auto#managePadding managePadding} */ contentPaddingProperty: 'padding', horizontalPosProp: 'left', // private borderBoxCls: Ext.baseCSSPrefix + 'border-box', /** * Creates new Component. * @param {Object} config (optional) Config object. */ constructor : function(config) { var me = this, i, len, xhooks; if (config) { Ext.apply(me, config); xhooks = me.xhooks; if (xhooks) { delete me.xhooks; Ext.override(me, xhooks); } } else { config = {}; } me.initialConfig = config; me.mixins.elementCt.constructor.call(me); me.addEvents( /** * @event beforeactivate * Fires before a Component has been visually activated. Returning `false` from an event listener can prevent * the activate from occurring. * @param {Ext.Component} this */ 'beforeactivate', /** * @event activate * Fires after a Component has been visually activated. * @param {Ext.Component} this */ 'activate', /** * @event beforedeactivate * Fires before a Component has been visually deactivated. Returning `false` from an event listener can * prevent the deactivate from occurring. * @param {Ext.Component} this */ 'beforedeactivate', /** * @event deactivate * Fires after a Component has been visually deactivated. * @param {Ext.Component} this */ 'deactivate', /** * @event added * Fires after a Component had been added to a Container. * @param {Ext.Component} this * @param {Ext.container.Container} container Parent Container * @param {Number} pos position of Component * @since 3.4.0 */ 'added', /** * @event disable * Fires after the component is disabled. * @param {Ext.Component} this * @since 1.1.0 */ 'disable', /** * @event enable * Fires after the component is enabled. * @param {Ext.Component} this * @since 1.1.0 */ 'enable', /** * @event beforeshow * Fires before the component is shown when calling the {@link Ext.Component#method-show show} method. Return `false` from an event * handler to stop the show. * @param {Ext.Component} this * @since 1.1.0 */ 'beforeshow', /** * @event show * Fires after the component is shown when calling the {@link Ext.Component#method-show show} method. * @param {Ext.Component} this * @since 1.1.0 */ 'show', /** * @event beforehide * Fires before the component is hidden when calling the {@link Ext.Component#method-hide hide} method. Return `false` from an event * handler to stop the hide. * @param {Ext.Component} this * @since 1.1.0 */ 'beforehide', /** * @event hide * Fires after the component is hidden. Fires after the component is hidden when calling the {@link Ext.Component#method-hide hide} * method. * @param {Ext.Component} this * @since 1.1.0 */ 'hide', /** * @event removed * Fires when a component is removed from an Ext.container.Container * @param {Ext.Component} this * @param {Ext.container.Container} ownerCt Container which holds the component * @since 3.4.0 */ 'removed', /** * @event beforerender * Fires before the component is {@link #rendered}. Return `false` from an event handler to stop the * {@link #method-render}. * @param {Ext.Component} this * @since 1.1.0 */ 'beforerender', /** * @event render * Fires after the component markup is {@link #rendered}. * @param {Ext.Component} this * @since 1.1.0 */ 'render', /** * @event afterrender * Fires after the component rendering is finished. * * The `afterrender` event is fired after this Component has been {@link #rendered}, been postprocessed by any * `afterRender` method defined for the Component. * @param {Ext.Component} this * @since 3.4.0 */ 'afterrender', /** * @event boxready * Fires *one time* - after the component has been laid out for the first time at its initial size. * @param {Ext.Component} this * @param {Number} width The initial width. * @param {Number} height The initial height. */ 'boxready', /** * @event beforedestroy * Fires before the component is {@link #method-destroy}ed. Return `false` from an event handler to stop the * {@link #method-destroy}. * @param {Ext.Component} this * @since 1.1.0 */ 'beforedestroy', /** * @event destroy * Fires after the component is {@link #method-destroy}ed. * @param {Ext.Component} this * @since 1.1.0 */ 'destroy', /** * @event resize * Fires after the component is resized. Note that this does *not* fire when the component is first laid out at its initial * size. To hook that point in the life cycle, use the {@link #boxready} event. * @param {Ext.Component} this * @param {Number} width The new width that was set. * @param {Number} height The new height that was set. * @param {Number} oldWidth The previous width. * @param {Number} oldHeight The previous height. */ 'resize', /** * @event move * Fires after the component is moved. * @param {Ext.Component} this * @param {Number} x The new x position. * @param {Number} y The new y position. */ 'move', /** * @event focus * Fires when this Component receives focus. * @param {Ext.Component} this * @param {Ext.EventObject} The focus event. */ 'focus', /** * @event blur * Fires when this Component loses focus. * @param {Ext.Component} this * @param {Ext.EventObject} The blur event. */ 'blur' ); me.getId(); me.setupProtoEl(); // initComponent, beforeRender, or event handlers may have set the style or `cls` property since the `protoEl` was set up // so we must apply styles and classes here too. if (me.cls) { me.initialCls = me.cls; me.protoEl.addCls(me.cls); } if (me.style) { me.initialStyle = me.style; me.protoEl.setStyle(me.style); } me.renderData = me.renderData || {}; me.renderSelectors = me.renderSelectors || {}; if (me.plugins) { me.plugins = me.constructPlugins(); } // we need this before we call initComponent if (!me.hasListeners) { me.hasListeners = new me.HasListeners(); } me.initComponent(); // ititComponent gets a chance to change the id property before registering Ext.ComponentManager.register(me); // Don't pass the config so that it is not applied to 'this' again me.mixins.observable.constructor.call(me); me.mixins.state.constructor.call(me, config); // Save state on resize. this.addStateEvents('resize'); // Move this into Observable? if (me.plugins) { for (i = 0, len = me.plugins.length; i < len; i++) { me.plugins[i] = me.initPlugin(me.plugins[i]); } } me.loader = me.getLoader(); if (me.renderTo) { me.render(me.renderTo); // EXTJSIV-1935 - should be a way to do afterShow or something, but that // won't work. Likewise, rendering hidden and then showing (w/autoShow) has // implications to afterRender so we cannot do that. } // Auto show only works unilaterally on *uncontained* Components. // If contained, then it is the Container's responsibility to do the showing at next layout time. if (me.autoShow && !me.isContained) { me.show(); } if (Ext.isDefined(me.disabledClass)) { if (Ext.isDefined(Ext.global.console)) { Ext.global.console.warn('Ext.Component: disabledClass has been deprecated. Please use disabledCls.'); } me.disabledCls = me.disabledClass; delete me.disabledClass; } }, initComponent: function () { // This is called again here to allow derived classes to add plugin configs to the // plugins array before calling down to this, the base initComponent. this.plugins = this.constructPlugins(); // this will properly (ignore or) constrain the configured width/height to their // min/max values for consistency. this.setSize(this.width, this.height); }, /** * The supplied default state gathering method for the AbstractComponent class. * * This method returns dimension settings such as `flex`, `anchor`, `width` and `height` along with `collapsed` * state. * * Subclasses which implement more complex state should call the superclass's implementation, and apply their state * to the result if this basic state is to be saved. * * Note that Component state will only be saved if the Component has a {@link #stateId} and there as a StateProvider * configured for the document. * * @return {Object} */ getState: function() { var me = this, state = null, sizeModel = me.getSizeModel(); if (sizeModel.width.configured) { state = me.addPropertyToState(state, 'width'); } if (sizeModel.height.configured) { state = me.addPropertyToState(state, 'height'); } return state; }, /** * Save a property to the given state object if it is not its default or configured * value. * * @param {Object} state The state object. * @param {String} propName The name of the property on this object to save. * @param {String} [value] The value of the state property (defaults to `this[propName]`). * @return {Boolean} The state object or a new object if state was `null` and the property * was saved. * @protected */ addPropertyToState: function (state, propName, value) { var me = this, len = arguments.length; // If the property is inherited, it is a default and we don't want to save it to // the state, however if we explicitly specify a value, always save it if (len == 3 || me.hasOwnProperty(propName)) { if (len < 3) { value = me[propName]; } // If the property has the same value as was initially configured, again, we // don't want to save it. if (value !== me.initialConfig[propName]) { (state || (state = {}))[propName] = value; } } return state; }, show: Ext.emptyFn, animate: function(animObj) { var me = this, hasToWidth, hasToHeight, toHeight, toWidth, to, clearWidth, clearHeight, curWidth, w, curHeight, h, isExpanding, wasConstrained, wasConstrainedHeader, passedCallback, oldOverflow; animObj = animObj || {}; to = animObj.to || {}; if (Ext.fx.Manager.hasFxBlock(me.id)) { return me; } hasToWidth = Ext.isDefined(to.width); if (hasToWidth) { toWidth = Ext.Number.constrain(to.width, me.minWidth, me.maxWidth); } hasToHeight = Ext.isDefined(to.height); if (hasToHeight) { toHeight = Ext.Number.constrain(to.height, me.minHeight, me.maxHeight); } // Special processing for animating Component dimensions. if (!animObj.dynamic && (hasToWidth || hasToHeight)) { curWidth = (animObj.from ? animObj.from.width : undefined) || me.getWidth(); w = curWidth; curHeight = (animObj.from ? animObj.from.height : undefined) || me.getHeight(); h = curHeight; isExpanding = false; if (hasToHeight && toHeight > curHeight) { h = toHeight; isExpanding = true; } if (hasToWidth && toWidth > curWidth) { w = toWidth; isExpanding = true; } // During animated sizing, overflow has to be hidden to clip expanded content if (hasToHeight || hasToWidth) { oldOverflow = me.el.getStyle('overtflow'); if (oldOverflow !== 'hidden') { me.el.setStyle('overflow', 'hidden'); } } // If any dimensions are being increased, we must resize the internal structure // of the Component, but then clip it by sizing its encapsulating element back to original dimensions. // The animation will then progressively reveal the larger content. if (isExpanding) { clearWidth = !Ext.isNumber(me.width); clearHeight = !Ext.isNumber(me.height); // Lay out this component at the new, larger size to get the internals correctly laid out. // Then size the encapsulating **Element** back down to size. // We will then just animate the element to reveal the correctly laid out content. me.setSize(w, h); me.el.setSize(curWidth, curHeight); if (clearWidth) { delete me.width; } if (clearHeight) { delete me.height; } } if (hasToWidth) { to.width = toWidth; } if (hasToHeight) { to.height = toHeight; } } // No constraining during the animate - the "to" size has already been calculated with respect to all settings. // Arrange to reinstate any constraining after the animation has completed wasConstrained = me.constrain; wasConstrainedHeader = me.constrainHeader; if (wasConstrained || wasConstrainedHeader) { me.constrain = me.constrainHeader = false; passedCallback = animObj.callback; animObj.callback = function() { me.constrain = wasConstrained; me.constrainHeader = wasConstrainedHeader; // Call the original callback if any if (passedCallback) { passedCallback.call(animObj.scope||me, arguments); } if (oldOverflow !== 'hidden') { me.el.setStyle('overflow', oldOverflow); } }; } return me.mixins.animate.animate.apply(me, arguments); }, setHiddenState: function(hidden){ var hierarchyState = this.getHierarchyState(); this.hidden = hidden; if (hidden) { hierarchyState.hidden = true; } else { delete hierarchyState.hidden; } }, onHide: function() { // Only lay out if there is an owning layout which might be affected by the hide if (this.ownerLayout) { this.updateLayout({ isRoot: false }); } }, onShow : function() { this.updateLayout({ isRoot: false }); }, /** * @private * @param {String/Object} ptype string or config object containing a ptype property. * * Constructs a plugin according to the passed config object/ptype string. * * Ensures that the constructed plugin always has a `cmp` reference back to this component. * The setting up of this is done in PluginManager. The PluginManager ensures that a reference to this * component is passed to the constructor. It also ensures that the plugin's `setCmp` method (if any) is called. */ constructPlugin: function(plugin) { var me = this; // ptype only, pass as the defultType if (typeof plugin == 'string') { plugin = Ext.PluginManager.create({}, plugin, me); } // Object (either config with ptype or an instantiated plugin) else { plugin = Ext.PluginManager.create(plugin, null, me); } return plugin; }, /** * @private * Returns an array of fully constructed plugin instances. This converts any configs into their * appropriate instances. * * It does not mutate the plugins array. It creates a new array. */ constructPlugins: function() { var me = this, plugins = me.plugins, result, i, len; if (plugins) { result = []; if (!Ext.isArray(plugins)) { plugins = [ plugins ]; } for (i = 0, len = plugins.length; i < len; i++) { // this just returns already-constructed plugin instances... result[i] = me.constructPlugin(plugins[i]); } } me.pluginsInitialized = true; return result; }, // @private initPlugin : function(plugin) { plugin.init(this); return plugin; }, // @private // Adds a plugin. May be called at any time in the component's lifecycle. addPlugin: function(plugin) { var me = this; plugin = me.constructPlugin(plugin); if (me.plugins) { me.plugins.push(plugin); } else { me.plugins = [ plugin ]; } if (me.pluginsInitialized) { me.initPlugin(plugin); } return plugin; }, removePlugin: function(plugin) { Ext.Array.remove(this.plugins, plugin); plugin.destroy(); }, /** * Retrieves plugin from this component's collection by its `ptype`. * @param {String} ptype The Plugin's ptype as specified by the class's `alias` configuration. * @return {Ext.AbstractPlugin} plugin instance. */ findPlugin: function(ptype) { var i, plugins = this.plugins, ln = plugins && plugins.length; for (i = 0; i < ln; i++) { if (plugins[i].ptype === ptype) { return plugins[i]; } } }, /** * Retrieves a plugin from this component's collection by its `pluginId`. * @param {String} pluginId * @return {Ext.AbstractPlugin} plugin instance. */ getPlugin: function(pluginId) { var i, plugins = this.plugins, ln = plugins && plugins.length; for (i = 0; i < ln; i++) { if (plugins[i].pluginId === pluginId) { return plugins[i]; } } }, /** * Occurs before componentLayout is run. In previous releases, this method could * return `false` to prevent its layout but that is not supported in Ext JS 4.1 or * higher. This method is simply a notification of the impending layout to give the * component a chance to adjust the DOM. Ideally, DOM reads should be avoided at this * time to reduce expensive document reflows. * * @template * @protected */ beforeLayout: Ext.emptyFn, /** * @private * Injected as an override by Ext.Aria.initialize */ updateAria: Ext.emptyFn, /** * Called by Component#doAutoRender * * Register a Container configured `floating: true` with this Component's {@link Ext.ZIndexManager ZIndexManager}. * * Components added in this way will not participate in any layout, but will be rendered * upon first show in the way that {@link Ext.window.Window Window}s are. */ registerFloatingItem: function(cmp) { var me = this; if (!me.floatingDescendants) { me.floatingDescendants = new Ext.ZIndexManager(me); } me.floatingDescendants.register(cmp); }, unregisterFloatingItem: function(cmp) { var me = this; if (me.floatingDescendants) { me.floatingDescendants.unregister(cmp); } }, layoutSuspendCount: 0, suspendLayouts: function () { var me = this; if (!me.rendered) { return; } if (++me.layoutSuspendCount == 1) { me.suspendLayout = true; } }, resumeLayouts: function (flushOptions) { var me = this; if (!me.rendered) { return; } if (! --me.layoutSuspendCount) { me.suspendLayout = false; if (flushOptions && !me.isLayoutSuspended()) { me.updateLayout(flushOptions); } } }, setupProtoEl: function() { var cls = this.initCls(); this.protoEl = new Ext.util.ProtoElement({ cls: cls.join(' ') // in case any of the parts have multiple classes }); }, initCls: function() { var me = this, cls = [ me.baseCls, me.getComponentLayout().targetCls ]; if (Ext.isDefined(me.cmpCls)) { if (Ext.isDefined(Ext.global.console)) { Ext.global.console.warn('Ext.Component: cmpCls has been deprecated. Please use componentCls.'); } me.componentCls = me.cmpCls; delete me.cmpCls; } if (me.componentCls) { cls.push(me.componentCls); } else { me.componentCls = me.baseCls; } return cls; }, /** * Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any * `uiCls` set on the component and rename them so they include the new UI. * @param {String} ui The new UI for the component. */ setUI: function(ui) { var me = this, uiCls = me.uiCls, activeUI = me.activeUI, classes; if (ui === activeUI) { // The ui hasn't changed return; } // activeUI will only be set if setUI has been called before. If it hasn't there's no need to remove anything if (activeUI) { classes = me.removeClsWithUI(uiCls, true); if (classes.length) { me.removeCls(classes); } // Remove the UI from the element me.removeUIFromElement(); } else { // We need uiCls to be empty otherwise our call to addClsWithUI won't do anything me.uiCls = []; } // Set the UI me.ui = ui; // After the first call to setUI the values ui and activeUI should track each other but initially we need some // way to tell whether the ui has really been set. me.activeUI = ui; // Add the new UI to the element me.addUIToElement(); classes = me.addClsWithUI(uiCls, true); if (classes.length) { me.addCls(classes); } // Changing the ui can lead to significant changes to a component's appearance, so the layout needs to be // updated. Internally most calls to setUI are pre-render. Buttons are a notable exception as setScale changes // the ui and often requires the layout to be updated. if (me.rendered) { me.updateLayout(); } }, /** * Adds a `cls` to the `uiCls` array, which will also call {@link #addUIClsToElement} and adds to all elements of this * component. * @param {String/String[]} classes A string or an array of strings to add to the `uiCls`. * @param {Object} skip (Boolean) skip `true` to skip adding it to the class and do it later (via the return). */ addClsWithUI: function(classes, skip) { var me = this, clsArray = [], i = 0, uiCls = me.uiCls = Ext.Array.clone(me.uiCls), activeUI = me.activeUI, length, cls; if (typeof classes === "string") { classes = (classes.indexOf(' ') < 0) ? [classes] : Ext.String.splitWords(classes); } length = classes.length; for (; i < length; i++) { cls = classes[i]; if (cls && !me.hasUICls(cls)) { uiCls.push(cls); // We can skip this bit if there isn't an activeUI because we'll be called again from setUI if (activeUI) { clsArray = clsArray.concat(me.addUIClsToElement(cls)); } } } if (skip !== true && activeUI) { me.addCls(clsArray); } return clsArray; }, /** * Removes a `cls` to the `uiCls` array, which will also call {@link #removeUIClsFromElement} and removes it from all * elements of this component. * @param {String/String[]} cls A string or an array of strings to remove to the `uiCls`. */ removeClsWithUI: function(classes, skip) { var me = this, clsArray = [], i = 0, extArray = Ext.Array, remove = extArray.remove, uiCls = me.uiCls = extArray.clone(me.uiCls), activeUI = me.activeUI, length, cls; if (typeof classes === "string") { classes = (classes.indexOf(' ') < 0) ? [classes] : Ext.String.splitWords(classes); } length = classes.length; for (i = 0; i < length; i++) { cls = classes[i]; if (cls && me.hasUICls(cls)) { remove(uiCls, cls); //If there's no activeUI then there's nothing to remove if (activeUI) { clsArray = clsArray.concat(me.removeUIClsFromElement(cls)); } } } if (skip !== true && activeUI) { me.removeCls(clsArray); } return clsArray; }, /** * Checks if there is currently a specified `uiCls`. * @param {String} cls The `cls` to check. */ hasUICls: function(cls) { var me = this, uiCls = me.uiCls || []; return Ext.Array.contains(uiCls, cls); }, frameElementsArray: ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], /** * Method which adds a specified UI + `uiCls` to the components element. Can be overridden to remove the UI from more * than just the components element. * @param {String} ui The UI to remove from the element. */ addUIClsToElement: function(cls) { var me = this, baseClsUi = me.baseCls + '-' + me.ui + '-' + cls, result = [Ext.baseCSSPrefix + cls, me.baseCls + '-' + cls, baseClsUi], frameElementsArray, frameElementsLength, i, el, frameElement; if (me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame frameElementsArray = me.frameElementsArray; frameElementsLength = frameElementsArray.length; // loop through each of them, and if they are defined add the ui for (i = 0; i < frameElementsLength; i++) { frameElement = frameElementsArray[i]; el = me['frame' + frameElement.toUpperCase()]; if (el) { el.addCls(baseClsUi + '-' + frameElement); } } } return result; }, /** * Method which removes a specified UI + `uiCls` from the components element. The `cls` which is added to the element * will be: `this.baseCls + '-' + ui`. * @param {String} ui The UI to add to the element. */ removeUIClsFromElement: function(cls) { var me = this, baseClsUi = me.baseCls + '-' + me.ui + '-' + cls, result = [Ext.baseCSSPrefix + cls, me.baseCls + '-' + cls, baseClsUi], frameElementsArray, frameElementsLength, i, el, frameElement; if (me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame frameElementsArray = me.frameElementsArray; frameElementsLength = frameElementsArray.length; // loop through each of them, and if they are defined add the ui for (i = 0; i < frameElementsLength; i++) { frameElement = frameElementsArray[i]; el = me['frame' + frameElement.toUpperCase()]; if (el) { el.removeCls(baseClsUi + '-' + frameElement); } } } return result; }, /** * Method which adds a specified UI to the components element. * @private */ addUIToElement: function() { var me = this, baseClsUI = me.baseCls + '-' + me.ui, frameElementsArray, frameElementsLength, i, el, frameElement; me.addCls(baseClsUI); if (me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame frameElementsArray = me.frameElementsArray; frameElementsLength = frameElementsArray.length; // loop through each of them, and if they are defined add the ui for (i = 0; i < frameElementsLength; i++) { frameElement = frameElementsArray[i]; el = me['frame' + frameElement.toUpperCase()]; if (el) { el.addCls(baseClsUI + '-' + frameElement); } } } }, /** * Method which removes a specified UI from the components element. * @private */ removeUIFromElement: function() { var me = this, baseClsUI = me.baseCls + '-' + me.ui, frameElementsArray, frameElementsLength, i, el, frameElement; me.removeCls(baseClsUI); if (me.rendered && me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame frameElementsArray = me.frameElementsArray; frameElementsLength = frameElementsArray.length; for (i = 0; i < frameElementsLength; i++) { frameElement = frameElementsArray[i]; el = me['frame' + frameElement.toUpperCase()]; if (el) { el.removeCls(baseClsUI + '-' + frameElement); } } } }, /** * @private */ getTpl: function(name) { return Ext.XTemplate.getTpl(this, name); }, /** * Applies padding, margin, border, top, left, height, and width configs to the * appropriate elements. * @private */ initStyles: function(targetEl) { var me = this, Element = Ext.Element, margin = me.margin, border = me.border, cls = me.cls, style = me.style, x = me.x, y = me.y, width, height; me.initPadding(targetEl); if (margin != null) { targetEl.setStyle('margin', this.unitizeBox((margin === true) ? 5 : margin)); } if (border != null) { me.setBorder(border, targetEl); } // initComponent, beforeRender, or event handlers may have set the style or cls property since the protoEl was set up // so we must apply styles and classes here too. if (cls && cls != me.initialCls) { targetEl.addCls(cls); me.cls = me.initialCls = null; } if (style && style != me.initialStyle) { targetEl.setStyle(style); me.style = me.initialStyle = null; } if (x != null) { targetEl.setStyle(me.horizontalPosProp, (typeof x == 'number') ? (x + 'px') : x); } if (y != null) { targetEl.setStyle('top', (typeof y == 'number') ? (y + 'px') : y); } if (Ext.isBorderBox && (!me.ownerCt || me.floating)) { targetEl.addCls(me.borderBoxCls); } // Framed components need their width/height to apply to the frame, which is // best handled in layout at present. if (!me.getFrameInfo()) { width = me.width; height = me.height; // If we're using the content box model, we also cannot assign numeric initial sizes since we do not know the border widths to subtract if (width != null) { if (typeof width === 'number') { if (Ext.isBorderBox) { targetEl.setStyle('width', width + 'px'); } } else { targetEl.setStyle('width', width); } } if (height != null) { if (typeof height === 'number') { if (Ext.isBorderBox) { targetEl.setStyle('height', height + 'px'); } } else { targetEl.setStyle('height', height); } } } }, /** * Initializes padding by applying it to the target element, or if the layout manages * padding ensures that the padding on the target element is "0". * @private */ initPadding: function(targetEl) { var me = this, padding = me.padding; if (padding != null) { if (me.layout && me.layout.managePadding && me.contentPaddingProperty === 'padding') { // If the container layout manages padding, the layout will apply the // padding to an inner element rather than the target element. The // assumed intent is for the configured padding to override any padding // that is applied to the target element via stylesheet rules. It is // therefore necessary to set the target element's padding to "0". targetEl.setStyle('padding', 0); } else { // Convert the padding, margin and border properties from a space seperated string // into a proper style string targetEl.setStyle('padding', this.unitizeBox((padding === true) ? 5 : padding)); } } }, parseBox: function(box) { return Ext.dom.Element.parseBox(box); }, unitizeBox: function(box) { return Ext.dom.Element.unitizeBox(box); }, /** * Sets the margin on the target element. * @param {Number/String} margin The margin to set. See the {@link #margin} config. */ setMargin: function(margin, /* private */ preventLayout) { var me = this; if (me.rendered) { if (!margin && margin !== 0) { margin = ''; } else { if (margin === true) { margin = 5; } margin = this.unitizeBox(margin); } me.getTargetEl().setStyle('margin', margin); if (!preventLayout) { me.updateLayout(); } } else { me.margin = margin; } }, /** * Initialize any events on this component * @protected */ initEvents : function() { var me = this, afterRenderEvents = me.afterRenderEvents, afterRenderEvent, el, property, index, len; if (afterRenderEvents) { for (property in afterRenderEvents) { el = me[property]; if (el && el.on) { afterRenderEvent = afterRenderEvents[property]; for (index = 0, len = afterRenderEvent.length ; index < len ; ++index) { me.mon(el, afterRenderEvent[index]); } } } } // This will add focus/blur listeners to the getFocusEl() element if that is naturally focusable. // If *not* naturally focusable, then the FocusManager must be enabled to get it to listen for focus so that // the FocusManager can track and highlight focus. me.addFocusListener(); }, /** * @private * Sets up the focus listener on this Component's {@link #getFocusEl focusEl} if it has one. * * Form Components which must implicitly participate in tabbing order usually have a naturally focusable * element as their {@link #getFocusEl focusEl}, and it is the DOM event of that receiving focus which drives * the Component's `onFocus` handling, and the DOM event of it being blurred which drives the `onBlur` handling. * * If the {@link #getFocusEl focusEl} is **not** naturally focusable, then the listeners are only added * if the {@link Ext.FocusManager FocusManager} is enabled. */ addFocusListener: function() { var me = this, focusEl = me.getFocusEl(), needsTabIndex; // All Containers may be focusable, not only "form" type elements, but also // Panels, Toolbars, Windows etc. // Usually, the
element they will return as their focusEl will not be able to receive focus // However, if the FocusManager is invoked, its non-default navigation handlers (invoked when // tabbing/arrowing off of certain Components) may explicitly focus a Panel or Container or FieldSet etc. // Add listeners to the focus and blur events on the focus element // If this Component returns a focusEl, we might need to add a focus listener to it. if (focusEl) { // getFocusEl might return a Component if a Container wishes to delegate focus to a descendant. // Window can do this via its defaultFocus configuration which can reference a Button. if (focusEl.isComponent) { return focusEl.addFocusListener(); } // If the focusEl is naturally focusable, then we always need a focus listener to drive the Component's // onFocus handling. // If *not* naturally focusable, then we only need the focus listener if the FocusManager is enabled. needsTabIndex = focusEl.needsTabIndex(); if (!me.focusListenerAdded && (!needsTabIndex || Ext.FocusManager.enabled)) { if (needsTabIndex) { focusEl.dom.tabIndex = -1; } focusEl.on({ focus: me.onFocus, blur: me.onBlur, scope: me }); me.focusListenerAdded = true; } } }, /** * @private * Returns the focus holder element associated with this Component. At the Component base class level, this function returns `undefined`. * * Subclasses which use embedded focusable elements (such as Window, Field and Button) should override this * for use by the {@link Ext.Component#method-focus focus} method. * * Containers which need to participate in the {@link Ext.FocusManager FocusManager}'s navigation and Container focusing scheme also * need to return a `focusEl`, although focus is only listened for in this case if the {@link Ext.FocusManager FocusManager} is {@link Ext.FocusManager#method-enable enable}d. * * @returns {undefined} `undefined` because raw Components cannot by default hold focus. */ getFocusEl: Ext.emptyFn, isFocusable: function() { var me = this, focusEl; if ((me.focusable !== false) && (focusEl = me.getFocusEl()) && me.rendered && !me.destroying && !me.isDestroyed && !me.disabled && me.isVisible(true)) { // getFocusEl might return a Component if a Container wishes to delegate focus to a descendant. // Window can do this via its defaultFocus configuration which can reference a Button. // Both Component and Element implement isFocusable, so always ask that. return focusEl.isFocusable(true); } }, /** * Template method to do any pre-focus processing. * @protected * @param {Ext.EventObject} e The event object */ beforeFocus: Ext.emptyFn, // private onFocus: function(e) { var me = this, focusCls = me.focusCls, focusEl = me.getFocusEl(); if (!me.disabled) { me.beforeFocus(e); if (focusCls && focusEl) { focusEl.addCls(me.addClsWithUI(focusCls, true)); } if (!me.hasFocus) { me.hasFocus = true; me.fireEvent('focus', me, e); } } }, /** * Template method to do any pre-blur processing. * @protected * @param {Ext.EventObject} e The event object */ beforeBlur : Ext.emptyFn, // private onBlur : function(e) { var me = this, focusCls = me.focusCls, focusEl = me.getFocusEl(); if (me.destroying) { return; } me.beforeBlur(e); if (focusCls && focusEl) { focusEl.removeCls(me.removeClsWithUI(focusCls, true)); } if (me.validateOnBlur) { me.validate(); } me.hasFocus = false; me.fireEvent('blur', me, e); me.postBlur(e); }, /** * Template method to do any post-blur processing. * @protected * @param {Ext.EventObject} e The event object */ postBlur : Ext.emptyFn, /** * Tests whether this Component matches the selector string. * @param {String} selector The selector string to test against. * @return {Boolean} `true` if this Component matches the selector. */ is: function(selector) { return Ext.ComponentQuery.is(this, selector); }, /** * Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or component. * * *Important.* There is not a universal upwards navigation pointer. There are several upwards relationships * such as the {@link Ext.button.Button button} which activates a {@link Ext.button.Button#cfg-menu menu}, or the * {@link Ext.menu.Item menu item} which activated a {@link Ext.menu.Item#cfg-menu submenu}, or the * {@link Ext.grid.column.Column column header} which activated the column menu. * * These differences are abstracted away by this method. * * Example: * * var owningTabPanel = grid.up('tabpanel'); * * @param {String/Ext.Component} [selector] The simple selector component or actual component to test. If not passed the immediate owner/activater is returned. * @param {String/Number/Ext.Component} [limit] This may be a selector upon which to stop the upward scan, or a limit of teh number of steps, or Component reference to stop on. * @return {Ext.container.Container} The matching ancestor Container (or `undefined` if no match was found). */ up: function (selector, limit) { var result = this.getRefOwner(), limitSelector = typeof limit === 'string', limitCount = typeof limit === 'number', limitComponent = limit && limit.isComponent, steps = 0; if (selector) { for (; result; result = result.getRefOwner()) { steps++; if (selector.isComponent) { if (result === selector) { return result; } } else { if (Ext.ComponentQuery.is(result, selector)) { return result; } } // Stop when we hit the limit selector if (limitSelector && result.is(limit)) { return; } if (limitCount && steps === limit) { return; } if (limitComponent && result === limit) { return; } } } return result; }, /** * Returns the next sibling of this Component. * * Optionally selects the next sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery} selector. * * May also be referred to as **`next()`** * * Note that this is limited to siblings, and if no siblings of the item match, `null` is returned. Contrast with * {@link #nextNode} * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following items. * @return {Ext.Component} The next sibling (or the next sibling which matches the selector). * Returns `null` if there is no matching sibling. */ nextSibling: function(selector) { var o = this.ownerCt, it, last, idx, c; if (o) { it = o.items; idx = it.indexOf(this) + 1; if (idx) { if (selector) { for (last = it.getCount(); idx < last; idx++) { if ((c = it.getAt(idx)).is(selector)) { return c; } } } else { if (idx < it.getCount()) { return it.getAt(idx); } } } } return null; }, /** * Returns the previous sibling of this Component. * * Optionally selects the previous sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery} * selector. * * May also be referred to as **`prev()`** * * Note that this is limited to siblings, and if no siblings of the item match, `null` is returned. Contrast with * {@link #previousNode} * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding items. * @return {Ext.Component} The previous sibling (or the previous sibling which matches the selector). * Returns `null` if there is no matching sibling. */ previousSibling: function(selector) { var o = this.ownerCt, it, idx, c; if (o) { it = o.items; idx = it.indexOf(this); if (idx != -1) { if (selector) { for (--idx; idx >= 0; idx--) { if ((c = it.getAt(idx)).is(selector)) { return c; } } } else { if (idx) { return it.getAt(--idx); } } } } return null; }, /** * Returns the previous node in the Component tree in tree traversal order. * * Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the * tree in reverse order to attempt to find a match. Contrast with {@link #previousSibling}. * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding nodes. * @return {Ext.Component} The previous node (or the previous node which matches the selector). * Returns `null` if there is no matching node. */ previousNode: function(selector, /* private */ includeSelf) { var node = this, ownerCt = node.ownerCt, result, it, i, sib; // If asked to include self, test me if (includeSelf && node.is(selector)) { return node; } if (ownerCt) { for (it = ownerCt.items.items, i = Ext.Array.indexOf(it, node) - 1; i > -1; i--) { sib = it[i]; if (sib.query) { result = sib.query(selector); result = result[result.length - 1]; if (result) { return result; } } if (sib.is(selector)) { return sib; } } return ownerCt.previousNode(selector, true); } return null; }, /** * Returns the next node in the Component tree in tree traversal order. * * Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the * tree to attempt to find a match. Contrast with {@link #nextSibling}. * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following nodes. * @return {Ext.Component} The next node (or the next node which matches the selector). * Returns `null` if there is no matching node. */ nextNode: function(selector, /* private */ includeSelf) { var node = this, ownerCt = node.ownerCt, result, it, len, i, sib; // If asked to include self, test me if (includeSelf && node.is(selector)) { return node; } if (ownerCt) { for (it = ownerCt.items.items, i = Ext.Array.indexOf(it, node) + 1, len = it.length; i < len; i++) { sib = it[i]; if (sib.is(selector)) { return sib; } if (sib.down) { result = sib.down(selector); if (result) { return result; } } } return ownerCt.nextNode(selector); } return null; }, /** * Retrieves the `id` of this component. Will auto-generate an `id` if one has not already been set. * @return {String} */ getId : function() { return this.id || (this.id = 'ext-comp-' + (this.getAutoId())); }, /** * Returns the value of {@link #itemId} assigned to this component, or when that * is not set, returns the value of {@link #id}. * @return {String} */ getItemId : function() { return this.itemId || this.id; }, /** * Retrieves the top level element representing this component. * @return {Ext.dom.Element} * @since 1.1.0 */ getEl : function() { return this.el; }, /** * This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. * @private */ getTargetEl: function() { return this.frameBody || this.el; }, /** * Get an el for overflowing, defaults to the target el * @private */ getOverflowEl: function(){ return this.getTargetEl(); }, /** * @private * Returns the CSS style object which will set the Component's scroll styles. This must be applied * to the {@link #getTargetEl target element}. */ getOverflowStyle: function() { var me = this, result = null, ox, oy, overflowStyle; // Note to maintainer. To save on waves of testing, setting and defaulting, the code below // rolls assignent statements into conditional test value expressiona and property object initializers. // This avoids sprawling code. Maintain with care. if (typeof me.autoScroll === 'boolean') { result = { overflow: overflowStyle = me.autoScroll ? 'auto' : '' }; me.scrollFlags = { overflowX: overflowStyle, overflowY: overflowStyle, x: true, y: true, both: true }; } else { ox = me.overflowX; oy = me.overflowY; if (ox !== undefined || oy !== undefined) { result = { 'overflowX': ox = ox || '', 'overflowY': oy = oy || '' }; /** * @member Ext.Component * @property {Object} scrollFlags * An object property which provides unified information as to which dimensions are scrollable based upon * the {@link #autoScroll}, {@link #overflowX} and {@link #overflowY} settings (And for *views* of trees and grids, the owning panel's {@link Ext.panel.Table#scroll scroll} setting). * * Note that if you set overflow styles using the {@link #style} config or {@link Ext.panel.Panel#bodyStyle bodyStyle} config, this object does not include that information; * it is best to use {@link #autoScroll}, {@link #overflowX} and {@link #overflowY} if you need to access these flags. * * This object has the following properties: * @property {Boolean} scrollFlags.x `true` if this Component is scrollable horizontally - style setting may be `'auto'` or `'scroll'`. * @property {Boolean} scrollFlags.y `true` if this Component is scrollable vertically - style setting may be `'auto'` or `'scroll'`. * @property {Boolean} scrollFlags.both `true` if this Component is scrollable both horizontally and vertically. * @property {String} scrollFlags.overflowX The `overflow-x` style setting, `'auto'` or `'scroll'` or `''`. * @property {String} scrollFlags.overflowY The `overflow-y` style setting, `'auto'` or `'scroll'` or `''`. * @readonly */ me.scrollFlags = { overflowX: ox, overflowY: oy, x: ox = (ox === 'auto' || ox === 'scroll'), y: oy = (oy === 'auto' || oy === 'scroll'), both: ox && oy }; } else { me.scrollFlags = { overflowX: '', overflowY: '', x: false, y: false, both: false }; } } // The scrollable container element must be non-statically positioned or IE6/7 will make // positioned children stay in place rather than scrolling with the rest of the content if (result && Ext.isIE7m) { result.position = 'relative'; } return result; }, /** * Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended * from the xtype (default) or whether it is directly of the xtype specified (`shallow = true`). * * **If using your own subclasses, be aware that a Component must register its own xtype to participate in * determination of inherited xtypes.** * * For a list of all available xtypes, see the {@link Ext.Component} header. * * Example usage: * * @example * var t = new Ext.form.field.Text(); * var isText = t.isXType('textfield'); // true * var isBoxSubclass = t.isXType('field'); // true, descended from Ext.form.field.Base * var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance * * @param {String} xtype The xtype to check for this Component * @param {Boolean} [shallow=false] `true` to check whether this Component is directly of the specified xtype, `false` to * check whether this Component is descended from the xtype. * @return {Boolean} `true` if this component descends from the specified xtype, `false` otherwise. * * @since 2.3.0 */ isXType: function(xtype, shallow) { if (shallow) { return this.xtype === xtype; } else { return this.xtypesMap[xtype]; } }, /** * Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the * {@link Ext.Component} header. * * **If using your own subclasses, be aware that a Component must register its own xtype to participate in * determination of inherited xtypes.** * * Example usage: * * @example * var t = new Ext.form.field.Text(); * alert(t.getXTypes()); // alerts 'component/field/textfield' * * @return {String} The xtype hierarchy string * * @since 2.3.0 */ getXTypes: function() { var self = this.self, xtypes, parentPrototype, parentXtypes; if (!self.xtypes) { xtypes = []; parentPrototype = this; while (parentPrototype) { parentXtypes = parentPrototype.xtypes; if (parentXtypes !== undefined) { xtypes.unshift.apply(xtypes, parentXtypes); } parentPrototype = parentPrototype.superclass; } self.xtypeChain = xtypes; self.xtypes = xtypes.join('/'); } return self.xtypes; }, /** * Update the content area of a component. * @param {String/Object} htmlOrData If this component has been configured with a template via the tpl config then * it will use this argument as data to populate the template. If this component was not configured with a template, * the components content area will be updated via Ext.Element update. * @param {Boolean} [loadScripts=false] Only legitimate when using the `html` configuration. * @param {Function} [callback] Only legitimate when using the `html` configuration. Callback to execute when * scripts have finished loading. * * @since 3.4.0 */ update : function(htmlOrData, loadScripts, cb) { var me = this, isData = (me.tpl && !Ext.isString(htmlOrData)), el; if (isData) { me.data = htmlOrData; } else { me.html = Ext.isObject(htmlOrData) ? Ext.DomHelper.markup(htmlOrData) : htmlOrData; } if (me.rendered) { el = me.isContainer ? me.layout.getRenderTarget() : me.getTargetEl(); if (isData) { me.tpl[me.tplWriteMode](el, htmlOrData || {}); } else { el.update(me.html, loadScripts, cb); } me.updateLayout(); } }, /** * Convenience function to hide or show this component by Boolean. * @param {Boolean} visible `true` to show, `false` to hide. * @return {Ext.Component} this * @since 1.1.0 */ setVisible : function(visible) { return this[visible ? 'show': 'hide'](); }, /** * Returns `true` if this component is visible. * * @param {Boolean} [deep=false] Pass `true` to interrogate the visibility status of all parent Containers to * determine whether this Component is truly visible to the user. * * Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating * dynamically laid out UIs in a hidden Container before showing them. * * @return {Boolean} `true` if this component is visible, `false` otherwise. * * @since 1.1.0 */ isVisible: function(deep) { var me = this, hidden; if (me.hidden || !me.rendered || me.isDestroyed) { hidden = true; } else if (deep) { hidden = me.isHierarchicallyHidden(); } return !hidden; }, isHierarchicallyHidden: function() { var child = this, hidden = false, parent, parentHierarchyState; // It is possible for some components to be immune to collapse meaning the immune // component remains visible when its direct parent is collapsed, e.g. panel header. // Because of this, we must walk up the component hierarchy to determine the true // visible state of the component. for (; (parent = child.ownerCt || child.floatParent); child = parent) { parentHierarchyState = parent.getHierarchyState(); if (parentHierarchyState.hidden) { hidden = true; break; } if (child.getHierarchyState().collapseImmune) { // The child or one of its ancestors is immune to collapse. if (parent.collapsed && !child.collapseImmune) { // If the child's direct parent is collapsed, and the child // itself does not have collapse immunity we know that // the child is not visible. hidden = true; break; } } else { // We have ascended the tree to a point where collapse immunity // is not in play. This means if any anscestor above this point // is collapsed, then the component is not visible. hidden = !!parentHierarchyState.collapsed; break; } } return hidden; }, onBoxReady: function(width, height) { var me = this; if (me.disableOnBoxReady) { me.onDisable(); } else if (me.enableOnBoxReady) { me.onEnable(); } if (me.resizable) { me.initResizable(me.resizable); } // Draggability must be initialized after resizability // Because if we have to be wrapped, the resizer wrapper must be dragged as a pseudo-Component if (me.draggable) { me.initDraggable(); } if (me.hasListeners.boxready) { me.fireEvent('boxready', me, width, height); } }, /** * Enable the component * @param {Boolean} [silent=false] Passing `true` will suppress the `enable` event from being fired. * @since 1.1.0 */ enable: function(silent) { var me = this; delete me.disableOnBoxReady; me.removeCls(me.disabledCls); if (me.rendered) { me.onEnable(); } else { me.enableOnBoxReady = true; } me.disabled = false; delete me.resetDisable; if (silent !== true) { me.fireEvent('enable', me); } return me; }, /** * Disable the component. * @param {Boolean} [silent=false] Passing `true` will suppress the `disable` event from being fired. * @since 1.1.0 */ disable: function(silent) { var me = this; delete me.enableOnBoxReady; me.addCls(me.disabledCls); if (me.rendered) { me.onDisable(); } else { me.disableOnBoxReady = true; } me.disabled = true; if (silent !== true) { delete me.resetDisable; me.fireEvent('disable', me); } return me; }, /** * Allows addition of behavior to the enable operation. * After calling the superclass's `onEnable`, the Component will be enabled. * * @template * @protected */ onEnable: function() { if (this.maskOnDisable) { this.el.dom.disabled = false; this.unmask(); } }, /** * Allows addition of behavior to the disable operation. * After calling the superclass's `onDisable`, the Component will be disabled. * * @template * @protected */ onDisable : function() { var me = this, focusCls = me.focusCls, focusEl = me.getFocusEl(); if (focusCls && focusEl) { focusEl.removeCls(me.removeClsWithUI(focusCls, true)); } if (me.maskOnDisable) { me.el.dom.disabled = true; me.mask(); } }, mask: function() { var box = this.lastBox, target = this.getMaskTarget(), args = []; // Pass it the height of our element if we know it. if (box) { args[2] = box.height; } target.mask.apply(target, args); }, unmask: function() { this.getMaskTarget().unmask(); }, getMaskTarget: function(){ return this.el; }, /** * Method to determine whether this Component is currently disabled. * @return {Boolean} the disabled state of this Component. */ isDisabled : function() { return this.disabled; }, /** * Enable or disable the component. * @param {Boolean} disabled `true` to disable. */ setDisabled : function(disabled) { return this[disabled ? 'disable': 'enable'](); }, /** * Method to determine whether this Component is currently set to hidden. * @return {Boolean} the hidden state of this Component. */ isHidden : function() { return this.hidden; }, /** * Adds a CSS class to the top level element representing this component. * @param {String/String[]} cls The CSS class name to add. * @return {Ext.Component} Returns the Component to allow method chaining. */ addCls : function(cls) { var me = this, el = me.rendered ? me.el : me.protoEl; el.addCls.apply(el, arguments); return me; }, /** * @inheritdoc Ext.AbstractComponent#addCls * @deprecated 4.1 Use {@link #addCls} instead. * @since 2.3.0 */ addClass : function() { return this.addCls.apply(this, arguments); }, /** * Checks if the specified CSS class exists on this element's DOM node. * @param {String} className The CSS class to check for. * @return {Boolean} `true` if the class exists, else `false`. * @method */ hasCls: function (cls) { var me = this, el = me.rendered ? me.el : me.protoEl; return el.hasCls.apply(el, arguments); }, /** * Removes a CSS class from the top level element representing this component. * @param {String/String[]} cls The CSS class name to remove. * @returns {Ext.Component} Returns the Component to allow method chaining. */ removeCls : function(cls) { var me = this, el = me.rendered ? me.el : me.protoEl; el.removeCls.apply(el, arguments); return me; }, // @since 2.3.0 removeClass : function() { if (Ext.isDefined(Ext.global.console)) { Ext.global.console.warn('Ext.Component: removeClass has been deprecated. Please use removeCls.'); } return this.removeCls.apply(this, arguments); }, addOverCls: function() { var me = this; if (!me.disabled) { me.el.addCls(me.overCls); } }, removeOverCls: function() { this.el.removeCls(this.overCls); }, addListener : function(element, listeners, scope, options) { var me = this, fn, option; if (Ext.isString(element) && (Ext.isObject(listeners) || options && options.element)) { if (options.element) { fn = listeners; listeners = {}; listeners[element] = fn; element = options.element; if (scope) { listeners.scope = scope; } for (option in options) { if (options.hasOwnProperty(option)) { if (me.eventOptionsRe.test(option)) { listeners[option] = options[option]; } } } } // At this point we have a variable called element, // and a listeners object that can be passed to on if (me[element] && me[element].on) { me.mon(me[element], listeners); } else { me.afterRenderEvents = me.afterRenderEvents || {}; if (!me.afterRenderEvents[element]) { me.afterRenderEvents[element] = []; } me.afterRenderEvents[element].push(listeners); } return; } return me.mixins.observable.addListener.apply(me, arguments); }, // inherit docs removeManagedListenerItem: function(isClear, managedListener, item, ename, fn, scope){ var me = this, element = managedListener.options ? managedListener.options.element : null; if (element) { element = me[element]; if (element && element.un) { if (isClear || (managedListener.item === item && managedListener.ename === ename && (!fn || managedListener.fn === fn) && (!scope || managedListener.scope === scope))) { element.un(managedListener.ename, managedListener.fn, managedListener.scope); if (!isClear) { Ext.Array.remove(me.managedListeners, managedListener); } } } } else { return me.mixins.observable.removeManagedListenerItem.apply(me, arguments); } }, /** * Provides the link for Observable's `fireEvent` method to bubble up the ownership hierarchy. * @return {Ext.container.Container} the Container which owns this Component. * @since 3.4.0 */ getBubbleTarget : function() { return this.ownerCt; }, /** * Method to determine whether this Component is floating. * @return {Boolean} the floating state of this component. */ isFloating : function() { return this.floating; }, /** * Method to determine whether this Component is draggable. * @return {Boolean} the draggable state of this component. */ isDraggable : function() { return !!this.draggable; }, /** * Method to determine whether this Component is droppable. * @return {Boolean} the droppable state of this component. */ isDroppable : function() { return !!this.droppable; }, /** * Method to manage awareness of when components are added to their * respective Container, firing an #added event. References are * established at add time rather than at render time. * * Allows addition of behavior when a Component is added to a * Container. At this stage, the Component is in the parent * Container's collection of child items. After calling the * superclass's `onAdded`, the `ownerCt` reference will be present, * and if configured with a ref, the `refOwner` will be set. * * @param {Ext.container.Container} container Container which holds the component. * @param {Number} pos Position at which the component was added. * * @template * @protected * @since 3.4.0 */ onAdded : function(container, pos) { var me = this; me.ownerCt = container; if (me.hierarchyState) { // if component has a hierarchyState at this point we set an invalid flag in the // hierarchy state so that descendants of this component know to re-initialize // their hierarchyState the next time it is requested (see getHierarchyState()) me.hierarchyState.invalid = true; // We can now delete the old hierarchyState since it is invalid. IMPORTANT: // the descendants are still linked to the old hierarchy state via the // prototype chain, and their heirarchyState property will be synced up // the next time their getHierarchyState() method is called. For this reason // hierarchyState should always be accessed using getHierarchyState() delete me.hierarchyState; } if (me.hasListeners.added) { me.fireEvent('added', me, container, pos); } }, /** * Method to manage awareness of when components are removed from their * respective Container, firing a #removed event. References are properly * cleaned up after removing a component from its owning container. * * Allows addition of behavior when a Component is removed from * its parent Container. At this stage, the Component has been * removed from its parent Container's collection of child items, * but has not been destroyed (It will be destroyed if the parent * Container's `autoDestroy` is `true`, or if the remove call was * passed a truthy second parameter). After calling the * superclass's `onRemoved`, the `ownerCt` and the `refOwner` will not * be present. * @param {Boolean} destroying Will be passed as `true` if the Container performing the remove operation will delete this * Component upon remove. * * @template * @protected * @since 3.4.0 */ onRemoved : function(destroying) { var me = this; if (me.hasListeners.removed) { me.fireEvent('removed', me, me.ownerCt); } delete me.ownerCt; delete me.ownerLayout; }, /** * Invoked before the Component is destroyed. * * @method * @template * @protected */ beforeDestroy : Ext.emptyFn, /** * Allows addition of behavior to the resize operation. * * Called when Ext.resizer.Resizer#drag event is fired. * * @method * @template * @protected */ onResize: function(width, height, oldWidth, oldHeight) { var me = this; // constrain is a config on Floating if (me.floating && me.constrain) { me.doConstrain(); } if (me.hasListeners.resize) { me.fireEvent('resize', me, width, height, oldWidth, oldHeight); } }, /** * Sets the width and height of this Component. This method fires the {@link #resize} event. This method can accept * either width and height as separate arguments, or you can pass a size object like `{width:10, height:20}`. * * @param {Number/String/Object} width The new width to set. This may be one of: * * - A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels). * - A String used to set the CSS width style. * - A size object in the format `{width: widthValue, height: heightValue}`. * - `undefined` to leave the width unchanged. * * @param {Number/String} height The new height to set (not required if a size object is passed as the first arg). * This may be one of: * * - A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels). * - A String used to set the CSS height style. Animation may **not** be used. * - `undefined` to leave the height unchanged. * * @return {Ext.Component} this */ setSize : function(width, height) { var me = this; // support for standard size objects if (width && typeof width == 'object') { height = width.height; width = width.width; } // Constrain within configured maxima if (typeof width == 'number') { me.width = Ext.Number.constrain(width, me.minWidth, me.maxWidth); } else if (width === null) { delete me.width; } if (typeof height == 'number') { me.height = Ext.Number.constrain(height, me.minHeight, me.maxHeight); } else if (height === null) { delete me.height; } // If not rendered, all we need to is set the properties. // The initial layout will set the size if (me.rendered && me.isVisible()) { // If we are changing size, then we are not the root. me.updateLayout({ isRoot: false }); } return me; }, /** * Determines whether this Component is the root of a layout. This returns `true` if * this component can run its layout without assistance from or impact on its owner. * If this component cannot run its layout given these restrictions, `false` is returned * and its owner will be considered as the next candidate for the layout root. * * Setting the {@link #_isLayoutRoot} property to `true` causes this method to always * return `true`. This may be useful when updating a layout of a Container which shrink * wraps content, and you know that it will not change size, and so can safely be the * topmost participant in the layout run. * @protected */ isLayoutRoot: function() { var me = this, ownerLayout = me.ownerLayout; // Return true if we have been explicitly flagged as the layout root, or if we are floating. // Sometimes floating Components get an ownerCt ref injected into them which is *not* a true ownerCt, merely // an upward link for reference purposes. For example a grid column menu is linked to the // owning header via an ownerCt reference. if (!ownerLayout || me._isLayoutRoot || me.floating) { return true; } return ownerLayout.isItemLayoutRoot(me); }, /** * Returns `true` if layout is suspended for this component. This can come from direct * suspension of this component's layout activity ({@link Ext.Container#suspendLayout}) or if one * of this component's containers is suspended. * * @return {Boolean} `true` layout of this component is suspended. */ isLayoutSuspended: function () { var comp = this, ownerLayout; while (comp) { if (comp.layoutSuspendCount || comp.suspendLayout) { return true; } ownerLayout = comp.ownerLayout; if (!ownerLayout) { break; } // TODO - what about suspending a Layout instance? // this works better than ownerCt since ownerLayout means "is managed by" in // the proper sense... some floating components have ownerCt but won't have an // ownerLayout comp = ownerLayout.owner; } return false; }, /** * Updates this component's layout. If this update affects this components {@link #ownerCt}, * that component's `updateLayout` method will be called to perform the layout instead. * Otherwise, just this component (and its child items) will layout. * * @param {Object} [options] An object with layout options. * @param {Boolean} options.defer `true` if this layout should be deferred. * @param {Boolean} options.isRoot `true` if this layout should be the root of the layout. */ updateLayout: function (options) { var me = this, defer, lastBox = me.lastBox, isRoot = options && options.isRoot; if (lastBox) { // remember that this component's last layout result is invalid and must be // recalculated lastBox.invalid = true; } if (!me.rendered || me.layoutSuspendCount || me.suspendLayout) { return; } if (me.hidden) { Ext.AbstractComponent.cancelLayout(me); } else if (typeof isRoot != 'boolean') { isRoot = me.isLayoutRoot(); } // if we aren't the root, see if our ownerLayout will handle it... if (isRoot || !me.ownerLayout || !me.ownerLayout.onContentChange(me)) { // either we are the root or our ownerLayout doesn't care if (!me.isLayoutSuspended()) { // we aren't suspended (knew that), but neither is any of our ownerCt's... defer = (options && options.hasOwnProperty('defer')) ? options.defer : me.deferLayouts; Ext.AbstractComponent.updateLayout(me, defer); } } }, /** * Returns an object that describes how this component's width and height are managed. * All of these objects are shared and should not be modified. * * @return {Object} The size model for this component. * @return {Ext.layout.SizeModel} return.width The {@link Ext.layout.SizeModel size model} * for the width. * @return {Ext.layout.SizeModel} return.height The {@link Ext.layout.SizeModel size model} * for the height. */ getSizeModel: function (ownerCtSizeModel) { var me = this, models = Ext.layout.SizeModel, ownerContext = me.componentLayout.ownerContext, width = me.width, height = me.height, typeofWidth, typeofHeight, hasPixelWidth, hasPixelHeight, heightModel, ownerLayout, policy, shrinkWrap, topLevel, widthModel; if (ownerContext) { // If we are in the middle of a running layout, always report the current, // dynamic size model rather than recompute it. This is not (only) a time // saving thing, but a correctness thing since we cannot get the right answer // otherwise. widthModel = ownerContext.widthModel; heightModel = ownerContext.heightModel; } if (!widthModel || !heightModel) { hasPixelWidth = ((typeofWidth = typeof width) == 'number'); hasPixelHeight = ((typeofHeight = typeof height) == 'number'); topLevel = me.floating || !(ownerLayout = me.ownerLayout); // Floating or no owner layout, e.g. rendered using renderTo if (topLevel) { policy = Ext.layout.Layout.prototype.autoSizePolicy; shrinkWrap = me.floating ? 3 : me.shrinkWrap; if (hasPixelWidth) { widthModel = models.configured; } if (hasPixelHeight) { heightModel = models.configured; } } else { policy = ownerLayout.getItemSizePolicy(me, ownerCtSizeModel); shrinkWrap = ownerLayout.isItemShrinkWrap(me); } if (ownerContext) { ownerContext.ownerSizePolicy = policy; } shrinkWrap = (shrinkWrap === true) ? 3 : (shrinkWrap || 0); // false->0, true->3 // Now that we have shrinkWrap as a 0-3 value, we need to turn off shrinkWrap // bits for any dimension that has a configured size not in pixels. These must // be read from the DOM. // if (topLevel && shrinkWrap) { if (width && typeofWidth == 'string') { shrinkWrap &= 2; // percentage, "30em" or whatever - not width shrinkWrap } if (height && typeofHeight == 'string') { shrinkWrap &= 1; // percentage, "30em" or whatever - not height shrinkWrap } } if (shrinkWrap !== 3) { if (!ownerCtSizeModel) { ownerCtSizeModel = me.ownerCt && me.ownerCt.getSizeModel(); } if (ownerCtSizeModel) { shrinkWrap |= (ownerCtSizeModel.width.shrinkWrap ? 1 : 0) | (ownerCtSizeModel.height.shrinkWrap ? 2 : 0); } } if (!widthModel) { if (!policy.setsWidth) { if (hasPixelWidth) { widthModel = models.configured; } else { widthModel = (shrinkWrap & 1) ? models.shrinkWrap : models.natural; } } else if (policy.readsWidth) { if (hasPixelWidth) { widthModel = models.calculatedFromConfigured; } else { widthModel = (shrinkWrap & 1) ? models.calculatedFromShrinkWrap : models.calculatedFromNatural; } } else { widthModel = models.calculated; } } if (!heightModel) { if (!policy.setsHeight) { if (hasPixelHeight) { heightModel = models.configured; } else { heightModel = (shrinkWrap & 2) ? models.shrinkWrap : models.natural; } } else if (policy.readsHeight) { if (hasPixelHeight) { heightModel = models.calculatedFromConfigured; } else { heightModel = (shrinkWrap & 2) ? models.calculatedFromShrinkWrap : models.calculatedFromNatural; } } else { heightModel = models.calculated; } } } // We return one of the cached objects with the proper "width" and "height" as the // sizeModels we have determined. return widthModel.pairsByHeightOrdinal[heightModel.ordinal]; }, isDescendant: function(ancestor) { if (ancestor.isContainer) { for (var c = this.ownerCt; c; c = c.ownerCt) { if (c === ancestor) { return true; } } } return false; }, /** * This method needs to be called whenever you change something on this component that requires the Component's * layout to be recalculated. * @return {Ext.container.Container} this */ doComponentLayout : function() { this.updateLayout(); return this; }, /** * Forces this component to redo its componentLayout. * @deprecated 4.1.0 Use {@link #updateLayout} instead. */ forceComponentLayout: function () { this.updateLayout(); }, // @private setComponentLayout : function(layout) { var currentLayout = this.componentLayout; if (currentLayout && currentLayout.isLayout && currentLayout != layout) { currentLayout.setOwner(null); } this.componentLayout = layout; layout.setOwner(this); }, getComponentLayout : function() { var me = this; if (!me.componentLayout || !me.componentLayout.isLayout) { me.setComponentLayout(Ext.layout.Layout.create(me.componentLayout, 'autocomponent')); } return me.componentLayout; }, /** * Called by the layout system after the Component has been laid out. * * @param {Number} width The width that was set * @param {Number} height The height that was set * @param {Number/undefined} oldWidth The old width, or `undefined` if this was the initial layout. * @param {Number/undefined} oldHeight The old height, or `undefined` if this was the initial layout. * * @template * @protected */ afterComponentLayout: function(width, height, oldWidth, oldHeight) { var me = this; if (++me.componentLayoutCounter === 1) { me.afterFirstLayout(width, height); } if (width !== oldWidth || height !== oldHeight) { me.onResize(width, height, oldWidth, oldHeight); } }, /** * Occurs before `componentLayout` is run. Returning `false` from this method will prevent the `componentLayout` from * being executed. * * @param {Number} adjWidth The box-adjusted width that was set. * @param {Number} adjHeight The box-adjusted height that was set. * * @template * @protected */ beforeComponentLayout: function(width, height) { return true; }, /** * @member Ext.Component * Sets the left and top of the component. To set the page XY position instead, use {@link Ext.Component#setPagePosition setPagePosition}. This * method fires the {@link #event-move} event. * @param {Number/Number[]/Object} x The new left, an array of `[x,y]`, or animation config object containing `x` and `y` properties. * @param {Number} [y] The new top. * @param {Boolean/Object} [animate] If `true`, the Component is _animated_ into its new position. You may also pass an * animation configuration. * @return {Ext.Component} this */ setPosition: function(x, y, animate) { var me = this, pos = me.beforeSetPosition.apply(me, arguments); if (pos && me.rendered) { x = pos.x; y = pos.y; if (animate) { // Proceed only if the new position is different from the current // one. We only do these DOM reads in the animate case as we don't // want to incur the penalty of read/write on every call to setPosition if (x !== me.getLocalX() || y !== me.getLocalY()) { me.stopAnimation(); me.animate(Ext.apply({ duration: 1000, listeners: { afteranimate: Ext.Function.bind(me.afterSetPosition, me, [x, y]) }, to: { x: x, y: y } }, animate)); } } else { me.setLocalXY(x, y); me.afterSetPosition(x, y); } } return me; }, /** * @private Template method called before a Component is positioned. * * Ensures that the position is adjusted so that the Component is constrained if so configured. */ beforeSetPosition: function (x, y, animate) { var pos, x0; // Decode members of x if x is an array or an object. // If it is numeric (including zero), we need do nothing. if (x) { // Position in first argument as an array of [x, y] if (Ext.isNumber(x0 = x[0])) { animate = y; y = x[1]; x = x0; } // Position in first argument as object w/ x & y properties else if ((x0 = x.x) !== undefined) { animate = y; y = x.y; x = x0; } } if (this.constrain || this.constrainHeader) { pos = this.calculateConstrainedPosition(null, [x, y], true); if (pos) { x = pos[0]; y = pos[1]; } } // Set up the return info and store the position in this object pos = { x : this.x = x, y : this.y = y, anim: animate, hasX: x !== undefined, hasY: y !== undefined }; return (pos.hasX || pos.hasY) ? pos : null; }, /** * Template method called after a Component has been positioned. * * @param {Number} x * @param {Number} y * * @template * @protected */ afterSetPosition: function(x, y) { var me = this; me.onPosition(x, y); if (me.hasListeners.move) { me.fireEvent('move', me, x, y); } }, /** * Called after the component is moved, this method is empty by default but can be implemented by any * subclass that needs to perform custom logic after a move occurs. * * @param {Number} x The new x position. * @param {Number} y The new y position. * * @template * @protected */ onPosition: Ext.emptyFn, /** * Sets the width of the component. This method fires the {@link #resize} event. * * @param {Number} width The new width to setThis may be one of: * * - A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels). * - A String used to set the CSS width style. * * @return {Ext.Component} this */ setWidth : function(width) { return this.setSize(width); }, /** * Sets the height of the component. This method fires the {@link #resize} event. * * @param {Number} height The new height to set. This may be one of: * * - A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels). * - A String used to set the CSS height style. * - _undefined_ to leave the height unchanged. * * @return {Ext.Component} this */ setHeight : function(height) { return this.setSize(undefined, height); }, /** * Gets the current size of the component's underlying element. * @return {Object} An object containing the element's size `{width: (element width), height: (element height)}` */ getSize : function() { return this.el.getSize(); }, /** * Gets the current width of the component's underlying element. * @return {Number} */ getWidth : function() { return this.el.getWidth(); }, /** * Gets the current height of the component's underlying element. * @return {Number} */ getHeight : function() { return this.el.getHeight(); }, /** * Gets the {@link Ext.ComponentLoader} for this Component. * @return {Ext.ComponentLoader} The loader instance, null if it doesn't exist. */ getLoader: function(){ var me = this, autoLoad = me.autoLoad ? (Ext.isObject(me.autoLoad) ? me.autoLoad : {url: me.autoLoad}) : null, loader = me.loader || autoLoad; if (loader) { if (!loader.isLoader) { me.loader = new Ext.ComponentLoader(Ext.apply({ target: me, autoLoad: autoLoad }, loader)); } else { loader.setTarget(me); } return me.loader; } return null; }, /** * Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part * of the `dockedItems` collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default) * @param {Object} dock The dock position. * @param {Boolean} [layoutParent=false] `true` to re-layout parent. * @return {Ext.Component} this */ setDocked : function(dock, layoutParent) { var me = this; me.dock = dock; if (layoutParent && me.ownerCt && me.rendered) { me.ownerCt.updateLayout(); } return me; }, /** * * @param {String/Number} border The border, see {@link #border}. If a falsey value is passed * the border will be removed. */ setBorder: function(border, /* private */ targetEl) { var me = this, initial = !!targetEl; if (me.rendered || initial) { if (!initial) { targetEl = me.el; } if (!border) { border = 0; } else if (border === true) { border = '1px'; } else { border = this.unitizeBox(border); } targetEl.setStyle('border-width', border); if (!initial) { me.updateLayout(); } } me.border = border; }, onDestroy : function() { var me = this; if (me.monitorResize && Ext.EventManager.resizeEvent) { Ext.EventManager.resizeEvent.removeListener(me.setSize, me); } // Destroying the floatingItems ZIndexManager will also destroy descendant floating Components Ext.destroy( me.componentLayout, me.loadMask, me.floatingDescendants ); }, /** * Destroys the Component. * @since 1.1.0 */ destroy : function() { var me = this, selectors = me.renderSelectors, selector, el; if (!me.isDestroyed) { if (!me.hasListeners.beforedestroy || me.fireEvent('beforedestroy', me) !== false) { me.destroying = true; me.beforeDestroy(); if (me.floating) { delete me.floatParent; // A zIndexManager is stamped into a *floating* Component when it is added to a Container. // If it has no zIndexManager at render time, it is assigned to the global Ext.WindowManager instance. if (me.zIndexManager) { me.zIndexManager.unregister(me); } } else if (me.ownerCt && me.ownerCt.remove) { me.ownerCt.remove(me, false); } me.stopAnimation(); me.onDestroy(); // Attempt to destroy all plugins Ext.destroy(me.plugins); if (me.hasListeners.destroy) { me.fireEvent('destroy', me); } Ext.ComponentManager.unregister(me); me.mixins.state.destroy.call(me); me.clearListeners(); // make sure we clean up the element references after removing all events if (me.rendered) { if (!me.preserveElOnDestroy) { me.el.remove(); } me.mixins.elementCt.destroy.call(me); // removes childEls if (selectors) { for (selector in selectors) { if (selectors.hasOwnProperty(selector)) { el = me[selector]; if (el) { // in case any other code may have already removed it delete me[selector]; el.remove(); } } } } delete me.el; delete me.frameBody; delete me.rendered; } me.destroying = false; me.isDestroyed = true; } } }, /** * Determines whether this component is the descendant of a particular container. * @param {Ext.Container} container * @return {Boolean} `true` if the component is the descendant of a particular container, otherwise `false`. */ isDescendantOf: function(container) { return !!this.findParentBy(function(p){ return p === container; }); }, /** * A component's hierarchyState is used to keep track of aspects of a component's * state that affect its descendants hierarchically like "collapsed" and "hidden". * For example, if this.hierarchyState.hidden == true, it means that either this * component, or one of its ancestors is hidden. * * Hierarchical state management is implemented by chaining each component's * hierarchyState property to its parent container's hierarchyState property via the * prototype. The result is such that if a component's hierarchyState does not have * it's own property, it inherits the property from the nearest ancestor that does. * * To set a hierarchical "hidden" value: * * this.getHierarchyState().hidden = true; * * It is important to remember when unsetting hierarchyState properties to delete * them instead of just setting them to a falsy value. This ensures that the * hierarchyState returns to a state of inheriting the value instead of overriding it * To unset the hierarchical "hidden" value: * * delete this.getHierarchyState().hidden; * * IMPORTANT! ALWAYS access hierarchyState using this method, not by accessing * this.hierarchyState directly. The hierarchyState property does not exist until * the first time getHierarchyState() is called. At that point getHierarchyState() * walks up the component tree to establish the hierarchyState prototype chain. * Additionally the hierarchyState property should NOT be relied upon even after * the initial call to getHierarchyState() because it is possible for the * hierarchyState to be invalidated. Invalidation typically happens when a component * is moved to a new container. In such a case the hierarchy state remains invalid * until the next time getHierarchyState() is called on the component or one of its * descendants. * * @private */ getHierarchyState: function (inner) { var me = this, hierarchyState = (inner && me.hierarchyStateInner) || me.hierarchyState, ownerCt = me.ownerCt, parent, layout, hierarchyStateInner, getInner; if (!hierarchyState || hierarchyState.invalid) { // Use upward navigational link, not ownerCt. // 99% of the time, this will use ownerCt/floatParent. // Certain floating components do not have an ownerCt, but they are still linked // into a navigational hierarchy. The getRefOwner method normalizes these differences. parent = me.getRefOwner(); if (ownerCt) { // This will only be true if the item is a "child" of its owning container // For example, a docked item will not get the inner hierarchy state getInner = me.ownerLayout === ownerCt.layout; } me.hierarchyState = hierarchyState = // chain this component's hierarchyState to that of its parent. If it // doesn't have a parent, then chain to the rootHierarchyState. This is // done so that when there is a viewport, all component's will inherit // from its hierarchyState, even components that are not descendants of // the viewport. Ext.Object.chain(parent ? parent.getHierarchyState(getInner) : Ext.rootHierarchyState); me.initHierarchyState(hierarchyState); if ((layout = me.componentLayout).initHierarchyState) { layout.initHierarchyState(hierarchyState); } if (me.isContainer) { me.hierarchyStateInner = hierarchyStateInner = Ext.Object.chain(hierarchyState); layout = me.layout; if (layout && layout.initHierarchyState) { layout.initHierarchyState(hierarchyStateInner, hierarchyState); } if (inner) { hierarchyState = hierarchyStateInner; } } } return hierarchyState; }, /** * Called by {@link #getHierarchyState} to initialize the hierarchyState the first * time it is requested. * @private */ initHierarchyState: function(hierarchyState) { var me = this; if (me.collapsed) { hierarchyState.collapsed = true; } if (me.hidden) { hierarchyState.hidden = true; } if (me.collapseImmune) { hierarchyState.collapseImmune = true; } }, // ********************************************************************************** // Begin Positionable methods // ********************************************************************************** getAnchorToXY: function(el, anchor, local, mySize) { return el.getAnchorXY(anchor, local, mySize); }, getBorderPadding: function() { return this.el.getBorderPadding(); }, getLocalX: function() { return this.el.getLocalX(); }, getLocalXY: function() { return this.el.getLocalXY(); }, getLocalY: function() { return this.el.getLocalY(); }, getX: function() { return this.el.getX(); }, getXY: function() { return this.el.getXY(); }, getY: function() { return this.el.getY(); }, setLocalX: function(x) { this.el.setLocalX(x); }, setLocalXY: function(x, y) { this.el.setLocalXY(x, y); }, setLocalY: function(y) { this.el.setLocalY(y); }, setX: function(x, animate) { this.el.setX(x, animate); }, setXY: function(xy, animate) { this.el.setXY(xy, animate); }, setY: function(y, animate) { this.el.setY(y, animate); } // ********************************************************************************** // End Positionable methods // ********************************************************************************** }, function() { var AbstractComponent = this; AbstractComponent.createAlias({ on: 'addListener', prev: 'previousSibling', next: 'nextSibling' }); /** * @inheritdoc Ext.AbstractComponent#resumeLayouts * @member Ext */ Ext.resumeLayouts = function (flush) { AbstractComponent.resumeLayouts(flush); }; /** * @inheritdoc Ext.AbstractComponent#suspendLayouts * @member Ext */ Ext.suspendLayouts = function () { AbstractComponent.suspendLayouts(); }; /** * Utility wrapper that suspends layouts of all components for the duration of a given function. * @param {Function} fn The function to execute. * @param {Object} [scope] The scope (`this` reference) in which the specified function is executed. * @member Ext */ Ext.batchLayouts = function(fn, scope) { AbstractComponent.suspendLayouts(); // Invoke the function fn.call(scope); AbstractComponent.resumeLayouts(true); }; }); /** * The AbstractPlugin class is the base class from which user-implemented plugins should inherit. * * This class defines the essential API of plugins as used by Components by defining the following methods: * * - `init` : The plugin initialization method which the owning Component calls at Component initialization time. * * The Component passes itself as the sole parameter. * * Subclasses should set up bidirectional links between the plugin and its client Component here. * * - `destroy` : The plugin cleanup method which the owning Component calls at Component destruction time. * * Use this method to break links between the plugin and the Component and to free any allocated resources. * * - `enable` : The base implementation just sets the plugin's `disabled` flag to `false` * * - `disable` : The base implementation just sets the plugin's `disabled` flag to `true` */ Ext.define('Ext.AbstractPlugin', { disabled: false, /** * @property {Boolean} isPlugin * `true` in this class to identify an object as an instantiated Plugin, or subclass thereof. */ isPlugin: true, /** * Instantiates the plugin. * @param {Object} [config] Configuration object. */ constructor: function(config) { this.pluginConfig = config; Ext.apply(this, config); }, /** * Creates clone of the plugin. * @param {Object} [overrideCfg] Additional config for the derived plugin. */ clonePlugin: function(overrideCfg) { return new this.self(Ext.apply({}, overrideCfg, this.pluginConfig)); }, /** * Sets the component to which this plugin is attached. * @param {Ext.Component} cmp Owner component. */ setCmp: function(cmp) { this.cmp = cmp; }, /** * Returns the component to which this plugin is attached. * @return {Ext.Component} Owner component. */ getCmp: function() { return this.cmp; }, /** * @cfg {String} pluginId * A name for the plugin that can be set at creation time to then retrieve the plugin * through {@link Ext.AbstractComponent#getPlugin getPlugin} method. For example: * * var grid = Ext.create('Ext.grid.Panel', { * plugins: [{ * ptype: 'cellediting', * clicksToEdit: 2, * pluginId: 'cellplugin' * }] * }); * * // later on: * var plugin = grid.getPlugin('cellplugin'); */ /** * @method * The init method is invoked after initComponent method has been run for the client Component. * * The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional * links between the plugin and its client Component in their own implementation of this method. * @param {Ext.Component} client The client Component which owns this plugin. */ init: Ext.emptyFn, /** * @method * The destroy method is invoked by the owning Component at the time the Component is being destroyed. * * The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of * this method. */ destroy: Ext.emptyFn, /** * The base implementation just sets the plugin's `disabled` flag to `false` * * Plugin subclasses which need more complex processing may implement an overriding implementation. */ enable: function() { this.disabled = false; }, /** * The base implementation just sets the plugin's `disabled` flag to `true` * * Plugin subclasses which need more complex processing may implement an overriding implementation. */ disable: function() { this.disabled = true; }, // Private. // Inject a ptype property so that AbstractComponent.findPlugin(ptype) works. onClassExtended: function(cls, data, hooks) { var alias = data.alias; // No ptype built into the class if (alias && !data.ptype) { if (Ext.isArray(alias)) { alias = alias[0]; } cls.prototype.ptype = alias.split('plugin.')[1]; } } }); /** * An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it * can be usefully shared among multiple components. Actions let you share handlers, configuration options and UI * updates across any components that support the Action interface (primarily {@link Ext.toolbar.Toolbar}, * {@link Ext.button.Button} and {@link Ext.menu.Menu} components). * * Use a single Action instance as the config object for any number of UI Components which share the same configuration. The * Action not only supplies the configuration, but allows all Components based upon it to have a common set of methods * called at once through a single call to the Action. * * Any Component that is to be configured with an Action must also support * the following methods: * * - setText(string) * - setIconCls(string) * - setDisabled(boolean) * - setVisible(boolean) * - setHandler(function) * * This allows the Action to control its associated Components. * * Example usage: * * // Define the shared Action. Each Component below will have the same * // display text and icon, and will display the same message on click. * var action = new Ext.Action({ * {@link #text}: 'Do something', * {@link #handler}: function(){ * Ext.Msg.alert('Click', 'You did something.'); * }, * {@link #iconCls}: 'do-something', * {@link #itemId}: 'myAction' * }); * * var panel = new Ext.panel.Panel({ * title: 'Actions', * width: 500, * height: 300, * tbar: [ * // Add the Action directly to a toolbar as a menu button * action, * { * text: 'Action Menu', * // Add the Action to a menu as a text item * menu: [action] * } * ], * items: [ * // Add the Action to the panel body as a standard button * new Ext.button.Button(action) * ], * renderTo: Ext.getBody() * }); * * // Change the text for all components using the Action * action.setText('Something else'); * * // Reference an Action through a container using the itemId * var btn = panel.getComponent('myAction'); * var aRef = btn.baseAction; * aRef.setText('New text'); */ Ext.define('Ext.Action', { /* Begin Definitions */ /* End Definitions */ /** * @cfg {String} [text=''] * The text to set for all components configured by this Action. */ /** * @cfg {String} [iconCls=''] * The CSS class selector that specifies a background image to be used as the header icon for * all components configured by this Action. * * An example of specifying a custom icon class would be something like: * * // specify the property in the config for the class: * ... * iconCls: 'do-something' * * // css class that specifies background image to be used as the icon image: * .do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; } */ /** * @cfg {Boolean} [disabled=false] * True to disable all components configured by this Action, false to enable them. */ /** * @cfg {Boolean} [hidden=false] * True to hide all components configured by this Action, false to show them. */ /** * @cfg {Function} handler * The function that will be invoked by each component tied to this Action * when the component's primary event is triggered. */ /** * @cfg {String} itemId * See {@link Ext.Component}.{@link Ext.Component#itemId itemId}. */ /** * @cfg {Object} scope * The scope (this reference) in which the {@link #handler} is executed. * Defaults to the browser window. */ /** * Creates new Action. * @param {Object} config Config object. */ constructor : function(config){ this.initialConfig = config; this.itemId = config.itemId = (config.itemId || config.id || Ext.id()); this.items = []; }, /* * @property {Boolean} isAction * `true` in this class to identify an object as an instantiated Action, or subclass thereof. */ isAction : true, /** * Sets the text to be displayed by all components configured by this Action. * @param {String} text The text to display */ setText : function(text){ this.initialConfig.text = text; this.callEach('setText', [text]); }, /** * Gets the text currently displayed by all components configured by this Action. */ getText : function(){ return this.initialConfig.text; }, /** * Sets the icon CSS class for all components configured by this Action. The class should supply * a background image that will be used as the icon image. * @param {String} cls The CSS class supplying the icon image */ setIconCls : function(cls){ this.initialConfig.iconCls = cls; this.callEach('setIconCls', [cls]); }, /** * Gets the icon CSS class currently used by all components configured by this Action. */ getIconCls : function(){ return this.initialConfig.iconCls; }, /** * Sets the disabled state of all components configured by this Action. Shortcut method * for {@link #enable} and {@link #disable}. * @param {Boolean} disabled True to disable the component, false to enable it */ setDisabled : function(v){ this.initialConfig.disabled = v; this.callEach('setDisabled', [v]); }, /** * Enables all components configured by this Action. */ enable : function(){ this.setDisabled(false); }, /** * Disables all components configured by this Action. */ disable : function(){ this.setDisabled(true); }, /** * Returns true if the components using this Action are currently disabled, else returns false. */ isDisabled : function(){ return this.initialConfig.disabled; }, /** * Sets the hidden state of all components configured by this Action. Shortcut method * for `{@link #hide}` and `{@link #show}`. * @param {Boolean} hidden True to hide the component, false to show it. */ setHidden : function(v){ this.initialConfig.hidden = v; this.callEach('setVisible', [!v]); }, /** * Shows all components configured by this Action. */ show : function(){ this.setHidden(false); }, /** * Hides all components configured by this Action. */ hide : function(){ this.setHidden(true); }, /** * Returns true if the components configured by this Action are currently hidden, else returns false. */ isHidden : function(){ return this.initialConfig.hidden; }, /** * Sets the function that will be called by each Component using this action when its primary event is triggered. * @param {Function} fn The function that will be invoked by the action's components. The function * will be called with no arguments. * @param {Object} scope The scope (this reference) in which the function is executed. Defaults to the Component * firing the event. */ setHandler : function(fn, scope){ this.initialConfig.handler = fn; this.initialConfig.scope = scope; this.callEach('setHandler', [fn, scope]); }, /** * Executes the specified function once for each Component currently tied to this Action. The function passed * in should accept a single argument that will be an object that supports the basic Action config/method interface. * @param {Function} fn The function to execute for each component * @param {Object} scope The scope (this reference) in which the function is executed. * Defaults to the Component. */ each : function(fn, scope){ Ext.each(this.items, fn, scope); }, // @private callEach : function(fnName, args){ var items = this.items, i = 0, len = items.length, item; Ext.suspendLayouts(); for(; i < len; i++){ item = items[i]; item[fnName].apply(item, args); } Ext.resumeLayouts(true); }, // @private addComponent : function(comp){ this.items.push(comp); comp.on('destroy', this.removeComponent, this); }, // @private removeComponent : function(comp){ Ext.Array.remove(this.items, comp); }, /** * Executes this Action manually using the handler function specified in the original config object * or the handler function set with {@link #setHandler}. Any arguments passed to this * function will be passed on to the handler function. * @param {Object...} args Variable number of arguments passed to the handler function */ execute : function(){ this.initialConfig.handler.apply(this.initialConfig.scope || Ext.global, arguments); } }); /** * * Simulates an XMLHttpRequest object's methods and properties as returned * form the flash polyfill plugin. Used in submitting binary data in browsers that do * not support doing so from JavaScript. * NOTE: By default this will look for the flash object in the ext directory. When packaging and deploying the app, copy the ext/plugins directory and its contents to your root directory. For custom deployments where just the FlashPlugin.swf file gets copied (e.g. to /resources/FlashPlugin.swf), make sure to notify the framework of the location of the plugin before making the first attempt to post binary data, e.g. in the launch method of your app do: *

Ext.flashPluginPath="/resources/FlashPlugin.swf";
 
* * @private */ Ext.define('Ext.data.flash.BinaryXhr', { statics: { /** * Called by the flash plugin once it's installed and open for business. * @private */ flashPluginActivated: function() { Ext.data.flash.BinaryXhr.flashPluginActive = true; Ext.data.flash.BinaryXhr.flashPlugin = document.getElementById("ext-flash-polyfill"); Ext.globalEvents.fireEvent("flashready"); // let all pending connections know }, /** * Set to trut once the plugin registers and is active. * @private */ flashPluginActive: false, /** * Flag to avoid installing the plugin twice. * @private */ flashPluginInjected: false, /** * Counts IDs for new connections. * @private */ connectionIndex: 1, /** * Plcaeholder for active connections. * @private */ liveConnections: {}, /** * Reference to the actual plugin, once activated. * @private */ flashPlugin: null, /** * Called by the flash plugin once the state of one of the active connections changes. * @param {Number/number} javascriptId the ID of the connection. * @param {number} state the state of the connection. Equivalent to readyState numbers in XHR. * @param {Object} data optional object containing the returned data, error and status codes. * @private */ onFlashStateChange: function(javascriptId, state, data) { var connection; // Identify the request this is for connection = this.liveConnections[Number(javascriptId)]; // Make sure its a native number if (connection) { connection.onFlashStateChange(state, data); } else { Ext.warn.log("onFlashStateChange for unknown connection ID: " + javascriptId); } }, /** * Adds the BinaryXhr object to the tracked connection list and assigns it an ID * @param {Ext.data.flash.BinaryXhr} conn the connection to register * @return {Number} id * @private */ registerConnection: function(conn) { var i = this.connectionIndex; this.conectionIndex = this.connectionIndex + 1; this.liveConnections[i] = conn; return i; }, /** * Injects the flash polyfill plugin to allow posting binary data. * This is done in two steps: First we load the javascript loader for flash objects, then we call it to inject the flash object. * @private */ injectFlashPlugin: function() { var divTag, pTag, aTag, iTag, me=this, flashLoaderPath, flashObjectPath; // Generate the following HTML set of tags: // + '
' // + '

To view this page ensure that Adobe Flash Player version 11.1.0 or greater is installed, and that the FlashPlugin.swf file was correctly placed in the /resources directory.

' //+ 'Get Adobe Flash player' //+ '
' iTag=document.createElement("img"); iTag.setAttribute("src", window.location.protocol + '//www.adobe.com/images/shared/download_buttons/get_flash_player.gif'); iTag.setAttribute("alt", "Get Adobe Flash player"); aTag=document.createElement("a"); aTag.setAttribute("href", "http://www.adobe.com/go/getflashplayer"); aTag.appendChild(iTag); pTag=document.createElement("p"); pTag.innerHTML="To view this page ensure that Adobe Flash Player version 11.1.0 or greater is installed."; divTag=document.createElement("div"); divTag.setAttribute("id", "ext-flash-polyfill"); divTag.appendChild(pTag); divTag.appendChild(iTag); Ext.getBody().dom.appendChild(divTag); // Now load the flash-loading script flashLoaderPath = [Ext.Loader.getPath('Ext.data.Connection'), '../../../plugins/flash/swfobject.js'].join('/'); flashObjectPath = "/plugins/flash/FlashPlugin.swf"; flashObjectPath = [Ext.Loader.getPath('Ext.data.Connection'), '../../plugins/flash/FlashPlugin.swf'].join('/'); if (Ext.flashPluginPath) { flashObjectPath = Ext.flashPluginPath; } //console.log('LOADING Flash plugin from: ' + flashObjectPath); Ext.Loader.loadScript({ url:flashLoaderPath, onLoad: function() { // For version detection, set to min. required Flash Player version, or 0 (or 0.0.0), for no version detection. var swfVersionStr = "11.4.0"; // To use express install, set to playerProductInstall.swf, otherwise the empty string. var xiSwfUrlStr = "playerProductInstall.swf"; var flashvars = {}; var params = {}; params.quality = "high"; params.bgcolor = "#ffffff"; params.allowscriptaccess = "sameDomain"; params.allowfullscreen = "true"; var attributes = {}; attributes.id = "ext-flash-polyfill"; attributes.name = "polyfill"; attributes.align = "middle"; swfobject.embedSWF( flashObjectPath, "ext-flash-polyfill", "0", "0", // no size so it's not visible. swfVersionStr, xiSwfUrlStr, flashvars, params, attributes); }, onError: function() { Ext.Error.raise("Could not load flash-loader file swfobject.js from " + flashLoader); }, scope: me }); Ext.globalEvents.addEvents("flashready"); // we'll fire this one once flash is loaded Ext.data.flash.BinaryXhr.flashPluginInjected = true; } }, /** * @property {number} readyState The connection's simulated readyState. Note that the only supported values are 0, 1 and 4. States 2 and 3 will never be reported. */ readyState: 0, /** * @property {number} status Connection status code returned by flash or the server. */ status: 0, /** * Status text (if any) returned by flash or the server. */ statusText: "", /** * @property {Array} responseBytes The binary bytes returned. */ responseBytes: null, /** * An ID representing this connection with flash. * @private */ javascriptId: null, /** * Creates a new instance of BinaryXhr. */ constructor: function (config) { // first, make sure flash is loading if needed if (!Ext.data.flash.BinaryXhr.flashPluginInjected) { Ext.data.flash.BinaryXhr.injectFlashPlugin(); } var me = this; Ext.apply(me, config); me.requestHeaders = {}; }, /** * Abort this connection. Sets its readyState to 4. */ abort: function () { var me = this; // if complete, nothing to abort if (me.readyState == 4) { Ext.warn.log("Aborting a connection that's completed its transfer: " + this.url); return; } // Mark as aborted me.aborted = true; // Remove ourselves from the listeners if flash isn't active yet if (!Ext.data.flash.BinaryXhr.flashPluginActive) { Ext.globalEvents.removeListener("flashready", me.onFlashReady, me); return; } // Flash is already live, so we should have a javascriptID and should have called flash to get the request going. Cancel: Ext.data.flash.BinaryXhr.flashPlugin.abortRequest(me.javascriptId); // remove from list delete Ext.data.flash.BinaryXhr.liveConnections[me.javascriptId]; }, /** * As in XMLHttpRequest. */ getAllResponseHeaders: function () { var headers = []; Ext.Object.each(this.responseHeaders, function (name, value) { headers.push(name + ': ' + value); }); return headers.join('\x0d\x0a'); }, /** * As in XMLHttpRequest. */ getResponseHeader: function (header) { var headers = this.responseHeaders; return (headers && headers[header]) || null; }, /** * As in XMLHttpRequest. */ open: function (method, url, async, user, password) { var me = this; me.method = method; me.url = url; me.async = async !== false; me.user = user; me.password = password; if (!me.async) { Ext.Error.raise("Binary posts are only supported in async mode: " + url); } if (me.method != "POST") { Ext.log.warn("Binary data can only be sent as a POST request: " + url); } }, /** * As in XMLHttpRequest. */ overrideMimeType: function (mimeType) { this.mimeType = mimeType; }, /** * Initiate the request. * @param {Array} body an array of byte values to send. */ send: function (body) { var me = this; me.body = body; if (!Ext.data.flash.BinaryXhr.flashPluginActive) { Ext.globalEvents.addListener("flashready", me.onFlashReady, me); } else { this.onFlashReady(); } }, /** * Called by send, or once flash is loaded, to actually send the bytes. * @private */ onFlashReady: function() { var me = this, req, status; me.javascriptId = Ext.data.flash.BinaryXhr.registerConnection(me); // Create the request object we're sending to flash req = { method: me.method, // ignored since we always POST binary data url: me.url, user: me.user, password: me.password, mimeType: me.mimeType, requestHeaders: me.requestHeaders, body: me.body, javascriptId: me.javascriptId }; status = Ext.data.flash.BinaryXhr.flashPlugin.postBinary(req); }, /** * Updates readyState and notifies listeners. * @private */ setReadyState: function (state) { var me = this; if (me.readyState != state) { me.readyState = state; me.onreadystatechange(); } }, /** * As in XMLHttpRequest. */ setRequestHeader: function (header, value) { this.requestHeaders[header] = value; }, /** * As in XMLHttpRequest. */ onreadystatechange: Ext.emptyFn, /** * Parses data returned from flash once a connection is done. * @param {Object} data the data object send from Flash. * @private */ parseData: function (data) { var me = this; // parse data and set up variables so that listeners can use this XHR this.status = data.status || 0; // we get back no response headers, so fake what we know: me.responseHeaders = {}; if (me.mimeType) { me.responseHeaders["content-type"] = me.mimeType; } if (data.reason == "complete") { // Transfer complete and data received this.responseBytes = data.data; me.responseHeaders["content-length"] = data.data.length; } else if (data.reason == "error" || data.reason == "securityError") { this.statusText = data.text; me.responseHeaders["content-length"] = 0; // we don't get the error response data } else { Ext.Error.raise("Unkown reason code in data: " + data.reason); } }, /** * Called once flash calls back with updates about the connection * @param {Number} state the readyState of the connection. * @param {Object} data optional data object. * @private */ onFlashStateChange: function(state, data) { var me = this; if (state == 4) { // parse data and prepare for handing back to initiator me.parseData(data); // remove from list delete Ext.data.flash.BinaryXhr.liveConnections[me.javascriptId]; } me.setReadyState(state); // notify all listeners } }); /** * The Connection class encapsulates a connection to the page's originating domain, allowing requests to be made either * to a configured URL, or to a URL specified at request time. * * Requests made by this class are asynchronous, and will return immediately. No data from the server will be available * to the statement immediately following the {@link #request} call. To process returned data, use a success callback * in the request options object, or an {@link #requestcomplete event listener}. * * # File Uploads * * File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. * Instead the form is submitted in the standard manner with the DOM <form> element temporarily modified to have its * target set to refer to a dynamically generated, hidden <iframe> which is inserted into the document but removed * after the return data has been gathered. * * The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to * send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to * insert the text unchanged into the document body. * * Characters which are significant to an HTML parser must be sent as HTML entities, so encode `<` as `<`, `&` as * `&` etc. * * The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a * responseText property in order to conform to the requirements of event handlers and callbacks. * * Be aware that file upload packets are sent with the content type multipart/form and some server technologies * (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the * packet content. * * Also note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire. * * # Binary Posts * * The class supports posting binary data to the server by using native browser capabilities, or a flash polyfill plugin in browsers that do not support native binary posting (e.g. Internet Explorer version 9 or less). A number of limitations exist when the polyfill is used: * * - Only asynchronous connections are supported. * - Only the POST method can be used. * - The return data can only be binary for now. Set the {@link Ext.data.Connection#binary binary} parameter to true. * - Only the 0, 1 and 4 (complete) readyState values will be reported to listeners. * - The flash object will be injected at the bottom of the document and should be invisible. * - Important: See note about packaing the flash plugin with the app in the documenetation of {@link Ext.data.flash.BinaryXhr BinaryXhr}. * */ Ext.define('Ext.data.Connection', { mixins: { observable: Ext.util.Observable }, statics: { requestId: 0 }, url: null, async: true, method: null, username: '', password: '', /** * @cfg {Boolean} disableCaching * True to add a unique cache-buster param to GET requests. */ disableCaching: true, /** * @cfg {Boolean} withCredentials * True to set `withCredentials = true` on the XHR object */ withCredentials: false, /** * @cfg {Boolean} binary * True if the response should be treated as binary data. If true, the binary * data will be accessible as a "responseBytes" property on the response object. */ binary: false, /** * @cfg {Boolean} cors * True to enable CORS support on the XHR object. Currently the only effect of this option * is to use the XDomainRequest object instead of XMLHttpRequest if the browser is IE8 or above. */ cors: false, isXdr: false, defaultXdrContentType: 'text/plain', /** * @cfg {String} disableCachingParam * Change the parameter which is sent went disabling caching through a cache buster. */ disableCachingParam: '_dc', /** * @cfg {Number} timeout * The timeout in milliseconds to be used for requests. */ timeout : 30000, /** * @cfg {Object} extraParams * Any parameters to be appended to the request. */ /** * @cfg {Boolean} [autoAbort=false] * Whether this request should abort any pending requests. */ /** * @cfg {String} method * The default HTTP method to be used for requests. * * If not set, but {@link #request} params are present, POST will be used; * otherwise, GET will be used. */ /** * @cfg {Object} defaultHeaders * An object containing request headers which are added to each request made by this object. */ useDefaultHeader : true, defaultPostHeader : 'application/x-www-form-urlencoded; charset=UTF-8', useDefaultXhrHeader : true, defaultXhrHeader : 'XMLHttpRequest', constructor : function(config) { config = config || {}; Ext.apply(this, config); /** * @event beforerequest * Fires before a network request is made to retrieve a data object. * @param {Ext.data.Connection} conn This Connection object. * @param {Object} options The options config object passed to the {@link #request} method. */ /** * @event requestcomplete * Fires if the request was successfully completed. * @param {Ext.data.Connection} conn This Connection object. * @param {Object} response The XHR object containing the response data. * See [The XMLHttpRequest Object](http://www.w3.org/TR/XMLHttpRequest/) for details. * @param {Object} options The options config object passed to the {@link #request} method. */ /** * @event requestexception * Fires if an error HTTP status was returned from the server. This event may also * be listened to in the event that a request has timed out or has been aborted. * See [HTTP Status Code Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) * for details of HTTP status codes. * @param {Ext.data.Connection} conn This Connection object. * @param {Object} response The XHR object containing the response data. * See [The XMLHttpRequest Object](http://www.w3.org/TR/XMLHttpRequest/) for details. * @param {Object} options The options config object passed to the {@link #request} method. */ this.requests = {}; this.mixins.observable.constructor.call(this); }, /** * Sends an HTTP request to a remote server. * * **Important:** Ajax server requests are asynchronous, and this call will * return before the response has been received. Process any returned data * in a callback function. * * Ext.Ajax.request({ * url: 'ajax_demo/sample.json', * success: function(response, opts) { * var obj = Ext.decode(response.responseText); * console.dir(obj); * }, * failure: function(response, opts) { * console.log('server-side failure with status code ' + response.status); * } * }); * * To execute a callback function in the correct scope, use the `scope` option. * * @param {Object} options An object which may contain the following properties: * * (The options object may also contain any other property which might be needed to perform * postprocessing in a callback because it is passed to callback functions.) * * @param {String/Function} options.url The URL to which to send the request, or a function * to call which returns a URL string. The scope of the function is specified by the `scope` option. * Defaults to the configured `url`. * * @param {Object/String/Function} options.params An object containing properties which are * used as parameters to the request, a url encoded string or a function to call to get either. The scope * of the function is specified by the `scope` option. * * @param {String} options.method The HTTP method to use * for the request. Defaults to the configured method, or if no method was configured, * "GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that * the method name is case-sensitive and should be all caps. * * @param {Function} options.callback The function to be called upon receipt of the HTTP response. * The callback is called regardless of success or failure and is passed the following parameters: * @param {Object} options.callback.options The parameter to the request call. * @param {Boolean} options.callback.success True if the request succeeded. * @param {Object} options.callback.response The XMLHttpRequest object containing the response data. * See [www.w3.org/TR/XMLHttpRequest/](http://www.w3.org/TR/XMLHttpRequest/) for details about * accessing elements of the response. * * @param {Function} options.success The function to be called upon success of the request. * The callback is passed the following parameters: * @param {Object} options.success.response The XMLHttpRequest object containing the response data. * @param {Object} options.success.options The parameter to the request call. * * @param {Function} options.failure The function to be called upon failure of the request. * The callback is passed the following parameters: * @param {Object} options.failure.response The XMLHttpRequest object containing the response data. * @param {Object} options.failure.options The parameter to the request call. * * @param {Object} options.scope The scope in which to execute the callbacks: The "this" object for * the callback function. If the `url`, or `params` options were specified as functions from which to * draw values, then this also serves as the scope for those function calls. Defaults to the browser * window. * * @param {Number} options.timeout The timeout in milliseconds to be used for this request. * Defaults to 30 seconds. * * @param {Ext.Element/HTMLElement/String} options.form The `
` Element or the id of the `` * to pull parameters from. * * @param {Boolean} options.isUpload **Only meaningful when used with the `form` option.** * * True if the form object is a file upload (will be set automatically if the form was configured * with **`enctype`** `"multipart/form-data"`). * * File uploads are not performed using normal "Ajax" techniques, that is they are **not** * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the * DOM `` element temporarily modified to have its [target][] set to refer to a dynamically * generated, hidden `', '{afterIFrameTpl}', { disableFormats: true } ], stretchInputElFixed: true, subTplInsertions: [ /** * @cfg {String/Array/Ext.XTemplate} beforeTextAreaTpl * An optional string or `XTemplate` configuration to insert in the field markup * before the textarea element. If an `XTemplate` is used, the component's * {@link Ext.form.field.Base#getSubTplData subTpl data} serves as the context. */ 'beforeTextAreaTpl', /** * @cfg {String/Array/Ext.XTemplate} afterTextAreaTpl * An optional string or `XTemplate` configuration to insert in the field markup * after the textarea element. If an `XTemplate` is used, the component's * {@link Ext.form.field.Base#getSubTplData subTpl data} serves as the context. */ 'afterTextAreaTpl', /** * @cfg {String/Array/Ext.XTemplate} beforeIFrameTpl * An optional string or `XTemplate` configuration to insert in the field markup * before the iframe element. If an `XTemplate` is used, the component's * {@link Ext.form.field.Base#getSubTplData subTpl data} serves as the context. */ 'beforeIFrameTpl', /** * @cfg {String/Array/Ext.XTemplate} afterIFrameTpl * An optional string or `XTemplate` configuration to insert in the field markup * after the iframe element. If an `XTemplate` is used, the component's * {@link Ext.form.field.Base#getSubTplData subTpl data} serves as the context. */ 'afterIFrameTpl', /** * @cfg {String/Array/Ext.XTemplate} iframeAttrTpl * An optional string or `XTemplate` configuration to insert in the field markup * inside the iframe element (as attributes). If an `XTemplate` is used, the component's * {@link Ext.form.field.Base#getSubTplData subTpl data} serves as the context. */ 'iframeAttrTpl', // inherited 'inputAttrTpl' ], /** * @cfg {Boolean} enableFormat * Enable the bold, italic and underline buttons */ enableFormat: true, /** * @cfg {Boolean} enableFontSize * Enable the increase/decrease font size buttons */ enableFontSize: true, /** * @cfg {Boolean} enableColors * Enable the fore/highlight color buttons */ enableColors: true, /** * @cfg {Boolean} enableAlignments * Enable the left, center, right alignment buttons */ enableAlignments: true, /** * @cfg {Boolean} enableLists * Enable the bullet and numbered list buttons. Not available in Safari 2. */ enableLists: true, /** * @cfg {Boolean} enableSourceEdit * Enable the switch to source edit button. Not available in Safari 2. */ enableSourceEdit: true, /** * @cfg {Boolean} enableLinks * Enable the create link button. Not available in Safari 2. */ enableLinks: true, /** * @cfg {Boolean} enableFont * Enable font selection. Not available in Safari 2. */ enableFont: true, // /** * @cfg {String} createLinkText * The default text for the create link prompt */ createLinkText: 'Please enter the URL for the link:', // /** * @cfg {String} [defaultLinkValue='http://'] * The default value for the create link prompt */ defaultLinkValue: 'http:/'+'/', /** * @cfg {String[]} fontFamilies * An array of available font families */ fontFamilies: [ 'Arial', 'Courier New', 'Tahoma', 'Times New Roman', 'Verdana' ], /** * @cfg {String} defaultValue * A default value to be put into the editor to resolve focus issues. * * Defaults to (Non-breaking space) in Opera and IE6, * (Zero-width space) in all other browsers. */ defaultValue: (Ext.isOpera || Ext.isIE6) ? ' ' : '​', // private extraFieldBodyCls: Ext.baseCSSPrefix + 'html-editor-wrap', /** * @cfg {String} defaultButtonUI * A default {@link Ext.Component#ui ui} to use for the HtmlEditor's toolbar * {@link Ext.button.Button Buttons} */ // @private initialized: false, // @private activated: false, // @private sourceEditMode: false, // @private iframePad:3, // @private hideMode:'offsets', maskOnDisable: true, containerElCls: Ext.baseCSSPrefix + 'html-editor-container', // @private initComponent: function(){ var me = this; me.addEvents( /** * @event initialize * Fires when the editor is fully initialized (including the iframe) * @param {Ext.form.field.HtmlEditor} this */ 'initialize', /** * @event activate * Fires when the editor is first receives the focus. Any insertion must wait until after this event. * @param {Ext.form.field.HtmlEditor} this */ 'activate', /** * @event beforesync * Fires before the textarea is updated with content from the editor iframe. Return false to cancel the * sync. * @param {Ext.form.field.HtmlEditor} this * @param {String} html */ 'beforesync', /** * @event beforepush * Fires before the iframe editor is updated with content from the textarea. Return false to cancel the * push. * @param {Ext.form.field.HtmlEditor} this * @param {String} html */ 'beforepush', /** * @event sync * Fires when the textarea is updated with content from the editor iframe. * @param {Ext.form.field.HtmlEditor} this * @param {String} html */ 'sync', /** * @event push * Fires when the iframe editor is updated with content from the textarea. * @param {Ext.form.field.HtmlEditor} this * @param {String} html */ 'push', /** * @event editmodechange * Fires when the editor switches edit modes * @param {Ext.form.field.HtmlEditor} this * @param {Boolean} sourceEdit True if source edit, false if standard editing. */ 'editmodechange' ); me.items = [me.createToolbar(), me.createInputCmp()]; me.layout = { type: 'vbox', align: 'stretch' }; me.callParent(arguments); me.initField(); }, createInputCmp: function(){ this.inputCmp = Ext.widget(this.getInputCmpCfg()); return this.inputCmp; }, getInputCmpCfg: function(){ var me = this, id = me.id + '-inputCmp', data = { id : id, name : me.name, textareaCls : Ext.baseCSSPrefix + 'hidden', value : me.value, iframeName : Ext.id(), iframeSrc : Ext.SSL_SECURE_URL, iframeCls : Ext.baseCSSPrefix + 'htmleditor-iframe' }; me.getInsertionRenderData(data, me.subTplInsertions); return { flex: 1, xtype: 'component', tpl: me.getTpl('componentTpl'), childEls: ['iframeEl', 'textareaEl'], id: id, cls: Ext.baseCSSPrefix + 'html-editor-input', data: data }; }, /* * Called when the editor creates its toolbar. Override this method if you need to * add custom toolbar buttons. * @param {Ext.form.field.HtmlEditor} editor * @protected */ createToolbar: function(){ this.toolbar = Ext.widget(this.getToolbarCfg()); return this.toolbar; }, getToolbarCfg: function(){ var me = this, items = [], i, tipsEnabled = Ext.quickTipsActive && Ext.tip.QuickTipManager.isEnabled(), baseCSSPrefix = Ext.baseCSSPrefix, fontSelectItem, undef; function btn(id, toggle, handler){ return { itemId: id, cls: baseCSSPrefix + 'btn-icon', iconCls: baseCSSPrefix + 'edit-'+id, enableToggle:toggle !== false, scope: me, handler:handler||me.relayBtnCmd, clickEvent: 'mousedown', tooltip: tipsEnabled ? me.buttonTips[id] || undef : undef, overflowText: me.buttonTips[id].title || undef, tabIndex: -1 }; } if (me.enableFont && !Ext.isSafari2) { fontSelectItem = Ext.widget('component', { itemId: 'fontSelect', renderTpl: [ '' ], childEls: ['selectEl'], afterRender: function() { me.fontSelect = this.selectEl; Ext.Component.prototype.afterRender.apply(this, arguments); }, onDisable: function() { var selectEl = this.selectEl; if (selectEl) { selectEl.dom.disabled = true; } Ext.Component.prototype.onDisable.apply(this, arguments); }, onEnable: function() { var selectEl = this.selectEl; if (selectEl) { selectEl.dom.disabled = false; } Ext.Component.prototype.onEnable.apply(this, arguments); }, listeners: { change: function() { me.win.focus(); me.relayCmd('fontName', me.fontSelect.dom.value); me.deferFocus(); }, element: 'selectEl' } }); items.push( fontSelectItem, '-' ); } if (me.enableFormat) { items.push( btn('bold'), btn('italic'), btn('underline') ); } if (me.enableFontSize) { items.push( '-', btn('increasefontsize', false, me.adjustFont), btn('decreasefontsize', false, me.adjustFont) ); } if (me.enableColors) { items.push( '-', { itemId: 'forecolor', cls: baseCSSPrefix + 'btn-icon', iconCls: baseCSSPrefix + 'edit-forecolor', overflowText: me.buttonTips.forecolor.title, tooltip: tipsEnabled ? me.buttonTips.forecolor || undef : undef, tabIndex:-1, menu: Ext.widget('menu', { plain: true, items: [{ xtype: 'colorpicker', allowReselect: true, focus: Ext.emptyFn, value: '000000', plain: true, clickEvent: 'mousedown', handler: function(cp, color) { me.relayCmd('forecolor', Ext.isWebKit || Ext.isIE ? '#'+color : color); this.up('menu').hide(); } }] }) }, { itemId: 'backcolor', cls: baseCSSPrefix + 'btn-icon', iconCls: baseCSSPrefix + 'edit-backcolor', overflowText: me.buttonTips.backcolor.title, tooltip: tipsEnabled ? me.buttonTips.backcolor || undef : undef, tabIndex:-1, menu: Ext.widget('menu', { plain: true, items: [{ xtype: 'colorpicker', focus: Ext.emptyFn, value: 'FFFFFF', plain: true, allowReselect: true, clickEvent: 'mousedown', handler: function(cp, color) { if (Ext.isGecko) { me.execCmd('useCSS', false); me.execCmd('hilitecolor', '#'+color); me.execCmd('useCSS', true); me.deferFocus(); } else { me.relayCmd(Ext.isOpera ? 'hilitecolor' : 'backcolor', Ext.isWebKit || Ext.isIE || Ext.isOpera ? '#'+color : color); } this.up('menu').hide(); } }] }) } ); } if (me.enableAlignments) { items.push( '-', btn('justifyleft'), btn('justifycenter'), btn('justifyright') ); } if (!Ext.isSafari2) { if (me.enableLinks) { items.push( '-', btn('createlink', false, me.createLink) ); } if (me.enableLists) { items.push( '-', btn('insertorderedlist'), btn('insertunorderedlist') ); } if (me.enableSourceEdit) { items.push( '-', btn('sourceedit', true, function(btn){ me.toggleSourceEdit(!me.sourceEditMode); }) ); } } // Everything starts disabled. for (i = 0; i < items.length; i++) { if (items[i].itemId !== 'sourceedit') { items[i].disabled = true; } } // build the toolbar // Automatically rendered in AbstractComponent.afterRender's renderChildren call return { xtype: 'toolbar', defaultButtonUI: me.defaultButtonUI, cls: Ext.baseCSSPrefix + 'html-editor-tb', enableOverflow: true, items: items, // stop form submits listeners: { click: function(e){ e.preventDefault(); }, element: 'el' } }; }, getMaskTarget: function(){ // Can't be the body td directly because of issues with absolute positioning // inside td's in FF return Ext.isGecko ? this.inputCmp.el : this.bodyEl; }, /** * Sets the read only state of this field. * @param {Boolean} readOnly Whether the field should be read only. */ setReadOnly: function(readOnly) { var me = this, textareaEl = me.textareaEl, iframeEl = me.iframeEl, body; me.readOnly = readOnly; if (textareaEl) { textareaEl.dom.readOnly = readOnly; } if (me.initialized) { body = me.getEditorBody(); if (Ext.isIE) { // Hide the iframe while setting contentEditable so it doesn't grab focus iframeEl.setDisplayed(false); body.contentEditable = !readOnly; iframeEl.setDisplayed(true); } else { me.setDesignMode(!readOnly); } if (body) { body.style.cursor = readOnly ? 'default' : 'text'; } me.disableItems(readOnly); } }, /** * Called when the editor initializes the iframe with HTML contents. Override this method if you * want to change the initialization markup of the iframe (e.g. to add stylesheets). * * **Note:** IE8-Standards has unwanted scroller behavior, so the default meta tag forces IE7 compatibility. * Also note that forcing IE7 mode works when the page is loaded normally, but if you are using IE's Web * Developer Tools to manually set the document mode, that will take precedence and override what this * code sets by default. This can be confusing when developing, but is not a user-facing issue. * @protected */ getDocMarkup: function() { var me = this, h = me.iframeEl.getHeight() - me.iframePad * 2, oldIE = Ext.isIE8m; // - IE9+ require a strict doctype otherwise text outside visible area can't be selected. // - Opera inserts

tags on Return key, so P margins must be removed to avoid double line-height. // - On browsers other than IE, the font is not inherited by the IFRAME so it must be specified. return Ext.String.format( (oldIE ? '' : '') + '' , me.iframePad, h, me.defaultFont); }, // @private getEditorBody: function() { var doc = this.getDoc(); return doc.body || doc.documentElement; }, // @private getDoc: function() { return (!Ext.isIE && this.iframeEl.dom.contentDocument) || this.getWin().document; }, // @private getWin: function() { return Ext.isIE ? this.iframeEl.dom.contentWindow : window.frames[this.iframeEl.dom.name]; }, initDefaultFont: function(){ // It's not ideal to do this here since it's a write phase, but we need to know // what the font used in the textarea is so that we can setup the appropriate font // options in the select box. The select box will reflow once we populate it, so we want // to do so before we layout the first time. var me = this, selIdx = 0, fonts, font, select, option, i, len, lower; if (!me.defaultFont) { font = me.textareaEl.getStyle('font-family'); font = Ext.String.capitalize(font.split(',')[0]); fonts = Ext.Array.clone(me.fontFamilies); Ext.Array.include(fonts, font); fonts.sort(); me.defaultFont = font; select = me.down('#fontSelect').selectEl.dom; for (i = 0, len = fonts.length; i < len; ++i) { font = fonts[i]; lower = font.toLowerCase(); option = new Option(font, lower); if (font == me.defaultFont) { selIdx = i; } option.style.fontFamily = lower; if (Ext.isIE) { select.add(option); } else { select.options.add(option); } } // Old IE versions have a problem if we set the selected property // in the loop, so set it after. select.options[selIdx].selected = true; } }, isEqual: function(value1, value2){ return this.isEqualAsString(value1, value2); }, // @private afterRender: function() { var me = this, inputCmp = me.inputCmp; me.callParent(arguments); me.iframeEl = inputCmp.iframeEl; me.textareaEl = inputCmp.textareaEl; // The input element is interrogated by the layout to extract height when labelAlign is 'top' // It must be set, and then switched between the iframe and the textarea me.inputEl = me.iframeEl; if (me.enableFont) { me.initDefaultFont(); } // Start polling for when the iframe document is ready to be manipulated me.monitorTask = Ext.TaskManager.start({ run: me.checkDesignMode, scope: me, interval: 100 }); me.relayCmd('fontName', me.defaultFont); }, initFrameDoc: function() { var me = this, doc, task; Ext.TaskManager.stop(me.monitorTask); doc = me.getDoc(); me.win = me.getWin(); doc.open(); doc.write(me.getDocMarkup()); doc.close(); task = { // must defer to wait for browser to be ready run: function() { var doc = me.getDoc(); if (doc.body || doc.readyState === 'complete') { Ext.TaskManager.stop(task); me.setDesignMode(true); Ext.defer(me.initEditor, 10, me); } }, interval: 10, duration:10000, scope: me }; Ext.TaskManager.start(task); }, checkDesignMode: function() { var me = this, doc = me.getDoc(); if (doc && (!doc.editorInitialized || me.getDesignMode() !== 'on')) { me.initFrameDoc(); } }, /** * @private * Sets current design mode. To enable, mode can be true or 'on', off otherwise */ setDesignMode: function(mode) { var me = this, doc = me.getDoc(); if (doc) { if (me.readOnly) { mode = false; } doc.designMode = (/on|true/i).test(String(mode).toLowerCase()) ?'on':'off'; } }, // @private getDesignMode: function() { var doc = this.getDoc(); return !doc ? '' : String(doc.designMode).toLowerCase(); }, disableItems: function(disabled) { var items = this.getToolbar().items.items, i, iLen = items.length, item; for (i = 0; i < iLen; i++) { item = items[i]; if (item.getItemId() !== 'sourceedit') { item.setDisabled(disabled); } } }, /** * Toggles the editor between standard and source edit mode. * @param {Boolean} [sourceEditMode] True for source edit, false for standard */ toggleSourceEdit: function(sourceEditMode) { var me = this, iframe = me.iframeEl, textarea = me.textareaEl, hiddenCls = Ext.baseCSSPrefix + 'hidden', btn = me.getToolbar().getComponent('sourceedit'); if (!Ext.isBoolean(sourceEditMode)) { sourceEditMode = !me.sourceEditMode; } me.sourceEditMode = sourceEditMode; if (btn.pressed !== sourceEditMode) { btn.toggle(sourceEditMode); } if (sourceEditMode) { me.disableItems(true); me.syncValue(); iframe.addCls(hiddenCls); textarea.removeCls(hiddenCls); textarea.dom.removeAttribute('tabIndex'); textarea.focus(); me.inputEl = textarea; } else { if (me.initialized) { me.disableItems(me.readOnly); } me.pushValue(); iframe.removeCls(hiddenCls); textarea.addCls(hiddenCls); textarea.dom.setAttribute('tabIndex', -1); me.deferFocus(); me.inputEl = iframe; } me.fireEvent('editmodechange', me, sourceEditMode); me.updateLayout(); }, // @private used internally createLink: function() { var url = prompt(this.createLinkText, this.defaultLinkValue); if (url && url !== 'http:/'+'/') { this.relayCmd('createlink', url); } }, clearInvalid: Ext.emptyFn, setValue: function(value) { var me = this, textarea = me.textareaEl, inputCmp = me.inputCmp; me.mixins.field.setValue.call(me, value); if (value === null || value === undefined) { value = ''; } if (textarea) { textarea.dom.value = value; } me.pushValue(); if (!me.rendered && me.inputCmp) { me.inputCmp.data.value = value; } return me; }, /** * If you need/want custom HTML cleanup, this is the method you should override. * @param {String} html The HTML to be cleaned * @return {String} The cleaned HTML * @protected */ cleanHtml: function(html) { html = String(html); if (Ext.isWebKit) { // strip safari nonsense html = html.replace(/\sclass="(?:Apple-style-span|Apple-tab-span|khtml-block-placeholder)"/gi, ''); } /* * Neat little hack. Strips out all the non-digit characters from the default * value and compares it to the character code of the first character in the string * because it can cause encoding issues when posted to the server. We need the * parseInt here because charCodeAt will return a number. */ if (html.charCodeAt(0) === parseInt(this.defaultValue.replace(/\D/g, ''), 10)) { html = html.substring(1); } return html; }, /** * Syncs the contents of the editor iframe with the textarea. * @protected */ syncValue: function(){ var me = this, body, changed, html, bodyStyle, match, textElDom; if (me.initialized) { body = me.getEditorBody(); html = body.innerHTML; textElDom = me.textareaEl.dom; if (Ext.isWebKit) { bodyStyle = body.getAttribute('style'); // Safari puts text-align styles on the body element! match = bodyStyle.match(/text-align:(.*?);/i); if (match && match[1]) { html = '

' + html + '
'; } } html = me.cleanHtml(html); if (me.fireEvent('beforesync', me, html) !== false) { // Gecko inserts single
tag when input is empty // and user toggles source mode. See https://sencha.jira.com/browse/EXTJSIV-8542 if (Ext.isGecko && textElDom.value === '' && html === '
') { html = ''; } if (textElDom.value !== html) { textElDom.value = html; changed = true; } me.fireEvent('sync', me, html); if (changed) { // we have to guard this to avoid infinite recursion because getValue // calls this method... me.checkChange(); } } } }, getValue: function() { var me = this, value; if (!me.sourceEditMode) { me.syncValue(); } value = me.rendered ? me.textareaEl.dom.value : me.value; me.value = value; return value; }, /** * Pushes the value of the textarea into the iframe editor. * @protected */ pushValue: function() { var me = this, v; if(me.initialized){ v = me.textareaEl.dom.value || ''; if (!me.activated && v.length < 1) { v = me.defaultValue; } if (me.fireEvent('beforepush', me, v) !== false) { me.getEditorBody().innerHTML = v; if (Ext.isGecko) { // Gecko hack, see: https://bugzilla.mozilla.org/show_bug.cgi?id=232791#c8 me.setDesignMode(false); //toggle off first me.setDesignMode(true); } me.fireEvent('push', me, v); } } }, // @private deferFocus: function(){ this.focus(false, true); }, getFocusEl: function() { var me = this, win = me.win; return win && !me.sourceEditMode ? win : me.textareaEl; }, focus: function(selectText, delay) { var me = this, value, focusEl; if (delay) { if (!me.focusTask) { me.focusTask = new Ext.util.DelayedTask(me.focus); } me.focusTask.delay(Ext.isNumber(delay) ? delay : 10, null, me, [selectText, false]); } else { if (selectText) { if (me.textareaEl && me.textareaEl.dom) { value = me.textareaEl.dom.value; } if (value && value.length) { // Make sure there is content before calling SelectAll, otherwise the caret disappears. me.execCmd('selectall', true); } } focusEl = me.getFocusEl(); if (focusEl && focusEl.focus) { focusEl.focus(); } } return me; }, // @private initEditor: function(){ //Destroying the component during/before initEditor can cause issues. try { var me = this, dbody = me.getEditorBody(), ss = me.textareaEl.getStyles('font-size', 'font-family', 'background-image', 'background-repeat', 'background-color', 'color'), doc, fn; ss['background-attachment'] = 'fixed'; // w3c dbody.bgProperties = 'fixed'; // ie Ext.DomHelper.applyStyles(dbody, ss); doc = me.getDoc(); if (doc) { try { Ext.EventManager.removeAll(doc); } catch(e) {} } /* * We need to use createDelegate here, because when using buffer, the delayed task is added * as a property to the function. When the listener is removed, the task is deleted from the function. * Since onEditorEvent is shared on the prototype, if we have multiple html editors, the first time one of the editors * is destroyed, it causes the fn to be deleted from the prototype, which causes errors. Essentially, we're just anonymizing the function. */ fn = Ext.Function.bind(me.onEditorEvent, me); Ext.EventManager.on(doc, { mousedown: fn, dblclick: fn, click: fn, keyup: fn, buffer:100 }); // These events need to be relayed from the inner document (where they stop // bubbling) up to the outer document. This has to be done at the DOM level so // the event reaches listeners on elements like the document body. The effected // mechanisms that depend on this bubbling behavior are listed to the right // of the event. fn = me.onRelayedEvent; Ext.EventManager.on(doc, { mousedown: fn, // menu dismisal (MenuManager) and Window onMouseDown (toFront) mousemove: fn, // window resize drag detection mouseup: fn, // window resize termination click: fn, // not sure, but just to be safe dblclick: fn, // not sure again scope: me }); if (Ext.isGecko) { Ext.EventManager.on(doc, 'keypress', me.applyCommand, me); } if (me.fixKeys) { Ext.EventManager.on(doc, 'keydown', me.fixKeys, me); } if (me.fixKeysAfter) { Ext.EventManager.on(doc, 'keyup', me.fixKeysAfter, me); } if (Ext.isIE9 && Ext.isStrict) { Ext.EventManager.on(doc.documentElement, 'focus', me.focus, me); } // In old IEs, clicking on a toolbar button shifts focus from iframe // and it loses selection. To avoid this, we save current selection // and restore it. if (Ext.isIE8m || (Ext.isIE9 && !Ext.isStrict)) { Ext.EventManager.on(doc, 'focusout', function() { me.savedSelection = doc.selection.type !== 'None' ? doc.selection.createRange() : null; }, me); Ext.EventManager.on(doc, 'focusin', function() { if (me.savedSelection) { me.savedSelection.select(); } }, me); } // We need to be sure we remove all our events from the iframe on unload or we're going to LEAK! Ext.EventManager.onWindowUnload(me.beforeDestroy, me); doc.editorInitialized = true; me.initialized = true; me.pushValue(); me.setReadOnly(me.readOnly); me.fireEvent('initialize', me); } catch(ex) { // ignore (why?) } }, // @private beforeDestroy: function(){ var me = this, monitorTask = me.monitorTask, doc, prop; if (monitorTask) { Ext.TaskManager.stop(monitorTask); } if (me.rendered) { Ext.EventManager.removeUnloadListener(me.beforeDestroy, me); try { doc = me.getDoc(); if (doc) { // removeAll() doesn't currently know how to handle iframe document, // so for now we have to wrap it in an Ext.Element using Ext.fly, // or else IE6/7 will leak big time when the page is refreshed. // TODO: this may not be needed once we find a more permanent fix. // see EXTJSIV-5891. Ext.EventManager.removeAll(Ext.fly(doc)); for (prop in doc) { if (doc.hasOwnProperty && doc.hasOwnProperty(prop)) { delete doc[prop]; } } } } catch(e) { // ignore (why?) } delete me.iframeEl; delete me.textareaEl; delete me.toolbar; delete me.inputCmp; } me.callParent(); }, // @private onRelayedEvent: function (event) { // relay event from the iframe's document to the document that owns the iframe... var iframeEl = this.iframeEl, // Get the left-based iframe position iframeXY = Ext.Element.getTrueXY(iframeEl), originalEventXY = event.getXY(), // Get the left-based XY position. // This is because the consumer of the injected event (Ext.EventManager) will // perform its own RTL normalization. eventXY = Ext.EventManager.getPageXY(event.browserEvent); // the event from the inner document has XY relative to that document's origin, // so adjust it to use the origin of the iframe in the outer document: event.xy = [iframeXY[0] + eventXY[0], iframeXY[1] + eventXY[1]]; event.injectEvent(iframeEl); // blame the iframe for the event... event.xy = originalEventXY; // restore the original XY (just for safety) }, // @private onFirstFocus: function(){ var me = this, selection, range; me.activated = true; me.disableItems(me.readOnly); if (Ext.isGecko) { // prevent silly gecko errors me.win.focus(); selection = me.win.getSelection(); if (!selection.focusNode || selection.focusNode.nodeType !== 3) { range = selection.getRangeAt(0); range.selectNodeContents(me.getEditorBody()); range.collapse(true); me.deferFocus(); } try { me.execCmd('useCSS', true); me.execCmd('styleWithCSS', false); } catch(e) { // ignore (why?) } } me.fireEvent('activate', me); }, // @private adjustFont: function(btn) { var adjust = btn.getItemId() === 'increasefontsize' ? 1 : -1, size = this.getDoc().queryCommandValue('FontSize') || '2', isPxSize = Ext.isString(size) && size.indexOf('px') !== -1, isSafari; size = parseInt(size, 10); if (isPxSize) { // Safari 3 values // 1 = 10px, 2 = 13px, 3 = 16px, 4 = 18px, 5 = 24px, 6 = 32px if (size <= 10) { size = 1 + adjust; } else if (size <= 13) { size = 2 + adjust; } else if (size <= 16) { size = 3 + adjust; } else if (size <= 18) { size = 4 + adjust; } else if (size <= 24) { size = 5 + adjust; } else { size = 6 + adjust; } size = Ext.Number.constrain(size, 1, 6); } else { isSafari = Ext.isSafari; if (isSafari) { // safari adjust *= 2; } size = Math.max(1, size + adjust) + (isSafari ? 'px' : 0); } this.relayCmd('FontSize', size); }, // @private onEditorEvent: function(e) { this.updateToolbar(); }, /** * Triggers a toolbar update by reading the markup state of the current selection in the editor. * @protected */ updateToolbar: function() { var me = this, i, l, btns, doc, name, queriedName, fontSelect, toolbarSubmenus; if (me.readOnly) { return; } if (!me.activated) { me.onFirstFocus(); return; } btns = me.getToolbar().items.map; doc = me.getDoc(); if (me.enableFont && !Ext.isSafari2) { // When querying the fontName, Chrome may return an Array of font names // with those containing spaces being placed between single-quotes. queriedName = doc.queryCommandValue('fontName'); name = (queriedName ? queriedName.split(",")[0].replace(/^'/,'').replace(/'$/,'') : me.defaultFont).toLowerCase(); fontSelect = me.fontSelect.dom; if (name !== fontSelect.value || name != queriedName) { fontSelect.value = name; } } function updateButtons() { var state; for (i = 0, l = arguments.length, name; i < l; i++) { name = arguments[i]; // Firefox 18+ sometimes throws NS_ERROR_INVALID_POINTER exception // See https://sencha.jira.com/browse/EXTJSIV-9766 try { state = doc.queryCommandState(name); } catch (e) { state = false; } btns[name].toggle(state); } } if(me.enableFormat){ updateButtons('bold', 'italic', 'underline'); } if(me.enableAlignments){ updateButtons('justifyleft', 'justifycenter', 'justifyright'); } if(!Ext.isSafari2 && me.enableLists){ updateButtons('insertorderedlist', 'insertunorderedlist'); } // Ensure any of our toolbar's owned menus are hidden. // The overflow menu must control itself. toolbarSubmenus = me.toolbar.query('menu'); for (i = 0; i < toolbarSubmenus.length; i++) { toolbarSubmenus[i].hide(); } me.syncValue(); }, // @private relayBtnCmd: function(btn) { this.relayCmd(btn.getItemId()); }, /** * Executes a Midas editor command on the editor document and performs necessary focus and toolbar updates. * **This should only be called after the editor is initialized.** * @param {String} cmd The Midas command * @param {String/Boolean} [value=null] The value to pass to the command */ relayCmd: function(cmd, value) { Ext.defer(function() { var me = this; if (!this.isDestroyed) { me.win.focus(); me.execCmd(cmd, value); me.updateToolbar(); } }, 10, this); }, /** * Executes a Midas editor command directly on the editor document. For visual commands, you should use * {@link #relayCmd} instead. **This should only be called after the editor is initialized.** * @param {String} cmd The Midas command * @param {String/Boolean} [value=null] The value to pass to the command */ execCmd: function(cmd, value){ var me = this, doc = me.getDoc(); doc.execCommand(cmd, false, (value == undefined ? null : value)); me.syncValue(); }, // @private applyCommand: function(e){ if (e.ctrlKey) { var me = this, c = e.getCharCode(), cmd; if (c > 0) { c = String.fromCharCode(c); switch (c) { case 'b': cmd = 'bold'; break; case 'i': cmd = 'italic'; break; case 'u': cmd = 'underline'; break; } if (cmd) { me.win.focus(); me.execCmd(cmd); me.deferFocus(); e.preventDefault(); } } } }, /** * Inserts the passed text at the current cursor position. * __Note:__ the editor must be initialized and activated to insert text. * @param {String} text */ insertAtCursor: function(text){ var me = this, range; if (me.activated) { me.win.focus(); if (Ext.isIE) { range = me.getDoc().selection.createRange(); if (range) { range.pasteHTML(text); me.syncValue(); me.deferFocus(); } }else{ me.execCmd('InsertHTML', text); me.deferFocus(); } } }, // @private fixKeys: (function() { // load time branching for fastest keydown performance if (Ext.isIE) { return function(e){ var me = this, k = e.getKey(), doc = me.getDoc(), readOnly = me.readOnly, range, target; if (k === e.TAB) { e.stopEvent(); if (!readOnly) { range = doc.selection.createRange(); if (range){ if (range.collapse) { range.collapse(true); range.pasteHTML('    '); } me.deferFocus(); } } } else if (k === e.ENTER) { if (!readOnly) { range = doc.selection.createRange(); if (range) { target = range.parentElement(); if(!target || target.tagName.toLowerCase() !== 'li'){ e.stopEvent(); range.pasteHTML('
'); range.collapse(false); range.select(); } } } } }; } if (Ext.isOpera) { return function(e){ var me = this, k = e.getKey(), readOnly = me.readOnly; if (k === e.TAB) { e.stopEvent(); if (!readOnly) { me.win.focus(); me.execCmd('InsertHTML','    '); me.deferFocus(); } } }; } return null; // not needed, so null }()), // @private fixKeysAfter: (function() { if (Ext.isIE) { return function(e) { var me = this, k = e.getKey(), doc = me.getDoc(), readOnly = me.readOnly, innerHTML; if (!readOnly && (k === e.BACKSPACE || k === e.DELETE)) { innerHTML = doc.body.innerHTML; // If HtmlEditor had some input and user cleared it, IE inserts

 

// which makes an impression that there is still some text, and creeps // into source mode when toggled. We don't want this. // // See https://sencha.jira.com/browse/EXTJSIV-8542 // // N.B. There is **small** chance that user could go to source mode, // type '

 

', switch back to visual mode, type something else // and then clear it -- the code below would clear the

tag as well, // which could be considered a bug. However I see no way to distinguish // between offending markup being entered manually and generated by IE, // so this can be considered a nasty corner case. // if (innerHTML === '

 

' || innerHTML === '

 

') { doc.body.innerHTML = ''; } } } } return null; }()), /** * Returns the editor's toolbar. **This is only available after the editor has been rendered.** * @return {Ext.toolbar.Toolbar} */ getToolbar: function(){ return this.toolbar; }, // /** * @property {Object} buttonTips * Object collection of toolbar tooltips for the buttons in the editor. The key is the command id associated with * that button and the value is a valid QuickTips object. For example: * * { * bold: { * title: 'Bold (Ctrl+B)', * text: 'Make the selected text bold.', * cls: 'x-html-editor-tip' * }, * italic: { * title: 'Italic (Ctrl+I)', * text: 'Make the selected text italic.', * cls: 'x-html-editor-tip' * } * // ... * } */ buttonTips: { bold: { title: 'Bold (Ctrl+B)', text: 'Make the selected text bold.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, italic: { title: 'Italic (Ctrl+I)', text: 'Make the selected text italic.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, underline: { title: 'Underline (Ctrl+U)', text: 'Underline the selected text.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, increasefontsize: { title: 'Grow Text', text: 'Increase the font size.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, decreasefontsize: { title: 'Shrink Text', text: 'Decrease the font size.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, backcolor: { title: 'Text Highlight Color', text: 'Change the background color of the selected text.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, forecolor: { title: 'Font Color', text: 'Change the color of the selected text.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, justifyleft: { title: 'Align Text Left', text: 'Align text to the left.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, justifycenter: { title: 'Center Text', text: 'Center text in the editor.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, justifyright: { title: 'Align Text Right', text: 'Align text to the right.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, insertunorderedlist: { title: 'Bullet List', text: 'Start a bulleted list.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, insertorderedlist: { title: 'Numbered List', text: 'Start a numbered list.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, createlink: { title: 'Hyperlink', text: 'Make the selected text a hyperlink.', cls: Ext.baseCSSPrefix + 'html-editor-tip' }, sourceedit: { title: 'Source Edit', text: 'Switch to source editing mode.', cls: Ext.baseCSSPrefix + 'html-editor-tip' } } // // hide stuff that is not compatible /** * @event blur * @private */ /** * @event focus * @private */ /** * @event specialkey * @private */ /** * @cfg {String} fieldCls * @private */ /** * @cfg {String} focusCls * @private */ /** * @cfg {String} autoCreate * @private */ /** * @cfg {String} inputType * @private */ /** * @cfg {String} invalidCls * @private */ /** * @cfg {String} invalidText * @private */ /** * @cfg {String} msgFx * @private */ /** * @cfg {Boolean} allowDomMove * @private */ /** * @cfg {String} applyTo * @private */ /** * @cfg {String} readOnly * @private */ /** * @cfg {String} tabIndex * @private */ /** * @method validate * @private */ }); /** * A time picker which provides a list of times from which to choose. This is used by the Ext.form.field.Time * class to allow browsing and selection of valid times, but could also be used with other components. * * By default, all times starting at midnight and incrementing every 15 minutes will be presented. This list of * available times can be controlled using the {@link #minValue}, {@link #maxValue}, and {@link #increment} * configuration properties. The format of the times presented in the list can be customized with the {@link #format} * config. * * To handle when the user selects a time from the list, you can subscribe to the {@link #selectionchange} event. * * @example * Ext.create('Ext.picker.Time', { * width: 60, * minValue: Ext.Date.parse('04:30:00 AM', 'h:i:s A'), * maxValue: Ext.Date.parse('08:00:00 AM', 'h:i:s A'), * renderTo: Ext.getBody() * }); */ Ext.define('Ext.picker.Time', { extend: Ext.view.BoundList , alias: 'widget.timepicker', /** * @cfg {Date} minValue * The minimum time to be shown in the list of times. This must be a Date object (only the time fields will be * used); no parsing of String values will be done. */ /** * @cfg {Date} maxValue * The maximum time to be shown in the list of times. This must be a Date object (only the time fields will be * used); no parsing of String values will be done. */ /** * @cfg {Number} increment * The number of minutes between each time value in the list. */ increment: 15, // /** * @cfg {String} [format=undefined] * The default time format string which can be overriden for localization support. The format must be valid * according to {@link Ext.Date#parse}. * * Defaults to `'g:i A'`, e.g., `'3:15 PM'`. For 24-hour time format try `'H:i'` instead. */ format : "g:i A", // /** * @private * The field in the implicitly-generated Model objects that gets displayed in the list. This is * an internal field name only and is not useful to change via config. */ displayField: 'disp', /** * @private * Year, month, and day that all times will be normalized into internally. */ initDate: [2008,0,1], componentCls: Ext.baseCSSPrefix + 'timepicker', /** * @cfg * @private */ loadMask: false, initComponent: function() { var me = this, dateUtil = Ext.Date, clearTime = dateUtil.clearTime, initDate = me.initDate; // Set up absolute min and max for the entire day me.absMin = clearTime(new Date(initDate[0], initDate[1], initDate[2])); me.absMax = dateUtil.add(clearTime(new Date(initDate[0], initDate[1], initDate[2])), 'mi', (24 * 60) - 1); me.store = me.createStore(); // Add our min/max range filter, but do not apply it. // The owning TimeField will filter it. me.store.addFilter(me.rangeFilter = new Ext.util.Filter({ id: 'time-picker-filter' }), false); // Updates the range filter's filterFn according to our configured min and max me.updateList(); me.callParent(); }, /** * Set the {@link #minValue} and update the list of available times. This must be a Date object (only the time * fields will be used); no parsing of String values will be done. * @param {Date} value */ setMinValue: function(value) { this.minValue = value; this.updateList(); }, /** * Set the {@link #maxValue} and update the list of available times. This must be a Date object (only the time * fields will be used); no parsing of String values will be done. * @param {Date} value */ setMaxValue: function(value) { this.maxValue = value; this.updateList(); }, /** * @private * Sets the year/month/day of the given Date object to the {@link #initDate}, so that only * the time fields are significant. This makes values suitable for time comparison. * @param {Date} date */ normalizeDate: function(date) { var initDate = this.initDate; date.setFullYear(initDate[0], initDate[1], initDate[2]); return date; }, /** * Update the list of available times in the list to be constrained within the {@link #minValue} * and {@link #maxValue}. */ updateList: function() { var me = this, min = me.normalizeDate(me.minValue || me.absMin), max = me.normalizeDate(me.maxValue || me.absMax); me.rangeFilter.setFilterFn(function(record) { var date = record.get('date'); return date >= min && date <= max; }); me.store.filter(); }, /** * @private * Creates the internal {@link Ext.data.Store} that contains the available times. The store * is loaded with all possible times, and it is later filtered to hide those times outside * the minValue/maxValue. */ createStore: function() { var me = this, utilDate = Ext.Date, times = [], min = me.absMin, max = me.absMax; while(min <= max){ times.push({ disp: utilDate.dateFormat(min, me.format), date: min }); min = utilDate.add(min, 'mi', me.increment); } return new Ext.data.Store({ fields: ['disp', 'date'], data: times }); }, focusNode: function (rec) { // We don't want the view being focused when interacting with the inputEl (see Ext.form.field.ComboBox:onKeyUp) // so this is here to prevent focus of the boundlist view. See EXTJSIV-7319. return false; } }); /** * Provides a time input field with a time dropdown and automatic time validation. * * This field recognizes and uses JavaScript Date objects as its main {@link #value} type (only the time portion of the * date is used; the month/day/year are ignored). In addition, it recognizes string values which are parsed according to * the {@link #format} and/or {@link #altFormats} configs. These may be reconfigured to use time formats appropriate for * the user's locale. * * The field may be limited to a certain range of times by using the {@link #minValue} and {@link #maxValue} configs, * and the interval between time options in the dropdown can be changed with the {@link #increment} config. * * Example usage: * * @example * Ext.create('Ext.form.Panel', { * title: 'Time Card', * width: 300, * bodyPadding: 10, * renderTo: Ext.getBody(), * items: [{ * xtype: 'timefield', * name: 'in', * fieldLabel: 'Time In', * minValue: '6:00 AM', * maxValue: '8:00 PM', * increment: 30, * anchor: '100%' * }, { * xtype: 'timefield', * name: 'out', * fieldLabel: 'Time Out', * minValue: '6:00 AM', * maxValue: '8:00 PM', * increment: 30, * anchor: '100%' * }] * }); */ Ext.define('Ext.form.field.Time', { extend: Ext.form.field.ComboBox , alias: 'widget.timefield', alternateClassName: ['Ext.form.TimeField', 'Ext.form.Time'], /** * @cfg {String} [triggerCls='x-form-time-trigger'] * An additional CSS class used to style the trigger button. The trigger will always get the {@link #triggerBaseCls} * by default and triggerCls will be **appended** if specified. */ triggerCls: Ext.baseCSSPrefix + 'form-time-trigger', /** * @cfg {Date/String} minValue * The minimum allowed time. Can be either a Javascript date object with a valid time value or a string time in a * valid format -- see {@link #format} and {@link #altFormats}. */ /** * @cfg {Date/String} maxValue * The maximum allowed time. Can be either a Javascript date object with a valid time value or a string time in a * valid format -- see {@link #format} and {@link #altFormats}. */ // /** * @cfg {String} minText * The error text to display when the entered time is before {@link #minValue}. */ minText : "The time in this field must be equal to or after {0}", // // /** * @cfg {String} maxText * The error text to display when the entered time is after {@link #maxValue}. */ maxText : "The time in this field must be equal to or before {0}", // // /** * @cfg {String} invalidText * The error text to display when the time in the field is invalid. */ invalidText : "{0} is not a valid time", // // /** * @cfg {String} [format=undefined] * The default time format string which can be overriden for localization support. The format must be valid * according to {@link Ext.Date#parse}. * * Defaults to `'g:i A'`, e.g., `'3:15 PM'`. For 24-hour time format try `'H:i'` instead. */ format : "g:i A", // // /** * @cfg {String} [submitFormat=undefined] * The date format string which will be submitted to the server. The format must be valid according to * {@link Ext.Date#parse}. * * Defaults to {@link #format}. */ // // /** * @cfg {String} altFormats * Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined * format. */ altFormats : "g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A", // /** * @cfg {Number} increment * The number of minutes between each time value in the list. */ increment: 15, /** * @cfg {Number} pickerMaxHeight * The maximum height of the {@link Ext.picker.Time} dropdown. */ pickerMaxHeight: 300, /** * @cfg {Boolean} selectOnTab * Whether the Tab key should select the currently highlighted item. */ selectOnTab: true, /** * @cfg {Boolean} [snapToIncrement=false] * Specify as `true` to enforce that only values on the {@link #increment} boundary are accepted. */ snapToIncrement: false, /** * @private * This is the date to use when generating time values in the absence of either minValue * or maxValue. Using the current date causes DST issues on DST boundary dates, so this is an * arbitrary "safe" date that can be any date aside from DST boundary dates. */ initDate: '1/1/2008', initDateFormat: 'j/n/Y', ignoreSelection: 0, queryMode: 'local', displayField: 'disp', valueField: 'date', initComponent: function() { var me = this, min = me.minValue, max = me.maxValue; if (min) { me.setMinValue(min); } if (max) { me.setMaxValue(max); } me.displayTpl = new Ext.XTemplate( '' + '{[typeof values === "string" ? values : this.formatDate(values["' + me.displayField + '"])]}' + '' + me.delimiter + '' + '', { formatDate: Ext.Function.bind(me.formatDate, me) }); this.callParent(); }, /** * @private */ transformOriginalValue: function(value) { if (Ext.isString(value)) { return this.rawToValue(value); } return value; }, /** * @private */ isEqual: function(v1, v2) { return Ext.Date.isEqual(v1, v2); }, /** * Replaces any existing {@link #minValue} with the new time and refreshes the picker's range. * @param {Date/String} value The minimum time that can be selected */ setMinValue: function(value) { var me = this, picker = me.picker; me.setLimit(value, true); if (picker) { picker.setMinValue(me.minValue); } }, /** * Replaces any existing {@link #maxValue} with the new time and refreshes the picker's range. * @param {Date/String} value The maximum time that can be selected */ setMaxValue: function(value) { var me = this, picker = me.picker; me.setLimit(value, false); if (picker) { picker.setMaxValue(me.maxValue); } }, /** * @private * Updates either the min or max value. Converts the user's value into a Date object whose * year/month/day is set to the {@link #initDate} so that only the time fields are significant. */ setLimit: function(value, isMin) { var me = this, d, val; if (Ext.isString(value)) { d = me.parseDate(value); } else if (Ext.isDate(value)) { d = value; } if (d) { val = Ext.Date.clearTime(new Date(me.initDate)); val.setHours(d.getHours(), d.getMinutes(), d.getSeconds(), d.getMilliseconds()); } // Invalid min/maxValue config should result in a null so that defaulting takes over else { val = null; } me[isMin ? 'minValue' : 'maxValue'] = val; }, rawToValue: function(rawValue) { return this.parseDate(rawValue) || rawValue || null; }, valueToRaw: function(value) { return this.formatDate(this.parseDate(value)); }, /** * Runs all of Time's validations and returns an array of any errors. Note that this first runs Text's validations, * so the returned array is an amalgamation of all field errors. The additional validation checks are testing that * the time format is valid, that the chosen time is within the {@link #minValue} and {@link #maxValue} constraints * set. * @param {Object} [value] The value to get errors for (defaults to the current field value) * @return {String[]} All validation errors for this field */ getErrors: function(value) { var me = this, format = Ext.String.format, errors = me.callParent(arguments), minValue = me.minValue, maxValue = me.maxValue, date; value = me.formatDate(value || me.processRawValue(me.getRawValue())); if (value === null || value.length < 1) { // if it's blank and textfield didn't flag it then it's valid return errors; } date = me.parseDate(value); if (!date) { errors.push(format(me.invalidText, value, Ext.Date.unescapeFormat(me.format))); return errors; } if (minValue && date < minValue) { errors.push(format(me.minText, me.formatDate(minValue))); } if (maxValue && date > maxValue) { errors.push(format(me.maxText, me.formatDate(maxValue))); } return errors; }, formatDate: function() { return Ext.form.field.Date.prototype.formatDate.apply(this, arguments); }, /** * @private * Parses an input value into a valid Date object. * @param {String/Date} value */ parseDate: function(value) { var me = this, val = value, altFormats = me.altFormats, altFormatsArray = me.altFormatsArray, i = 0, len; if (value && !Ext.isDate(value)) { val = me.safeParse(value, me.format); if (!val && altFormats) { altFormatsArray = altFormatsArray || altFormats.split('|'); len = altFormatsArray.length; for (; i < len && !val; ++i) { val = me.safeParse(value, altFormatsArray[i]); } } } // If configured to snap, snap resulting parsed Date to the closest increment. if (val && me.snapToIncrement) { val = new Date(Ext.Number.snap(val.getTime(), me.increment * 60 * 1000)); } return val; }, safeParse: function(value, format){ var me = this, utilDate = Ext.Date, parsedDate, result = null; if (utilDate.formatContainsDateInfo(format)) { // assume we've been given a full date result = utilDate.parse(value, format); } else { // Use our initial safe date parsedDate = utilDate.parse(me.initDate + ' ' + value, me.initDateFormat + ' ' + format); if (parsedDate) { result = parsedDate; } } return result; }, // @private getSubmitValue: function() { var me = this, format = me.submitFormat || me.format, value = me.getValue(); return value ? Ext.Date.format(value, format) : null; }, /** * @private * Creates the {@link Ext.picker.Time} */ createPicker: function() { var me = this, picker; me.listConfig = Ext.apply({ xtype: 'timepicker', selModel: { mode: 'SINGLE' }, cls: undefined, minValue: me.minValue, maxValue: me.maxValue, increment: me.increment, format: me.format, maxHeight: me.pickerMaxHeight }, me.listConfig); picker = me.callParent(); me.bindStore(picker.store); return picker; }, onItemClick: function(picker, record){ // The selection change events won't fire when clicking on the selected element. Detect it here. var me = this, selected = picker.getSelectionModel().getSelection(); if (selected.length > 0) { selected = selected[0]; if (selected && Ext.Date.isEqual(record.get('date'), selected.get('date'))) { me.collapse(); } } }, /** * @private * Handles a time being selected from the Time picker. */ onListSelectionChange: function(list, recordArray) { if (recordArray.length) { var me = this, val = recordArray[0].get('date'); if (!me.ignoreSelection) { me.skipSync = true; me.setValue(val); me.skipSync = false; me.fireEvent('select', me, val); me.picker.clearHighlight(); me.collapse(); me.inputEl.focus(); } } }, /** * @private * Synchronizes the selection in the picker to match the current value */ syncSelection: function() { var me = this, picker = me.picker, toSelect, selModel, value, data, d, dLen, rec; if (picker && !me.skipSync) { picker.clearHighlight(); value = me.getValue(); selModel = picker.getSelectionModel(); // Update the selection to match me.ignoreSelection++; if (value === null) { selModel.deselectAll(); } else if (Ext.isDate(value)) { // find value, select it data = picker.store.data.items; dLen = data.length; for (d = 0; d < dLen; d++) { rec = data[d]; if (Ext.Date.isEqual(rec.get('date'), value)) { toSelect = rec; break; } } selModel.select(toSelect); } me.ignoreSelection--; } }, postBlur: function() { var me = this, val = me.getValue(); me.callParent(arguments); // Only set the raw value if the current value is valid and is not falsy if (me.wasValid && val) { me.setRawValue(me.formatDate(val)); } }, setValue: function() { // Store MUST be created for parent setValue to function this.getPicker(); return this.callParent(arguments); }, getValue: function() { return this.parseDate(this.callParent(arguments)); } }); /** * Internal utility class that provides a unique cell context. * @private */ Ext.define('Ext.grid.CellContext', { /** * @property {Boolean} isCellContext * @readonly * `true` in this class to identify an object as an instantiated CellContext, or subclass thereof. */ isCellContext: true, constructor: function(view) { this.view = view; }, // Selection row/record & column/columnHeader setPosition: function(row, col) { var me = this; // We were passed {row: 1, column: 2, view: myView} if (arguments.length === 1) { if (row.view) { me.view = row.view; } col = row.column; row = row.row; } me.setRow(row); me.setColumn(col); return me; }, setRow: function(row) { var me = this; if (row !== undefined) { // Row index passed if (typeof row === 'number') { me.row = Math.max(Math.min(row, me.view.dataSource.getCount() - 1), 0); me.record = me.view.dataSource.getAt(row); } // row is a Record else if (row.isModel) { me.record = row; me.row = me.view.indexOf(row); } // row is a grid row else if (row.tagName) { me.record = me.view.getRecord(row); me.row = me.view.indexOf(me.record); } } }, setColumn: function(col) { var me = this, columnManager = me.view.ownerCt.columnManager; if (col !== undefined) { // column index passed if (typeof col === 'number') { me.column = col; me.columnHeader = columnManager.getHeaderAtIndex(col); } // column Header passed else if (col.isHeader) { me.columnHeader = col; me.column = columnManager.getHeaderIndex(col); } } } }); /** * Internal utility class that provides default configuration for cell editing. * @private */ Ext.define('Ext.grid.CellEditor', { extend: Ext.Editor , constructor: function(config) { config = Ext.apply({}, config); if (config.field) { config.field.monitorTab = false; } this.callParent([config]); }, /** * @private * Hides the grid cell inner element when a cell editor is shown. */ onShow: function() { var me = this, innerCell = me.boundEl.first(); if (innerCell) { if (me.isForTree) { innerCell = innerCell.child(me.treeNodeSelector); } innerCell.hide(); } me.callParent(arguments); }, /** * @private * Shows the grid cell inner element when a cell editor is hidden */ onHide: function() { var me = this, innerCell = me.boundEl.first(); if (innerCell) { if (me.isForTree) { innerCell = innerCell.child(me.treeNodeSelector); } innerCell.show(); } me.callParent(arguments); }, /** * @private * Fix checkbox blur when it is clicked. */ afterRender: function() { var me = this, field = me.field; me.callParent(arguments); if (field.isCheckbox) { field.mon(field.inputEl, { mousedown: me.onCheckBoxMouseDown, click: me.onCheckBoxClick, scope: me }); } }, /** * @private * Because when checkbox is clicked it loses focus completeEdit is bypassed. */ onCheckBoxMouseDown: function() { this.completeEdit = Ext.emptyFn; }, /** * @private * Restore checkbox focus and completeEdit method. */ onCheckBoxClick: function() { delete this.completeEdit; this.field.focus(false, 10); }, /** * @private * Realigns the Editor to the grid cell, or to the text node in the grid inner cell * if the inner cell contains multiple child nodes. */ realign: function(autoSize) { var me = this, boundEl = me.boundEl, innerCell = boundEl.first(), width = boundEl.getWidth(), offsets = Ext.Array.clone(me.offsets), grid = me.grid, xOffset; if (me.isForTree) { // When editing a tree, adjust the width and offsets of the editor to line // up with the tree cell's text element xOffset = me.getTreeNodeOffset(innerCell); width -= Math.abs(xOffset); offsets[0] += xOffset; } if (grid.columnLines) { // Subtract the column border width so that the editor displays inside the // borders. The column border could be either on the left or the right depending // on whether the grid is RTL - using the sum of both borders works in both modes. width -= boundEl.getBorderWidth('rl'); } if (autoSize === true) { me.field.setWidth(width); } me.alignTo(innerCell, me.alignment, offsets); }, // private getTreeNodeOffset: function(innerCell) { return innerCell.child(this.treeNodeSelector).getOffsetsTo(innerCell)[0]; }, onEditorTab: function(e){ var field = this.field; if (field.onEditorTab) { field.onEditorTab(e); } }, alignment: "l-l", hideEl : false, cls: Ext.baseCSSPrefix + 'small-editor ' + Ext.baseCSSPrefix + 'grid-editor ' + Ext.baseCSSPrefix + 'grid-cell-editor', treeNodeSelector: '.' + Ext.baseCSSPrefix + 'tree-node-text', shim: false, shadow: false }); /** * Component layout for grid column headers which have a title element at the top followed by content. * @private */ Ext.define('Ext.grid.ColumnComponentLayout', { extend: Ext.layout.component.Auto , alias: 'layout.columncomponent', type: 'columncomponent', setWidthInDom: true, beginLayout: function(ownerContext) { var me = this; me.callParent(arguments); ownerContext.titleContext = ownerContext.getEl('titleEl'); ownerContext.triggerContext = ownerContext.getEl('triggerEl'); }, beginLayoutCycle: function(ownerContext) { var me = this, owner = me.owner; me.callParent(arguments); // If shrinkwrapping, allow content width to stretch the element if (ownerContext.widthModel.shrinkWrap) { owner.el.setWidth(''); } // When we are the last subheader, bordering is provided by our owning header, so we need // to set border width to zero var borderRightWidth = owner.isLast && owner.isSubHeader ? '0' : ''; if (borderRightWidth !== me.lastBorderRightWidth) { owner.el.dom.style.borderRightWidth = me.lasBorderRightWidth = borderRightWidth; } owner.titleEl.setStyle({ paddingTop: '', // reset back to default padding of the style paddingBottom: '' }); }, // If not shrink wrapping, push height info down into child items publishInnerHeight: function(ownerContext, outerHeight) { // TreePanels (and grids with hideHeaders: true) set their column container height to zero ti hide them. // This is because they need to lay out in order to calculate widths for the columns (eg flexes). // If there is no height to lay out, bail out early. if (!outerHeight) { return; } var me = this, owner = me.owner, innerHeight = outerHeight - ownerContext.getBorderInfo().height, availableHeight = innerHeight, textHeight, titleHeight, pt, pb; // We do not have enough information to get the height of the titleEl if (!owner.noWrap && !ownerContext.hasDomProp('width')) { me.done = false; return; } // If we are not a container, but just have HTML content... if (ownerContext.hasRawContent) { titleHeight = availableHeight; // Vertically center the header text and ensure titleContext occupies availableHeight textHeight = owner.textEl.getHeight(); if (textHeight) { availableHeight -= textHeight; if (availableHeight > 0) { pt = Math.floor(availableHeight / 2); pb = availableHeight - pt; ownerContext.titleContext.setProp('padding-top', pt); ownerContext.titleContext.setProp('padding-bottom', pb); } } } // There are child items else { titleHeight = owner.titleEl.getHeight(); ownerContext.setProp('innerHeight', innerHeight - titleHeight, false); } // Only IE6 and IEQuirks needs this. // This is why we maintain titleHeight when setting it. if ((Ext.isIE6 || Ext.isIEQuirks) && ownerContext.triggerContext) { ownerContext.triggerContext.setHeight(titleHeight); } }, // We do not need the Direct2D sub pixel measurement here. Just the offsetHeight will do. // TODO: When https://sencha.jira.com/browse/EXTJSIV-7734 is fixed to not do subpixel adjustment on height, // remove this override. measureContentHeight: function(ownerContext) { return ownerContext.el.dom.offsetHeight; }, publishOwnerHeight: function(ownerContext, contentHeight) { this.callParent(arguments); // Only IE6 and IEQuirks needs this. // This is why we maintain titleHeight when setting it. if ((Ext.isIE6 || Ext.isIEQuirks) && ownerContext.triggerContext) { ownerContext.triggerContext.setHeight(contentHeight); } }, // If not shrink wrapping, push width info down into child items publishInnerWidth: function(ownerContext, outerWidth) { // If we are acting as a container, publish the innerWidth for the ColumnLayout to use if (!ownerContext.hasRawContent) { ownerContext.setProp('innerWidth', outerWidth - ownerContext.getBorderInfo().width, false); } }, // Push content height outwards when we are shrinkwrapping calculateOwnerHeightFromContentHeight: function (ownerContext, contentHeight) { var result = this.callParent(arguments); // If we are NOT a group header, we just use the auto component's measurement if (!ownerContext.hasRawContent) { if (this.owner.noWrap || ownerContext.hasDomProp('width')) { return contentHeight + this.owner.titleEl.getHeight() + ownerContext.getBorderInfo().height; } // We do not have the information to return the height yet because we cannot know // the final height of the text el return null; } return result; }, // Push content width outwards when we are shrinkwrapping calculateOwnerWidthFromContentWidth: function (ownerContext, contentWidth) { var owner = this.owner, inner = Math.max(contentWidth, owner.textEl.getWidth() + ownerContext.titleContext.getPaddingInfo().width), padWidth = ownerContext.getPaddingInfo().width, triggerOffset = this.getTriggerOffset(owner, ownerContext); return inner + padWidth + triggerOffset; }, getTriggerOffset: function(owner, ownerContext) { var width = 0; if (ownerContext.widthModel.shrinkWrap && !owner.menuDisabled) { // If we have any children underneath, then we already have space reserved if (owner.query('>:not([hidden])').length === 0) { width = owner.self.triggerElWidth; } } return width; } }); /** * @private * * This class is used only by the grid's HeaderContainer docked child. * * It adds the ability to shrink the vertical size of the inner container element back if a grouped * column header has all its child columns dragged out, and the whole HeaderContainer needs to shrink back down. * * Also, after every layout, after all headers have attained their 'stretchmax' height, it goes through and calls * `setPadding` on the columns so that they lay out correctly. */ Ext.define('Ext.grid.ColumnLayout', { extend: Ext.layout.container.HBox , alias: 'layout.gridcolumn', type : 'gridcolumn', reserveOffset: false, firstHeaderCls: Ext.baseCSSPrefix + 'column-header-first', lastHeaderCls: Ext.baseCSSPrefix + 'column-header-last', initLayout: function() { if (!this.scrollbarWidth) { this.self.prototype.scrollbarWidth = Ext.getScrollbarSize().width; } this.grid = this.owner.up('[scrollerOwner]'); this.callParent(); }, // Collect the height of the table of data upon layout begin beginLayout: function (ownerContext) { var me = this, owner = me.owner, grid = me.grid, view = grid.view, items = me.getVisibleItems(), len = items.length, firstCls = me.firstHeaderCls, lastCls = me.lastHeaderCls, i, item; // If we are one side of a locking grid, then if we are on the "normal" side, we have to grab the normal view // for use in determining whether to subtract scrollbar width from available width. // The locked side does not have scrollbars, so it should not look at the view. if (grid.lockable) { if (owner.up('tablepanel') === view.normalGrid) { view = view.normalGrid.getView(); } else { view = null; } } for (i = 0; i < len; i++) { item = items[i]; // Keep the isLast flag correct so that the column's component layout can know whether or not // it needs a right border. See ColumnComponentLayout.beginLayoutCycle item.isLast = false; item.removeCls([firstCls, lastCls]); if (i === 0) { item.addCls(firstCls); } if (i === len - 1) { item.addCls(lastCls); item.isLast = true; } } me.callParent(arguments); // If the owner is the grid's HeaderContainer, and the UI displays old fashioned scrollbars and there is a rendered View with data in it, // collect the View context to interrogate it for overflow, and possibly invalidate it if there is overflow if (!owner.isColumn && Ext.getScrollbarSize().width && !grid.collapsed && view && view.rendered && (ownerContext.viewTable = view.body.dom)) { ownerContext.viewContext = ownerContext.context.getCmp(view); } }, roundFlex: function(width) { return Math.floor(width); }, calculate: function(ownerContext) { this.callParent(arguments); // If we have calculated the widths, then if forceFit, and there are no flexes, we cannot tell the // TableLayout we are done. We will have to go through the convertWidthsToFlexes stage. if (ownerContext.state.parallelDone && (!this.owner.forceFit || ownerContext.flexedItems.length)) { // TODO: auto width columns aren't necessarily done here. // see view.TableLayout, there is a work around for that there ownerContext.setProp('columnWidthsDone', true); } // Collect the height of the data table if we need it to determine overflow if (ownerContext.viewContext) { ownerContext.state.tableHeight = ownerContext.viewTable.offsetHeight; } }, completeLayout: function(ownerContext) { var me = this, owner = me.owner, state = ownerContext.state; me.callParent(arguments); // If we have not been through this already, and the owning Container is configured // forceFit, is not a group column and and there is a valid width, then convert // widths to flexes, and loop back. if (!ownerContext.flexedItems.length && !state.flexesCalculated && owner.forceFit && // Recalculate based upon all columns now being flexed instead of sized. // Set flag, so that we do not do this infinitely me.convertWidthsToFlexes(ownerContext)) { me.cacheFlexes(ownerContext); ownerContext.invalidate({ state: { flexesCalculated: true } }); } else { ownerContext.setProp('columnWidthsDone', true); } }, convertWidthsToFlexes: function(ownerContext) { var me = this, totalWidth = 0, calculated = me.sizeModels.calculated, childItems, len, i, childContext, item; childItems = ownerContext.childItems; len = childItems.length; for (i = 0; i < len; i++) { childContext = childItems[i]; item = childContext.target; totalWidth += childContext.props.width; // Only allow to be flexed if it's a resizable column if (!(item.fixed || item.resizable === false)) { // For forceFit, just use allocated width as the flex value, and the proportions // will end up the same whatever HeaderContainer width they are being forced into. item.flex = ownerContext.childItems[i].flex = childContext.props.width; item.width = null; childContext.widthModel = calculated; } } // Only need to loop back if the total column width is not already an exact fit return totalWidth !== ownerContext.props.width; }, /** * @private * Local getContainerSize implementation accounts for vertical scrollbar in the view. */ getContainerSize: function(ownerContext) { var me = this, result, viewContext = ownerContext.viewContext, viewHeight; // Column, NOT the main grid's HeaderContainer if (me.owner.isColumn) { result = me.getColumnContainerSize(ownerContext); } // This is the maingrid's HeaderContainer else { result = me.callParent(arguments); // If we've collected a viewContext and we're not shrinkwrapping the height // then we see if we have to narrow the width slightly to account for scrollbar if (viewContext && !viewContext.heightModel.shrinkWrap && viewContext.target.componentLayout.ownerContext) { // if (its layout is running) viewHeight = viewContext.getProp('height'); if (isNaN(viewHeight)) { me.done = false; } else if (ownerContext.state.tableHeight > viewHeight) { result.width -= Ext.getScrollbarSize().width; ownerContext.state.parallelDone = false; viewContext.invalidate(); } } } // TODO - flip the initial assumption to "we have a vscroll" to avoid the invalidate in most // cases (and the expensive ones to boot) return result; }, getColumnContainerSize : function(ownerContext) { var padding = ownerContext.paddingContext.getPaddingInfo(), got = 0, needed = 0, gotWidth, gotHeight, width, height; // In an shrinkWrap width/height case, we must not ask for any of these dimensions // because they will be determined by contentWidth/Height which is calculated by // this layout... // Fit/Card layouts are able to set just the width of children, allowing child's // resulting height to autosize the Container. // See examples/tabs/tabs.html for an example of this. if (!ownerContext.widthModel.shrinkWrap) { ++needed; width = ownerContext.getProp('innerWidth'); gotWidth = (typeof width == 'number'); if (gotWidth) { ++got; width -= padding.width; if (width < 0) { width = 0; } } } if (!ownerContext.heightModel.shrinkWrap) { ++needed; height = ownerContext.getProp('innerHeight'); gotHeight = (typeof height == 'number'); if (gotHeight) { ++got; height -= padding.height; if (height < 0) { height = 0; } } } return { width: width, height: height, needed: needed, got: got, gotAll: got == needed, gotWidth: gotWidth, gotHeight: gotHeight }; }, // FIX: when flexing we actually don't have enough space as we would // typically because of the scrollOffset on the GridView, must reserve this publishInnerCtSize: function(ownerContext) { var me = this, size = ownerContext.state.boxPlan.targetSize, cw = ownerContext.peek('contentWidth'), view; // Allow the other co-operating objects to know whether the columns overflow the available width. me.owner.tooNarrow = ownerContext.state.boxPlan.tooNarrow; // InnerCt MUST stretch to accommodate all columns so that left/right scrolling is enabled in the header container. if ((cw != null) && !me.owner.isColumn) { size.width = cw; // innerCt must also encompass any vertical scrollbar width if there may be one view = me.owner.ownerCt.view; if (view.scrollFlags.y) { size.width += Ext.getScrollbarSize().width; } } return me.callParent(arguments); } }); /** * @private * * Manages and provides information about a TablePanel's *visible leaf* columns. */ Ext.define('Ext.grid.ColumnManager', { alternateClassName: ['Ext.grid.ColumnModel'], columns: null, constructor: function(headerCt, secondHeaderCt) { if (!headerCt.isRootHeader) { Ext.Error.raise('ColumnManager must be passed an instantiated HeaderContainer'); } this.headerCt = headerCt; // We are managing columns for a lockable grid... if (secondHeaderCt) { if (!headerCt.isRootHeader) { Ext.Error.raise('ColumnManager must be passed an instantiated HeaderContainer'); } this.secondHeaderCt = secondHeaderCt; } }, getColumns: function() { if (!this.columns) { this.cacheColumns(); } return this.columns; }, /** * Returns the index of a leaf level header regardless of what the nesting * structure is. * * If a group header is passed, the index of the first leaf level heder within it is returned. * * @param {Ext.grid.column.Column} header The header to find the index of * @return {Number} The index of the specified column header */ getHeaderIndex: function(header) { // If we are being asked the index of a group header, find the first leaf header node, and return the index of that if (header.isGroupHeader) { header = header.down(':not([isGroupHeader])'); } return Ext.Array.indexOf(this.getColumns(), header); }, /** * Get a leaf level header by index regardless of what the nesting * structure is. * @param {Number} index The column index for which to retrieve the column. * @return {Ext.grid.column.Column} The header. `null` if it doesn't exist. */ getHeaderAtIndex: function(index) { var columns = this.getColumns(); return columns.length ? columns[index] : null; }, /** * Get a leaf level header by index regardless of what the nesting * structure is. * @param {String} id The id * @return {Ext.grid.column.Column} The header. `null` if it doesn't exist. */ getHeaderById: function(id) { var columns = this.getColumns(), len = columns.length, i, header; for (i = 0; i < len; ++i) { header = columns[i]; if (header.getItemId() === id) { return header; } } return null; }, /** * When passed a column index, returns the closet *visible* column to that. If the column at the passed index is visible, * that is returned. If it is hidden, either the next visible, or the previous visible column is returned. * @param {Number} index Position at which to find the closest visible column. */ getVisibleHeaderClosestToIndex: function(index) { var result = this.getHeaderAtIndex(index); if (result && result.hidden) { result = result.next(':not([hidden])') || result.prev(':not([hidden])'); } return result; }, cacheColumns: function() { this.columns = this.headerCt.getVisibleGridColumns(); if (this.secondHeaderCt) { Ext.Array.push(this.columns, this.secondHeaderCt.getVisibleGridColumns()); } }, invalidate: function() { this.columns = null; // If we are part of a lockable assembly, invalidate the root column manager if (this.rootColumns) { this.rootColumns.invalidate(); } } }, function() { this.createAlias('indexOf', 'getHeaderIndex'); }); /** * This is a base class for layouts that contain a single item that automatically expands to fill the layout's * container. This class is intended to be extended or created via the layout:'fit' * {@link Ext.container.Container#layout} config, and should generally not need to be created directly via the new keyword. * * Fit layout does not have any direct config options (other than inherited ones). To fit a panel to a container using * Fit layout, simply set `layout: 'fit'` on the container and add a single panel to it. * * @example * Ext.create('Ext.panel.Panel', { * title: 'Fit Layout', * width: 300, * height: 150, * layout:'fit', * items: { * title: 'Inner Panel', * html: 'This is the inner panel content', * bodyPadding: 20, * border: false * }, * renderTo: Ext.getBody() * }); * * If the container has multiple items, all of the items will all be equally sized. This is usually not * desired, so to avoid this, place only a **single** item in the container. This sizing of all items * can be used to provide a background {@link Ext.Img image} that is "behind" another item * such as a {@link Ext.view.View dataview} if you also absolutely position the items. */ Ext.define('Ext.layout.container.Fit', { /* Begin Definitions */ extend: Ext.layout.container.Container , alternateClassName: 'Ext.layout.FitLayout', alias: 'layout.fit', /* End Definitions */ itemCls: Ext.baseCSSPrefix + 'fit-item', targetCls: Ext.baseCSSPrefix + 'layout-fit', type: 'fit', /** * @cfg {Object} defaultMargins * If the individual contained items do not have a margins property specified or margin specified via CSS, the * default margins from this property will be applied to each item. * * This property may be specified as an object containing margins to apply in the format: * * { * top: (top margin), * right: (right margin), * bottom: (bottom margin), * left: (left margin) * } * * This property may also be specified as a string containing space-separated, numeric margin values. The order of * the sides associated with each value matches the way CSS processes margin values: * * - If there is only one value, it applies to all sides. * - If there are two values, the top and bottom borders are set to the first value and the right and left are * set to the second. * - If there are three values, the top is set to the first value, the left and right are set to the second, * and the bottom is set to the third. * - If there are four values, they apply to the top, right, bottom, and left, respectively. * */ defaultMargins: { top: 0, right: 0, bottom: 0, left: 0 }, manageMargins: true, sizePolicies: { 0: { readsWidth: 1, readsHeight: 1, setsWidth: 0, setsHeight: 0 }, 1: { readsWidth: 0, readsHeight: 1, setsWidth: 1, setsHeight: 0 }, 2: { readsWidth: 1, readsHeight: 0, setsWidth: 0, setsHeight: 1 }, 3: { readsWidth: 0, readsHeight: 0, setsWidth: 1, setsHeight: 1 } }, getItemSizePolicy: function (item, ownerSizeModel) { // this layout's sizePolicy is derived from its owner's sizeModel: var sizeModel = ownerSizeModel || this.owner.getSizeModel(), mode = (sizeModel.width.shrinkWrap ? 0 : 1) | (sizeModel.height.shrinkWrap ? 0 : 2); return this.sizePolicies[mode]; }, beginLayoutCycle: function (ownerContext, firstCycle) { var me = this, // determine these before the lastSizeModels get updated: resetHeight = me.lastHeightModel && me.lastHeightModel.calculated, resetWidth = me.lastWidthModel && me.lastWidthModel.calculated, resetSizes = resetWidth || resetHeight, maxChildMinHeight = 0, maxChildMinWidth = 0, c, childItems, i, item, length, margins, minHeight, minWidth, style, undef; me.callParent(arguments); // Clear any dimensions which we set before calculation, in case the current // settings affect the available size. This particularly effects self-sizing // containers such as fields, in which the target element is naturally sized, // and should not be stretched by a sized child item. if (resetSizes && ownerContext.targetContext.el.dom.tagName.toUpperCase() != 'TD') { resetSizes = resetWidth = resetHeight = false; } childItems = ownerContext.childItems; length = childItems.length; for (i = 0; i < length; ++i) { item = childItems[i]; // On the firstCycle, we determine the max of the minWidth/Height of the items // since these can cause the container to grow scrollbars despite our attempts // to fit the child to the container. if (firstCycle) { c = item.target; minHeight = c.minHeight; minWidth = c.minWidth; if (minWidth || minHeight) { margins = item.marginInfo || item.getMarginInfo(); // if the child item has undefined minWidth/Height, these will become // NaN by adding the margins... minHeight += margins.height; minWidth += margins.height; // if the child item has undefined minWidth/Height, these comparisons // will evaluate to false... that is, "0 < NaN" == false... if (maxChildMinHeight < minHeight) { maxChildMinHeight = minHeight; } if (maxChildMinWidth < minWidth) { maxChildMinWidth = minWidth; } } } if (resetSizes) { style = item.el.dom.style; if (resetHeight) { style.height = ''; } if (resetWidth) { style.width = ''; } } } if (firstCycle) { ownerContext.maxChildMinHeight = maxChildMinHeight; ownerContext.maxChildMinWidth = maxChildMinWidth; } // Cache the overflowX/Y flags, but make them false in shrinkWrap mode (since we // won't be triggering overflow in that case) and false if we have no minSize (so // no child to trigger an overflow). c = ownerContext.target; ownerContext.overflowX = (!ownerContext.widthModel.shrinkWrap && ownerContext.maxChildMinWidth && c.scrollFlags.x) || undef; ownerContext.overflowY = (!ownerContext.heightModel.shrinkWrap && ownerContext.maxChildMinHeight && c.scrollFlags.y) || undef; }, calculate : function (ownerContext) { var me = this, childItems = ownerContext.childItems, length = childItems.length, containerSize = me.getContainerSize(ownerContext), info = { length: length, ownerContext: ownerContext, targetSize: containerSize }, shrinkWrapWidth = ownerContext.widthModel.shrinkWrap, shrinkWrapHeight = ownerContext.heightModel.shrinkWrap, overflowX = ownerContext.overflowX, overflowY = ownerContext.overflowY, scrollbars, scrollbarSize, padding, i, contentWidth, contentHeight; if (overflowX || overflowY) { // If we have children that have minHeight/Width, we may be forced to overflow // and gain scrollbars. If so, we want to remove their space from the other // axis so that we fit things inside the scrollbars rather than under them. scrollbars = me.getScrollbarsNeeded( overflowX && containerSize.width, overflowY && containerSize.height, ownerContext.maxChildMinWidth, ownerContext.maxChildMinHeight); if (scrollbars) { scrollbarSize = Ext.getScrollbarSize(); if (scrollbars & 1) { // if we need the hscrollbar, remove its height containerSize.height -= scrollbarSize.height; } if (scrollbars & 2) { // if we need the vscrollbar, remove its width containerSize.width -= scrollbarSize.width; } } } // Size the child items to the container (if non-shrinkWrap): for (i = 0; i < length; ++i) { info.index = i; me.fitItem(childItems[i], info); } if (shrinkWrapHeight || shrinkWrapWidth) { padding = ownerContext.targetContext.getPaddingInfo(); if (shrinkWrapWidth) { if (overflowY && !containerSize.gotHeight) { // if we might overflow vertically and don't have the container height, // we don't know if we will need a vscrollbar or not, so we must wait // for that height so that we can determine the contentWidth... me.done = false; } else { contentWidth = info.contentWidth + padding.width; // the scrollbar flag (if set) will indicate that an overflow exists on // the horz(1) or vert(2) axis... if not set, then there could never be // an overflow... if (scrollbars & 2) { // if we need the vscrollbar, add its width contentWidth += scrollbarSize.width; } if (!ownerContext.setContentWidth(contentWidth)) { me.done = false; } } } if (shrinkWrapHeight) { if (overflowX && !containerSize.gotWidth) { // if we might overflow horizontally and don't have the container width, // we don't know if we will need a hscrollbar or not, so we must wait // for that width so that we can determine the contentHeight... me.done = false; } else { contentHeight = info.contentHeight + padding.height; // the scrollbar flag (if set) will indicate that an overflow exists on // the horz(1) or vert(2) axis... if not set, then there could never be // an overflow... if (scrollbars & 1) { // if we need the hscrollbar, add its height contentHeight += scrollbarSize.height; } if (!ownerContext.setContentHeight(contentHeight)) { me.done = false; } } } } }, fitItem: function (itemContext, info) { var me = this; if (itemContext.invalid) { me.done = false; return; } info.margins = itemContext.getMarginInfo(); info.needed = info.got = 0; me.fitItemWidth(itemContext, info); me.fitItemHeight(itemContext, info); // If not all required dimensions have been satisfied, we're not done. if (info.got != info.needed) { me.done = false; } }, fitItemWidth: function (itemContext, info) { var contentWidth, width; // Attempt to set only dimensions that are being controlled, not shrinkWrap dimensions if (info.ownerContext.widthModel.shrinkWrap) { // contentWidth must include the margins to be consistent with setItemWidth width = itemContext.getProp('width') + info.margins.width; // because we add margins, width will be NaN or a number (not undefined) contentWidth = info.contentWidth; if (contentWidth === undefined) { info.contentWidth = width; } else { info.contentWidth = Math.max(contentWidth, width); } } else if (itemContext.widthModel.calculated) { ++info.needed; if (info.targetSize.gotWidth) { ++info.got; this.setItemWidth(itemContext, info); } } this.positionItemX(itemContext, info); }, fitItemHeight: function (itemContext, info) { var contentHeight, height; if (info.ownerContext.heightModel.shrinkWrap) { // contentHeight must include the margins to be consistent with setItemHeight height = itemContext.getProp('height') + info.margins.height; // because we add margins, height will be NaN or a number (not undefined) contentHeight = info.contentHeight; if (contentHeight === undefined) { info.contentHeight = height; } else { info.contentHeight = Math.max(contentHeight, height); } } else if (itemContext.heightModel.calculated) { ++info.needed; if (info.targetSize.gotHeight) { ++info.got; this.setItemHeight(itemContext, info); } } this.positionItemY(itemContext, info); }, positionItemX: function (itemContext, info) { var margins = info.margins; // Adjust position to account for configured margins or if we have multiple items // (all items should overlap): if (info.index || margins.left) { itemContext.setProp('x', margins.left); } if (margins.width) { // Need the margins for shrink-wrapping but old IE sometimes collapses the left margin into the padding itemContext.setProp('margin-right', margins.width); } }, positionItemY: function (itemContext, info) { var margins = info.margins; if (info.index || margins.top) { itemContext.setProp('y', margins.top); } if (margins.height) { // Need the margins for shrink-wrapping but old IE sometimes collapses the top margin into the padding itemContext.setProp('margin-bottom', margins.height); } }, setItemHeight: function (itemContext, info) { itemContext.setHeight(info.targetSize.height - info.margins.height); }, setItemWidth: function (itemContext, info) { itemContext.setWidth(info.targetSize.width - info.margins.width); } }); /** * @author Nicolas Ferrero * * TablePanel is the basis of both {@link Ext.tree.Panel TreePanel} and {@link Ext.grid.Panel GridPanel}. * * TablePanel aggregates: * * - a Selection Model * - a View * - a Store * - Scrollers * - Ext.grid.header.Container * * @mixins Ext.grid.locking.Lockable */ Ext.define('Ext.panel.Table', { extend: Ext.panel.Panel , alias: 'widget.tablepanel', extraBaseCls: Ext.baseCSSPrefix + 'grid', extraBodyCls: Ext.baseCSSPrefix + 'grid-body', layout: 'fit', /** * @property {Boolean} hasView * True to indicate that a view has been injected into the panel. */ hasView: false, // each panel should dictate what viewType and selType to use /** * @cfg {String} viewType * An xtype of view to use. This is automatically set to 'gridview' by {@link Ext.grid.Panel Grid} * and to 'treeview' by {@link Ext.tree.Panel Tree}. * @protected */ viewType: null, /** * @cfg {Object} viewConfig * A config object that will be applied to the grid's UI view. Any of the config options available for * {@link Ext.view.Table} can be specified here. This option is ignored if {@link #view} is specified. */ /** * @cfg {Ext.view.Table} view * The {@link Ext.view.Table} used by the grid. Use {@link #viewConfig} to just supply some config options to * view (instead of creating an entire View instance). */ /** * @cfg {String} selType * An xtype of selection model to use. Defaults to 'rowmodel'. This is used to create selection model if just * a config object or nothing at all given in {@link #selModel} config. */ selType: 'rowmodel', /** * @cfg {Ext.selection.Model/Object} selModel * A {@link Ext.selection.Model selection model} instance or config object. In latter case the {@link #selType} * config option determines to which type of selection model this config is applied. */ /** * @cfg {Boolean} [multiSelect=false] * True to enable 'MULTI' selection mode on selection model. * @deprecated 4.1.1 Use {@link Ext.selection.Model#mode} 'MULTI' instead. */ /** * @cfg {Boolean} [simpleSelect=false] * True to enable 'SIMPLE' selection mode on selection model. * @deprecated 4.1.1 Use {@link Ext.selection.Model#mode} 'SIMPLE' instead. */ /** * @cfg {Ext.data.Store} store (required) * The {@link Ext.data.Store Store} the grid should use as its data source. */ /** * @cfg {String/Boolean} scroll * Scrollers configuration. Valid values are 'both', 'horizontal' or 'vertical'. * True implies 'both'. False implies 'none'. */ scroll: true, /** * @cfg {Ext.grid.column.Column[]/Object} columns * An array of {@link Ext.grid.column.Column column} definition objects which define all columns that appear in this * grid. Each column definition provides the header text for the column, and a definition of where the data for that * column comes from. * * This can also be a configuration object for a {Ext.grid.header.Container HeaderContainer} which may override * certain default configurations if necessary. For example, the special layout may be overridden to use a simpler * layout, or one can set default values shared by all columns: * * columns: { * items: [ * { * text: "Column A" * dataIndex: "field_A" * },{ * text: "Column B", * dataIndex: "field_B" * }, * ... * ], * defaults: { * flex: 1 * } * } */ /** * @cfg {Boolean} forceFit * True to force the columns to fit into the available width. Headers are first sized according to configuration, * whether that be a specific width, or flex. Then they are all proportionally changed in width so that the entire * content width is used. For more accurate control, it is more optimal to specify a flex setting on the columns * that are to be stretched & explicit widths on columns that are not. */ /** * @cfg {Ext.grid.feature.Feature[]/Object[]/Ext.enums.Feature[]} features * An array of grid Features to be added to this grid. Can also be just a single feature instead of array. * * Features config behaves much like {@link #plugins}. * A feature can be added by either directly referencing the instance: * * features: [Ext.create('Ext.grid.feature.GroupingSummary', {groupHeaderTpl: 'Subject: {name}'})], * * By using config object with ftype: * * features: [{ftype: 'groupingsummary', groupHeaderTpl: 'Subject: {name}'}], * * Or with just a ftype: * * features: ['grouping', 'groupingsummary'], * * See {@link Ext.enums.Feature} for list of all ftypes. */ /** * @cfg {Boolean} [hideHeaders=false] * True to hide column headers. */ /** * @cfg {Boolean} deferRowRender * Defaults to true to enable deferred row rendering. * * This allows the View to execute a refresh quickly, with the expensive update of the row structure deferred so * that layouts with GridPanels appear, and lay out more quickly. */ /** * @cfg {Object} verticalScroller * A config object to be used when configuring the {@link Ext.grid.plugin.BufferedRenderer scroll monitor} to control * refreshing of data in an "infinite grid". * * Configurations of this object allow fine tuning of data caching which can improve performance and usability * of the infinite grid. */ deferRowRender: true, /** * @cfg {Boolean} sortableColumns * False to disable column sorting via clicking the header and via the Sorting menu items. */ sortableColumns: true, /** * @cfg {Boolean} [enableLocking=false] * Configure as `true` to enable locking support for this grid. Alternatively, locking will also be automatically * enabled if any of the columns in the {@link #columns columns} configuration contain a {@link Ext.grid.column.Column#locked locked} config option. * * A locking grid is processed in a special way. The configuration options are cloned and *two* grids are created to be the locked (left) side * and the normal (right) side. This Panel becomes merely a {@link Ext.container.Container container} which arranges both in an {@link Ext.layout.container.HBox HBox} layout. * * {@link #plugins Plugins} may be targeted at either locked, or unlocked grid, or, both, in which case the plugin is cloned and used on both sides. * * Plugins may also be targeted at the containing locking Panel. * * This is configured by specifying a `lockableScope` property in your plugin which may have the following values: * * * `"both"` (the default) - The plugin is added to both grids * * `"top"` - The plugin is added to the containing Panel * * `"locked"` - The plugin is added to the locked (left) grid * * `"normal"` - The plugin is added to the normal (right) grid * * If `both` is specified, then each copy of the plugin gains a property `lockingPartner` which references its sibling on the other side so that they * can synchronize operations is necessary. * * {@link #features Features} may also be configured with `lockableScope` and may target the locked grid, the normal grid or both grids. Features * also get a `lockingPartner` reference injected. */ enableLocking: false, // private property used to determine where to go down to find views // this is here to support locking. scrollerOwner: true, /** * @cfg {Boolean} [enableColumnMove=true] * False to disable column dragging within this grid. */ enableColumnMove: true, /** * @cfg {Boolean} [sealedColumns=false] * True to constrain column dragging so that a column cannot be dragged in or out of it's * current group. Only relevant while {@link #enableColumnMove} is enabled. */ sealedColumns: false, /** * @cfg {Boolean} [enableColumnResize=true] * False to disable column resizing within this grid. */ enableColumnResize: true, /** * @cfg {Boolean} [enableColumnHide=true] * False to disable column hiding within this grid. */ /** * @cfg {Boolean} columnLines Adds column line styling */ /** * @cfg {Boolean} [rowLines=true] Adds row line styling */ rowLines: true, /** * @cfg {Boolean} [disableSelection=false] * True to disable selection model. */ /** * @cfg {String} emptyText Default text (html tags are accepted) to display in the Panel body when the Store * is empty. When specified, and the Store is empty, the text will be rendered inside a DIV with the CSS class "x-grid-empty". */ /** * @cfg {Boolean} [allowDeselect=false] * True to allow deselecting a record. This config is forwarded to {@link Ext.selection.Model#allowDeselect}. */ /** * @property {Boolean} optimizedColumnMove * If you are writing a grid plugin or a {Ext.grid.feature.Feature Feature} which creates a column-based structure which * needs a view refresh when columns are moved, then set this property in the grid. * * An example is the built in {@link Ext.grid.feature.AbstractSummary Summary} Feature. This creates summary rows, and the * summary columns must be in the same order as the data columns. This plugin sets the `optimizedColumnMove` to `false. */ colLinesCls: Ext.baseCSSPrefix + 'grid-with-col-lines', rowLinesCls: Ext.baseCSSPrefix + 'grid-with-row-lines', noRowLinesCls: Ext.baseCSSPrefix + 'grid-no-row-lines', hiddenHeaderCtCls: Ext.baseCSSPrefix + 'grid-header-ct-hidden', hiddenHeaderCls: Ext.baseCSSPrefix + 'grid-header-hidden', resizeMarkerCls: Ext.baseCSSPrefix + 'grid-resize-marker', emptyCls: Ext.baseCSSPrefix + 'grid-empty', initComponent: function() { if (!this.viewType) { Ext.Error.raise("You must specify a viewType config."); } if (this.headers) { Ext.Error.raise("The headers config is not supported. Please specify columns instead."); } var me = this, headerCtCfg = me.columns || me.colModel, view, i, len, // Look up the configured Store. If none configured, use the fieldless, empty Store defined in Ext.data.Store. store = me.store = Ext.data.StoreManager.lookup(me.store || 'ext-empty-store'), columns; if (me.columnLines) { me.addCls(me.colLinesCls); } me.addCls(me.rowLines ? me.rowLinesCls : me.noRowLinesCls); if (!headerCtCfg) { Ext.Error.raise("A column configuration must be specified"); } // The columns/colModel config may be either a fully instantiated HeaderContainer, or an array of Column definitions, or a config object of a HeaderContainer // Either way, we extract a columns property referencing an array of Column definitions. if (headerCtCfg instanceof Ext.grid.header.Container) { headerCtCfg.isRootHeader = true; me.headerCt = headerCtCfg; } else { // If any of the Column objects contain a locked property, and are not processed, this is a lockable TablePanel, a // special view will be injected by the Ext.grid.locking.Lockable mixin, so no processing of . if (me.enableLocking || me.hasLockedColumns(headerCtCfg)) { me.self.mixin('lockable', Ext.grid.locking.Lockable); me.injectLockable(); } // Not lockable - create the HeaderContainer else { if (Ext.isArray(headerCtCfg)) { headerCtCfg = { items: headerCtCfg }; } Ext.apply(headerCtCfg, { grid: me, forceFit: me.forceFit, sortable: me.sortableColumns, enableColumnMove: me.enableColumnMove, enableColumnResize: me.enableColumnResize, sealed: me.sealedColumns, isRootHeader: true }); if (Ext.isDefined(me.enableColumnHide)) { headerCtCfg.enableColumnHide = me.enableColumnHide; } // Create our HeaderCOntainer from the generated configuration if (!me.headerCt) { me.headerCt = new Ext.grid.header.Container(headerCtCfg); } } } // Maintain backward compatibiliy by providing the initial column set as a property. me.columns = me.headerCt.getGridColumns(); me.scrollTask = new Ext.util.DelayedTask(me.syncHorizontalScroll, me); me.addEvents( // documented on GridPanel 'reconfigure', /** * @event viewready * Fires when the grid view is available (use this for selecting a default row). * @param {Ext.panel.Table} this */ 'viewready' ); me.bodyCls = me.bodyCls || ''; me.bodyCls += (' ' + me.extraBodyCls); me.cls = me.cls || ''; me.cls += (' ' + me.extraBaseCls); // autoScroll is not a valid configuration delete me.autoScroll; // If this TablePanel is lockable (Either configured lockable, or any of the defined columns has a 'locked' property) // then a special lockable view containing 2 side-by-side grids will have been injected so we do not need to set up any UI. if (!me.hasView) { // Extract the array of leaf Column objects columns = me.headerCt.getGridColumns(); // If the Store is paging blocks of the dataset in, then it can only be sorted remotely. if (store.buffered && !store.remoteSort) { for (i = 0, len = columns.length; i < len; i++) { columns[i].sortable = false; } } if (me.hideHeaders) { me.headerCt.height = 0; // don't se the hidden property, we still need these to layout me.headerCt.hiddenHeaders = true; me.headerCt.addCls(me.hiddenHeaderCtCls); me.addCls(me.hiddenHeaderCls); // IE Quirks Mode fix // If hidden configuration option was used, several layout calculations will be bypassed. if (Ext.isIEQuirks) { me.headerCt.style = { display: 'none' }; } } me.relayHeaderCtEvents(me.headerCt); me.features = me.features || []; if (!Ext.isArray(me.features)) { me.features = [me.features]; } me.dockedItems = [].concat(me.dockedItems || []); me.dockedItems.unshift(me.headerCt); me.viewConfig = me.viewConfig || {}; // AbstractDataView will look up a Store configured as an object // getView converts viewConfig into a View instance view = me.getView(); me.items = [view]; me.hasView = true; // Add a listener to synchronize the horizontal scroll position of the headers // with the table view's element... Unless we are not showing headers! if (!me.hideHeaders) { view.on({ scroll: { fn: me.onHorizontalScroll, element: 'el', scope: me } }); } // Attach this Panel to the Store me.bindStore(store, true); me.mon(view, { viewready: me.onViewReady, refresh: me.onRestoreHorzScroll, scope: me }); } // Relay events from the View whether it be a LockingView, or a regular GridView me.relayEvents(me.view, [ /** * @event beforeitemmousedown * @inheritdoc Ext.view.View#beforeitemmousedown */ 'beforeitemmousedown', /** * @event beforeitemmouseup * @inheritdoc Ext.view.View#beforeitemmouseup */ 'beforeitemmouseup', /** * @event beforeitemmouseenter * @inheritdoc Ext.view.View#beforeitemmouseenter */ 'beforeitemmouseenter', /** * @event beforeitemmouseleave * @inheritdoc Ext.view.View#beforeitemmouseleave */ 'beforeitemmouseleave', /** * @event beforeitemclick * @inheritdoc Ext.view.View#beforeitemclick */ 'beforeitemclick', /** * @event beforeitemdblclick * @inheritdoc Ext.view.View#beforeitemdblclick */ 'beforeitemdblclick', /** * @event beforeitemcontextmenu * @inheritdoc Ext.view.View#beforeitemcontextmenu */ 'beforeitemcontextmenu', /** * @event itemmousedown * @inheritdoc Ext.view.View#itemmousedown */ 'itemmousedown', /** * @event itemmouseup * @inheritdoc Ext.view.View#itemmouseup */ 'itemmouseup', /** * @event itemmouseenter * @inheritdoc Ext.view.View#itemmouseenter */ 'itemmouseenter', /** * @event itemmouseleave * @inheritdoc Ext.view.View#itemmouseleave */ 'itemmouseleave', /** * @event itemclick * @inheritdoc Ext.view.View#itemclick */ 'itemclick', /** * @event itemdblclick * @inheritdoc Ext.view.View#itemdblclick */ 'itemdblclick', /** * @event itemcontextmenu * @inheritdoc Ext.view.View#itemcontextmenu */ 'itemcontextmenu', /** * @event beforecellclick * @inheritdoc Ext.view.Table#beforecellclick */ 'beforecellclick', /** * @event cellclick * @inheritdoc Ext.view.Table#cellclick */ 'cellclick', /** * @event beforecelldblclick * @inheritdoc Ext.view.Table#beforecelldblclick */ 'beforecelldblclick', /** * @event celldblclick * @inheritdoc Ext.view.Table#celldblclick */ 'celldblclick', /** * @event beforecellcontextmenu * @inheritdoc Ext.view.Table#beforecellcontextmenu */ 'beforecellcontextmenu', /** * @event cellcontextmenu * @inheritdoc Ext.view.Table#cellcontextmenu */ 'cellcontextmenu', /** * @event beforecellmousedown * @inheritdoc Ext.view.Table#beforecellmousedown */ 'beforecellmousedown', /** * @event cellmousedown * @inheritdoc Ext.view.Table#cellmousedown */ 'cellmousedown', /** * @event beforecellmouseup * @inheritdoc Ext.view.Table#beforecellmouseup */ 'beforecellmouseup', /** * @event cellmouseup * @inheritdoc Ext.view.Table#cellmouseup */ 'cellmouseup', /** * @event beforecellkeydown * @inheritdoc Ext.view.Table#beforecellkeydown */ 'beforecellkeydown', /** * @event cellkeydown * @inheritdoc Ext.view.Table#cellkeydown */ 'cellkeydown', /** * @event beforecontainermousedown * @inheritdoc Ext.view.View#beforecontainermousedown */ 'beforecontainermousedown', /** * @event beforecontainermouseup * @inheritdoc Ext.view.View#beforecontainermouseup */ 'beforecontainermouseup', /** * @event beforecontainermouseover * @inheritdoc Ext.view.View#beforecontainermouseover */ 'beforecontainermouseover', /** * @event beforecontainermouseout * @inheritdoc Ext.view.View#beforecontainermouseout */ 'beforecontainermouseout', /** * @event beforecontainerclick * @inheritdoc Ext.view.View#beforecontainerclick */ 'beforecontainerclick', /** * @event beforecontainerdblclick * @inheritdoc Ext.view.View#beforecontainerdblclick */ 'beforecontainerdblclick', /** * @event beforecontainercontextmenu * @inheritdoc Ext.view.View#beforecontainercontextmenu */ 'beforecontainercontextmenu', /** * @event containermouseup * @inheritdoc Ext.view.View#containermouseup */ 'containermouseup', /** * @event containermouseover * @inheritdoc Ext.view.View#containermouseover */ 'containermouseover', /** * @event containermouseout * @inheritdoc Ext.view.View#containermouseout */ 'containermouseout', /** * @event containerclick * @inheritdoc Ext.view.View#containerclick */ 'containerclick', /** * @event containerdblclick * @inheritdoc Ext.view.View#containerdblclick */ 'containerdblclick', /** * @event containercontextmenu * @inheritdoc Ext.view.View#containercontextmenu */ 'containercontextmenu', /** * @event selectionchange * @inheritdoc Ext.selection.Model#selectionchange */ 'selectionchange', /** * @event beforeselect * @inheritdoc Ext.selection.RowModel#beforeselect */ 'beforeselect', /** * @event select * @inheritdoc Ext.selection.RowModel#select */ 'select', /** * @event beforedeselect * @inheritdoc Ext.selection.RowModel#beforedeselect */ 'beforedeselect', /** * @event deselect * @inheritdoc Ext.selection.RowModel#deselect */ 'deselect' ]); me.callParent(arguments); me.addStateEvents(['columnresize', 'columnmove', 'columnhide', 'columnshow', 'sortchange', 'filterchange']); // If lockable, the headerCt is just a collection of Columns, not a Container if (!me.lockable && me.headerCt) { me.headerCt.on('afterlayout', me.onRestoreHorzScroll, me); } }, // Private. Determine if there are any columns with a locked configuration option hasLockedColumns: function(columns) { var i, len, column; // In case they specified a config object with items... if (Ext.isObject(columns)) { columns = columns.items; } for (i = 0, len = columns.length; i < len; i++) { column = columns[i]; if (!column.processed && column.locked) { return true; } } }, relayHeaderCtEvents: function (headerCt) { this.relayEvents(headerCt, [ /** * @event columnresize * @inheritdoc Ext.grid.header.Container#columnresize */ 'columnresize', /** * @event columnmove * @inheritdoc Ext.grid.header.Container#columnmove */ 'columnmove', /** * @event columnhide * @inheritdoc Ext.grid.header.Container#columnhide */ 'columnhide', /** * @event columnshow * @inheritdoc Ext.grid.header.Container#columnshow */ 'columnshow', /** * @event columnschanged * @inheritdoc Ext.grid.header.Container#columnschanged */ 'columnschanged', /** * @event sortchange * @inheritdoc Ext.grid.header.Container#sortchange */ 'sortchange', /** * @event headerclick * @inheritdoc Ext.grid.header.Container#headerclick */ 'headerclick', /** * @event headercontextmenu * @inheritdoc Ext.grid.header.Container#headercontextmenu */ 'headercontextmenu', /** * @event headertriggerclick * @inheritdoc Ext.grid.header.Container#headertriggerclick */ 'headertriggerclick' ]); }, getState: function(){ var me = this, state = me.callParent(), storeState = me.store.getState(); state = me.addPropertyToState(state, 'columns', me.headerCt.getColumnsState()); if (storeState) { state.storeState = storeState; } return state; }, applyState: function(state) { var me = this, sorter = state.sort, storeState = state.storeState, store = me.store, columns = state.columns; delete state.columns; // Ensure superclass has applied *its* state. // AbstractComponent saves dimensions (and anchor/flex) plus collapsed state. me.callParent(arguments); if (columns) { me.headerCt.applyColumnsState(columns); } // Old stored sort state. Deprecated and will die out. if (sorter) { if (store.remoteSort) { // Pass false to prevent a sort from occurring store.sort({ property: sorter.property, direction: sorter.direction, root: sorter.root }, null, false); } else { store.sort(sorter.property, sorter.direction); } } // New storeState which encapsulates groupers, sorters and filters else if (storeState) { store.applyState(storeState); } }, /** * Returns the store associated with this Panel. * @return {Ext.data.Store} The store */ getStore: function(){ return this.store; }, /** * Gets the view for this panel. * @return {Ext.view.Table} */ getView: function() { var me = this, sm; if (!me.view) { sm = me.getSelectionModel(); // TableView injects the view reference into this grid so that we have a reference as early as possible Ext.widget(Ext.apply({ // Features need a reference to the grid, so configure a reference into the View grid: me, deferInitialRefresh: me.deferRowRender !== false, trackOver: me.trackMouseOver !== false, scroll: me.scroll, xtype: me.viewType, store: me.store, headerCt: me.headerCt, columnLines: me.columnLines, rowLines: me.rowLines, selModel: sm, features: me.features, panel: me, emptyText: me.emptyText || '' }, me.viewConfig)); // Normalize the application of the markup wrapping the emptyText config. // `emptyText` can now be defined on the grid as well as on its viewConfig, and this led to the emptyText not // having the wrapping markup when it was defined in the viewConfig. It should be backwards compatible. // Note that in the unlikely event that emptyText is defined on both the grid config and the viewConfig that the viewConfig wins. if (me.view.emptyText) { me.view.emptyText = '
' + me.view.emptyText + '
'; } // TableView's custom component layout, Ext.view.TableLayout requires a reference to the headerCt because it depends on the headerCt doing its work. me.view.getComponentLayout().headerCt = me.headerCt; me.mon(me.view, { uievent: me.processEvent, scope: me }); sm.view = me.view; me.headerCt.view = me.view; } return me.view; }, /** * @private * autoScroll is never valid for all classes which extend TablePanel. */ setAutoScroll: Ext.emptyFn, /** * @private * Processes UI events from the view. Propagates them to whatever internal Components need to process them. * @param {String} type Event type, eg 'click' * @param {Ext.view.Table} view TableView Component * @param {HTMLElement} cell Cell HtmlElement the event took place within * @param {Number} recordIndex Index of the associated Store Model (-1 if none) * @param {Number} cellIndex Cell index within the row * @param {Ext.EventObject} e Original event */ processEvent: function(type, view, cell, recordIndex, cellIndex, e, record, row) { var me = this, header; if (cellIndex !== -1) { header = me.columnManager.getColumns()[cellIndex]; return header.processEvent.apply(header, arguments); } }, /** * This method is obsolete in 4.1. The closest equivalent in * 4.1 is {@link #doLayout}, but it is also possible that no * layout is needed. * @deprecated 4.1 */ determineScrollbars: function () { Ext.log.warn('Obsolete'); }, /** * This method is obsolete in 4.1. The closest equivalent in 4.1 is * {@link Ext.AbstractComponent#updateLayout}, but it is also possible that no layout * is needed. * @deprecated 4.1 */ invalidateScroller: function () { Ext.log.warn('Obsolete'); }, scrollByDeltaY: function(yDelta, animate) { this.getView().scrollBy(0, yDelta, animate); }, scrollByDeltaX: function(xDelta, animate) { this.getView().scrollBy(xDelta, 0, animate); }, afterCollapse: function() { var me = this; me.saveScrollPos(); me.saveScrollPos(); me.callParent(arguments); }, afterExpand: function() { var me = this; me.callParent(arguments); me.restoreScrollPos(); me.restoreScrollPos(); }, saveScrollPos: Ext.emptyFn, restoreScrollPos: Ext.emptyFn, onHeaderResize: function(){ this.delayScroll(); }, // Update the view when a header moves onHeaderMove: function(headerCt, header, colsToMove, fromIdx, toIdx) { var me = this; // If there are Features or Plugins which create DOM which must match column order, they set the optimizedColumnMove flag to false. // In this case we must refresh the view on column move. if (me.optimizedColumnMove === false) { me.view.refresh(); } // Simplest case for default DOM structure is just to swap the columns round in the view. else { me.view.moveColumn(fromIdx, toIdx, colsToMove); } me.delayScroll(); }, // Section onHeaderHide is invoked after view. onHeaderHide: function(headerCt, header) { this.view.refresh(); this.delayScroll(); }, onHeaderShow: function(headerCt, header) { this.view.refresh(); this.delayScroll(); }, delayScroll: function(){ var target = this.getScrollTarget().el; if (target) { this.scrollTask.delay(10, null, null, [target.dom.scrollLeft]); } }, /** * @private * Fires the TablePanel's viewready event when the view declares that its internal DOM is ready */ onViewReady: function() { this.fireEvent('viewready', this); }, /** * @private * Tracks when things happen to the view and preserves the horizontal scroll position. */ onRestoreHorzScroll: function() { var left = this.scrollLeftPos; if (left) { // We need to restore the body scroll position here this.syncHorizontalScroll(left, true); } }, getScrollerOwner: function() { var rootCmp = this; if (!this.scrollerOwner) { rootCmp = this.up('[scrollerOwner]'); } return rootCmp; }, /** * Gets left hand side marker for header resizing. * @private */ getLhsMarker: function() { var me = this; return me.lhsMarker || (me.lhsMarker = Ext.DomHelper.append(me.el, { cls: me.resizeMarkerCls }, true)); }, /** * Gets right hand side marker for header resizing. * @private */ getRhsMarker: function() { var me = this; return me.rhsMarker || (me.rhsMarker = Ext.DomHelper.append(me.el, { cls: me.resizeMarkerCls }, true)); }, /** * Returns the selection model being used and creates it via the configuration if it has not been created already. * @return {Ext.selection.Model} selModel */ getSelectionModel: function(){ var me = this, selModel = me.selModel, applyMode, mode, type; if (!selModel) { selModel = {}; // no config, set our own mode applyMode = true; } if (!selModel.events) { // only config provided, set our mode if one doesn't exist on the config type = selModel.selType || me.selType; applyMode = !selModel.mode; selModel = me.selModel = Ext.create('selection.' + type, selModel); } if (me.simpleSelect) { mode = 'SIMPLE'; } else if (me.multiSelect) { mode = 'MULTI'; } Ext.applyIf(selModel, { allowDeselect: me.allowDeselect }); if (mode && applyMode) { selModel.setSelectionMode(mode); } if (!selModel.hasRelaySetup) { me.relayEvents(selModel, [ 'selectionchange', 'beforeselect', 'beforedeselect', 'select', 'deselect' ]); selModel.hasRelaySetup = true; } // lock the selection model if user // has disabled selection if (me.disableSelection) { selModel.locked = true; } return selModel; }, getScrollTarget: function(){ var owner = this.getScrollerOwner(), items = owner.query('tableview'); return items[1] || items[0]; }, onHorizontalScroll: function(event, target) { this.syncHorizontalScroll(target.scrollLeft); }, syncHorizontalScroll: function(left, setBody) { var me = this, scrollTarget; setBody = setBody === true; // Only set the horizontal scroll if we've changed position, // so that we don't set this on vertical scrolls if (me.rendered && (setBody || left !== me.scrollLeftPos)) { // Only set the body position if we're reacting to a refresh, otherwise // we just need to set the header. if (setBody) { scrollTarget = me.getScrollTarget(); scrollTarget.el.dom.scrollLeft = left; } me.headerCt.el.dom.scrollLeft = left; me.scrollLeftPos = left; } }, // template method meant to be overriden onStoreLoad: Ext.emptyFn, getEditorParent: function() { return this.body; }, bindStore: function(store, initial) { var me = this, view = me.getView(), bufferedStore = store && store.buffered, bufferedRenderer; // Bind to store immediately because subsequent processing looks for grid's store property me.store = store; // If the Store is buffered, create a BufferedRenderer to monitor the View's scroll progress // and scroll rows on/off when it detects we are nearing an edge. // MUST be done before store is bound to the view so that the BufferedRenderer may inject its getViewRange implementation // before the view tries to refresh. bufferedRenderer = me.findPlugin('bufferedrenderer'); if (bufferedRenderer) { me.verticalScroller = bufferedRenderer; // If we're in a reconfigure rebind the BufferedRenderer if (bufferedRenderer.store) { bufferedRenderer.bindStore(store); } } else if (bufferedStore) { me.verticalScroller = bufferedRenderer = me.addPlugin(Ext.apply({ ptype: 'bufferedrenderer' }, me.initialConfig.verticalScroller)); } if (view.store !== store) { if (initial) { // The initially created View will already be bound to the configured Store view.bindStore(store, false, 'dataSource'); } else { // Otherwise, we're coming from a reconfigure, so we need to set the actual // store property on the view. It will set the data source view.bindStore(store, false); } } me.mon(store, { load: me.onStoreLoad, scope: me }); me.storeRelayers = me.relayEvents(store, [ /** * @event filterchange * @inheritdoc Ext.data.Store#filterchange */ 'filterchange' ]); // If buffered rendering is being used, scroll position must be preserved across refreshes if (bufferedRenderer) { me.invalidateScrollerOnRefresh = false; } if (me.invalidateScrollerOnRefresh !== undefined) { view.preserveScrollOnRefresh = !me.invalidateScrollerOnRefresh; } }, unbindStore: function() { var me = this, store = me.store; if (store) { me.store = null; me.mun(store, { load: me.onStoreLoad, scope: me }); Ext.destroy(me.storeRelayers); } }, // documented on GridPanel reconfigure: function(store, columns) { var me = this, view = me.getView(), originalDeferinitialRefresh, oldStore = me.store, headerCt = me.headerCt, oldColumns = headerCt ? headerCt.items.getRange() : me.columns; // Make copy in case the beforereconfigure listener mutates it. if (columns) { columns = Ext.Array.slice(columns); } me.fireEvent('beforereconfigure', me, store, columns, oldStore, oldColumns); if (me.lockable) { me.reconfigureLockable(store, columns); } else { Ext.suspendLayouts(); if (columns) { // new columns, delete scroll pos delete me.scrollLeftPos; headerCt.removeAll(); headerCt.add(columns); } // The following test compares the result of an assignment of the store var with the oldStore var // This saves a large amount of code. if (store && (store = Ext.StoreManager.lookup(store)) !== oldStore) { // Only unbind the store if a new one was passed if (me.store) { me.unbindStore(); } // On reconfigure, view refresh must be inline. originalDeferinitialRefresh = view.deferInitialRefresh; view.deferInitialRefresh = false; me.bindStore(store); view.deferInitialRefresh = originalDeferinitialRefresh; } else { me.getView().refresh(); } headerCt.setSortState(); Ext.resumeLayouts(true); } me.fireEvent('reconfigure', me, store, columns, oldStore, oldColumns); }, beforeDestroy: function(){ var task = this.scrollTask; if (task) { task.cancel(); this.scrollTask = null; } this.callParent(); }, onDestroy: function(){ if (this.lockable) { this.destroyLockable(); } this.callParent(); } }); /** * Utility class for manipulating CSS rules * @singleton */ Ext.define('Ext.util.CSS', function() { var CSS, rules = null, doc = document, camelRe = /(-[a-z])/gi, camelFn = function(m, a){ return a.charAt(1).toUpperCase(); }; return { singleton: true, rules: rules, initialized: false, constructor: function() { // Cache a reference to the singleton CSS = this; }, /** * Creates a stylesheet from a text blob of rules. * These rules will be wrapped in a STYLE tag and appended to the HEAD of the document. * @param {String} cssText The text containing the css rules * @param {String} id An id to add to the stylesheet for later removal * @return {CSSStyleSheet} */ createStyleSheet : function(cssText, id) { var ss, head = doc.getElementsByTagName("head")[0], styleEl = doc.createElement("style"); styleEl.setAttribute("type", "text/css"); if (id) { styleEl.setAttribute("id", id); } if (Ext.isIE) { head.appendChild(styleEl); ss = styleEl.styleSheet; ss.cssText = cssText; } else { try{ styleEl.appendChild(doc.createTextNode(cssText)); } catch(e) { styleEl.cssText = cssText; } head.appendChild(styleEl); ss = styleEl.styleSheet ? styleEl.styleSheet : (styleEl.sheet || doc.styleSheets[doc.styleSheets.length-1]); } CSS.cacheStyleSheet(ss); return ss; }, /** * Removes a style or link tag by id * @param {String} id The id of the tag */ removeStyleSheet : function(id) { var existing = doc.getElementById(id); if (existing) { existing.parentNode.removeChild(existing); } }, /** * Dynamically swaps an existing stylesheet reference for a new one * @param {String} id The id of an existing link tag to remove * @param {String} url The href of the new stylesheet to include */ swapStyleSheet : function(id, url) { var ss; CSS.removeStyleSheet(id); ss = doc.createElement("link"); ss.setAttribute("rel", "stylesheet"); ss.setAttribute("type", "text/css"); ss.setAttribute("id", id); ss.setAttribute("href", url); doc.getElementsByTagName("head")[0].appendChild(ss); }, /** * Refresh the rule cache if you have dynamically added stylesheets * @return {Object} An object (hash) of rules indexed by selector */ refreshCache : function() { return CSS.getRules(true); }, // @private cacheStyleSheet : function(ss) { if (!rules) { rules = CSS.rules = {}; } try {// try catch for cross domain access issue var ssRules = ss.cssRules || ss.rules, i = ssRules.length - 1, imports = ss.imports, len = imports ? imports.length : 0, rule, j; // Old IE has a different way of handling imports for (j = 0; j < len; ++j) { CSS.cacheStyleSheet(imports[j]); } for (; i >= 0; --i) { rule = ssRules[i]; // If it's an @import rule, import its stylesheet if (rule.styleSheet) { CSS.cacheStyleSheet(rule.styleSheet); } CSS.cacheRule(rule, ss); } } catch(e) {} }, cacheRule: function(cssRule, styleSheet) { // If it's an @import rule, import its stylesheet if (cssRule.styleSheet) { return CSS.cacheStyleSheet(cssRule.styleSheet); } var selectorText = cssRule.selectorText, selectorCount, j; if (selectorText) { // Split in case there are multiple, comma-delimited selectors selectorText = selectorText.split(','); selectorCount = selectorText.length; for (j = 0; j < selectorCount; j++) { // IE<8 does not keep a reference to parentStyleSheet in the rule, so we // must cache an object like this until IE<8 is deprecated. rules[Ext.String.trim(selectorText[j]).toLowerCase()] = { parentStyleSheet: styleSheet, cssRule: cssRule }; }; } }, /** * Gets all css rules for the document * @param {Boolean} refreshCache true to refresh the internal cache * @return {Object} An object (hash) of rules indexed by selector */ getRules : function(refreshCache) { var result = {}, selector; if (rules === null || refreshCache) { CSS.refreshCache(); } for (selector in rules) { result[selector] = rules[selector].cssRule; } return result; }, refreshCache: function() { var ds = doc.styleSheets, i = 0, len = ds.length; rules = CSS.rules = {} for (; i < len; i++) { try { if (!ds[i].disabled) { CSS.cacheStyleSheet(ds[i]); } } catch(e) {} } }, /** * Gets an an individual CSS rule by selector(s) * @param {String/String[]} selector The CSS selector or an array of selectors to try. The first selector that is found is returned. * @param {Boolean} refreshCache true to refresh the internal cache if you have recently updated any rules or added styles dynamically * @return {CSSStyleRule} The CSS rule or null if one is not found */ getRule: function(selector, refreshCache, rawCache) { var i, result; if (!rules || refreshCache) { CSS.refreshCache(); } if (!Ext.isArray(selector)) { result = rules[selector.toLowerCase()] if (result && !rawCache) { result = result.cssRule; } return result || null; } for (i = 0; i < selector.length; i++) { if (rules[selector[i]]) { return rawCache ? rules[selector[i].toLowerCase()] : rules[selector[i].toLowerCase()].cssRule; } } return null; }, /** * Creates a rule. * @param {CSSStyleSheet} styleSheet The StyleSheet to create the rule in as returned from {@link #createStyleSheet}. * @param {String} selector The selector to target the rule. * @param {String} property The cssText specification eg `"color:red;font-weight:bold;text-decoration:underline"` * @return {CSSStyleRule} The created rule */ createRule: function(styleSheet, selector, cssText) { var result, ruleSet = styleSheet.cssRules || styleSheet.rules, index = ruleSet.length; if (styleSheet.insertRule) { styleSheet.insertRule(selector + '{' + cssText + '}', index); } else { styleSheet.addRule(selector, cssText||' '); } CSS.cacheRule(result = ruleSet[index], styleSheet); return result; }, /** * Updates a rule property * @param {String/String[]} selector If it's an array it tries each selector until it finds one. Stops immediately once one is found. * @param {String} property The css property or a cssText specification eg `"color:red;font-weight:bold;text-decoration:underline"` * @param {String} value The new value for the property * @return {Boolean} true If a rule was found and updated */ updateRule : function(selector, property, value) { var rule, i, styles; if (!Ext.isArray(selector)) { rule = CSS.getRule(selector); if (rule) { // 2 arg form means cssText sent, so parse it and update each style if (arguments.length == 2) { styles = Ext.Element.parseStyles(property); for (property in styles) { rule.style[property.replace(camelRe, camelFn)] = styles[property]; } } else { rule.style[property.replace(camelRe, camelFn)] = value; } return true; } } else { for (i = 0; i < selector.length; i++) { if (CSS.updateRule(selector[i], property, value)) { return true; } } } return false; }, deleteRule: function(selector) { var rule = CSS.getRule(selector, false, true), styleSheet, index; if (rule) { styleSheet = rule.parentStyleSheet; index = Ext.Array.indexOf(styleSheet.cssRules || styleSheet.rules, rule.cssRule); if (styleSheet.deleteRule) { styleSheet.deleteRule(index); } else { styleSheet.removeRule(index); } delete rules[selector]; } } }; }); /** * Component layout for {@link Ext.view.Table} * @private * */ Ext.define('Ext.view.TableLayout', { extend: Ext.layout.component.Auto , alias: ['layout.tableview'], type: 'tableview', beginLayout: function(ownerContext) { var me = this, otherSide = me.owner.lockingPartner, owner = me.owner; me.callParent(arguments); // If we are in a twinned grid (locked view) then set up bidirectional links with the other side's layout context if (otherSide) { me.lockedGrid = me.owner.up('[lockable]'); me.lockedGrid.needsRowHeightSync = true; if (!ownerContext.lockingPartner) { ownerContext.lockingPartner = ownerContext.context.getItem(otherSide, otherSide.el); if (ownerContext.lockingPartner && !ownerContext.lockingPartner.lockingPartner) { ownerContext.lockingPartner.lockingPartner = ownerContext; } } } // Grab a ContextItem for the header container ownerContext.headerContext = ownerContext.context.getCmp(me.headerCt); // Grab ContextItem for the table only if there is a table to size if (me.owner.body.dom) { ownerContext.bodyContext = ownerContext.getEl(me.owner.body); } if (Ext.isWebKit) { owner.el.select(owner.getBodySelector()).setStyle('table-layout', 'auto'); } }, calculate: function(ownerContext) { var me = this, lockingPartner = me.lockingPartner, owner = me.owner, contentHeight = 0, emptyEl; // We can only complete our work (setting the CSS rules governing column widths) if the // Grid's HeaderContainer's ColumnLayout has set the widths of its columns. if (ownerContext.headerContext.hasProp('columnWidthsDone')) { if (!me.setColumnWidths(ownerContext)) { me.done = false; return; } ownerContext.state.columnWidthsSynced = true; if (ownerContext.bodyContext) { emptyEl = me.owner.el.down('.' + owner.ownerCt.emptyCls, true); if (!emptyEl) { contentHeight = ownerContext.bodyContext.el.dom.offsetHeight; ownerContext.bodyContext.setHeight(contentHeight, false); } else { contentHeight = emptyEl.offsetHeight; } ownerContext.setProp('contentHeight', contentHeight); } // If we are part of a twinned table view set (locking grid) // Then only complete when both sides are complete. if (lockingPartner && !lockingPartner.state.columnWidthsSynced) { me.done = false; } else { me.callParent(arguments); } } else { me.done = false; } }, measureContentHeight: function(ownerContext) { var lockingPartner = ownerContext.lockingPartner; // Only able to produce a valid contentHeight if there's no table // ... or we have flushed all column widths to the table (or both tables if we are a pair) if (!ownerContext.bodyContext || (ownerContext.state.columnWidthsSynced && (!lockingPartner || lockingPartner.state.columnWidthsSynced))) { return this.callParent(arguments); } }, setColumnWidths: function(ownerContext) { var me = this, owner = me.owner, context = ownerContext.context, columns = me.headerCt.getVisibleGridColumns(), column, i = 0, len = columns.length, tableWidth = 0, columnLineWidth = 0, childContext, colWidth, isContentBox = !Ext.isBorderBox; // So that the setProp can trigger this layout. if (context) { context.currentLayout = me; } // Set column width corresponding to each header for (i = 0; i < len; i++) { column = columns[i]; childContext = context.getCmp(column); colWidth = childContext.props.width; if (isNaN(colWidth)) { // We don't have a width set, so we need to trigger when this child // actually gets a width assigned so we can continue. Technically this // shouldn't happen however we have a bug inside ColumnLayout where // columnWidthsDone is set incorrectly. This is just a workaround. childContext.getProp('width'); return false; } tableWidth += colWidth; // https://sencha.jira.com/browse/EXTJSIV-9263 - Browsers which cannot be switched to border box when doctype present (IE6 & IE7) - must subtract borders width from width of cells. if (isContentBox && owner.columnLines) { // https://sencha.jira.com/browse/EXTJSIV-9744 - default border width to 1 because // We are looking at the *header* border widths and Neptune, being a borderless theme // omits the border from the last column *HEADER*. But we are interrogating that to // know the width of border lines between cells which are not omitted. if (!columnLineWidth) { columnLineWidth = context.getCmp(column).borderInfo.width || 1; } colWidth -= columnLineWidth; } // Select column sizing elements within every within the grid. // 90% of the time, there will be only one table. // The RowWrap and Summary Features embed tables within colspanning cells, and these also // get sizers which need updating. // On IE8, sizing elements to control column width was about 2.25 times // faster than selecting all the cells in the column to be resized. // Column sizing using dynamic CSS rules is *extremely* expensive on IE. owner.body.select(owner.getColumnSizerSelector(column)).setWidth(colWidth); } // Set widths of all tables (includes tables embedded in RowWrap and Summary rows) owner.el.select(owner.getBodySelector()).setWidth(tableWidth); return true; }, finishedLayout: function() { var me = this, owner = me.owner; me.callParent(arguments); if (Ext.isWebKit) { owner.el.select(owner.getBodySelector()).setStyle('table-layout', ''); } // Make sure only one side gets to do the sync on completion - it's an expensive process. // Only do it if the syncRowHeightConfig hasn't been set to false. if (owner.refreshCounter && me.lockedGrid && me.lockedGrid.syncRowHeight && me.lockedGrid.needsRowHeightSync) { me.lockedGrid.syncRowHeights(); me.lockedGrid.needsRowHeightSync = false; } } }); /** * @private * A cache of View elements keyed using the index of the associated record in the store. * * This implements the methods of {Ext.dom.CompositeElement} which are used by {@link Ext.view.AbstractView} * to privide a map of record nodes and methods to manipulate the nodes. */ Ext.define('Ext.view.NodeCache', { constructor: function(view) { this.view = view; this.clear(); this.el = new Ext.dom.AbstractElement.Fly(); }, /** * Removes all elements from this NodeCache. * @param {Boolean} [removeDom] True to also remove the elements from the document. */ clear: function(removeDom) { var me = this, elements = this.elements, i, el; if (removeDom) { for (i in elements) { el = elements[i]; el.parentNode.removeChild(el); } } me.elements = {}; me.count = me.startIndex = 0; me.endIndex = -1; }, /** * Clears this NodeCache and adds the elements passed. * @param {HTMLElement[]} els An array of DOM elements from which to fill this NodeCache. * @return {Ext.view.NodeCache} this */ fill: function(newElements, startIndex) { var me = this, elements = me.elements = {}, i, len = newElements.length; if (!startIndex) { startIndex = 0; } for (i = 0; i < len; i++) { elements[startIndex + i] = newElements[i]; } me.startIndex = startIndex; me.endIndex = startIndex + len - 1; me.count = len; return this; }, insert: function(insertPoint, nodes) { var me = this, elements = me.elements, i, nodeCount = nodes.length; // If not inserting into empty cache, validate, and possibly shuffle. if (me.count) { if (insertPoint > me.endIndex + 1 || insertPoint + nodes.length - 1 < me.startIndex) { Ext.Error.raise('Discontiguous range would result from inserting ' + nodes.length + ' nodes at ' + insertPoint); } // Move following nodes forwards by positions if (insertPoint < me.count) { for (i = me.endIndex + nodeCount; i >= insertPoint + nodeCount; i--) { elements[i] = elements[i - nodeCount]; elements[i].setAttribute('data-recordIndex', i); } } me.endIndex = me.endIndex + nodeCount; } // Empty cache. set up counters else { me.startIndex = insertPoint; me.endIndex = insertPoint + nodeCount - 1; } // Insert new nodes into place for (i = 0; i < nodeCount; i++, insertPoint++) { elements[insertPoint] = nodes[i]; elements[insertPoint].setAttribute('data-recordIndex', insertPoint); } me.count += nodeCount; }, item: function(index, asDom) { var el = this.elements[index], result = null; if (el) { result = asDom ? this.elements[index] : this.el.attach(this.elements[index]); } return result; }, first: function(asDom) { return this.item(this.startIndex, asDom); }, last: function(asDom) { return this.item(this.endIndex, asDom); }, getCount : function() { return this.count; }, slice: function(start, end) { var elements = this.elements, result = [], i; if (arguments.length < 2) { end = this.endIndex; } else { end = Math.min(this.endIndex, end - 1); } for (i = start||this.startIndex; i <= end; i++) { result.push(elements[i]); } return result; }, /** * Replaces the specified element with the passed element. * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, the Element itself, the index of the * element in this composite to replace. * @param {String/Ext.Element} replacement The id of an element or the Element itself. * @param {Boolean} [domReplace] True to remove and replace the element in the document too. */ replaceElement: function(el, replacement, domReplace) { var elements = this.elements, index = (typeof el === 'number') ? el : this.indexOf(el); if (index > -1) { replacement = Ext.getDom(replacement); if (domReplace) { el = elements[index]; el.parentNode.insertBefore(replacement, el); Ext.removeNode(el); replacement.setAttribute('data-recordIndex', index); } this.elements[index] = replacement; } return this; }, /** * Find the index of the passed element within the composite collection. * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, or an Ext.dom.Element, or an HtmlElement * to find within the composite collection. * @return {Number} The index of the passed Ext.dom.Element in the composite collection, or -1 if not found. */ indexOf: function(el) { var elements = this.elements, index; el = Ext.getDom(el); for (index = this.startIndex; index <= this.endIndex; index++) { if (elements[index] === el) { return index; } } return -1; }, removeRange: function(start, end, removeDom) { var me = this, elements = me.elements, el, i, removeCount, fromPos; if (end === undefined) { end = me.count; } else { end = Math.min(me.endIndex + 1, end + 1); } if (!start) { start = 0; } removeCount = end - start; for (i = start, fromPos = end; i < me.endIndex; i++, fromPos++) { // Within removal range and we are removing from DOM if (removeDom && i < end) { Ext.removeNode(elements[i]); } // If the from position is occupied, shuffle that entry back into reference "i" if (fromPos <= me.endIndex) { el = elements[i] = elements[fromPos]; el.setAttribute('data-recordIndex', i); } // The from position has walked off the end, so delete reference "i" else { delete elements[i]; } } me.count -= removeCount; me.endIndex -= removeCount; }, /** * Removes the specified element(s). * @param {String/HTMLElement/Ext.Element/Number} el The id of an element, the Element itself, the index of the * element in this composite or an array of any of those. * @param {Boolean} [removeDom] True to also remove the element from the document */ removeElement: function(keys, removeDom) { var me = this, inKeys, key, elements = me.elements, el, deleteCount, keyIndex = 0, index, fromIndex; // Sort the keys into ascending order so that we can iterate through the elements // collection, and delete items encountered in the keys array as we encounter them. if (Ext.isArray(keys)) { inKeys = keys; keys = []; deleteCount = inKeys.length; for (keyIndex = 0; keyIndex < deleteCount; keyIndex++) { key = inKeys[keyIndex]; if (typeof key !== 'number') { key = me.indexOf(key); } // Could be asked to remove data above the start, or below the end of rendered zone in a buffer rendered view // So only collect keys which are within our range if (key >= me.startIndex && key <= me.endIndex) { keys[keys.length] = key; } } Ext.Array.sort(keys); deleteCount = keys.length; } else { // Could be asked to remove data above the start, or below the end of rendered zone in a buffer rendered view if (keys < me.startIndex || keys > me.endIndex) { return; } deleteCount = 1; keys = [keys]; } // Iterate through elements starting at the element referenced by the first deletion key. // We also start off and index zero in the keys to delete array. for (index = fromIndex = keys[0], keyIndex = 0; index <= me.endIndex; index++, fromIndex++) { // If the current index matches the next key in the delete keys array, this // entry is being deleted, so increment the fromIndex to skip it. // Advance to next entry in keys array. if (keyIndex < deleteCount && index === keys[keyIndex]) { fromIndex++; keyIndex++; if (removeDom) { Ext.removeNode(elements[index]); } } // Shuffle entries forward of the delete range back into contiguity. if (fromIndex <= me.endIndex && fromIndex >= me.startIndex) { el = elements[index] = elements[fromIndex]; el.setAttribute('data-recordIndex', index); } else { delete elements[index]; } } me.endIndex -= deleteCount; me.count -= deleteCount; }, /** * Appends/prepends records depending on direction flag * @param {Ext.data.Model[]} newRecords Items to append/prepend * @param {Number} direction `-1' = scroll up, `0` = scroll down. * @param {Number} removeCount The number of records to remove from the end. if scrolling * down, rows are removed from the top and the new rows are added at the bottom. */ scroll: function(newRecords, direction, removeCount) { var me = this, elements = me.elements, recCount = newRecords.length, i, el, removeEnd, newNodes, nodeContainer = me.view.getNodeContainer(), frag = document.createDocumentFragment(); // Scrolling up (content moved down - new content needed at top, remove from bottom) if (direction == -1) { for (i = (me.endIndex - removeCount) + 1; i <= me.endIndex; i++) { el = elements[i]; delete elements[i]; el.parentNode.removeChild(el); } me.endIndex -= removeCount; // grab all nodes rendered, not just the data rows newNodes = me.view.bufferRender(newRecords, me.startIndex -= recCount); for (i = 0; i < recCount; i++) { elements[me.startIndex + i] = newNodes[i]; frag.appendChild(newNodes[i]); } nodeContainer.insertBefore(frag, nodeContainer.firstChild); } // Scrolling down (content moved up - new content needed at bottom, remove from top) else { removeEnd = me.startIndex + removeCount; for (i = me.startIndex; i < removeEnd; i++) { el = elements[i]; delete elements[i]; el.parentNode.removeChild(el); } me.startIndex = i; // grab all nodes rendered, not just the data rows newNodes = me.view.bufferRender(newRecords, me.endIndex + 1); for (i = 0; i < recCount; i++) { elements[me.endIndex += 1] = newNodes[i]; frag.appendChild(newNodes[i]); } nodeContainer.appendChild(frag); } // Keep count consistent. me.count = me.endIndex - me.startIndex + 1; } }); /** * This class encapsulates the user interface for a tabular data set. * It acts as a centralized manager for controlling the various interface * elements of the view. This includes handling events, such as row and cell * level based DOM events. It also reacts to events from the underlying {@link Ext.selection.Model} * to provide visual feedback to the user. * * This class does not provide ways to manipulate the underlying data of the configured * {@link Ext.data.Store}. * * This is the base class for both {@link Ext.grid.View} and {@link Ext.tree.View} and is not * to be used directly. */ Ext.define('Ext.view.Table', { extend: Ext.view.View , alias: 'widget.tableview', componentLayout: 'tableview', baseCls: Ext.baseCSSPrefix + 'grid-view', /** * @cfg {String} [firstCls='x-grid-cell-first'] * A CSS class to add to the *first* cell in every row to enable special styling for the first column. * If no styling is needed on the first column, this may be configured as `null`. */ firstCls: Ext.baseCSSPrefix + 'grid-cell-first', /** * @cfg {String} [lastCls='x-grid-cell-last'] * A CSS class to add to the *last* cell in every row to enable special styling for the last column. * If no styling is needed on the last column, this may be configured as `null`. */ lastCls: Ext.baseCSSPrefix + 'grid-cell-last', headerRowSelector: 'tr.' + Ext.baseCSSPrefix + 'grid-header-row', selectedItemCls: Ext.baseCSSPrefix + 'grid-row-selected', beforeSelectedItemCls: Ext.baseCSSPrefix + 'grid-row-before-selected', selectedCellCls: Ext.baseCSSPrefix + 'grid-cell-selected', focusedItemCls: Ext.baseCSSPrefix + 'grid-row-focused', beforeFocusedItemCls: Ext.baseCSSPrefix + 'grid-row-before-focused', tableFocusedFirstCls: Ext.baseCSSPrefix + 'grid-table-focused-first', tableSelectedFirstCls: Ext.baseCSSPrefix + 'grid-table-selected-first', tableOverFirstCls: Ext.baseCSSPrefix + 'grid-table-over-first', overItemCls: Ext.baseCSSPrefix + 'grid-row-over', beforeOverItemCls: Ext.baseCSSPrefix + 'grid-row-before-over', altRowCls: Ext.baseCSSPrefix + 'grid-row-alt', dirtyCls: Ext.baseCSSPrefix + 'grid-dirty-cell', rowClsRe: new RegExp('(?:^|\\s*)' + Ext.baseCSSPrefix + 'grid-row-(first|last|alt)(?:\\s+|$)', 'g'), cellRe: new RegExp(Ext.baseCSSPrefix + 'grid-cell-([^\\s]+) ', ''), positionBody: true, // cfg docs inherited trackOver: true, /** * Override this function to apply custom CSS classes to rows during rendering. This function should return the * CSS class name (or empty string '' for none) that will be added to the row's wrapping div. To apply multiple * class names, simply return them space-delimited within the string (e.g. 'my-class another-class'). * Example usage: * * viewConfig: { * getRowClass: function(record, rowIndex, rowParams, store){ * return record.get("valid") ? "row-valid" : "row-error"; * } * } * * @param {Ext.data.Model} record The record corresponding to the current row. * @param {Number} index The row index. * @param {Object} rowParams **DEPRECATED.** For row body use the * {@link Ext.grid.feature.RowBody#getAdditionalData getAdditionalData} method of the rowbody feature. * @param {Ext.data.Store} store The store this grid is bound to * @return {String} a CSS class name to add to the row. * @method */ getRowClass: null, /** * @cfg {Boolean} stripeRows * True to stripe the rows. * * This causes the CSS class **`x-grid-row-alt`** to be added to alternate rows of * the grid. A default CSS rule is provided which sets a background color, but you can override this * with a rule which either overrides the **background-color** style using the `!important` * modifier, or which uses a CSS selector of higher specificity. */ stripeRows: true, /** * @cfg {Boolean} markDirty * True to show the dirty cell indicator when a cell has been modified. */ markDirty : true, /** * @cfg {Boolean} enableTextSelection * True to enable text selections. */ /** * @private * Simple initial tpl for TableView just to satisfy the validation within AbstractView.initComponent. */ tpl: '{%values.view.tableTpl.applyOut(values, out)%}', tableTpl: [ '{%', // Add the row/column line classes to the table element. 'var view=values.view,tableCls=["' + Ext.baseCSSPrefix + '" + view.id + "-table ' + Ext.baseCSSPrefix + 'grid-table"];', 'if (view.columnLines) tableCls[tableCls.length]=view.ownerCt.colLinesCls;', 'if (view.rowLines) tableCls[tableCls.length]=view.ownerCt.rowLinesCls;', '%}', '
', '{[view.renderColumnSizer(out)]}', '{[view.renderTHead(values, out)]}', '{[view.renderTFoot(values, out)]}', '', '{%', 'view.renderRows(values.rows, values.viewStartIndex, out);', '%}', '', '', { priority: 0 } ], rowTpl: [ '{%', 'var dataRowCls = values.recordIndex === -1 ? "" : " ' + Ext.baseCSSPrefix + 'grid-data-row";', '%}', '', '' + '{%', 'parent.view.renderCell(values, parent.record, parent.recordIndex, xindex - 1, out, parent)', '%}', '', '', { priority: 0 } ], cellTpl: [ '', '
{style}">{value}
', '', { priority: 0 } ], /** * @private * Flag to disable refreshing SelectionModel on view refresh. Table views render rows with selected CSS class already added if necessary. */ refreshSelmodelOnRefresh: false, tableValues: {}, // Private properties used during the row and cell render process. // They are allocated here on the prototype, and cleared/re-used to avoid GC churn during repeated rendering. rowValues: { itemClasses: [], rowClasses: [] }, cellValues: { classes: [ Ext.baseCSSPrefix + 'grid-cell ' + Ext.baseCSSPrefix + 'grid-td' // for styles shared between cell and rowwrap ] }, /// Private used for buffered rendering renderBuffer: document.createElement('div'), constructor: function(config) { // Adjust our base class if we are inside a TreePanel if (config.grid.isTree) { config.baseCls = Ext.baseCSSPrefix + 'tree-view'; } this.callParent([config]); }, initComponent: function() { var me = this, scroll = me.scroll; this.addEvents( /** * @event beforecellclick * Fired before the cell click is processed. Return false to cancel the default action. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'beforecellclick', /** * @event cellclick * Fired when table cell is clicked. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'cellclick', /** * @event beforecelldblclick * Fired before the cell double click is processed. Return false to cancel the default action. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'beforecelldblclick', /** * @event celldblclick * Fired when table cell is double clicked. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'celldblclick', /** * @event beforecellcontextmenu * Fired before the cell right click is processed. Return false to cancel the default action. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'beforecellcontextmenu', /** * @event cellcontextmenu * Fired when table cell is right clicked. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'cellcontextmenu', /** * @event beforecellmousedown * Fired before the cell mouse down is processed. Return false to cancel the default action. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'beforecellmousedown', /** * @event cellmousedown * Fired when the mousedown event is captured on the cell. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'cellmousedown', /** * @event beforecellmouseup * Fired before the cell mouse up is processed. Return false to cancel the default action. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'beforecellmouseup', /** * @event cellmouseup * Fired when the mouseup event is captured on the cell. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'cellmouseup', /** * @event beforecellkeydown * Fired before the cell key down is processed. Return false to cancel the default action. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'beforecellkeydown', /** * @event cellkeydown * Fired when the keydown event is captured on the cell. * @param {Ext.view.Table} this * @param {HTMLElement} td The TD element for the cell. * @param {Number} cellIndex * @param {Ext.data.Model} record * @param {HTMLElement} tr The TR element for the cell. * @param {Number} rowIndex * @param {Ext.EventObject} e */ 'cellkeydown' ); /** * @private * @property {Ext.dom.AbstractElement.Fly} body * A flyweight Ext.Element which encapsulates a reference to the view's main row containing element. * *Note that the `dom` reference will not be present until the first data refresh* */ me.body = new Ext.dom.Element.Fly(); me.body.id = me.id + 'gridBody'; // Scrolling within a TableView is controlled by the scroll config of its owning GridPanel // It must see undefined in this property in order to leave the scroll styles alone at afterRender time me.autoScroll = undefined; // If trackOver has been turned off, null out the overCls because documented behaviour // in AbstractView is to turn trackOver on if overItemCls is set. if (!me.trackOver) { me.overItemCls = null; me.beforeOverItemCls = null; } // Convert grid scroll config to standard Component scrolling configurations. if (scroll === true || scroll === 'both') { me.autoScroll = true; } else if (scroll === 'horizontal') { me.overflowX = 'auto'; } else if (scroll === 'vertical') { me.overflowY = 'auto'; } me.selModel.view = me; me.headerCt.view = me; // Features need a reference to the grid. // Grid needs an immediate reference to its view so that the view cabn reliably be got from the grid during initialization me.grid.view = me; me.initFeatures(me.grid); delete me.grid; // The real tpl is generated, but AbstractView.initComponent insists upon the presence of a fully instantiated XTemplate at construction time. me.tpl = me.getTpl('tpl'); me.itemSelector = me.getItemSelector(); me.all = new Ext.view.NodeCache(me); me.callParent(); }, /** * @private * Move a grid column from one position to another * @param {Number} fromIdx The index from which to move columns * @param {Number} toIdx The index at which to insert columns. * @param {Number} [colsToMove=1] The number of columns to move beginning at the `fromIdx` */ moveColumn: function(fromIdx, toIdx, colsToMove) { var me = this, fragment = (colsToMove > 1) ? document.createDocumentFragment() : undefined, destinationCellIdx = toIdx, colCount = me.getGridColumns().length, lastIndex = colCount - 1, doFirstLastClasses = (me.firstCls || me.lastCls) && (toIdx === 0 || toIdx == colCount || fromIdx === 0 || fromIdx == lastIndex), i, j, rows, len, tr, cells, tables; // Dragging between locked and unlocked side first refreshes the view, and calls onHeaderMoved with // fromIndex and toIndex the same. if (me.rendered && toIdx !== fromIdx) { // Grab all rows which have column cells in. // That is data rows and column sizing rows. rows = me.el.query(me.getDataRowSelector()); if (toIdx > fromIdx && fragment) { destinationCellIdx -= colsToMove; } for (i = 0, len = rows.length; i < len; i++) { tr = rows[i]; cells = tr.childNodes; // Keep first cell class and last cell class correct *only if needed* if (doFirstLastClasses) { if (cells.length === 1) { Ext.fly(cells[0]).addCls(me.firstCls); Ext.fly(cells[0]).addCls(me.lastCls); continue; } if (fromIdx === 0) { Ext.fly(cells[0]).removeCls(me.firstCls); Ext.fly(cells[1]).addCls(me.firstCls); } else if (fromIdx === lastIndex) { Ext.fly(cells[lastIndex]).removeCls(me.lastCls); Ext.fly(cells[lastIndex - 1]).addCls(me.lastCls); } if (toIdx === 0) { Ext.fly(cells[0]).removeCls(me.firstCls); Ext.fly(cells[fromIdx]).addCls(me.firstCls); } else if (toIdx === colCount) { Ext.fly(cells[lastIndex]).removeCls(me.lastCls); Ext.fly(cells[fromIdx]).addCls(me.lastCls); } } if (fragment) { for (j = 0; j < colsToMove; j++) { fragment.appendChild(cells[fromIdx]); } tr.insertBefore(fragment, cells[destinationCellIdx] || null); } else { tr.insertBefore(cells[fromIdx], cells[destinationCellIdx] || null); } } // Shuffle the elements at the ta=op of all in the grid tables = me.el.query(me.getBodySelector()); for (i = 0, len = tables.length; i < len; i++) { tr = tables[i]; if (fragment) { for (j = 0; j < colsToMove; j++) { fragment.appendChild(tr.childNodes[fromIdx]); } tr.insertBefore(fragment, tr.childNodes[destinationCellIdx] || null); } else { tr.insertBefore(tr.childNodes[fromIdx], tr.childNodes[destinationCellIdx] || null); } } } }, // scroll the view to the top scrollToTop: Ext.emptyFn, /** * Add a listener to the main view element. It will be destroyed with the view. * @private */ addElListener: function(eventName, fn, scope){ this.mon(this, eventName, fn, scope, { element: 'el' }); }, /** * Get the leaf columns used for rendering the grid rows. * @private */ getGridColumns: function() { return this.ownerCt.columnManager.getColumns(); }, /** * Get a leaf level header by index regardless of what the nesting * structure is. * @private * @param {Number} index The index */ getHeaderAtIndex: function(index) { return this.ownerCt.columnManager.getHeaderAtIndex(index); }, /** * Get the cell (td) for a particular record and column. * @param {Ext.data.Model} record * @param {Ext.grid.column.Column} column * @private */ getCell: function(record, column) { var row = this.getNode(record, true); return Ext.fly(row).down(column.getCellSelector()); }, /** * Get a reference to a feature * @param {String} id The id of the feature * @return {Ext.grid.feature.Feature} The feature. Undefined if not found */ getFeature: function(id) { var features = this.featuresMC; if (features) { return features.get(id); } }, // @private // Finds a features by ftype in the features array findFeature: function(ftype) { if (this.features) { return Ext.Array.findBy(this.features, function(feature) { if (feature.ftype === ftype) { return true; } }); } }, /** * Initializes each feature and bind it to this view. * @private */ initFeatures: function(grid) { var me = this, i, features, feature, len; me.tableTpl = Ext.XTemplate.getTpl(this, 'tableTpl'); me.rowTpl = Ext.XTemplate.getTpl(this, 'rowTpl'); me.cellTpl = Ext.XTemplate.getTpl(this, 'cellTpl'); me.featuresMC = new Ext.util.MixedCollection(); features = me.features = me.constructFeatures(); len = features ? features.length : 0; for (i = 0; i < len; i++) { feature = features[i]; // inject a reference to view and grid - Features need both feature.view = me; feature.grid = grid; me.featuresMC.add(feature); feature.init(grid); } }, renderTHead: function(values, out) { var headers = values.view.headerFns, len, i; if (headers) { for (i = 0, len = headers.length; i < len; ++i) { headers[i].call(this, values, out); } } }, // Currently, we don't have ordering support for header/footer functions, // they will be pushed on at construction time. If the need does arise, // we can add this functionality in the future, but for now it's not // really necessary since currently only the summary feature uses this. addHeaderFn: function(){ var headers = this.headerFns; if (!headers) { headers = this.headerFns = []; } headers.push(fn); }, renderTFoot: function(values, out){ var footers = values.view.footerFns, len, i; if (footers) { for (i = 0, len = footers.length; i < len; ++i) { footers[i].call(this, values, out); } } }, addFooterFn: function(fn){ var footers = this.footerFns; if (!footers) { footers = this.footerFns = []; } footers.push(fn); }, addTableTpl: function(newTpl) { return this.addTpl('tableTpl', newTpl); }, addRowTpl: function(newTpl) { return this.addTpl('rowTpl', newTpl); }, addCellTpl: function(newTpl) { return this.addTpl('cellTpl', newTpl); }, addTpl: function(which, newTpl) { var me = this, tpl, prevTpl; newTpl = Ext.Object.chain(newTpl); // If we have been passed an object of the form // { // before: fn // after: fn // } if (!newTpl.isTemplate) { newTpl.applyOut = me.tplApplyOut; } // Stop at the first TPL who's priority is less than the passed rowTpl for (tpl = me[which]; newTpl.priority < tpl.priority; tpl = tpl.nextTpl) { prevTpl = tpl; } // If we had skipped over some, link the previous one to the passed rowTpl if (prevTpl) { prevTpl.nextTpl = newTpl; } // First one else { me[which] = newTpl; } newTpl.nextTpl = tpl; return newTpl; }, tplApplyOut: function(values, out) { if (this.before) { if (this.before(values, out) === false) { return; } } this.nextTpl.applyOut(values, out); if (this.after) { this.after(values, out); } }, /** * @private * Converts the features array as configured, into an array of instantiated Feature objects. * * Must have no side effects other than Feature instantiation. * * MUST NOT update the this.features property, and MUST NOT update the instantiated Features. */ constructFeatures: function() { var me = this, features = me.features, feature, result, i = 0, len; if (features) { result = []; len = features.length; for (; i < len; i++) { feature = features[i]; if (!feature.isFeature) { feature = Ext.create('feature.' + feature.ftype, feature); } result[i] = feature; } } return result; }, beforeRender: function() { var me = this; me.callParent(); if (!me.enableTextSelection) { me.protoEl.unselectable(); } }, // Private template method implemented starting at the AbstractView class. onViewScroll: function(e, t) { this.callParent(arguments); this.fireEvent('bodyscroll', e, t); }, // private // Create the DOM element which enapsulates the passed record. // Used when updating existing rows, so drills down into resulting structure . createRowElement: function(record, index) { var me = this, div = me.renderBuffer; me.tpl.overwrite(div, me.collectData([record], index)); // Return first element within node containing element return Ext.fly(div).down(me.getNodeContainerSelector(), true).firstChild; }, // private // Override so that we can use a quicker way to access the row nodes. // They are simply all child nodes of the TBODY element. bufferRender: function(records, index) { var me = this, div = me.renderBuffer; me.tpl.overwrite(div, me.collectData(records, index)); return Ext.Array.toArray(Ext.fly(div).down(me.getNodeContainerSelector(), true).childNodes); }, collectData: function(records, startIndex) { this.rowValues.view = this; return { view: this, rows: records, viewStartIndex: startIndex, tableStyle: this.bufferedRenderer ? ('position:absolute;top:' + this.bufferedRenderer.bodyTop) : '' }; }, // Overridden implementation. // Called by refresh to collect the view item nodes. // Note that these may be wrapping rows which *contain* rows which map to records collectNodes: function(targetEl) { this.all.fill(this.getNodeContainer().childNodes, this.all.startIndex); }, // Private. Called when the table changes height. // For example, see examples/grid/group-summary-grid.html // If we have flexed column headers, we need to update the header layout // because it may have to accommodate (or cease to accommodate) a vertical scrollbar. // Only do this on platforms which have a space-consuming scrollbar. // Only do it when vertical scrolling is enabled. refreshSize: function() { var me = this, grid, bodySelector = me.getBodySelector(); // On every update of the layout system due to data update, capture the view's main element in our private flyweight. // IF there *is* a main element. Some TplFactories emit naked rows. if (bodySelector) { me.body.attach(me.el.child(bodySelector, true)); } if (!me.hasLoadingHeight) { grid = me.up('tablepanel'); // Suspend layouts in case the superclass requests a layout. We might too, so they // must be coalescsed. Ext.suspendLayouts(); me.callParent(); // Since columns and tables are not sized by generated CSS rules any more, EVERY table refresh // has to be followed by a layout to ensure correct table and column sizing. grid.updateLayout(); Ext.resumeLayouts(true); } }, statics: { getBoundView: function(node) { return Ext.getCmp(node.getAttribute('data-boundView')); } }, getRecord: function(node) { node = this.getNode(node); if (node) { var recordIndex = node.getAttribute('data-recordIndex'); if (recordIndex) { recordIndex = parseInt(recordIndex, 10); if (recordIndex > -1) { // The index is the index in the original Store, not in a GroupStore // The Grouping Feature increments the index to skip over unrendered records in collapsed groups return this.store.data.getAt(recordIndex); } } return this.dataSource.data.get(node.getAttribute('data-recordId')); } }, indexOf: function(node) { node = this.getNode(node, false); if (!node && node !== 0) { return -1; } return this.all.indexOf(node); }, indexInStore: function(node) { node = this.getNode(node, true); if (!node && node !== 0) { return -1; } var recordIndex = node.getAttribute('data-recordIndex'); if (recordIndex) { return parseInt(recordIndex, 10); } return this.dataSource.indexOf(this.getRecord(node)); }, renderRows: function(rows, viewStartIndex, out) { var rowValues = this.rowValues, rowCount = rows.length, i; rowValues.view = this; rowValues.columns = this.ownerCt.columnManager.getColumns(); for (i = 0; i < rowCount; i++, viewStartIndex++) { rowValues.itemClasses.length = rowValues.rowClasses.length = 0; this.renderRow(rows[i], viewStartIndex, out); } // Dereference objects since rowValues is a persistent on our prototype rowValues.view = rowValues.columns = rowValues.record = null; }, /* Alternative column sizer element renderer. renderTHeadColumnSizer: function(out) { var columns = this.getGridColumns(), len = columns.length, i, column, width; out.push(''); for (i = 0; i < len; i++) { column = columns[i]; width = column.hidden ? 0 : (column.lastBox ? column.lastBox.width : Ext.grid.header.Container.prototype.defaultWidth); out.push(''); } out.push(''); }, */ renderColumnSizer: function(out) { var columns = this.getGridColumns(), len = columns.length, i, column, width; for (i = 0; i < len; i++) { column = columns[i]; width = column.hidden ? 0 : (column.lastBox ? column.lastBox.width : Ext.grid.header.Container.prototype.defaultWidth); out.push(''); } }, /** * @private * Renders the HTML markup string for a single row into the passed array as a sequence of strings, or * returns the HTML markup for a single row. * * @param {Ext.data.Model} record The record to render. * @param {String[]} [out] A string array onto which to append the resulting HTML string. If omitted, * the resulting HTML string is returned. * @return {String} **only when the out parameter is omitted** The resulting HTML string. */ renderRow: function(record, rowIdx, out) { var me = this, isMetadataRecord = rowIdx === -1, selModel = me.selModel, rowValues = me.rowValues, itemClasses = rowValues.itemClasses, rowClasses = rowValues.rowClasses, cls, rowTpl = me.rowTpl; // Set up mandatory properties on rowValues rowValues.record = record; rowValues.recordId = record.internalId; rowValues.recordIndex = rowIdx; rowValues.rowId = me.getRowId(record); rowValues.itemCls = rowValues.rowCls = ''; if (!rowValues.columns) { rowValues.columns = me.ownerCt.columnManager.getColumns(); } itemClasses.length = rowClasses.length = 0; // If it's a metadata record such as a summary record. // So do not decorate it with the regular CSS. // The Feature which renders it must know how to decorate it. if (!isMetadataRecord) { itemClasses[0] = Ext.baseCSSPrefix + "grid-row"; if (selModel && selModel.isRowSelected) { if (selModel.isRowSelected(rowIdx + 1)) { itemClasses.push(me.beforeSelectedItemCls); } if (selModel.isRowSelected(record)) { itemClasses.push(me.selectedItemCls); } } if (me.stripeRows && rowIdx % 2 !== 0) { rowClasses.push(me.altRowCls); } if (me.getRowClass) { cls = me.getRowClass(record, rowIdx, null, me.dataSource); if (cls) { rowClasses.push(cls); } } } if (out) { rowTpl.applyOut(rowValues, out); } else { return rowTpl.apply(rowValues); } }, /** * @private * Emits the HTML representing a single grid cell into the passed output stream (which is an array of strings). * * @param {Ext.grid.column.Column} column The column definition for which to render a cell. * @param {Number} recordIndex The row index (zero based within the {@link #store}) for which to render the cell. * @param {Number} columnIndex The column index (zero based) for which to render the cell. * @param {String[]} out The output stream into which the HTML strings are appended. */ renderCell: function(column, record, recordIndex, columnIndex, out) { var me = this, selModel = me.selModel, cellValues = me.cellValues, classes = cellValues.classes, fieldValue = record.data[column.dataIndex], cellTpl = me.cellTpl, value, clsInsertPoint; cellValues.record = record; cellValues.column = column; cellValues.recordIndex = recordIndex; cellValues.columnIndex = columnIndex; cellValues.cellIndex = columnIndex; cellValues.align = column.align; cellValues.tdCls = column.tdCls; cellValues.innerCls = column.innerCls; cellValues.style = cellValues.tdAttr = ""; cellValues.unselectableAttr = me.enableTextSelection ? '' : 'unselectable="on"'; if (column.renderer && column.renderer.call) { value = column.renderer.call(column.scope || me.ownerCt, fieldValue, cellValues, record, recordIndex, columnIndex, me.dataSource, me); if (cellValues.css) { // This warning attribute is used by the compat layer // TODO: remove when compat layer becomes deprecated record.cssWarning = true; cellValues.tdCls += ' ' + cellValues.css; delete cellValues.css; } } else { value = fieldValue; } cellValues.value = (value == null || value === '') ? ' ' : value; // Calculate classes to add to cell classes[1] = Ext.baseCSSPrefix + 'grid-cell-' + column.getItemId(); // On IE8, array[len] = 'foo' is twice as fast as array.push('foo') // So keep an insertion point and use assignment to help IE! clsInsertPoint = 2; if (column.tdCls) { classes[clsInsertPoint++] = column.tdCls; } if (me.markDirty && record.isModified(column.dataIndex)) { classes[clsInsertPoint++] = me.dirtyCls; } if (column.isFirstVisible) { classes[clsInsertPoint++] = me.firstCls; } if (column.isLastVisible) { classes[clsInsertPoint++] = me.lastCls; } if (!me.enableTextSelection) { classes[clsInsertPoint++] = Ext.baseCSSPrefix + 'unselectable'; } classes[clsInsertPoint++] = cellValues.tdCls; if (selModel && selModel.isCellSelected && selModel.isCellSelected(me, recordIndex, columnIndex)) { classes[clsInsertPoint++] = (me.selectedCellCls); } // Chop back array to only what we've set classes.length = clsInsertPoint; cellValues.tdCls = classes.join(' '); cellTpl.applyOut(cellValues, out); // Dereference objects since cellValues is a persistent var in the XTemplate's scope chain cellValues.column = null; }, /** * Returns the node given the passed Record, or index or node. * @param {HTMLElement/String/Number/Ext.data.Model} nodeInfo The node or record * @param {Boolean} [dataRow] `true` to return the data row (not the top level row if wrapped), `false` * to return the top level row. * @return {HTMLElement} The node or null if it wasn't found */ getNode: function(nodeInfo, dataRow) { var fly, result = this.callParent(arguments); if (result && result.tagName) { if (dataRow) { if (!(fly = Ext.fly(result)).is(this.dataRowSelector)) { return fly.down(this.dataRowSelector, true); } } else if (dataRow === false) { if (!(fly = Ext.fly(result)).is(this.itemSelector)) { return fly.up(this.itemSelector, null, true); } } } return result; }, getRowId: function(record){ return this.id + '-record-' + record.internalId; }, constructRowId: function(internalId){ return this.id + '-record-' + internalId; }, getNodeById: function(id, dataRow){ id = this.constructRowId(id); return this.retrieveNode(id, dataRow); }, getNodeByRecord: function(record, dataRow) { var id = this.getRowId(record); return this.retrieveNode(id, dataRow); }, retrieveNode: function(id, dataRow){ var result = this.el.getById(id, true), itemSelector = this.itemSelector, fly; if (dataRow === false && result) { if (!(fly = Ext.fly(result)).is(itemSelector)) { return fly.up(itemSelector, null, true); } } return result; }, // Links back from grid rows are installed by the XTemplate as data attributes updateIndexes: Ext.emptyFn, // Outer table bodySelector: 'table', // Element which contains rows nodeContainerSelector: 'tbody', // view item (may be a wrapper) itemSelector: 'tr.' + Ext.baseCSSPrefix + 'grid-row', // row which contains cells as opposed to wrapping rows dataRowSelector: 'tr.' + Ext.baseCSSPrefix + 'grid-data-row', // cell cellSelector: 'td.' + Ext.baseCSSPrefix + 'grid-cell', // `` sizerSelector: 'col.' + Ext.baseCSSPrefix + 'grid-cell', innerSelector: 'div.' + Ext.baseCSSPrefix + 'grid-cell-inner', getNodeContainer: function() { return this.el.down(this.nodeContainerSelector, true); }, /** * Returns a CSS selector which selects the outermost element(s) in this view. */ getBodySelector: function() { return this.bodySelector + '.' + Ext.baseCSSPrefix + this.id + '-table'; }, /** * Returns a CSS selector which selects the element which contains record nodes. */ getNodeContainerSelector: function() { return this.nodeContainerSelector; }, /** * Returns a CSS selector which selects the element(s) which define the width of a column. * * This is used by the {@link Ext.view.TableLayout} when resizing columns. * */ getColumnSizerSelector: function(header) { return this.sizerSelector + '-' + header.getItemId(); }, /** * Returns a CSS selector which selects items of the view rendered by the rowTpl */ getItemSelector: function() { return this.itemSelector; }, /** * Returns a CSS selector which selects a row which contains cells. * * These *may not* correspond to actual records in the store. This selector may be used * to identify things like total rows or header rows as injected by features which modify * the rowTpl. * */ getDataRowSelector: function() { return this.dataRowSelector; }, /** * Returns a CSS selector which selects a particular column if the desired header is passed, * or a general cell selector is no parameter is passed. * * @param {Ext.grid.column.Column} [header] The column for which to return the selector. If * omitted, the general cell selector which matches **ant cell** will be returned. * */ getCellSelector: function(header) { var result = this.cellSelector; if (header) { result += '-' + header.getItemId(); } return result; }, /* * Returns a CSS selector which selects the content carrying element within cells. */ getCellInnerSelector: function(header) { return this.getCellSelector(header) + ' ' + this.innerSelector; }, /** * Adds a CSS Class to a specific row. * @param {HTMLElement/String/Number/Ext.data.Model} rowInfo An HTMLElement, index or instance of a model * representing this row * @param {String} cls */ addRowCls: function(rowInfo, cls) { var row = this.getNode(rowInfo, false); if (row) { Ext.fly(row).addCls(cls); } }, /** * Removes a CSS Class from a specific row. * @param {HTMLElement/String/Number/Ext.data.Model} rowInfo An HTMLElement, index or instance of a model * representing this row * @param {String} cls */ removeRowCls: function(rowInfo, cls) { var row = this.getNode(rowInfo, false); if (row) { Ext.fly(row).removeCls(cls); } }, setHighlightedItem: function(item) { var me = this, highlighted = me.highlightedItem; if (highlighted && me.el.isAncestor(highlighted) && me.isRowStyleFirst(highlighted)) { me.getRowStyleTableEl(highlighted).removeCls(me.tableOverFirstCls); } if (item && me.isRowStyleFirst(item)) { me.getRowStyleTableEl(item).addCls(me.tableOverFirstCls); } me.callParent(arguments); }, // GridSelectionModel invokes onRowSelect as selection changes onRowSelect : function(rowIdx) { var me = this; me.addRowCls(rowIdx, me.selectedItemCls); if (me.isRowStyleFirst(rowIdx)) { me.getRowStyleTableEl(rowIdx).addCls(me.tableSelectedFirstCls); } else { me.addRowCls(rowIdx - 1, me.beforeSelectedItemCls); } }, // GridSelectionModel invokes onRowDeselect as selection changes onRowDeselect : function(rowIdx) { var me = this; me.removeRowCls(rowIdx, [me.selectedItemCls, me.focusedItemCls]); if (me.isRowStyleFirst(rowIdx)) { me.getRowStyleTableEl(rowIdx).removeCls([me.tableFocusedFirstCls, me.tableSelectedFirstCls]); } else { me.removeRowCls(rowIdx - 1, [me.beforeFocusedItemCls, me.beforeSelectedItemCls]); } }, onCellSelect: function(position) { var cell = this.getCellByPosition(position); if (cell) { cell.addCls(this.selectedCellCls); this.scrollCellIntoView(cell); } }, onCellDeselect: function(position) { var cell = this.getCellByPosition(position, true); if (cell) { Ext.fly(cell).removeCls(this.selectedCellCls); } }, getCellByPosition: function(position, returnDom) { if (position) { var row = this.getNode(position.row, true), header = this.ownerCt.columnManager.getHeaderAtIndex(position.column); if (header && row) { return Ext.fly(row).down(this.getCellSelector(header), returnDom); } } return false; }, getFocusEl: function() { var me = this, result; if (me.refreshCounter) { result = me.focusedRow; // No focused row or the row focused is no longer in the DOM if (!(result && me.el.contains(result))) { // Focus first visible row if (me.all.getCount() && (result = me.getNode(me.all.item(0).dom, true))) { me.focusRow(result); } else { result = me.body; } } } else { return me.el; } return Ext.get(result); }, // GridSelectionModel invokes onRowFocus to 'highlight' // the last row focused onRowFocus: function(rowIdx, highlight, supressFocus) { var me = this; if (highlight) { me.addRowCls(rowIdx, me.focusedItemCls); if (me.isRowStyleFirst(rowIdx)) { me.getRowStyleTableEl(rowIdx).addCls(me.tableFocusedFirstCls); } else { me.addRowCls(rowIdx - 1, me.beforeFocusedItemCls); } if (!supressFocus) { me.focusRow(rowIdx); } //this.el.dom.setAttribute('aria-activedescendant', row.id); } else { me.removeRowCls(rowIdx, me.focusedItemCls); if (me.isRowStyleFirst(rowIdx)) { me.getRowStyleTableEl(rowIdx).removeCls(me.tableFocusedFirstCls); } else { me.removeRowCls(rowIdx - 1, me.beforeFocusedItemCls); } } if ((Ext.isIE6 || Ext.isIE7) && !me.ownerCt.rowLines) { me.repaintRow(rowIdx) } }, focus: function(selectText, delay) { var me = this, saveScroll = Ext.isIE && !delay, scrollPos; // IE does horizontal scrolling when row is focused if (saveScroll) { scrollPos = me.el.dom.scrollLeft; } this.callParent(arguments); if (saveScroll) { me.el.dom.scrollLeft = scrollPos; } }, /** * Focuses a particular row and brings it into view. Will fire the rowfocus event. * @param {HTMLElement/String/Number/Ext.data.Model} row An HTMLElement template node, index of a template node, the id of a template node or the * @param {Boolean/Number} [delay] Delay the focus this number of milliseconds (true for 10 milliseconds). * record associated with the node. */ focusRow: function(row, delay) { var me = this, rowIdx, gridCollapsed = me.ownerCt && me.ownerCt.collapsed, record; // Do not attempt to focus if hidden or owning grid is collapsed if (me.isVisible(true) && !gridCollapsed && (row = me.getNode(row, true))) { me.scrollRowIntoView(row); record = me.getRecord(row); rowIdx = me.indexInStore(row); me.selModel.setLastFocused(record); me.focusedRow = row; me.focus(false, delay, function() { me.fireEvent('rowfocus', record, row, rowIdx); }); } }, scrollRowIntoView: function(row) { row = this.getNode(row, true); if (row) { Ext.fly(row).scrollIntoView(this.el, false); } }, focusCell: function(position) { var me = this, cell = me.getCellByPosition(position), record = me.getRecord(position.row); me.focusRow(record); if (cell) { me.scrollCellIntoView(cell); me.fireEvent('cellfocus', record, cell, position); } }, scrollCellIntoView: function(cell) { // Allow cell context object to be passed. // TODO: change to .isCellContext check when implement cell context class if (cell.row != null && cell.column != null) { cell = this.getCellByPosition(cell); } if (cell) { Ext.fly(cell).scrollIntoView(this.el, true); } }, /** * Scrolls by delta. This affects this individual view ONLY and does not * synchronize across views or scrollers. * @param {Number} delta * @param {String} [dir] Valid values are scrollTop and scrollLeft. Defaults to scrollTop. * @private */ scrollByDelta: function(delta, dir) { dir = dir || 'scrollTop'; var elDom = this.el.dom; elDom[dir] = (elDom[dir] += delta); }, /** * @private * Used to test if a row being updated is a basic data row as opposed to containing extra markup * provided by a Feature, eg a wrapping row containing extra elements such as group header, group summary, * row body etc. * * If A row being updated *is not* a data row, then the elements within it which are not valid data rows * must be copied. * @param row * @return {Boolean} `true` if the passed element is a basic data row. */ isDataRow: function(row) { return Ext.fly(row).hasCls(Ext.baseCSSPrefix + 'grid-data-row'); }, syncRowHeights: function(firstRow, secondRow) { firstRow = Ext.get(firstRow); secondRow = Ext.get(secondRow); firstRow.dom.style.height = secondRow.dom.style.height = ''; var me = this, rowTpl = me.rowTpl, firstRowHeight = firstRow.dom.offsetHeight, secondRowHeight = secondRow.dom.offsetHeight; // If the two rows *need* syncing... if (firstRowHeight !== secondRowHeight) { // loop thru all of rowTpls asking them to sync the two row heights if they know how to. while (rowTpl) { if (rowTpl.syncRowHeights) { // If any rowTpl in the chain returns false, quit processing if (rowTpl.syncRowHeights(firstRow, secondRow) === false) { break; } } rowTpl = rowTpl.nextTpl; } // If that did not fix it, see if we have nested data rows, and equalize the data row heights firstRowHeight = firstRow.dom.offsetHeight; secondRowHeight = secondRow.dom.offsetHeight; if (firstRowHeight !== secondRowHeight) { // See if the real data row has been nested deeper by a Feature. firstRow = firstRow.down('[data-recordId]') || firstRow; secondRow = secondRow.down('[data-recordId]') || secondRow; // Yes, there's a nested data row on each side. Sync the heights of the two. if (firstRow && secondRow) { firstRow.dom.style.height = secondRow.dom.style.height = ''; firstRowHeight = firstRow.dom.offsetHeight; secondRowHeight = secondRow.dom.offsetHeight; if (firstRowHeight > secondRowHeight) { firstRow.setHeight(firstRowHeight); secondRow.setHeight(firstRowHeight); } else if (secondRowHeight > firstRowHeight) { firstRow.setHeight(secondRowHeight); secondRow.setHeight(secondRowHeight); } } } } }, onIdChanged: function(store, rec, oldId, newId, oldInternalId){ var me = this, rowDom; if (me.viewReady) { rowDom = me.getNodeById(oldInternalId); if (rowDom) { rowDom.setAttribute('data-recordId', rec.internalId); rowDom.id = me.getRowId(rec); } } }, // private onUpdate : function(store, record, operation, changedFieldNames) { var me = this, rowTpl = me.rowTpl, index, oldRow, oldRowDom, newRowDom, newAttrs, attLen, attName, attrIndex, overItemCls, beforeOverItemCls, focusedItemCls, beforeFocusedItemCls, selectedItemCls, beforeSelectedItemCls, columns; if (me.viewReady) { // Table row being updated oldRowDom = me.getNodeByRecord(record, false); // Row might not be rendered due to buffered rendering or being part of a collapsed group... if (oldRowDom) { overItemCls = me.overItemCls; beforeOverItemCls = me.overItemCls; focusedItemCls = me.focusedItemCls; beforeFocusedItemCls = me.beforeFocusedItemCls; selectedItemCls = me.selectedItemCls; beforeSelectedItemCls = me.beforeSelectedItemCls; index = me.indexInStore(record); oldRow = Ext.fly(oldRowDom, '_internal'); newRowDom = me.createRowElement(record, index); if (oldRow.hasCls(overItemCls)) { Ext.fly(newRowDom).addCls(overItemCls); } if (oldRow.hasCls(beforeOverItemCls)) { Ext.fly(newRowDom).addCls(beforeOverItemCls); } if (oldRow.hasCls(focusedItemCls)) { Ext.fly(newRowDom).addCls(focusedItemCls); } if (oldRow.hasCls(beforeFocusedItemCls)) { Ext.fly(newRowDom).addCls(beforeFocusedItemCls); } if (oldRow.hasCls(selectedItemCls)) { Ext.fly(newRowDom).addCls(selectedItemCls); } if (oldRow.hasCls(beforeSelectedItemCls)) { Ext.fly(newRowDom).addCls(beforeSelectedItemCls); } columns = me.ownerCt.columnManager.getColumns(); // Copy new row attributes across. Use IE-specific method if possible. // In IE10, there is a problem where the className will not get updated // in the view, even though the className on the dom element is correct. // See EXTJSIV-9462 if (Ext.isIE9m && oldRowDom.mergeAttributes) { oldRowDom.mergeAttributes(newRowDom, true); } else { newAttrs = newRowDom.attributes; attLen = newAttrs.length; for (attrIndex = 0; attrIndex < attLen; attrIndex++) { attName = newAttrs[attrIndex].name; if (attName !== 'id') { oldRowDom.setAttribute(attName, newAttrs[attrIndex].value); } } } // If we have columns which may *need* updating (think locked side of lockable grid with all columns unlocked) // and the changed record is within our view, then update the view if (columns.length) { me.updateColumns(record, me.getNode(oldRowDom, true), me.getNode(newRowDom, true), columns, changedFieldNames); } // loop thru all of rowTpls asking them to sync the content they are responsible for if any. while (rowTpl) { if (rowTpl.syncContent) { if (rowTpl.syncContent(oldRowDom, newRowDom) === false) { break; } } rowTpl = rowTpl.nextTpl; } // Since we don't actually replace the row, we need to fire the event with the old row // because it's the thing that is still in the DOM me.fireEvent('itemupdate', record, index, oldRowDom); me.refreshSize(); } } }, updateColumns: function(record, oldRowDom, newRowDom, columns, changedFieldNames) { var me = this, newAttrs, attLen, attName, attrIndex, colCount = columns.length, colIndex, column, oldCell, newCell, row, // See if our View has an editingPlugin, or if we are a locking twin, see if the top LockingView // has an editingPlugin. // We do not support one editing plugin on the top lockable and some other on the twinned views. editingPlugin = me.editingPlugin || (me.lockingPartner && me.ownerCt.ownerLockable.view.editingPlugin), // See if the found editing plugin is active. isEditing = editingPlugin && editingPlugin.editing, cellSelector = me.getCellSelector(); // Copy new row attributes across. Use IE-specific method if possible. // Must do again at this level because the row DOM passed here may be the nested row in a row wrap. if (oldRowDom.mergeAttributes) { oldRowDom.mergeAttributes(newRowDom, true); } else { newAttrs = newRowDom.attributes; attLen = newAttrs.length; for (attrIndex = 0; attrIndex < attLen; attrIndex++) { attName = newAttrs[attrIndex].name; if (attName !== 'id') { oldRowDom.setAttribute(attName, newAttrs[attrIndex].value); } } } // Replace changed cells in the existing row structure with the new version from the rendered row. for (colIndex = 0; colIndex < colCount; colIndex++) { column = columns[colIndex]; // If the field at this column index was changed, or column has a custom renderer // (which means value could rely on any other changed field) the update the cell's content. if (me.shouldUpdateCell(record, column, changedFieldNames)) { // Pluck out cells using the column's unique cell selector. // Becuse in a wrapped row, there may be several TD elements. cellSelector = me.getCellSelector(column); oldCell = Ext.DomQuery.selectNode(cellSelector, oldRowDom); newCell = Ext.DomQuery.selectNode(cellSelector, newRowDom); // If an editor plugin is active, we carefully replace just the *contents* of the cell. if (isEditing) { Ext.fly(oldCell).syncContent(newCell); } // Otherwise, we simply replace whole TDs with a new version else { // Use immediate parentNode when replacing in case the main row was a wrapping row row = oldCell.parentNode; row.insertBefore(newCell, oldCell); row.removeChild(oldCell); } } } }, shouldUpdateCell: function(record, column, changedFieldNames){ // Though this may not be the most efficient, a renderer could be dependent on any field in the // store, so we must always update the cell. // If no changeFieldNames array was passed, we have to assume that that information // is unknown and update all cells. if (column.hasCustomRenderer || !changedFieldNames) { return true; } if (changedFieldNames) { var len = changedFieldNames.length, i, field; for (i = 0; i < len; ++i) { field = changedFieldNames[i]; if (field === column.dataIndex || field === record.idProperty) { return true; } } } return false; }, /** * Refreshes the grid view. Sets the sort state and focuses the previously focused row. */ refresh: function() { var me = this, hasFocus = me.el && me.el.isAncestor(Ext.Element.getActiveElement()); me.callParent(arguments); me.headerCt.setSortState(); // Create horizontal stretcher element if no records in view and there is overflow of the header container. // Element will be transient and destroyed by the next refresh. if (me.el && !me.all.getCount() && me.headerCt && me.headerCt.tooNarrow) { me.el.createChild({style:'position:absolute;height:1px;width:1px;left:' + (me.headerCt.getFullWidth() - 1) + 'px'}); } if (hasFocus) { me.selModel.onLastFocusChanged(null, me.selModel.lastFocused); } }, processItemEvent: function(record, row, rowIndex, e) { // Only process the event if it occurred within a row which maps to a record in the store if (this.indexInStore(row) !== -1) { var me = this, cell = e.getTarget(me.getCellSelector(), row), cellIndex, map = me.statics().EventMap, selModel = me.getSelectionModel(), type = e.type, features = me.features, len = features.length, i, result, feature, header; if (type == 'keydown' && !cell && selModel.getCurrentPosition) { // CellModel, otherwise we can't tell which cell to invoke cell = me.getCellByPosition(selModel.getCurrentPosition(), true); } // cellIndex is an attribute only of TD elements. Other TplFactories must use the data-cellIndex attribute. if (cell) { if (!cell.parentNode) { // If we have no parentNode, the td has been removed from the DOM, probably via an update, // so just jump out since the target for the event isn't valid return false; } // We can't use the cellIndex because we don't render hidden columns header = me.getHeaderByCell(cell); cellIndex = Ext.Array.indexOf(me.getGridColumns(), header); } else { cellIndex = -1; } result = me.fireEvent('uievent', type, me, cell, rowIndex, cellIndex, e, record, row); if (result === false || me.callParent(arguments) === false) { me.selModel.onVetoUIEvent(type, me, cell, rowIndex, cellIndex, e, record, row); return false; } for (i = 0; i < len; ++i) { feature = features[i]; // In some features, the first/last row might be wrapped to contain extra info, // such as grouping or summary, so we may need to stop the event if (feature.wrapsItem) { if (feature.vetoEvent(record, row, rowIndex, e) === false) { // If the feature is vetoing the event, there's a good chance that // it's for some feature action in the wrapped row. me.processSpecialEvent(e); return false; } } } // Don't handle cellmouseenter and cellmouseleave events for now if (type == 'mouseover' || type == 'mouseout') { return true; } if(!cell) { // if the element whose event is being processed is not an actual cell (for example if using a rowbody // feature and the rowbody element's event is being processed) then do not fire any "cell" events return true; } return !( // We are adding cell and feature events (me['onBeforeCell' + map[type]](cell, cellIndex, record, row, rowIndex, e) === false) || (me.fireEvent('beforecell' + type, me, cell, cellIndex, record, row, rowIndex, e) === false) || (me['onCell' + map[type]](cell, cellIndex, record, row, rowIndex, e) === false) || (me.fireEvent('cell' + type, me, cell, cellIndex, record, row, rowIndex, e) === false) ); } else { // If it's not in the store, it could be a feature event, so check here this.processSpecialEvent(e); return false; } }, processSpecialEvent: function(e) { var me = this, features = me.features, ln = features.length, type = e.type, i, feature, prefix, featureTarget, beforeArgs, args, panel = me.ownerCt; me.callParent(arguments); if (type == 'mouseover' || type == 'mouseout') { return; } for (i = 0; i < ln; i++) { feature = features[i]; if (feature.hasFeatureEvent) { featureTarget = e.getTarget(feature.eventSelector, me.getTargetEl()); if (featureTarget) { prefix = feature.eventPrefix; // allows features to implement getFireEventArgs to change the // fireEvent signature beforeArgs = feature.getFireEventArgs('before' + prefix + type, me, featureTarget, e); args = feature.getFireEventArgs(prefix + type, me, featureTarget, e); if ( // before view event (me.fireEvent.apply(me, beforeArgs) === false) || // panel grid event (panel.fireEvent.apply(panel, beforeArgs) === false) || // view event (me.fireEvent.apply(me, args) === false) || // panel event (panel.fireEvent.apply(panel, args) === false) ) { return false; } } } } return true; }, onCellMouseDown: Ext.emptyFn, onCellMouseUp: Ext.emptyFn, onCellClick: Ext.emptyFn, onCellDblClick: Ext.emptyFn, onCellContextMenu: Ext.emptyFn, onCellKeyDown: Ext.emptyFn, onBeforeCellMouseDown: Ext.emptyFn, onBeforeCellMouseUp: Ext.emptyFn, onBeforeCellClick: Ext.emptyFn, onBeforeCellDblClick: Ext.emptyFn, onBeforeCellContextMenu: Ext.emptyFn, onBeforeCellKeyDown: Ext.emptyFn, /** * Expands a particular header to fit the max content width. * @deprecated Use {@link #autoSizeColumn} instead. */ expandToFit: function(header) { this.autoSizeColumn(header); }, /** * Sizes the passed header to fit the max content width. * *Note that group columns shrinkwrap around the size of leaf columns. Auto sizing a group column * autosizes descendant leaf columns.* * @param {Ext.grid.column.Column/Number} header The header (or index of header) to auto size. */ autoSizeColumn: function(header) { if (Ext.isNumber(header)) { header = this.getGridColumns[header]; } if (header) { if (header.isGroupHeader) { header.autoSize(); return; } delete header.flex; header.setWidth(this.getMaxContentWidth(header)); } }, /** * Returns the max contentWidth of the header's text and all cells * in the grid under this header. * @private */ getMaxContentWidth: function(header) { var me = this, cells = me.el.query(header.getCellInnerSelector()), originalWidth = header.getWidth(), i = 0, ln = cells.length, hasPaddingBug = Ext.supports.ScrollWidthInlinePaddingBug, columnSizer = me.body.select(me.getColumnSizerSelector(header)), max = Math.max, paddingAdjust, maxWidth; if (hasPaddingBug && ln > 0) { paddingAdjust = me.getCellPaddingAfter(cells[0]); } // Set column width to 1px so we can detect the content width by measuring scrollWidth columnSizer.setWidth(1); // Allow for padding round text of header maxWidth = header.textEl.dom.offsetWidth + header.titleEl.getPadding('lr'); for (; i < ln; i++) { maxWidth = max(maxWidth, cells[i].scrollWidth); } if (hasPaddingBug) { // in some browsers, the "after" padding is not accounted for in the scrollWidth maxWidth += paddingAdjust; } // 40 is the minimum column width. TODO: should this be configurable? maxWidth = max(maxWidth, 40); // Set column width back to original width columnSizer.setWidth(originalWidth); return maxWidth; }, getPositionByEvent: function(e) { var me = this, cellNode = e.getTarget(me.cellSelector), rowNode = e.getTarget(me.itemSelector), record = me.getRecord(rowNode), header = me.getHeaderByCell(cellNode); return me.getPosition(record, header); }, getHeaderByCell: function(cell) { if (cell) { var match = cell.className.match(this.cellRe); if (match && match[1]) { return this.ownerCt.columnManager.getHeaderById(match[1]); } } return false; }, /** * @param {Object} position The current row and column: an object containing the following properties: * * - row - The row index * - column - The column index * * @param {String} direction 'up', 'down', 'right' and 'left' * @param {Ext.EventObject} e event * @param {Boolean} preventWrap Set to true to prevent wrap around to the next or previous row. * @param {Function} verifierFn A function to verify the validity of the calculated position. * When using this function, you must return true to allow the newPosition to be returned. * @param {Object} scope Scope to run the verifierFn in * @returns {Ext.grid.CellContext} An object encapsulating the unique cell position. * * @private */ walkCells: function(pos, direction, e, preventWrap, verifierFn, scope) { // Caller (probably CellModel) had no current position. This can happen // if the main el is focused and any navigation key is presssed. if (!pos) { return false; } var me = this, row = pos.row, column = pos.column, rowCount = me.dataSource.getCount(), lastCol = me.ownerCt.columnManager.getColumns().length - 1, newRow = row, newColumn = column, activeHeader = me.ownerCt.columnManager.getHeaderAtIndex(column); // no active header or its currently hidden if (!activeHeader || activeHeader.hidden || !rowCount) { return false; } e = e || {}; direction = direction.toLowerCase(); switch (direction) { case 'right': // has the potential to wrap if its last if (column === lastCol) { // if bottom row and last column, deny right if (preventWrap || row === rowCount - 1) { return false; } if (!e.ctrlKey) { // otherwise wrap to nextRow and firstCol newRow = me.walkRows(row, 1); if (newRow !== row) { newColumn = 0; } } // go right } else { if (!e.ctrlKey) { newColumn = column + 1; } else { newColumn = lastCol; } } break; case 'left': // has the potential to wrap if (column === 0) { // if top row and first column, deny left if (preventWrap || row === 0) { return false; } if (!e.ctrlKey) { // otherwise wrap to prevRow and lastCol newRow = me.walkRows(row, -1); if (newRow !== row) { newColumn = lastCol; } } // go left } else { if (!e.ctrlKey) { newColumn = column - 1; } else { newColumn = 0; } } break; case 'up': // if top row, deny up if (row === 0) { return false; // go up } else { if (!e.ctrlKey) { newRow = me.walkRows(row, -1); } else { // Go to first row by walking down from row -1 newRow = me.walkRows(-1, 1); } } break; case 'down': // if bottom row, deny down if (row === rowCount - 1) { return false; // go down } else { if (!e.ctrlKey) { newRow = me.walkRows(row, 1); } else { // Go to first row by walking up from beyond the last row newRow = me.walkRows(rowCount, -1); } } break; } if (verifierFn && verifierFn.call(scope || me, {row: newRow, column: newColumn}) !== true) { return false; } else { return new Ext.grid.CellContext(me).setPosition(newRow, newColumn); } }, /** * Increments the passed row index by the passed increment which may be +ve or -ve * * Skips hidden rows. * * If no row is visible in the specified direction, returns the input row index unchanged. * @param {Number} startRow The zero-based row index to start from. * @param {Number} distance The distance to move the row by. May be +ve or -ve. */ walkRows: function(startRow, distance) { // Note that we use the **dataSource** here because row indices mean view row indices // so records in collapsed groups must be omitted. var me = this, moved = 0, lastValid = startRow, node, last = (me.dataSource.buffered ? me.dataSource.getTotalCount() : me.dataSource.getCount()) - 1, limit = (distance < 0) ? 0 : last, increment = limit ? 1 : -1, result = startRow; do { // Walked off the end: return the last encountered valid row if (limit ? result >= limit : result <= 0) { return lastValid || limit; } // Move the result pointer on by one position. We have to count intervening VISIBLE nodes result += increment; // Stepped onto VISIBLE record: Increment the moved count. // We must not count stepping onto a non-rendered record as a move. if ((node = Ext.fly(me.getNode(result, true))) && node.isVisible(true)) { moved += increment; lastValid = result; } } while (moved !== distance); return result; }, /** * Navigates from the passed record by the passed increment which may be +ve or -ve * * Skips hidden records. * * If no record is visible in the specified direction, returns the starting record index unchanged. * @param {Ext.data.Model} startRec The Record to start from. * @param {Number} distance The distance to move from the record. May be +ve or -ve. */ walkRecs: function(startRec, distance) { // Note that we use the **store** to access the records by index because the dataSource omits records in collapsed groups. // This is used by selection models which use the **store** var me = this, moved = 0, lastValid = startRec, node, last = (me.store.buffered ? me.store.getTotalCount() : me.store.getCount()) - 1, limit = (distance < 0) ? 0 : last, increment = limit ? 1 : -1, testIndex = me.store.indexOf(startRec), rec; do { // Walked off the end: return the last encountered valid record if (limit ? testIndex >= limit : testIndex <= 0) { return lastValid; } // Move the result pointer on by one position. We have to count intervening VISIBLE nodes testIndex += increment; // Stepped onto VISIBLE record: Increment the moved count. // We must not count stepping onto a non-rendered record as a move. rec = me.store.getAt(testIndex); if ((node = Ext.fly(me.getNodeByRecord(rec, true))) && node.isVisible(true)) { moved += increment; lastValid = rec; } } while (moved !== distance); return lastValid; }, getFirstVisibleRowIndex: function() { var me = this, count = (me.dataSource.buffered ? me.dataSource.getTotalCount() : me.dataSource.getCount()), result = me.indexOf(me.all.first()) - 1; do { result += 1; if (result === count) { return; } } while (!Ext.fly(me.getNode(result, true)).isVisible(true)); return result; }, getLastVisibleRowIndex: function() { var me = this, result = me.indexOf(me.all.last()); do { result -= 1; if (result === -1) { return; } } while (!Ext.fly(me.getNode(result, true)).isVisible(true)); return result; }, getHeaderCt: function() { return this.headerCt; }, getPosition: function(record, header) { return new Ext.grid.CellContext(this).setPosition(record, header); }, beforeDestroy: function() { var me = this; if (me.rendered) { me.el.removeAllListeners(); } me.callParent(arguments); }, onDestroy: function() { var me = this, features = me.featuresMC, len, i; if (features) { for (i = 0, len = features.getCount(); i < len; ++i) { features.getAt(i).destroy(); } } me.featuresMC = null; this.callParent(arguments); }, // after adding a row stripe rows from then on onAdd: function(ds, records, index) { this.callParent(arguments); this.doStripeRows(index); }, // after removing a row stripe rows from then on onRemove: function(ds, records, indexes) { this.callParent(arguments); this.doStripeRows(indexes[0]); }, /** * Stripes rows from a particular row index. * @param {Number} startRow * @param {Number} [endRow] argument specifying the last row to process. * By default process up to the last row. * @private */ doStripeRows: function(startRow, endRow) { var me = this, rows, rowsLn, i, row; // ensure stripeRows configuration is turned on if (me.rendered && me.stripeRows) { rows = me.getNodes(startRow, endRow); for (i = 0, rowsLn = rows.length; i < rowsLn; i++) { row = rows[i]; // Remove prior applied row classes. row.className = row.className.replace(me.rowClsRe, ' '); startRow++; // Every odd row will get an additional cls if (startRow % 2 === 0) { row.className += (' ' + me.altRowCls); } } } }, repaintRow: function(rowIdx) { var node = this.getNode(rowIdx), tds = node.childNodes, i = tds.length; while (i--) { tds[i].className = tds[i].className; } }, // private // returns the table that gains a top border when the first grid row is focused, selected, // or hovered. Usually the main grid table but can be a sub-table, if a grouping // feature is being used. getRowStyleTableEl: function(item /* view item or row index */) { var me = this; if (!item.tagName) { item = this.getNode(item); } return (me.isGrouping ? Ext.fly(item) : this.el).down('table.x-grid-table'); }, // private // returns true if the row should be treated as the first row stylistically. Typically // only returns true for the first row in a grid. Returns true for the first row // in each group of a grouped grid. isRowStyleFirst: function(item /* view item or row index */) { var me = this, index; // An item not in the view if (item === -1) { return false; } if (!item.tagName) { index = item; item = this.getNode(item); } else { index = me.indexOf(item); } return (!index || me.isGrouping && Ext.fly(item).hasCls(Ext.baseCSSPrefix + 'grid-group-row')); }, getCellPaddingAfter: function(cell) { return Ext.fly(cell).getPadding('r'); } }); /** * The grid View class provides extra {@link Ext.grid.Panel} specific functionality to the * {@link Ext.view.Table}. In general, this class is not instanced directly, instead a viewConfig * option is passed to the grid: * * Ext.create('Ext.grid.Panel', { * // other options * viewConfig: { * stripeRows: false * } * }); * * ## Drag Drop * * Drag and drop functionality can be achieved in the grid by attaching a {@link Ext.grid.plugin.DragDrop} plugin * when creating the view. * * Ext.create('Ext.grid.Panel', { * // other options * viewConfig: { * plugins: { * ddGroup: 'people-group', * ptype: 'gridviewdragdrop', * enableDrop: false * } * } * }); */ Ext.define('Ext.grid.View', { extend: Ext.view.Table , alias: 'widget.gridview', /** * @cfg {Boolean} * True to stripe the rows. * * This causes the CSS class **`x-grid-row-alt`** to be added to alternate rows of the grid. A default CSS rule is * provided which sets a background color, but you can override this with a rule which either overrides the * **background-color** style using the `!important` modifier, or which uses a CSS selector of higher specificity. */ stripeRows: true, autoScroll: true }); /** * @author Aaron Conran * @docauthor Ed Spencer * * Grids are an excellent way of showing large amounts of tabular data on the client side. Essentially a supercharged * ``, GridPanel makes it easy to fetch, sort and filter large amounts of data. * * Grids are composed of two main pieces - a {@link Ext.data.Store Store} full of data and a set of columns to render. * * ## Basic GridPanel * * @example * Ext.create('Ext.data.Store', { * storeId:'simpsonsStore', * fields:['name', 'email', 'phone'], * data:{'items':[ * { 'name': 'Lisa', "email":"lisa@simpsons.com", "phone":"555-111-1224" }, * { 'name': 'Bart', "email":"bart@simpsons.com", "phone":"555-222-1234" }, * { 'name': 'Homer', "email":"home@simpsons.com", "phone":"555-222-1244" }, * { 'name': 'Marge', "email":"marge@simpsons.com", "phone":"555-222-1254" } * ]}, * proxy: { * type: 'memory', * reader: { * type: 'json', * root: 'items' * } * } * }); * * Ext.create('Ext.grid.Panel', { * title: 'Simpsons', * store: Ext.data.StoreManager.lookup('simpsonsStore'), * columns: [ * { text: 'Name', dataIndex: 'name' }, * { text: 'Email', dataIndex: 'email', flex: 1 }, * { text: 'Phone', dataIndex: 'phone' } * ], * height: 200, * width: 400, * renderTo: Ext.getBody() * }); * * The code above produces a simple grid with three columns. We specified a Store which will load JSON data inline. * In most apps we would be placing the grid inside another container and wouldn't need to use the * {@link #height}, {@link #width} and {@link #renderTo} configurations but they are included here to make it easy to get * up and running. * * The grid we created above will contain a header bar with a title ('Simpsons'), a row of column headers directly underneath * and finally the grid rows under the headers. * * ## Configuring columns * * By default, each column is sortable and will toggle between ASC and DESC sorting when you click on its header. Each * column header is also reorderable by default, and each gains a drop-down menu with options to hide and show columns. * It's easy to configure each column - here we use the same example as above and just modify the columns config: * * columns: [ * { * text: 'Name', * dataIndex: 'name', * sortable: false, * hideable: false, * flex: 1 * }, * { * text: 'Email', * dataIndex: 'email', * hidden: true * }, * { * text: 'Phone', * dataIndex: 'phone', * width: 100 * } * ] * * We turned off sorting and hiding on the 'Name' column so clicking its header now has no effect. We also made the Email * column hidden by default (it can be shown again by using the menu on any other column). We also set the Phone column to * a fixed with of 100px and flexed the Name column, which means it takes up all remaining width after the other columns * have been accounted for. See the {@link Ext.grid.column.Column column docs} for more details. * * ## Renderers * * As well as customizing columns, it's easy to alter the rendering of individual cells using renderers. A renderer is * tied to a particular column and is passed the value that would be rendered into each cell in that column. For example, * we could define a renderer function for the email column to turn each email address into a mailto link: * * columns: [ * { * text: 'Email', * dataIndex: 'email', * renderer: function(value) { * return Ext.String.format('{1}', value, value); * } * } * ] * * See the {@link Ext.grid.column.Column column docs} for more information on renderers. * * ## Selection Models * * Sometimes all you want is to render data onto the screen for viewing, but usually it's necessary to interact with or * update that data. Grids use a concept called a Selection Model, which is simply a mechanism for selecting some part of * the data in the grid. The two main types of Selection Model are RowSelectionModel, where entire rows are selected, and * CellSelectionModel, where individual cells are selected. * * Grids use a Row Selection Model by default, but this is easy to customise like so: * * Ext.create('Ext.grid.Panel', { * selType: 'cellmodel', * store: ... * }); * * Specifying the `cellmodel` changes a couple of things. Firstly, clicking on a cell now * selects just that cell (using a {@link Ext.selection.RowModel rowmodel} will select the entire row), and secondly the * keyboard navigation will walk from cell to cell instead of row to row. Cell-based selection models are usually used in * conjunction with editing. * * ## Sorting & Filtering * * Every grid is attached to a {@link Ext.data.Store Store}, which provides multi-sort and filtering capabilities. It's * easy to set up a grid to be sorted from the start: * * var myGrid = Ext.create('Ext.grid.Panel', { * store: { * fields: ['name', 'email', 'phone'], * sorters: ['name', 'phone'] * }, * columns: [ * { text: 'Name', dataIndex: 'name' }, * { text: 'Email', dataIndex: 'email' } * ] * }); * * Sorting at run time is easily accomplished by simply clicking each column header. If you need to perform sorting on * more than one field at run time it's easy to do so by adding new sorters to the store: * * myGrid.store.sort([ * { property: 'name', direction: 'ASC' }, * { property: 'email', direction: 'DESC' } * ]); * * See {@link Ext.data.Store} for examples of filtering. * * ## State saving * * When configured {@link #stateful}, grids save their column state (order and width) encapsulated within the default * Panel state of changed width and height and collapsed/expanded state. * * Each {@link #columns column} of the grid may be configured with a {@link Ext.grid.column.Column#stateId stateId} which * identifies that column locally within the grid. * * ## Plugins and Features * * Grid supports addition of extra functionality through features and plugins: * * - {@link Ext.grid.plugin.CellEditing CellEditing} - editing grid contents one cell at a time. * * - {@link Ext.grid.plugin.RowEditing RowEditing} - editing grid contents an entire row at a time. * * - {@link Ext.grid.plugin.DragDrop DragDrop} - drag-drop reordering of grid rows. * * - {@link Ext.toolbar.Paging Paging toolbar} - paging through large sets of data. * * - {@link Ext.grid.plugin.BufferedRenderer Infinite scrolling} - another way to handle large sets of data. * * - {@link Ext.grid.RowNumberer RowNumberer} - automatically numbered rows. * * - {@link Ext.grid.feature.Grouping Grouping} - grouping together rows having the same value in a particular field. * * - {@link Ext.grid.feature.Summary Summary} - a summary row at the bottom of a grid. * * - {@link Ext.grid.feature.GroupingSummary GroupingSummary} - a summary row at the bottom of each group. */ Ext.define('Ext.grid.Panel', { extend: Ext.panel.Table , alias: ['widget.gridpanel', 'widget.grid'], alternateClassName: ['Ext.list.ListView', 'Ext.ListView', 'Ext.grid.GridPanel'], viewType: 'gridview', lockable: false, /** * @cfg {Boolean} rowLines False to remove row line styling */ rowLines: true // Columns config is required in Grid /** * @cfg {Ext.grid.column.Column[]/Object} columns (required) * @inheritdoc */ /** * @event beforereconfigure * Fires before a reconfigure to enable modification of incoming Store and columns. * @param {Ext.grid.Panel} this * @param {Ext.data.Store} store The store that was passed to the {@link #method-reconfigure} method * @param {Object[]} columns The column configs that were passed to the {@link #method-reconfigure} method * @param {Ext.data.Store} oldStore The store that will be replaced * @param {Ext.grid.column.Column[]} The column headers that will be replaced. */ /** * @event reconfigure * Fires after a reconfigure. * @param {Ext.grid.Panel} this * @param {Ext.data.Store} store The store that was passed to the {@link #method-reconfigure} method * @param {Object[]} columns The column configs that were passed to the {@link #method-reconfigure} method * @param {Ext.data.Store} oldStore The store that was replaced * @param {Ext.grid.column.Column[]} The column headers that were replaced. */ /** * @method reconfigure * Reconfigures the grid with a new store/columns. Either the store or the columns can be omitted if you don't wish * to change them. * @param {Ext.data.Store} store (Optional) The new store. * @param {Object[]} columns (Optional) An array of column configs */ }); /** * @private * A set of overrides required by the presence of the BufferedRenderer plugin. * * These overrides of Ext.view.Table take into account the affect of a buffered renderer and * divert execution from the default course where necessary. */ Ext.define('Ext.grid.plugin.BufferedRendererTableView', { override: 'Ext.view.Table', // Listener function for the Store's add event onAdd: function(store, records, index) { var me = this, bufferedRenderer = me.bufferedRenderer, rows = me.all; // The newly added records will put us over the buffered view size, so we cannot just add as normal. if (me.rendered && bufferedRenderer && (rows.getCount() + records.length) > bufferedRenderer.viewSize) { // Index puts the new row(s) in the visible area, then we have to refresh the view if (index < rows.startIndex + bufferedRenderer.viewSize && (index + records.length) > rows.startIndex) { me.refreshView(); } // New rows outside of visible area, just ensure that the scroll range is updated else { bufferedRenderer.stretchView(me, bufferedRenderer.getScrollHeight()); } } // No BufferedRenderer present // or // View has not yet reached the viewSize: we can add as normal. else { me.callParent([store, records, index]); } }, onRemove: function(store, records, indices) { var me = this, bufferedRenderer = me.bufferedRenderer; // Ensure all records are removed from the view me.callParent([store, records, indices]); // If there's a BufferedRenderer, the view must refresh to keep the view correct. // Removing *may* have removed all of the rendered rows, leaving whitespace below the group header, // so the refresh will be needed to keep the buffer rendered zone valid - to pull records up from // below the removed zone into visibility. if (me.rendered && bufferedRenderer) { if (me.dataSource.getCount() > bufferedRenderer.viewSize) { me.refreshView(); } // No overflow, still we have to ensure the scroll range is updated else { bufferedRenderer.stretchView(me, bufferedRenderer.getScrollHeight()); } } }, // When there's a buffered renderer present, store refresh events cause TableViews to go to scrollTop:0 onDataRefresh: function() { var me = this; if (me.bufferedRenderer) { // Clear NodeCache. Do NOT remove nodes from DOM - that would blur the view, and then refresh will not refocus after the refresh. me.all.clear(); me.bufferedRenderer.onStoreClear(); } me.callParent(); } }); /** * @private * Private Container class used by the {@link Ext.grid.RowEditor} to hold its buttons. */ Ext.define('Ext.grid.RowEditorButtons', { extend: Ext.container.Container , alias: 'widget.roweditorbuttons', frame: true, shrinkWrap: true, position: 'bottom', constructor: function(config) { var me = this, rowEditor = config.rowEditor, cssPrefix = Ext.baseCSSPrefix, plugin = rowEditor.editingPlugin; config = Ext.apply({ baseCls: cssPrefix + 'grid-row-editor-buttons', defaults: { xtype: 'button', ui: rowEditor.buttonUI, scope: plugin, flex: 1, minWidth: Ext.panel.Panel.prototype.minButtonWidth }, items: [{ cls: cssPrefix + 'row-editor-update-button', itemId: 'update', handler: plugin.completeEdit, text: rowEditor.saveBtnText, disabled: rowEditor.updateButtonDisabled }, { cls: cssPrefix + 'row-editor-cancel-button', handler: plugin.cancelEdit, text: rowEditor.cancelBtnText }] }, config); me.callParent([config]); me.addClsWithUI(me.position); }, setButtonPosition: function(position) { var me = this; me.removeClsWithUI(me.position); me.position = position; me.addClsWithUI(position); }, getFramingInfoCls: function(){ return this.baseCls + '-' + this.ui + '-' + this.position; }, getFrameInfo: function() { var frameInfo = this.callParent(); // Trick Renderable into rendering the top framing elements, even though they // are not needed in the default "bottom" position. This allows us to flip the // buttons into "top" position without re-rendering. frameInfo.top = true; return frameInfo; } }); // Currently has the following issues: // - Does not handle postEditValue // - Fields without editors need to sync with their values in Store // - starting to edit another record while already editing and dirty should probably prevent it // - aggregating validation messages // - tabIndex is not managed bc we leave elements in dom, and simply move via positioning // - layout issues when changing sizes/width while hidden (layout bug) /** * Internal utility class used to provide row editing functionality. For developers, they should use * the RowEditing plugin to use this functionality with a grid. * * @private */ Ext.define('Ext.grid.RowEditor', { extend: Ext.form.Panel , alias: 'widget.roweditor', // saveBtnText : 'Update', // // cancelBtnText: 'Cancel', // // errorsText: 'Errors', // // dirtyText: 'You need to commit or cancel your changes', // lastScrollLeft: 0, lastScrollTop: 0, border: false, buttonUI: 'default', // Change the hideMode to offsets so that we get accurate measurements when // the roweditor is hidden for laying out things like a TriggerField. hideMode: 'offsets', initComponent: function() { var me = this, grid = me.editingPlugin.grid, Container = Ext.container.Container; me.cls = Ext.baseCSSPrefix + 'grid-editor ' + Ext.baseCSSPrefix + 'grid-row-editor'; me.layout = { type: 'hbox', align: 'middle' }; me.lockable = grid.lockable; // Create field containing structure for when editing a lockable grid. if (me.lockable) { me.items = [ // Locked columns container shrinkwraps the fields me.lockedColumnContainer = new Container({ id: grid.id + '-locked-editor-cells', layout: { type: 'hbox', align: 'middle' }, // Locked grid has a border, we must be exactly the same width margin: '0 1 0 0' }), // Normal columns container flexes the remaining RowEditor width me.normalColumnContainer = new Container({ flex: 1, id: grid.id + '-normal-editor-cells', layout: { type: 'hbox', align: 'middle' } }) ]; } else { me.lockedColumnContainer = me.normalColumnContainer = me; } me.callParent(arguments); if (me.fields) { me.addFieldsForColumn(me.fields, true); me.insertColumnEditor(me.fields); delete me.fields; } me.mon(me.hierarchyEventSource, { scope: me, show: me.repositionIfVisible }); me.getForm().trackResetOnLoad = true; }, // // Grid listener added when this is rendered. // Keep our containing element sized correctly // onGridResize: function() { var me = this, clientWidth = me.getClientWidth(), grid = me.editingPlugin.grid, gridBody = grid.body, btns = me.getFloatingButtons(); me.setLocalX(gridBody.getOffsetsTo(grid)[0] + gridBody.getBorderWidth('l') - grid.el.getBorderWidth('l')); me.setWidth(clientWidth); btns.setLocalX((clientWidth - btns.getWidth()) / 2); }, onFieldRender: function(field){ var me = this, column = field.column; if (column.isVisible()) { me.syncFieldWidth(column); } else if (!column.rendered) { // column is pending a layout, so we can't set the width until it does me.view.headerCt.on({ afterlayout: Ext.Function.bind(me.syncFieldWidth, me, [column]), single: true }); } }, syncFieldWidth: function(column) { var field = column.getEditor(), width; field._marginWidth = (field._marginWidth || field.el.getMargin('lr')); width = column.getWidth() - field._marginWidth; field.setWidth(width); if (field.xtype === 'displayfield') { // displayfield must have the width set on the inputEl for ellipsis to work field.inputWidth = width; } }, onFieldChange: function() { var me = this, form = me.getForm(), valid = form.isValid(); if (me.errorSummary && me.isVisible()) { me[valid ? 'hideToolTip' : 'showToolTip'](); } me.updateButton(valid); me.isValid = valid; }, updateButton: function(valid){ var buttons = this.floatingButtons; if (buttons) { buttons.child('#update').setDisabled(!valid); } else { // set flag so we can disabled when created if needed this.updateButtonDisabled = !valid; } }, afterRender: function() { var me = this, plugin = me.editingPlugin, grid = plugin.grid, view = grid.lockable ? grid.normalGrid.view : grid.view, field; me.callParent(arguments); // The scrollingViewEl is the TableView which scrolls me.scrollingView = view; me.scrollingViewEl = view.el; view.mon(me.scrollingViewEl, 'scroll', me.onViewScroll, me); // Prevent from bubbling click events to the grid view me.mon(me.el, { click: Ext.emptyFn, stopPropagation: true }); // Ensure that the editor width always matches the total header width me.mon(grid, { resize: me.onGridResize, scope: me }); me.el.swallowEvent([ 'keypress', 'keydown' ]); me.fieldScroller = me.normalColumnContainer.layout.innerCt; me.fieldScroller.dom.style.overflow = 'hidden'; me.fieldScroller.on({ scroll: me.onFieldContainerScroll, scope: me }); me.keyNav = new Ext.util.KeyNav(me.el, { enter: plugin.completeEdit, esc: plugin.onEscKey, scope: plugin }); me.mon(plugin.view, { beforerefresh: me.onBeforeViewRefresh, refresh: me.onViewRefresh, itemremove: me.onViewItemRemove, scope: me }); // Prevent trying to reposition while we set everything up me.preventReposition = true; Ext.Array.each(me.query('[isFormField]'), function(field) { if (field.column.isVisible()) { me.onColumnShow(field.column); } }, me); delete me.preventReposition; }, onBeforeViewRefresh: function(view) { var me = this, viewDom = view.el.dom; if (me.el.dom.parentNode === viewDom) { viewDom.removeChild(me.el.dom); } }, onViewRefresh: function(view) { var me = this, context = me.context, row; // Recover our row node after a view refresh if (context && (row = view.getNode(context.record, true))) { context.row = row; me.reposition(); if (me.tooltip && me.tooltip.isVisible()) { me.tooltip.setTarget(context.row); } } else { me.editingPlugin.cancelEdit(); } }, onViewItemRemove: function(record, index) { var context = this.context; if (context && record === context.record) { // if the record being edited was removed, cancel editing this.editingPlugin.cancelEdit(); } }, onViewScroll: function() { var me = this, viewEl = me.editingPlugin.view.el, scrollingViewEl = me.scrollingViewEl, scrollTop = scrollingViewEl.dom.scrollTop, scrollLeft = scrollingViewEl.getScrollLeft(), scrollLeftChanged = scrollLeft !== me.lastScrollLeft, scrollTopChanged = scrollTop !== me.lastScrollTop, row; me.lastScrollTop = scrollTop; me.lastScrollLeft = scrollLeft; if (me.isVisible()) { row = Ext.getDom(me.context.row.id); // Only reposition if the row is in the DOM (buffered rendering may mean the context row is not there) if (row && viewEl.contains(row)) { if (scrollTopChanged) { // The row element in the context may be stale due to buffered rendering removing out-of-view rows, then re-inserting newly rendered ones me.context.row = row; me.reposition(null, true); if ((me.tooltip && me.tooltip.isVisible()) || me.hiddenTip) { me.repositionTip(); } me.syncEditorClip(); } } // If row is NOT in the DOM, ensure the editor is out of sight else { me.setLocalY(-400); } } // Keep fields' left/right scroll position synced with view's left/right scroll if (me.rendered && scrollLeftChanged) { me.syncFieldsHorizontalScroll(); } }, // Synchronize the horizontal scroll position of the fields with the state of the grid view syncFieldsHorizontalScroll: function() { // Set overflow style here because it is an embedded element and the "style" Component config does not target it. this.fieldScroller.setScrollLeft(this.lastScrollLeft); }, // Synchronize the horizontal scroll position of the grid view with the fields. onFieldContainerScroll: function() { this.scrollingViewEl.setScrollLeft(this.fieldScroller.getScrollLeft()); }, onColumnResize: function(column, width) { var me = this; if (me.rendered) { // Need to ensure our lockable/normal horizontal scrollrange is set me.onGridResize(); me.onViewScroll(); if (!column.isGroupHeader) { me.syncFieldWidth(column); me.repositionIfVisible(); } } }, onColumnHide: function(column) { if (!column.isGroupHeader) { column.getEditor().hide(); this.repositionIfVisible(); } }, onColumnShow: function(column) { var me = this; if (me.rendered && !column.isGroupHeader) { column.getEditor().show(); me.syncFieldWidth(column); if (!me.preventReposition) { this.repositionIfVisible(); } } }, onColumnMove: function(column, fromIdx, toIdx) { var me = this, i, incr = 1, len, field, fieldIdx, fieldContainer = column.isLocked() ? me.lockedColumnContainer : me.normalColumnContainer; // If moving a group, move each leaf header if (column.isGroupHeader) { Ext.suspendLayouts(); column = column.getGridColumns(); if (toIdx > fromIdx) { toIdx--; incr = 0; } this.addFieldsForColumn(column); for (i = 0, len = column.length; i < len; i++, fromIdx += incr, toIdx += incr) { field = column[i].getEditor(); fieldIdx = fieldContainer.items.indexOf(field); // If the field is not in the container (moved from the main headerCt, INTO a group header) // then insert it into the correct place if (fieldIdx === -1) { fieldContainer.insert(toIdx, field); } // If the field has not already been processed by an onColumnAdd (move from a group header INTO the main headerCt), then move it else if (fieldIdx != toIdx) { fieldContainer.move(fromIdx, toIdx); } } Ext.resumeLayouts(true); } else { if (toIdx > fromIdx) { toIdx--; } this.addFieldsForColumn(column); field = column.getEditor(); fieldIdx = fieldContainer.items.indexOf(field); if (fieldIdx === -1) { fieldContainer.insert(toIdx, field); } else if (fieldIdx != toIdx) { fieldContainer.move(fromIdx, toIdx); } } }, onColumnAdd: function(column) { // If a column header added, process its leaves if (column.isGroupHeader) { column = column.getGridColumns(); } //this.preventReposition = true; this.addFieldsForColumn(column); this.insertColumnEditor(column); this.preventReposition = false; }, insertColumnEditor: function(column) { var me = this, fieldContainer, len, i; if (Ext.isArray(column)) { for (i = 0, len = column.length; i < len; i++) { me.insertColumnEditor(column[i]); } return; } if (!column.getEditor) { return; } fieldContainer = column.isLocked() ? me.lockedColumnContainer : me.normalColumnContainer; // Insert the column's field into the editor panel. fieldContainer.insert(column.getVisibleIndex(), column.getEditor()); }, onColumnRemove: function(ct, column) { column = column.isGroupHeader ? column.getGridColumns() : column; this.removeColumnEditor(column); }, removeColumnEditor: function(column) { var me = this, field, len, i; if (Ext.isArray(column)) { for (i = 0, len = column.length; i < len; i++) { me.removeColumnEditor(column[i]); } return; } if (column.hasEditor()) { field = column.getEditor(); if (field && field.ownerCt) { field.ownerCt.remove(field, false); } } }, onColumnReplace: function(map, fieldId, column, oldColumn) { this.onColumnRemove(oldColumn.ownerCt, oldColumn); }, getFloatingButtons: function() { var me = this, btns = me.floatingButtons; if (!btns) { me.floatingButtons = btns = new Ext.grid.RowEditorButtons({ rowEditor: me }); } return btns; }, repositionIfVisible: function(c) { var me = this, view = me.view; // If we're showing ourselves, jump out // If the component we're showing doesn't contain the view if (c && (c == me || !c.el.isAncestor(view.el))) { return; } if (me.isVisible() && view.isVisible(true)) { me.reposition(); } }, getRefOwner: function() { return this.editingPlugin.grid; }, // Lie to the CQ system about our nesting structure. // Pretend all the fields are always immediate children. // Include the two buttons. getRefItems: function() { var me = this, result; if (me.lockable) { result = me.lockedColumnContainer.getRefItems(); result.push.apply(result, me.normalColumnContainer.getRefItems()); } else { result = me.callParent(); } result.push.apply(result, me.getFloatingButtons().getRefItems()); return result; }, reposition: function(animateConfig, fromScrollHandler) { var me = this, context = me.context, row = context && Ext.get(context.row), yOffset = 0, rowTop, localY, deltaY, afterPosition; // Position this editor if the context row is rendered (buffered rendering may mean that it's not in the DOM at all) if (row && Ext.isElement(row.dom)) { deltaY = me.syncButtonPosition(me.getScrollDelta()); if (!me.editingPlugin.grid.rowLines) { // When the grid does not have rowLines we add a bottom border to the previous // row when the row is focused, but subtract the border width from the // top padding to keep the row from changing size. This adjusts the top offset // of the cell edtor to account for the added border. yOffset = -parseInt(row.first().getStyle('border-bottom-width')); } rowTop = me.calculateLocalRowTop(row); localY = me.calculateEditorTop(rowTop) + yOffset; // If not being called from scroll handler... // If the editor's top will end up above the fold // or the bottom will end up below the fold, // organize an afterPosition handler which will bring it into view and focus the correct input field if (!fromScrollHandler) { afterPosition = function() { if (deltaY) { me.scrollingViewEl.scrollBy(0, deltaY, true); } me.focusContextCell(); } } me.syncEditorClip(); // Get the y position of the row relative to its top-most static parent. // offsetTop will be relative to the table, and is incorrect // when mixed with certain grid features (e.g., grouping). if (animateConfig) { me.animate(Ext.applyIf({ to: { top: localY }, duration: animateConfig.duration || 125, callback: afterPosition }, animateConfig)); } else { me.setLocalY(localY); if (afterPosition) { afterPosition(); } } } }, /** * @private * Returns the scroll delta required to scroll the context row into view in order to make * the whole of this editor visible. * @return {Number} the scroll delta. Zero if scrolling is not required. */ getScrollDelta: function() { var me = this, scrollingViewDom = me.scrollingViewEl.dom, context = me.context, body = me.body, deltaY = 0; if (context) { deltaY = Ext.fly(context.row).getOffsetsTo(scrollingViewDom)[1] - body.getBorderPadding().beforeY; if (deltaY > 0) { deltaY = Math.max(deltaY + me.getHeight() + me.floatingButtons.getHeight() - scrollingViewDom.clientHeight - body.getBorderWidth('b'), 0); } } return deltaY; }, // // Calculates the top pixel position of the passed row within the view's scroll space. // So in a large, scrolled grid, this could be several thousand pixels. // calculateLocalRowTop: function(row) { var grid = this.editingPlugin.grid; return Ext.fly(row).getOffsetsTo(grid)[1] - grid.el.getBorderWidth('t') + this.lastScrollTop; }, // Given the top pixel position of a row in the scroll space, // calculate the editor top position in the view's encapsulating element. // This will only ever be in the visible range of the view's element. calculateEditorTop: function(rowTop) { return rowTop - this.body.getBorderPadding().beforeY - this.lastScrollTop; }, getClientWidth: function() { var me = this, grid = me.editingPlugin.grid, result; if (me.lockable) { result = grid.lockedGrid.getWidth() + grid.normalGrid.view.el.dom.clientWidth - 1; } else { result = grid.view.el.dom.clientWidth; } return result; }, getEditor: function(fieldInfo) { var me = this; if (Ext.isNumber(fieldInfo)) { // Query only form fields. This just future-proofs us in case we add // other components to RowEditor later on. Don't want to mess with // indices. return me.query('[isFormField]')[fieldInfo]; } else if (fieldInfo.isHeader && !fieldInfo.isGroupHeader) { return fieldInfo.getEditor(); } }, addFieldsForColumn: function(column, initial) { var me = this, i, length, field; if (Ext.isArray(column)) { for (i = 0, length = column.length; i < length; i++) { me.addFieldsForColumn(column[i], initial); } return; } if (column.getEditor) { // Get a default display field if necessary field = column.getEditor(null, { xtype: 'displayfield', // Override Field's implementation so that the default display fields will not return values. This is done because // the display field will pick up column renderers from the grid. getModelData: function() { return null; } }); if (column.align === 'right') { field.fieldStyle = 'text-align:right'; } if (column.xtype === 'actioncolumn') { field.fieldCls += ' ' + Ext.baseCSSPrefix + 'form-action-col-field' } if (me.isVisible() && me.context) { if (field.is('displayfield')) { me.renderColumnData(field, me.context.record, column); } else { field.suspendEvents(); field.setValue(me.context.record.get(column.dataIndex)); field.resumeEvents(); } } if (column.hidden) { me.onColumnHide(column); } else if (column.rendered && !initial) { // Setting after initial render me.onColumnShow(column); } } }, loadRecord: function(record) { var me = this, form = me.getForm(), fields = form.getFields(), items = fields.items, length = items.length, i, displayFields, isValid; // temporarily suspend events on form fields before loading record to prevent the fields' change events from firing for (i = 0; i < length; i++) { items[i].suspendEvents(); } form.loadRecord(record); for (i = 0; i < length; i++) { items[i].resumeEvents(); } isValid = form.isValid(); if (me.errorSummary) { if (isValid) { me.hideToolTip(); } else { me.showToolTip(); } } me.updateButton(isValid); // render display fields so they honor the column renderer/template displayFields = me.query('>displayfield'); length = displayFields.length; for (i = 0; i < length; i++) { me.renderColumnData(displayFields[i], record); } }, renderColumnData: function(field, record, activeColumn) { var me = this, grid = me.editingPlugin.grid, headerCt = grid.headerCt, view = me.scrollingView, store = view.dataSource, column = activeColumn || field.column, value = record.get(column.dataIndex), renderer = column.editRenderer || column.renderer, metaData, rowIdx, colIdx; // honor our column's renderer (TemplateHeader sets renderer for us!) if (renderer) { metaData = { tdCls: '', style: '' }; rowIdx = store.indexOf(record); colIdx = headerCt.getHeaderIndex(column); value = renderer.call( column.scope || headerCt.ownerCt, value, metaData, record, rowIdx, colIdx, store, view ); } field.setRawValue(value); field.resetOriginalValue(); }, beforeEdit: function() { var me = this, scrollDelta; if (me.isVisible() && me.errorSummary && !me.autoCancel && me.isDirty()) { // Scroll the visible RowEditor that is in error state back into view scrollDelta = me.getScrollDelta(); if (scrollDelta) { me.scrollingViewEl.scrollBy(0, scrollDelta, true) } me.showToolTip(); return false; } }, /** * Start editing the specified grid at the specified position. * @param {Ext.data.Model} record The Store data record which backs the row to be edited. * @param {Ext.data.Model} columnHeader The Column object defining the column to be edited. */ startEdit: function(record, columnHeader) { var me = this, editingPlugin = me.editingPlugin, grid = editingPlugin.grid, context = me.context = editingPlugin.context; if (!me.rendered) { me.width = me.getClientWidth(); me.render(grid.el, grid.el.dom.firstChild); me.getFloatingButtons().render(me.el); // On first show we need to ensure that we have the scroll positions cached me.onViewScroll(); } else { me.syncFieldsHorizontalScroll(); } if (me.isVisible()) { me.reposition(true); } else { me.show(); } // Make sure the container el is correctly sized. me.onGridResize(); // make sure our row is selected before editing context.grid.getSelectionModel().select(record); // Reload the record data me.loadRecord(record); }, // determines the amount by which the row editor will overflow, and flips the buttons // to the top of the editor if the required scroll amount is greater than the available // scroll space. Returns the scrollDelta required to scroll the editor into view after // adjusting the button position. syncButtonPosition: function(scrollDelta) { var me = this, floatingButtons = me.getFloatingButtons(), scrollingViewElDom = me.scrollingViewEl.dom, overflow = this.getScrollDelta() - (scrollingViewElDom.scrollHeight - scrollingViewElDom.scrollTop - scrollingViewElDom.clientHeight); if (overflow > 0) { if (!me._buttonsOnTop) { floatingButtons.setButtonPosition('top'); me._buttonsOnTop = true; } scrollDelta = 0; } else if (me._buttonsOnTop) { floatingButtons.setButtonPosition('bottom'); me._buttonsOnTop = false; } return scrollDelta; }, // since the editor is rendered to the grid el, it must be clipped when scrolled // outside of the grid view area so that it does not overlap the scrollbar or docked items syncEditorClip: function() { var me = this, overflow = me.getScrollDelta(), btnHeight; if (overflow) { // The editor is overflowing outside of the view area, either above or below me.isOverflowing = true; btnHeight = me.floatingButtons.getHeight(); if (overflow > 0) { // editor is overflowing the bottom of the view me.clipBottom(Math.max(me.getHeight() - overflow + btnHeight, -btnHeight)); } else if (overflow < 0) { // editor is overflowing the top of the view overflow = Math.abs(overflow); me.clipTop(Math.max(overflow, 0)); } } else if (me.isOverflowing) { me.clearClip(); me.isOverflowing = false; } }, // Focus the cell on start edit based upon the current context focusContextCell: function() { var field = this.getEditor(this.context.column); if (field && field.focus) { field.focus(); } }, cancelEdit: function() { var me = this, form = me.getForm(), fields = form.getFields(), items = fields.items, length = items.length, i; me.hide(); form.clearInvalid(); // temporarily suspend events on form fields before reseting the form to prevent the fields' change events from firing for (i = 0; i < length; i++) { items[i].suspendEvents(); } form.reset(); for (i = 0; i < length; i++) { items[i].resumeEvents(); } }, completeEdit: function() { var me = this, form = me.getForm(); if (!form.isValid()) { return false; } form.updateRecord(me.context.record); me.hide(); return true; }, onShow: function() { var me = this; me.callParent(arguments); me.reposition(); }, onHide: function() { var me = this; me.callParent(arguments); if (me.tooltip) { me.hideToolTip(); } if (me.context) { me.context.view.focusRow(me.context.record); me.context = null; } }, isDirty: function() { var me = this, form = me.getForm(); return form.isDirty(); }, getToolTip: function() { return this.tooltip || (this.tooltip = new Ext.tip.ToolTip({ cls: Ext.baseCSSPrefix + 'grid-row-editor-errors', title: this.errorsText, autoHide: false, closable: true, closeAction: 'disable', anchor: 'left', anchorToTarget: false })); }, hideToolTip: function() { var me = this, tip = me.getToolTip(); if (tip.rendered) { tip.disable(); } me.hiddenTip = false; }, showToolTip: function() { var me = this, tip = me.getToolTip(); tip.showAt([0, 0]); tip.update(me.getErrors()); me.repositionTip(); tip.enable(); }, repositionTip: function() { var me = this, tip = me.getToolTip(), context = me.context, row = Ext.get(context.row), viewEl = me.scrollingViewEl, viewHeight = viewEl.dom.clientHeight, viewTop = me.lastScrollTop, viewBottom = viewTop + viewHeight, rowHeight = row.getHeight(), rowTop = row.getOffsetsTo(me.context.view.body)[1], rowBottom = rowTop + rowHeight; if (rowBottom > viewTop && rowTop < viewBottom) { tip.showAt(tip.getAlignToXY(viewEl, 'tl-tr', [15, row.getOffsetsTo(viewEl)[1]])); me.hiddenTip = false; } else { tip.hide(); me.hiddenTip = true; } }, getErrors: function() { var me = this, errors = [], fields = me.query('>[isFormField]'), length = fields.length, i; for (i = 0; i < length; i++) { errors = errors.concat( Ext.Array.map(fields[i].getErrors(), me.createErrorListItem) ); } // Only complain about unsaved changes if all the fields are valid if (!errors.length && !me.autoCancel && me.isDirty()) { errors[0] = me.createErrorListItem(me.dirtyText); } return '
    ' + errors.join('') + '
'; }, createErrorListItem: function(e) { return '
  • ' + e + '
  • '; }, beforeDestroy: function(){ Ext.destroy(this.floatingButtons, this.tooltip); this.callParent(); }, clipBottom: function(value) { this.el.setStyle('clip', 'rect(-1000px auto ' + value + 'px auto)'); }, clipTop: function(value) { this.el.setStyle('clip', 'rect(' + value + 'px auto 1000px auto)'); }, clearClip: function(el) { this.el.setStyle( 'clip', Ext.isIE8m || Ext.isIEQuirks ? 'rect(-1000px auto 1000px auto)' : 'auto' ); } }); Ext.define('Ext.grid.Scroller', { constructor: Ext.deprecated() }); /** * @private */ Ext.define('Ext.view.DropZone', { extend: Ext.dd.DropZone , indicatorHtml: '
    ', indicatorCls: Ext.baseCSSPrefix + 'grid-drop-indicator', constructor: function(config) { var me = this; Ext.apply(me, config); // Create a ddGroup unless one has been configured. // User configuration of ddGroups allows users to specify which // DD instances can interact with each other. Using one // based on the id of the View would isolate it and mean it can only // interact with a DragZone on the same View also using a generated ID. if (!me.ddGroup) { me.ddGroup = 'view-dd-zone-' + me.view.id; } // The DropZone's encapsulating element is the View's main element. It must be this because drop gestures // may require scrolling on hover near a scrolling boundary. In Ext 4.x two DD instances may not use the // same element, so a DragZone on this same View must use the View's parent element as its element. me.callParent([me.view.el]); }, // Fire an event through the client DataView. Lock this DropZone during the event processing so that // its data does not become corrupted by processing mouse events. fireViewEvent: function() { var me = this, result; me.lock(); result = me.view.fireEvent.apply(me.view, arguments); me.unlock(); return result; }, getTargetFromEvent : function(e) { var node = e.getTarget(this.view.getItemSelector()), mouseY, nodeList, testNode, i, len, box; // Not over a row node: The content may be narrower than the View's encapsulating element, so return the closest. // If we fall through because the mouse is below the nodes (or there are no nodes), we'll get an onContainerOver call. if (!node) { mouseY = e.getPageY(); for (i = 0, nodeList = this.view.getNodes(), len = nodeList.length; i < len; i++) { testNode = nodeList[i]; box = Ext.fly(testNode).getBox(); if (mouseY <= box.bottom) { return testNode; } } } return node; }, getIndicator: function() { var me = this; if (!me.indicator) { me.indicator = new Ext.Component({ html: me.indicatorHtml, cls: me.indicatorCls, ownerCt: me.view, floating: true, shadow: false }); } return me.indicator; }, getPosition: function(e, node) { var y = e.getXY()[1], region = Ext.fly(node).getRegion(), pos; if ((region.bottom - y) >= (region.bottom - region.top) / 2) { pos = "before"; } else { pos = "after"; } return pos; }, /** * @private Determines whether the record at the specified offset from the passed record * is in the drag payload. * @param records * @param record * @param offset * @returns {Boolean} True if the targeted record is in the drag payload */ containsRecordAtOffset: function(records, record, offset) { if (!record) { return false; } var view = this.view, recordIndex = view.indexOf(record), nodeBefore = view.getNode(recordIndex + offset, true), recordBefore = nodeBefore ? view.getRecord(nodeBefore) : null; return recordBefore && Ext.Array.contains(records, recordBefore); }, positionIndicator: function(node, data, e) { var me = this, view = me.view, pos = me.getPosition(e, node), overRecord = view.getRecord(node), draggingRecords = data.records, indicatorY; if (!Ext.Array.contains(draggingRecords, overRecord) && ( pos == 'before' && !me.containsRecordAtOffset(draggingRecords, overRecord, -1) || pos == 'after' && !me.containsRecordAtOffset(draggingRecords, overRecord, 1) )) { me.valid = true; if (me.overRecord != overRecord || me.currentPosition != pos) { indicatorY = Ext.fly(node).getY() - view.el.getY() - 1; if (pos == 'after') { indicatorY += Ext.fly(node).getHeight(); } me.getIndicator().setWidth(Ext.fly(view.el).getWidth()).showAt(0, indicatorY); // Cache the overRecord and the 'before' or 'after' indicator. me.overRecord = overRecord; me.currentPosition = pos; } } else { me.invalidateDrop(); } }, invalidateDrop: function() { if (this.valid) { this.valid = false; this.getIndicator().hide(); } }, // The mouse is over a View node onNodeOver: function(node, dragZone, e, data) { var me = this; if (!Ext.Array.contains(data.records, me.view.getRecord(node))) { me.positionIndicator(node, data, e); } return me.valid ? me.dropAllowed : me.dropNotAllowed; }, // Moved out of the DropZone without dropping. // Remove drop position indicator notifyOut: function(node, dragZone, e, data) { var me = this; me.callParent(arguments); me.overRecord = me.currentPosition = null me.valid = false; if (me.indicator) { me.indicator.hide(); } }, // The mouse is past the end of all nodes (or there are no nodes) onContainerOver : function(dd, e, data) { var me = this, view = me.view, count = view.dataSource.getCount(); // There are records, so position after the last one if (count) { me.positionIndicator(view.all.last(), data, e); } // No records, position the indicator at the top else { me.overRecord = me.currentPosition = null; me.getIndicator().setWidth(Ext.fly(view.el).getWidth()).showAt(0, 0); me.valid = true; } return me.dropAllowed; }, onContainerDrop : function(dd, e, data) { return this.onNodeDrop(dd, null, e, data); }, onNodeDrop: function(targetNode, dragZone, e, data) { var me = this, dropHandled = false, // Create a closure to perform the operation which the event handler may use. // Users may now set the wait parameter in the beforedrop handler, and perform any kind // of asynchronous processing such as an Ext.Msg.confirm, or an Ajax request, // and complete the drop gesture at some point in the future by calling either the // processDrop or cancelDrop methods. dropHandlers = { wait: false, processDrop: function () { me.invalidateDrop(); me.handleNodeDrop(data, me.overRecord, me.currentPosition); dropHandled = true; me.fireViewEvent('drop', targetNode, data, me.overRecord, me.currentPosition); }, cancelDrop: function() { me.invalidateDrop(); dropHandled = true; } }, performOperation = false; if (me.valid) { performOperation = me.fireViewEvent('beforedrop', targetNode, data, me.overRecord, me.currentPosition, dropHandlers); if (dropHandlers.wait) { return; } if (performOperation !== false) { // If either of the drop handlers were called in the event handler, do not do it again. if (!dropHandled) { dropHandlers.processDrop(); } } } return performOperation; }, destroy: function(){ Ext.destroy(this.indicator); delete this.indicator; this.callParent(); } }); /** * @private */ Ext.define('Ext.grid.ViewDropZone', { extend: Ext.view.DropZone , indicatorHtml: '
    ', indicatorCls: Ext.baseCSSPrefix + 'grid-drop-indicator', handleNodeDrop : function(data, record, position) { var view = this.view, store = view.getStore(), index, records, i, len; // If the copy flag is set, create a copy of the models if (data.copy) { records = data.records; data.records = []; for (i = 0, len = records.length; i < len; i++) { data.records.push(records[i].copy()); } } else { /* * Remove from the source store. We do this regardless of whether the store * is the same bacsue the store currently doesn't handle moving records * within the store. In the future it should be possible to do this. * Here was pass the isMove parameter if we're moving to the same view. */ data.view.store.remove(data.records, data.view === view); } if (record && position) { index = store.indexOf(record); // 'after', or undefined (meaning a drop at index -1 on an empty View)... if (position !== 'before') { index++; } store.insert(index, data.records); } // No position specified - append. else { store.add(data.records); } view.getSelectionModel().select(data.records); } }); /** * Plugin to add header resizing functionality to a HeaderContainer. * Always resizing header to the left of the splitter you are resizing. */ Ext.define('Ext.grid.plugin.HeaderResizer', { extend: Ext.AbstractPlugin , alias: 'plugin.gridheaderresizer', disabled: false, config: { /** * @cfg {Boolean} dynamic * True to resize on the fly rather than using a proxy marker. * @accessor */ dynamic: false }, colHeaderCls: Ext.baseCSSPrefix + 'column-header', minColWidth: 40, maxColWidth: 1000, wResizeCursor: 'col-resize', eResizeCursor: 'col-resize', // not using w and e resize bc we are only ever resizing one // column //wResizeCursor: Ext.isWebKit ? 'w-resize' : 'col-resize', //eResizeCursor: Ext.isWebKit ? 'e-resize' : 'col-resize', init: function(headerCt) { this.headerCt = headerCt; headerCt.on('render', this.afterHeaderRender, this, {single: true}); }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { if (this.tracker) { this.tracker.destroy(); } }, afterHeaderRender: function() { var headerCt = this.headerCt, el = headerCt.el; headerCt.mon(el, 'mousemove', this.onHeaderCtMouseMove, this); this.tracker = new Ext.dd.DragTracker({ disabled: this.disabled, onBeforeStart: Ext.Function.bind(this.onBeforeStart, this), onStart: Ext.Function.bind(this.onStart, this), onDrag: Ext.Function.bind(this.onDrag, this), onEnd: Ext.Function.bind(this.onEnd, this), tolerance: 3, autoStart: 300, el: el }); }, // As we mouse over individual headers, change the cursor to indicate // that resizing is available, and cache the resize target header for use // if/when they mousedown. onHeaderCtMouseMove: function(e, t) { var me = this, prevSiblings, headerEl, overHeader, resizeHeader, resizeHeaderOwnerGrid, ownerGrid; if (me.headerCt.dragging) { if (me.activeHd) { me.activeHd.el.dom.style.cursor = ''; delete me.activeHd; } } else { headerEl = e.getTarget('.' + me.colHeaderCls, 3, true); if (headerEl){ overHeader = Ext.getCmp(headerEl.id); // On left edge, go back to the previous non-hidden header. if (overHeader.isOnLeftEdge(e)) { resizeHeader = overHeader.previousNode('gridcolumn:not([hidden]):not([isGroupHeader])') // There may not *be* a previous non-hidden header. if (resizeHeader) { ownerGrid = me.headerCt.up('tablepanel'); resizeHeaderOwnerGrid = resizeHeader.up('tablepanel'); // Need to check that previousNode didn't go outside the current grid/tree // But in the case of a Grid which contains a locked and normal grid, allow previousNode to jump // from the first column of the normalGrid to the last column of the lockedGrid if (!((resizeHeaderOwnerGrid === ownerGrid) || ((ownerGrid.ownerCt.isXType('tablepanel')) && ownerGrid.ownerCt.view.lockedGrid === resizeHeaderOwnerGrid))) { resizeHeader = null; } } } // Else, if on the right edge, we're resizing the column we are over else if (overHeader.isOnRightEdge(e)) { resizeHeader = overHeader; } // Between the edges: we are not resizing else { resizeHeader = null; } // We *are* resizing if (resizeHeader) { // If we're attempting to resize a group header, that cannot be resized, // so find its last visible leaf header; Group headers are sized // by the size of their child headers. if (resizeHeader.isGroupHeader) { prevSiblings = resizeHeader.getGridColumns(); resizeHeader = prevSiblings[prevSiblings.length - 1]; } // Check if the header is resizable. Continue checking the old "fixed" property, bug also // check whether the resizable property is set to false. if (resizeHeader && !(resizeHeader.fixed || (resizeHeader.resizable === false) || me.disabled)) { me.activeHd = resizeHeader; overHeader.el.dom.style.cursor = me.eResizeCursor; if (overHeader.triggerEl) { overHeader.triggerEl.dom.style.cursor = me.eResizeCursor; } } // reset } else { overHeader.el.dom.style.cursor = ''; if (overHeader.triggerEl) { overHeader.triggerEl.dom.style.cursor = ''; } me.activeHd = null; } } } }, // only start when there is an activeHd onBeforeStart : function(e) { // cache the activeHd because it will be cleared. this.dragHd = this.activeHd; if (!!this.dragHd && !this.headerCt.dragging) { this.tracker.constrainTo = this.getConstrainRegion(); return true; } else { this.headerCt.dragging = false; return false; } }, // get the region to constrain to, takes into account max and min col widths getConstrainRegion: function() { var me = this, dragHdEl = me.dragHd.el, rightAdjust = 0, nextHd, lockedGrid; // If forceFit, then right constraint is based upon not being able to force the next header // beyond the minColWidth. If there is no next header, then the header may not be expanded. if (me.headerCt.forceFit) { nextHd = me.dragHd.nextNode('gridcolumn:not([hidden]):not([isGroupHeader])'); if (nextHd) { if (!me.headerInSameGrid(nextHd)) { nextHd = null; } rightAdjust = nextHd.getWidth() - me.minColWidth; } } // If resize header is in a locked grid, the maxWidth has to be 30px within the available locking grid's width else if ((lockedGrid = me.dragHd.up('tablepanel')).isLocked) { rightAdjust = me.dragHd.up('[scrollerOwner]').getWidth() - lockedGrid.getWidth() - 30; } // Else ue our default max width else { rightAdjust = me.maxColWidth - dragHdEl.getWidth(); } return me.adjustConstrainRegion( dragHdEl.getRegion(), 0, rightAdjust, 0, me.minColWidth ); }, // initialize the left and right hand side markers around // the header that we are resizing onStart: function(e){ var me = this, dragHd = me.dragHd, width = dragHd.el.getWidth(), headerCt = dragHd.getOwnerHeaderCt(), x, y, gridSection, markerOwner, lhsMarker, rhsMarker, markerHeight; me.headerCt.dragging = true; me.origWidth = width; // setup marker proxies if (!me.dynamic) { gridSection = markerOwner = headerCt.up('tablepanel'); if (gridSection.ownerLockable) { markerOwner = gridSection.ownerLockable; } x = me.getLeftMarkerX(markerOwner); lhsMarker = markerOwner.getLhsMarker(); rhsMarker = markerOwner.getRhsMarker(); markerHeight = gridSection.body.getHeight() + headerCt.getHeight(); y = headerCt.getOffsetsTo(markerOwner)[1]; lhsMarker.setLocalY(y); rhsMarker.setLocalY(y); lhsMarker.setHeight(markerHeight); rhsMarker.setHeight(markerHeight); me.setMarkerX(lhsMarker, x); me.setMarkerX(rhsMarker, x + width); } }, // synchronize the rhsMarker with the mouse movement onDrag: function(e){ var me = this, markerOwner; if (me.dynamic) { me.doResize(); } else { markerOwner = this.headerCt.up('tablepanel'); if (markerOwner.ownerLockable) { markerOwner = markerOwner.ownerLockable; } this.setMarkerX(this.getMovingMarker(markerOwner), this.calculateDragX(markerOwner)); } }, getMovingMarker: function(markerOwner){ return markerOwner.getRhsMarker(); }, onEnd: function(e) { this.headerCt.dragging = false; if (this.dragHd) { if (!this.dynamic) { var markerOwner = this.headerCt.up('tablepanel'); // hide markers if (markerOwner.ownerLockable) { markerOwner = markerOwner.ownerLockable; } this.setMarkerX(markerOwner.getLhsMarker(), -9999); this.setMarkerX(markerOwner.getRhsMarker(), -9999); } this.doResize(); } }, doResize: function() { var me = this, dragHd = me.dragHd, nextHd, offset; if (dragHd) { offset = me.tracker.getOffset('point'); // resize the dragHd if (dragHd.flex) { delete dragHd.flex; } Ext.suspendLayouts(); // Set the new column width. me.adjustColumnWidth(offset[0]); // In the case of forceFit, change the following Header width. // Constraining so that neither neighbour can be sized to below minWidth is handled in getConstrainRegion if (me.headerCt.forceFit) { nextHd = dragHd.nextNode('gridcolumn:not([hidden]):not([isGroupHeader])'); if (nextHd && !me.headerInSameGrid(nextHd)) { nextHd = null; } if (nextHd) { delete nextHd.flex; nextHd.setWidth(nextHd.getWidth() - offset[0]); } } // Apply the two width changes by laying out the owning HeaderContainer Ext.resumeLayouts(true); } }, // nextNode can traverse out of this grid, possibly to others on the page, so limit it here headerInSameGrid: function(header) { var grid = this.dragHd.up('tablepanel'); return !!header.up(grid); }, disable: function() { this.disabled = true; if (this.tracker) { this.tracker.disable(); } }, enable: function() { this.disabled = false; if (this.tracker) { this.tracker.enable(); } }, calculateDragX: function(markerOwner) { return this.tracker.getXY('point')[0] - markerOwner.getX() - markerOwner.el.getBorderWidth('l'); }, getLeftMarkerX: function(markerOwner) { return this.dragHd.getX() - markerOwner.getX() - markerOwner.el.getBorderWidth('l') - 1; }, setMarkerX: function(marker, x) { marker.setLocalX(x); }, adjustConstrainRegion: function(region, t, r, b, l) { return region.adjust(t, r, b, l); }, adjustColumnWidth: function(offsetX) { this.dragHd.setWidth(this.origWidth + offsetX); } }); /** * @private */ Ext.define('Ext.grid.header.DragZone', { extend: Ext.dd.DragZone , colHeaderSelector: '.' + Ext.baseCSSPrefix + 'column-header', colInnerSelector: '.' + Ext.baseCSSPrefix + 'column-header-inner', maxProxyWidth: 120, constructor: function(headerCt) { this.headerCt = headerCt; this.ddGroup = this.getDDGroup(); this.callParent([headerCt.el]); this.proxy.el.addCls(Ext.baseCSSPrefix + 'grid-col-dd'); }, getDDGroup: function() { return 'header-dd-zone-' + this.headerCt.up('[scrollerOwner]').id; }, getDragData: function(e) { if (e.getTarget(this.colInnerSelector)) { var header = e.getTarget(this.colHeaderSelector), headerCmp, ddel; if (header) { headerCmp = Ext.getCmp(header.id); if (!this.headerCt.dragging && headerCmp.draggable && !(headerCmp.isOnLeftEdge(e) || headerCmp.isOnRightEdge(e))) { ddel = document.createElement('div'); ddel.innerHTML = Ext.getCmp(header.id).text; return { ddel: ddel, header: headerCmp }; } } } return false; }, onBeforeDrag: function() { return !(this.headerCt.dragging || this.disabled); }, onInitDrag: function() { this.headerCt.dragging = true; this.callParent(arguments); }, onDragDrop: function() { this.headerCt.dragging = false; this.callParent(arguments); }, afterRepair: function() { this.callParent(); this.headerCt.dragging = false; }, getRepairXY: function() { return this.dragData.header.el.getXY(); }, disable: function() { this.disabled = true; }, enable: function() { this.disabled = false; } }); /** * @private */ Ext.define('Ext.grid.header.DropZone', { extend: Ext.dd.DropZone , colHeaderCls: Ext.baseCSSPrefix + 'column-header', proxyOffsets: [-4, -9], constructor: function(headerCt){ this.headerCt = headerCt; this.ddGroup = this.getDDGroup(); this.callParent([headerCt.el]); }, getDDGroup: function() { return 'header-dd-zone-' + this.headerCt.up('[scrollerOwner]').id; }, getTargetFromEvent : function(e){ return e.getTarget('.' + this.colHeaderCls); }, getTopIndicator: function() { if (!this.topIndicator) { this.self.prototype.topIndicator = Ext.DomHelper.append(Ext.getBody(), { cls: "col-move-top", html: " " }, true); this.self.prototype.indicatorXOffset = Math.floor((this.topIndicator.dom.offsetWidth + 1) / 2); } return this.topIndicator; }, getBottomIndicator: function() { if (!this.bottomIndicator) { this.self.prototype.bottomIndicator = Ext.DomHelper.append(Ext.getBody(), { cls: "col-move-bottom", html: " " }, true); } return this.bottomIndicator; }, getLocation: function(e, t) { var x = e.getXY()[0], region = Ext.fly(t).getRegion(), pos; if ((region.right - x) <= (region.right - region.left) / 2) { pos = "after"; } else { pos = "before"; } return { pos: pos, header: Ext.getCmp(t.id), node: t }; }, positionIndicator: function(data, node, e){ var me = this, dragHeader = data.header, dropLocation = me.getLocation(e, node), targetHeader = dropLocation.header, pos = dropLocation.pos, nextHd, prevHd, topIndicator, bottomIndicator, topAnchor, bottomAnchor, topXY, bottomXY, headerCtEl, minX, maxX, allDropZones, ln, i, dropZone; // Avoid expensive CQ lookups and DOM calculations if dropPosition has not changed if (targetHeader === me.lastTargetHeader && pos === me.lastDropPos) { return; } nextHd = dragHeader.nextSibling('gridcolumn:not([hidden])'); prevHd = dragHeader.previousSibling('gridcolumn:not([hidden])'); me.lastTargetHeader = targetHeader; me.lastDropPos = pos; // Cannot drag to before non-draggable start column if (!targetHeader.draggable && pos === 'before' && targetHeader.getIndex() === 0) { return false; } data.dropLocation = dropLocation; if ((dragHeader !== targetHeader) && ((pos === "before" && nextHd !== targetHeader) || (pos === "after" && prevHd !== targetHeader)) && !targetHeader.isDescendantOf(dragHeader)) { // As we move in between different DropZones that are in the same // group (such as the case when in a locked grid), invalidateDrop // on the other dropZones. allDropZones = Ext.dd.DragDropManager.getRelated(me); ln = allDropZones.length; i = 0; for (; i < ln; i++) { dropZone = allDropZones[i]; if (dropZone !== me && dropZone.invalidateDrop) { dropZone.invalidateDrop(); } } me.valid = true; topIndicator = me.getTopIndicator(); bottomIndicator = me.getBottomIndicator(); if (pos === 'before') { topAnchor = 'bc-tl'; bottomAnchor = 'tc-bl'; } else { topAnchor = 'bc-tr'; bottomAnchor = 'tc-br'; } // Calculate arrow positions. Offset them to align exactly with column border line topXY = topIndicator.getAlignToXY(targetHeader.el, topAnchor); bottomXY = bottomIndicator.getAlignToXY(targetHeader.el, bottomAnchor); // constrain the indicators to the viewable section headerCtEl = me.headerCt.el; minX = headerCtEl.getX() - me.indicatorXOffset; maxX = headerCtEl.getX() + headerCtEl.getWidth(); topXY[0] = Ext.Number.constrain(topXY[0], minX, maxX); bottomXY[0] = Ext.Number.constrain(bottomXY[0], minX, maxX); // position and show indicators topIndicator.setXY(topXY); bottomIndicator.setXY(bottomXY); topIndicator.show(); bottomIndicator.show(); // invalidate drop operation and hide indicators } else { me.invalidateDrop(); } }, invalidateDrop: function() { this.valid = false; this.hideIndicators(); }, onNodeOver: function(node, dragZone, e, data) { var me = this, from = data.header, doPosition, to, fromPanel, toPanel; if (data.header.el.dom === node) { doPosition = false; } else { data.isLock = data.isUnlock = false; to = me.getLocation(e, node).header; // Dragging within the same container - always valid doPosition = (from.ownerCt === to.ownerCt); // If from different containers, and they are not sealed, then continue checking if (!doPosition && (!from.ownerCt.sealed && !to.ownerCt.sealed)) { doPosition = true; fromPanel = from.up('tablepanel'); toPanel = to.up('tablepanel'); // If it's a lock operation, check that it's allowable. data.isLock = toPanel.isLocked && !fromPanel.isLocked; data.isUnlock = !toPanel.isLocked && fromPanel.isLocked; if ((data.isUnlock && from.lockable === false) || (data.isLock && !from.isLockable())) { doPosition = false; } } } if (doPosition) { me.positionIndicator(data, node, e); } else { me.valid = false; } return me.valid ? me.dropAllowed : me.dropNotAllowed; }, hideIndicators: function() { var me = this; me.getTopIndicator().hide(); me.getBottomIndicator().hide(); me.lastTargetHeader = me.lastDropPos = null; }, onNodeOut: function() { this.hideIndicators(); }, onNodeDrop: function(node, dragZone, e, data) { if (this.valid) { var dragHeader = data.header, dropLocation = data.dropLocation, targetHeader = dropLocation.header, fromCt = dragHeader.ownerCt, localFromIdx = fromCt.items.indexOf(dragHeader), // Container.items is a MixedCollection toCt = targetHeader.ownerCt, localToIdx = toCt.items.indexOf(targetHeader), headerCt = this.headerCt, columnManager= headerCt.columnManager, fromIdx = columnManager.getHeaderIndex(dragHeader), toIdx = columnManager.getHeaderIndex(targetHeader), colsToMove = dragHeader.isGroupHeader ? dragHeader.query(':not([isGroupHeader])').length : 1, sameCt = fromCt === toCt, scrollerOwner, savedWidth; // Drop position is to the right of the targetHeader, increment the toIdx correctly if (dropLocation.pos === 'after') { localToIdx++; toIdx += targetHeader.isGroupHeader ? targetHeader.query(':not([isGroupHeader])').length : 1; } // If we are dragging in between two HeaderContainers that have had the lockable // mixin injected we will lock/unlock headers in between sections, and then continue // with another execution of onNodeDrop to ensure the header is dropped into the correct group if (data.isLock) { scrollerOwner = fromCt.up('[scrollerOwner]'); scrollerOwner.lock(dragHeader, localToIdx); data.isLock = false; // Now that the header has been transferred into the correct HeaderContainer, recurse, and continue the drop operation with the same dragData this.onNodeDrop(node, dragZone, e, data); } else if (data.isUnlock) { scrollerOwner = fromCt.up('[scrollerOwner]'); scrollerOwner.unlock(dragHeader, localToIdx); data.isUnlock = false; // Now that the header has been transferred into the correct HeaderContainer, recurse, and continue the drop operation with the same dragData this.onNodeDrop(node, dragZone, e, data); } // This is a drop within the same HeaderContainer. else { this.invalidateDrop(); // Cache the width here, we need to get it before we removed it from the DOM savedWidth = dragHeader.getWidth(); // Dragging within the same container. if (sameCt) { // A no-op. This can happen when cross lockable drag operations recurse (see above). // If a drop was a lock/unlock, and the lock/unlock call placed the column in the // desired position (lock places at end, unlock places at beginning) then we're done. if (localToIdx === localFromIdx) { // We still need to inform the rest of the components so that events can be fired. headerCt.onHeaderMoved(dragHeader, colsToMove, fromIdx, toIdx); return; } // If dragging rightwards, then after removal, the insertion index will be less. if (localToIdx > localFromIdx) { localToIdx -= 1; } } // Suspend layouts while we sort all this out. Ext.suspendLayouts(); if (sameCt) { toCt.move(localFromIdx, localToIdx); } else { fromCt.remove(dragHeader, false); toCt.insert(localToIdx, dragHeader); } // Group headers acquire the aggregate width of their child headers // Therefore a child header may not flex; it must contribute a fixed width. // But we restore the flex value when moving back into the main header container if (toCt.isGroupHeader) { // Adjust the width of the "to" group header only if we dragged in from somewhere else. if (!sameCt) { dragHeader.savedFlex = dragHeader.flex; delete dragHeader.flex; dragHeader.width = savedWidth; } } else { if (dragHeader.savedFlex) { dragHeader.flex = dragHeader.savedFlex; delete dragHeader.width; } } // Refresh columns cache in case we remove an emptied group column headerCt.purgeCache(); Ext.resumeLayouts(true); headerCt.onHeaderMoved(dragHeader, colsToMove, fromIdx, toIdx); // Ext.grid.header.Container will handle the removal of empty groups, don't handle it here } } } }); /** * @private */ Ext.define('Ext.grid.plugin.HeaderReorderer', { extend: Ext.AbstractPlugin , alias: 'plugin.gridheaderreorderer', init: function(headerCt) { this.headerCt = headerCt; headerCt.on({ render: this.onHeaderCtRender, single: true, scope: this }); }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { Ext.destroy(this.dragZone, this.dropZone); }, onHeaderCtRender: function() { var me = this; me.dragZone = new Ext.grid.header.DragZone(me.headerCt); me.dropZone = new Ext.grid.header.DropZone(me.headerCt); if (me.disabled) { me.dragZone.disable(); } }, enable: function() { this.disabled = false; if (this.dragZone) { this.dragZone.enable(); } }, disable: function() { this.disabled = true; if (this.dragZone) { this.dragZone.disable(); } } }); /** * Container which holds headers and is docked at the top or bottom of a TablePanel. * The HeaderContainer drives resizing/moving/hiding of columns within the TableView. * As headers are hidden, moved or resized the headercontainer is responsible for * triggering changes within the view. */ Ext.define('Ext.grid.header.Container', { extend: Ext.container.Container , border: true, alias: 'widget.headercontainer', baseCls: Ext.baseCSSPrefix + 'grid-header-ct', dock: 'top', /** * @cfg {Number} weight * HeaderContainer overrides the default weight of 0 for all docked items to 100. * This is so that it has more priority over things like toolbars. */ weight: 100, defaultType: 'gridcolumn', detachOnRemove: false, /** * @cfg {Number} defaultWidth * Width of the header if no width or flex is specified. */ defaultWidth: 100, /** * @cfg {Boolean} [sealed=false] * Specify as `true` to constrain column dragging so that a column cannot be dragged into or out of this column. * * **Note that this config is only valid for column headers which contain child column headers, eg:** * { * sealed: true * text: 'ExtJS', * columns: [{ * text: '3.0.4', * dataIndex: 'ext304' * }, { * text: '4.1.0', * dataIndex: 'ext410' * } * } * */ // sortAscText: 'Sort Ascending', // // sortDescText: 'Sort Descending', // // sortClearText: 'Clear Sort', // // columnsText: 'Columns', // headerOpenCls: Ext.baseCSSPrefix + 'column-header-open', menuSortAscCls: Ext.baseCSSPrefix + 'hmenu-sort-asc', menuSortDescCls: Ext.baseCSSPrefix + 'hmenu-sort-desc', menuColsIcon: Ext.baseCSSPrefix + 'cols-icon', // private; will probably be removed by 4.0 triStateSort: false, ddLock: false, dragging: false, /** * @property {Boolean} isGroupHeader * True if this HeaderContainer is in fact a group header which contains sub headers. */ /** * @cfg {Boolean} sortable * Provides the default sortable state for all Headers within this HeaderContainer. * Also turns on or off the menus in the HeaderContainer. Note that the menu is * shared across every header and therefore turning it off will remove the menu * items for every header. */ sortable: true, /** * @cfg {Boolean} [enableColumnHide=true] * False to disable column hiding within this grid. */ enableColumnHide: true, initComponent: function() { var me = this; me.headerCounter = 0; me.plugins = me.plugins || []; // TODO: Pass in configurations to turn on/off dynamic // resizing and disable resizing all together // Only set up a Resizer and Reorderer for the topmost HeaderContainer. // Nested Group Headers are themselves HeaderContainers if (!me.isColumn) { if (me.enableColumnResize) { me.resizer = new Ext.grid.plugin.HeaderResizer(); me.plugins.push(me.resizer); } if (me.enableColumnMove) { me.reorderer = new Ext.grid.plugin.HeaderReorderer(); me.plugins.push(me.reorderer); } } // If this is a leaf column header, and is NOT functioning as a container, // use Container layout with a no-op calculate method. if (me.isColumn && (!me.items || me.items.length === 0)) { me.isContainer = false; me.layout = { type: 'container', calculate: Ext.emptyFn }; } // HeaderContainer and Group header needs a gridcolumn layout. else { me.layout = Ext.apply({ type: 'gridcolumn', align: 'stretch' }, me.initialConfig.layout); // Create the owning grid's ColumnManager if (me.isRootHeader) { me.grid.columnManager = me.columnManager = new Ext.grid.ColumnManager(me); } } me.defaults = me.defaults || {}; Ext.applyIf(me.defaults, { triStateSort: me.triStateSort, sortable: me.sortable }); me.menuTask = new Ext.util.DelayedTask(me.updateMenuDisabledState, me); me.callParent(); me.addEvents( /** * @event columnresize * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition * @param {Number} width */ 'columnresize', /** * @event headerclick * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition * @param {Ext.EventObject} e * @param {HTMLElement} t */ 'headerclick', /** * @event headercontextmenu * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition * @param {Ext.EventObject} e * @param {HTMLElement} t */ 'headercontextmenu', /** * @event headertriggerclick * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition * @param {Ext.EventObject} e * @param {HTMLElement} t */ 'headertriggerclick', /** * @event columnmove * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition * @param {Number} fromIdx * @param {Number} toIdx */ 'columnmove', /** * @event columnhide * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition */ 'columnhide', /** * @event columnshow * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition */ 'columnshow', /** * @event columnschanged * Fired after the columns change in any way, when a column has been hidden or shown, or when a column * is added to or removed from this header container. * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. */ 'columnschanged', /** * @event sortchange * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers. * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition * @param {String} direction */ 'sortchange', /** * @event menucreate * Fired immediately after the column header menu is created. * @param {Ext.grid.header.Container} ct This instance * @param {Ext.menu.Menu} menu The Menu that was created */ 'menucreate' ); }, isLayoutRoot: function(){ // Since we're docked, the width is always calculated // If we're hidden, the height is explicitly 0, which // means we'll be considered a layout root. However, we // still need the view to layout to update the underlying // table to match the size. if (this.hiddenHeaders) { return false; } return this.callParent(); }, // Find the topmost HeaderContainer getOwnerHeaderCt: function() { var me = this; return me.isRootHeader ? me : me.up('[isRootHeader]'); }, onDestroy: function() { var me = this; if (me.menu) { me.menu.un('hide', me.onMenuHide, me); } me.menuTask.cancel(); Ext.destroy(me.resizer, me.reorderer); me.callParent(); }, applyColumnsState: function(columns) { if (!columns || !columns.length) { return; } var me = this, items = me.items.items, count = items.length, i = 0, length = columns.length, c, col, columnState, index; for (c = 0; c < length; c++) { columnState = columns[c]; for (index = count; index--; ) { col = items[index]; if (col.getStateId && col.getStateId() == columnState.id) { // If a column in the new grid matches up with a saved state... // Ensure that the column is restored to the state order. // i is incremented upon every column match, so all persistent // columns are ordered before any new columns. if (i !== index) { me.moveHeader(index, i); } if (col.applyColumnState) { col.applyColumnState(columnState); } ++i; break; } } } }, getColumnsState: function () { var me = this, columns = [], state; me.items.each(function (col) { state = col.getColumnState && col.getColumnState(); if (state) { columns.push(state); } }); return columns; }, // Invalidate column cache on add // We cannot refresh the View on every add because this method is called // when the HeaderDropZone moves Headers around, that will also refresh the view onAdd: function(c) { var me = this; if (!c.headerId) { c.headerId = c.initialConfig.id || Ext.id(null, 'header-'); } // Only generate a stateId if it really needs one - ie, it cannot yield a stateId if (!c.getStateId()) { // This was the headerId generated in 4.0, so to preserve saved state, we now // assign a default stateId in that same manner. The stateId's of a column are // not global at the stateProvider, but are local to the grid state data. The // headerId should still follow our standard naming convention. c.stateId = c.initialConfig.id || ('h' + (++me.headerCounter)); } if (Ext.global.console && Ext.global.console.warn) { if (!me._usedIDs) { me._usedIDs = {}; } if (me._usedIDs[c.headerId]) { Ext.global.console.warn(this.$className, 'attempted to reuse an existing id', c.headerId); } me._usedIDs[c.headerId] = true; } me.callParent(arguments); me.onColumnsChanged(); }, onMove: function() { this.callParent(arguments); this.onColumnsChanged(); }, onShow: function() { this.callParent(arguments); this.onColumnsChanged(); }, // Private // Called whenever a column is added or removed or moved. // Ensures that the gridColumns caches are cleared. onColumnsChanged: function() { var headerCt = this; // Each HeaderContainer up the chain must have its cache purged so that its getGridColumns method will return correct results. while (headerCt) { headerCt.purgeCache(); if (headerCt.isRootHeader) { break; } headerCt = headerCt.ownerCt; } if (headerCt && headerCt.rendered) { headerCt.fireEvent('columnschanged', headerCt); } }, // Invalidate column cache on remove // We cannot refresh the View on every remove because this method is called // when the HeaderDropZone moves Headers around, that will also refresh the view onRemove: function(c) { var me = this, ownerCt = me.ownerCt; me.callParent(arguments); if (!me._usedIDs) { me._usedIDs = {}; } delete me._usedIDs[c.headerId]; if (!me.destroying) { me.onColumnsChanged(); if (me.isGroupHeader && !me.items.getCount() && ownerCt) { // Detach the header from the DOM here. Since we're removing and destroying the container, // the inner DOM may get overwritten, since Container::deatchOnRemove gets processed after // onRemove. me.detachComponent(c); // If we don't have any items left and we're a group, remove ourselves. // This will cascade up if necessary Ext.suspendLayouts(); ownerCt.remove(me); Ext.resumeLayouts(true); } } }, // @private applyDefaults: function(config) { var ret; /* * Ensure header.Container defaults don't get applied to a RowNumberer * if an xtype is supplied. This isn't an ideal solution however it's * much more likely that a RowNumberer with no options will be created, * wanting to use the defaults specified on the class as opposed to * those setup on the Container. */ if (config && !config.isComponent && config.xtype == 'rownumberer') { ret = config; } else { ret = this.callParent(arguments); // Apply default width unless it's a group header (in which case it must be left to shrinkwrap), or it's flexed if (!config.isGroupHeader && !('width' in ret) && !ret.flex) { ret.width = this.defaultWidth; } } return ret; }, setSortState: function(){ var store = this.up('[store]').store, // grab the first sorter, since there may also be groupers // in this collection first = store.getFirstSorter(), hd; if (first) { hd = this.down('gridcolumn[dataIndex=' + first.property +']'); if (hd) { hd.setSortState(first.direction, false, true); } } else { this.clearOtherSortStates(null); } }, getHeaderMenu: function(){ var menu = this.getMenu(), item; if (menu) { item = menu.child('#columnItem'); if (item) { return item.menu; } } return null; }, onHeaderVisibilityChange: function(header, visible){ var me = this, menu = me.getHeaderMenu(), item; // Invalidate column collections upon column hide/show me.purgeCache(); if (menu) { // If the header was hidden programmatically, sync the Menu state item = me.getMenuItemForHeader(menu, header); if (item) { item.setChecked(visible, true); } // delay this since the headers may fire a number of times if we're hiding/showing groups if (menu.isVisible()) { me.menuTask.delay(50); } } }, updateMenuDisabledState: function(menu) { var me = this, columns = me.query(':not([hidden])'), i, len = columns.length, item, checkItem, method; // If called from menu creation, it will be passed to avoid infinite recursion if (!menu) { menu = me.getMenu(); } for (i = 0; i < len; ++i) { item = columns[i]; checkItem = me.getMenuItemForHeader(menu, item); if (checkItem) { method = item.isHideable() ? 'enable' : 'disable'; if (checkItem.menu) { method += 'CheckChange'; } checkItem[method](); } } }, getMenuItemForHeader: function(menu, header) { return header ? menu.down('menucheckitem[headerId=' + header.id + ']') : null; }, onHeaderShow: function(header) { // Pass up to the GridSection var me = this, gridSection = me.ownerCt; if (me.forceFit) { delete me.flex; } me.onHeaderVisibilityChange(header, true); // Only update the grid UI when we are notified about base level Header shows; // Group header shows just cause a layout of the HeaderContainer if (!header.isGroupHeader) { if (gridSection) { gridSection.onHeaderShow(me, header); } } me.fireEvent('columnshow', me, header); me.fireEvent('columnschanged', this); }, onHeaderHide: function(header) { // Pass up to the GridSection var me = this, gridSection = me.ownerCt; me.onHeaderVisibilityChange(header, false); // Only update the UI when we are notified about base level Header hides; if (!header.isGroupHeader) { if (gridSection) { gridSection.onHeaderHide(me, header); } } me.fireEvent('columnhide', me, header); me.fireEvent('columnschanged', this); }, /** * Temporarily lock the headerCt. This makes it so that clicking on headers * don't trigger actions like sorting or opening of the header menu. This is * done because extraneous events may be fired on the headers after interacting * with a drag drop operation. * @private */ tempLock: function() { this.ddLock = true; Ext.Function.defer(function() { this.ddLock = false; }, 200, this); }, onHeaderResize: function(header, w, suppressFocus) { var me = this, view = me.view, gridSection = me.ownerCt; // Do not react to header sizing during initial Panel layout when there is no view content to size. if (view && view.body.dom) { me.tempLock(); if (gridSection) { gridSection.onHeaderResize(me, header, w); } } me.fireEvent('columnresize', this, header, w); }, onHeaderClick: function(header, e, t) { header.fireEvent('headerclick', this, header, e, t); this.fireEvent('headerclick', this, header, e, t); }, onHeaderContextMenu: function(header, e, t) { header.fireEvent('headercontextmenu', this, header, e, t); this.fireEvent('headercontextmenu', this, header, e, t); }, onHeaderTriggerClick: function(header, e, t) { // generate and cache menu, provide ability to cancel/etc var me = this; if (header.fireEvent('headertriggerclick', me, header, e, t) !== false && me.fireEvent('headertriggerclick', me, header, e, t) !== false) { me.showMenuBy(t, header); } }, showMenuBy: function(t, header) { var menu = this.getMenu(), ascItem = menu.down('#ascItem'), descItem = menu.down('#descItem'), sortableMth; // Use ownerButton as the upward link. Menus *must have no ownerCt* - they are global floaters. // Upward navigation is done using the up() method. menu.activeHeader = menu.ownerButton = header; header.setMenuActive(true); // enable or disable asc & desc menu items based on header being sortable sortableMth = header.sortable ? 'enable' : 'disable'; if (ascItem) { ascItem[sortableMth](); } if (descItem) { descItem[sortableMth](); } menu.showBy(t); }, // remove the trigger open class when the menu is hidden onMenuHide: function(menu) { menu.activeHeader.setMenuActive(false); }, moveHeader: function(fromIdx, toIdx) { // An automatically expiring lock this.tempLock(); this.onHeaderMoved(this.move(fromIdx, toIdx), 1, fromIdx, toIdx); }, purgeCache: function() { var me = this, menu = me.menu; // Delete column cache - column order has changed. me.gridDataColumns = me.hideableColumns = null; // ColumnManager. Only the top if (me.columnManager) { me.columnManager.invalidate(); } // Menu changes when columns are moved. It will be recreated. // Menu does not change when columns are hidden or shown (which is all that happens when menu is visible) if (menu && menu.hidden) { // Must hide before destroy so that trigger el is deactivated menu.hide(); menu.destroy(); me.menu = null; } }, onHeaderMoved: function(header, colsToMove, fromIdx, toIdx) { var me = this, gridSection = me.ownerCt; if (gridSection && gridSection.onHeaderMove) { gridSection.onHeaderMove(me, header, colsToMove, fromIdx, toIdx); } me.fireEvent("columnmove", me, header, fromIdx, toIdx); }, /** * Gets the menu (and will create it if it doesn't already exist) * @private */ getMenu: function() { var me = this; if (!me.menu) { me.menu = new Ext.menu.Menu({ hideOnParentHide: false, // Persists when owning ColumnHeader is hidden items: me.getMenuItems(), listeners: { hide: me.onMenuHide, scope: me } }); me.fireEvent('menucreate', me, me.menu); } me.updateMenuDisabledState(me.menu); return me.menu; }, /** * Returns an array of menu items to be placed into the shared menu * across all headers in this header container. * @returns {Array} menuItems */ getMenuItems: function() { var me = this, menuItems = [], hideableColumns = me.enableColumnHide ? me.getColumnMenu(me) : null; if (me.sortable) { menuItems = [{ itemId: 'ascItem', text: me.sortAscText, cls: me.menuSortAscCls, handler: me.onSortAscClick, scope: me },{ itemId: 'descItem', text: me.sortDescText, cls: me.menuSortDescCls, handler: me.onSortDescClick, scope: me }]; } if (hideableColumns && hideableColumns.length) { if (me.sortable) { menuItems.push('-'); } menuItems.push({ itemId: 'columnItem', text: me.columnsText, cls: me.menuColsIcon, menu: hideableColumns, hideOnClick: false }); } return menuItems; }, // sort asc when clicking on item in menu onSortAscClick: function() { var menu = this.getMenu(), activeHeader = menu.activeHeader; activeHeader.setSortState('ASC'); }, // sort desc when clicking on item in menu onSortDescClick: function() { var menu = this.getMenu(), activeHeader = menu.activeHeader; activeHeader.setSortState('DESC'); }, /** * Returns an array of menu CheckItems corresponding to all immediate children * of the passed Container which have been configured as hideable. */ getColumnMenu: function(headerContainer) { var menuItems = [], i = 0, item, items = headerContainer.query('>gridcolumn[hideable]'), itemsLn = items.length, menuItem; for (; i < itemsLn; i++) { item = items[i]; menuItem = new Ext.menu.CheckItem({ text: item.menuText || item.text, checked: !item.hidden, hideOnClick: false, headerId: item.id, menu: item.isGroupHeader ? this.getColumnMenu(item) : undefined, checkHandler: this.onColumnCheckChange, scope: this }); menuItems.push(menuItem); // If the header is ever destroyed - for instance by dragging out the last remaining sub header, // then the associated menu item must also be destroyed. item.on({ destroy: Ext.Function.bind(menuItem.destroy, menuItem) }); } return menuItems; }, onColumnCheckChange: function(checkItem, checked) { var header = Ext.getCmp(checkItem.headerId); header[checked ? 'show' : 'hide'](); }, /** * Returns the number of grid columns descended from this HeaderContainer. * Group Columns are HeaderContainers. All grid columns are returned, including hidden ones. */ getColumnCount: function() { return this.getGridColumns().length; }, /** * Gets the full width of all columns that are visible. */ getFullWidth: function() { var fullWidth = 0, headers = this.getVisibleGridColumns(), headersLn = headers.length, i = 0, header; for (; i < headersLn; i++) { header = headers[i]; // use headers getDesiredWidth if its there if (header.getDesiredWidth) { fullWidth += header.getDesiredWidth() || 0; // if injected a diff cmp use getWidth } else { fullWidth += header.getWidth(); } } return fullWidth; }, // invoked internally by a header when not using triStateSorting clearOtherSortStates: function(activeHeader) { var headers = this.getGridColumns(), headersLn = headers.length, i = 0; for (; i < headersLn; i++) { if (headers[i] !== activeHeader) { // unset the sortstate and dont recurse headers[i].setSortState(null, true); } } }, /** * Returns an array of the **visible** columns in the grid. This goes down to the lowest column header * level, and does not return **grouped** headers which contain sub headers. * @returns {Array} */ getVisibleGridColumns: function() { var allColumns = this.getGridColumns(), result = [], len = allColumns.length, i; // Use an inline check instead of ComponentQuery filtering for better performance for // repeated grid row rendering - as in buffered rendering. for (i = 0; i < len; i++) { if (!allColumns[i].hidden) { result[result.length] = allColumns[i]; } } return result; }, /** * Returns an array of all columns which appear in the grid's View. This goes down to the leaf column header * level, and does not return **grouped** headers which contain sub headers. * * It includes hidden headers even though they are not rendered. This is for collection of menu items for the column hide/show menu. * * Headers which have a hidden ancestor have a `hiddenAncestor: true` property injected so that they can also be rendered at zero width without interrogating * that header's ownerCt axis for a hidden ancestor. * @returns {Array} */ getGridColumns: function(/* private - used in recursion*/inResult, hiddenAncestor) { if (!inResult && this.gridDataColumns) { return this.gridDataColumns; } var me = this, result = inResult || [], items, i, len, item, lastVisibleColumn; hiddenAncestor = hiddenAncestor || me.hidden; if (me.items) { items = me.items.items; for (i = 0, len = items.length; i < len; i++) { item = items[i]; if (item.isGroupHeader) { item.getGridColumns(result, hiddenAncestor); } else { item.hiddenAncestor = hiddenAncestor; result.push(item); } } } if (!inResult) { me.gridDataColumns = result; } // If top level, correct first and last visible column flags if (!inResult && len) { // Set firstVisible and lastVisible flags for (i = 0, len = result.length; i < len; i++) { item = result[i]; item.isFirstVisible = item.isLastVisible = false; if (!(item.hidden || item.hiddenAncestor)) { if (!lastVisibleColumn) { item.isFirstVisible = true; } lastVisibleColumn = item; } } // If we haven't hidden all columns, tag the last visible one encountered if (lastVisibleColumn) { lastVisibleColumn.isLastVisible = true; } } return result; }, /** * @private * For use by column headers in determining whether there are any hideable columns when deciding whether or not * the header menu should be disabled. */ getHideableColumns: function() { var me = this, result = me.hideableColumns; if (!result) { result = me.hideableColumns = me.query('[hideable]'); } return result; }, /** * Returns the index of a leaf level header regardless of what the nesting * structure is. * * If a group header is passed, the index of the first leaf level header within it is returned. * * @param {Ext.grid.column.Column} header The header to find the index of * @return {Number} The index of the specified column header */ getHeaderIndex: function(header) { return this.columnManager.getHeaderIndex(header); }, /** * Get a leaf level header by index regardless of what the nesting * structure is. * @param {Number} index The column index for which to retrieve the column. */ getHeaderAtIndex: function(index) { return this.columnManager.getHeaderAtIndex(index); }, /** * When passed a column index, returns the closet *visible* column to that. If the column at the passed index is visible, * that is returned. If it is hidden, either the next visible, or the previous visible column is returned. * @param {Number} index Position at which to find the closest visible column. */ getVisibleHeaderClosestToIndex: function(index) { return this.columnManager.getVisibleHeaderClosestToIndex(index); }, autoSizeColumn : function(header) { var view = this.view; if (view) { view.autoSizeColumn(header); } } }); /** * This class specifies the definition for a column inside a {@link Ext.grid.Panel}. It encompasses * both the grid header configuration as well as displaying data within the grid itself. If the * {@link #columns} configuration is specified, this column will become a column group and can * contain other columns inside. In general, this class will not be created directly, rather * an array of column configurations will be passed to the grid: * * @example * Ext.create('Ext.data.Store', { * storeId:'employeeStore', * fields:['firstname', 'lastname', 'seniority', 'dep', 'hired'], * data:[ * {firstname:"Michael", lastname:"Scott", seniority:7, dep:"Management", hired:"01/10/2004"}, * {firstname:"Dwight", lastname:"Schrute", seniority:2, dep:"Sales", hired:"04/01/2004"}, * {firstname:"Jim", lastname:"Halpert", seniority:3, dep:"Sales", hired:"02/22/2006"}, * {firstname:"Kevin", lastname:"Malone", seniority:4, dep:"Accounting", hired:"06/10/2007"}, * {firstname:"Angela", lastname:"Martin", seniority:5, dep:"Accounting", hired:"10/21/2008"} * ] * }); * * Ext.create('Ext.grid.Panel', { * title: 'Column Demo', * store: Ext.data.StoreManager.lookup('employeeStore'), * columns: [ * {text: 'First Name', dataIndex:'firstname'}, * {text: 'Last Name', dataIndex:'lastname'}, * {text: 'Hired Month', dataIndex:'hired', xtype:'datecolumn', format:'M'}, * {text: 'Department (Yrs)', xtype:'templatecolumn', tpl:'{dep} ({seniority})'} * ], * width: 400, * forceFit: true, * renderTo: Ext.getBody() * }); * * # Convenience Subclasses * * There are several column subclasses that provide default rendering for various data types * * - {@link Ext.grid.column.Action}: Renders icons that can respond to click events inline * - {@link Ext.grid.column.Boolean}: Renders for boolean values * - {@link Ext.grid.column.Date}: Renders for date values * - {@link Ext.grid.column.Number}: Renders for numeric values * - {@link Ext.grid.column.Template}: Renders a value using an {@link Ext.XTemplate} using the record data * * # Setting Sizes * * The columns are laid out by a {@link Ext.layout.container.HBox} layout, so a column can either * be given an explicit width value or a flex configuration. If no width is specified the grid will * automatically the size the column to 100px. For column groups, the size is calculated by measuring * the width of the child columns, so a width option should not be specified in that case. * * # Header Options * * - {@link #text}: Sets the header text for the column * - {@link #sortable}: Specifies whether the column can be sorted by clicking the header or using the column menu * - {@link #hideable}: Specifies whether the column can be hidden using the column menu * - {@link #menuDisabled}: Disables the column header menu * - {@link #cfg-draggable}: Specifies whether the column header can be reordered by dragging * - {@link #groupable}: Specifies whether the grid can be grouped by the column dataIndex. See also {@link Ext.grid.feature.Grouping} * * # Data Options * * - {@link #dataIndex}: The dataIndex is the field in the underlying {@link Ext.data.Store} to use as the value for the column. * - {@link #renderer}: Allows the underlying store value to be transformed before being displayed in the grid */ Ext.define('Ext.grid.column.Column', { extend: Ext.grid.header.Container , alias: 'widget.gridcolumn', alternateClassName: 'Ext.grid.Column', baseCls: Ext.baseCSSPrefix + 'column-header', // Not the standard, automatically applied overCls because we must filter out overs of child headers. hoverCls: Ext.baseCSSPrefix + 'column-header-over', handleWidth: 4, sortState: null, possibleSortStates: ['ASC', 'DESC'], childEls: [ 'titleEl', 'triggerEl', 'textEl' ], /** * @private * @cfg {Boolean} [noWrap=true] * The default setting indicates that external CSS rules dictate that the title is `white-space: nowrap` and * therefore, width cannot affect the measured height by causing text wrapping. This is what the Sencha-supplied * styles set. If you change those styles to allow text wrapping, you must set this to `false`. */ noWrap: true, renderTpl: '
    ' + '' + '{text}' + '' + ''+ '
    ' + '
    ' + '
    ' + '{%this.renderContainer(out,values)%}', /** * @cfg {Object[]} columns * An optional array of sub-column definitions. This column becomes a group, and houses the columns defined in the * `columns` config. * * Group columns may not be sortable. But they may be hideable and moveable. And you may move headers into and out * of a group. Note that if all sub columns are dragged out of a group, the group is destroyed. */ /** * @override * @cfg {String} stateId * An identifier which identifies this column uniquely within the owning grid's {@link #stateful state}. * * This does not have to be *globally* unique. A column's state is not saved standalone. It is encapsulated within * the owning grid's state. */ /** * @cfg {String} dataIndex * The name of the field in the grid's {@link Ext.data.Store}'s {@link Ext.data.Model} definition from * which to draw the column's value. **Required.** */ dataIndex: null, /** * @cfg {String} text * The header text to be used as innerHTML (html tags are accepted) to display in the Grid. * **Note**: to have a clickable header with no text displayed you can use the default of ` ` aka ` `. */ text: ' ', /** * @cfg {String} header * The header text. * @deprecated 4.0 Use {@link #text} instead. */ /** * @cfg {String} menuText * The text to render in the column visibility selection menu for this column. If not * specified, will default to the text value. */ menuText: null, /** * @cfg {String} [emptyCellText=undefined] * The text to diplay in empty cells (cells with a value of `undefined`, `null`, or `''`). * * Defaults to ` ` aka ` `. */ emptyCellText: ' ', /** * @cfg {Boolean} sortable * False to disable sorting of this column. Whether local/remote sorting is used is specified in * `{@link Ext.data.Store#remoteSort}`. */ sortable: true, /** * @cfg {Boolean} lockable * If the grid is configured with {@link Ext.panel.Table#enableLocking enableLocking}, or has columns which are * configured with a {@link #locked} value, this option may be used to disable user-driven locking or unlocking * of this column. This column will remain in the side into which its own {@link #locked} configuration placed it. */ /** * @cfg {Boolean} groupable * If the grid uses a {@link Ext.grid.feature.Grouping}, this option may be used to disable the header menu * item to group by the column selected. By default, the header menu group option is enabled. Set to false to * disable (but still show) the group option in the header menu for the column. */ /** * @cfg {Boolean} fixed * True to prevent the column from being resizable. * @deprecated 4.0 Use {@link #resizable} instead. */ /** * @cfg {Boolean} [locked=false] * True to lock this column in place. Implicitly enables locking on the grid. * See also {@link Ext.grid.Panel#enableLocking}. */ /** * @cfg {Boolean} resizable * False to prevent the column from being resizable. */ resizable: true, /** * @cfg {Boolean} hideable * False to prevent the user from hiding this column. */ hideable: true, /** * @cfg {Boolean} menuDisabled * True to disable the column header menu containing sort/hide options. */ menuDisabled: false, /** * @cfg {Function/String} renderer * A renderer is an 'interceptor' method which can be used to transform data (value, appearance, etc.) * before it is rendered. Example: * * { * renderer: function(value){ * if (value === 1) { * return '1 person'; * } * return value + ' people'; * } * } * * Additionally a string naming an {@link Ext.util.Format} method can be passed: * * { * renderer: 'uppercase' * } * * @cfg {Object} renderer.value The data value for the current cell * @cfg {Object} renderer.metaData A collection of metadata about the current cell; can be used or modified * by the renderer. Recognized properties are: tdCls, tdAttr, and style. * @cfg {Ext.data.Model} renderer.record The record for the current row * @cfg {Number} renderer.rowIndex The index of the current row * @cfg {Number} renderer.colIndex The index of the current column * @cfg {Ext.data.Store} renderer.store The data store * @cfg {Ext.view.View} renderer.view The current view * @cfg {String} renderer.return The HTML string to be rendered. */ renderer: false, /** * @cfg {Object} scope * The scope to use when calling the {@link #renderer} function. */ /** * @method defaultRenderer * When defined this will take precedence over the {@link Ext.grid.column.Column#renderer renderer} config. * This is meant to be defined in subclasses that wish to supply their own renderer. * @protected * @template */ /** * @cfg {Function} editRenderer * A renderer to be used in conjunction with {@link Ext.grid.plugin.RowEditing RowEditing}. This renderer is used to * display a custom value for non-editable fields. */ editRenderer: false, /** * @cfg {String} align * Sets the alignment of the header and rendered columns. * Possible values are: `'left'`, `'center'`, and `'right'`. */ align: 'left', /** * @cfg {Boolean} draggable * False to disable drag-drop reordering of this column. */ draggable: true, /** * @cfg {String} tooltip * A tooltip to display for this column header */ /** * @cfg {String} [tooltipType="qtip"] * The type of {@link #tooltip} to use. Either 'qtip' for QuickTips or 'title' for title attribute. */ tooltipType: 'qtip', // Header does not use the typical ComponentDraggable class and therefore we // override this with an emptyFn. It is controlled at the HeaderDragZone. initDraggable: Ext.emptyFn, /** * @cfg {String} tdCls * A CSS class names to apply to the table cells for this column. */ tdCls: '', /** * @cfg {Object/String} editor * An optional xtype or config object for a {@link Ext.form.field.Field Field} to use for editing. * Only applicable if the grid is using an {@link Ext.grid.plugin.Editing Editing} plugin. */ /** * @cfg {Object/String} field * Alias for {@link #editor}. * @deprecated 4.0.5 Use {@link #editor} instead. */ /** * @property {Ext.Element} triggerEl * Element that acts as button for column header dropdown menu. */ /** * @property {Ext.Element} textEl * Element that contains the text in column header. */ /** * @property {Boolean} isHeader * @deprecated see isColumn * Set in this class to identify, at runtime, instances which are not instances of the * HeaderContainer base class, but are in fact, the subclass: Header. */ isHeader: true, /** * @property {Boolean} isColumn * @readonly * Set in this class to identify, at runtime, instances which are not instances of the * HeaderContainer base class, but are in fact simple column headers. */ isColumn: true, ascSortCls: Ext.baseCSSPrefix + 'column-header-sort-ASC', descSortCls: Ext.baseCSSPrefix + 'column-header-sort-DESC', componentLayout: 'columncomponent', groupSubHeaderCls: Ext.baseCSSPrefix + 'group-sub-header', groupHeaderCls: Ext.baseCSSPrefix + 'group-header', clickTargetName: 'titleEl', // So that when removing from group headers which are then empty and then get destroyed, there's no child DOM left detachOnRemove : true, // We need to override the default component resizable behaviour here initResizable: Ext.emptyFn, initComponent: function() { var me = this, renderer, listeners; if (me.header != null) { me.text = me.header; me.header = null; } if (!me.triStateSort) { me.possibleSortStates.length = 2; } // A group header; It contains items which are themselves Headers if (me.columns != null) { me.isGroupHeader = true; if (me.dataIndex) { Ext.Error.raise('Ext.grid.column.Column: Group header may not accept a dataIndex'); } if ((me.width && me.width !== Ext.grid.header.Container.prototype.defaultWidth) || me.flex) { Ext.Error.raise('Ext.grid.column.Column: Group header does not support setting explicit widths or flexs. The group header width is calculated by the sum of its children.'); } // The headers become child items me.items = me.columns; me.columns = me.flex = me.width = null; me.cls = (me.cls||'') + ' ' + me.groupHeaderCls; // A group cannot be sorted, or resized - it shrinkwraps its children me.sortable = me.resizable = false; me.align = 'center'; } else { // Flexed Headers need to have a minWidth defined so that they can never be squeezed out of existence by the // HeaderContainer's specialized Box layout, the ColumnLayout. The ColumnLayout's overridden calculateChildboxes // method extends the available layout space to accommodate the "desiredWidth" of all the columns. if (me.flex) { me.minWidth = me.minWidth || Ext.grid.plugin.HeaderResizer.prototype.minColWidth; } } me.addCls(Ext.baseCSSPrefix + 'column-header-align-' + me.align); renderer = me.renderer; if (renderer) { // When specifying a renderer as a string, it always resolves // to Ext.util.Format if (typeof renderer == 'string') { me.renderer = Ext.util.Format[renderer]; } me.hasCustomRenderer = true; } else if (me.defaultRenderer) { me.scope = me; me.renderer = me.defaultRenderer; } // Initialize as a HeaderContainer me.callParent(arguments); listeners = { element: me.clickTargetName, click: me.onTitleElClick, contextmenu: me.onTitleElContextMenu, mouseenter: me.onTitleMouseOver, mouseleave: me.onTitleMouseOut, scope: me }; if (me.resizable) { listeners.dblclick = me.onTitleElDblClick; } me.on(listeners); }, onAdd: function(child) { if (child.isColumn) { child.isSubHeader = true; child.addCls(this.groupSubHeaderCls); } if (this.hidden) { child.hide(); } this.callParent(arguments); }, onRemove: function(child) { if (child.isSubHeader) { child.isSubHeader = false; child.removeCls(this.groupSubHeaderCls); } this.callParent(arguments); }, initRenderData: function() { var me = this, tipMarkup = '', tip = me.tooltip, attr = me.tooltipType == 'qtip' ? 'data-qtip' : 'title'; if (!Ext.isEmpty(tip)) { tipMarkup = attr + '="' + tip + '" '; } return Ext.applyIf(me.callParent(arguments), { text: me.text, menuDisabled: me.menuDisabled, tipMarkup: tipMarkup }); }, applyColumnState: function (state) { var me = this; // apply any columns me.applyColumnsState(state.columns); // Only state properties which were saved should be restored. // (Only user-changed properties were saved by getState) if (state.hidden != null) { me.hidden = state.hidden; } if (state.locked != null) { me.locked = state.locked; } if (state.sortable != null) { me.sortable = state.sortable; } if (state.width != null) { me.flex = null; me.width = state.width; } else if (state.flex != null) { me.width = null; me.flex = state.flex; } }, getColumnState: function () { var me = this, items = me.items.items, // Check for the existence of items, since column.Action won't have them iLen = items ? items.length : 0, i, columns = [], state = { id: me.getStateId() }; me.savePropsToState(['hidden', 'sortable', 'locked', 'flex', 'width'], state); if (me.isGroupHeader) { for (i = 0; i < iLen; i++) { columns.push(items[i].getColumnState()); } if (columns.length) { state.columns = columns; } } else if (me.isSubHeader && me.ownerCt.hidden) { // don't set hidden on the children so they can auto height delete me.hidden; } if ('width' in state) { delete state.flex; // width wins } return state; }, getStateId: function () { return this.stateId || this.headerId; }, /** * Sets the header text for this Column. * @param {String} text The header to display on this Column. */ setText: function(text) { this.text = text; if (this.rendered) { this.textEl.update(text); } }, /** * Returns the index of this column only if this column is a base level Column. If it * is a group column, it returns `false`. * @return {Number} */ getIndex: function() { return this.isGroupColumn ? false : this.getOwnerHeaderCt().getHeaderIndex(this); }, /** * Returns the index of this column in the list of *visible* columns only if this column is a base level Column. If it * is a group column, it returns `false`. * @return {Number} */ getVisibleIndex: function() { return this.isGroupColumn ? false : Ext.Array.indexOf(this.getOwnerHeaderCt().getVisibleGridColumns(), this); }, beforeRender: function() { var me = this, grid = me.up('tablepanel'); me.callParent(); // Disable the menu if there's nothing to show in the menu, ie: // Column cannot be sorted, grouped or locked, and there are no grid columns which may be hidden if (grid && (!me.sortable || grid.sortableColumns === false) && !me.groupable && !me.lockable && (grid.enableColumnHide === false || !me.getOwnerHeaderCt().getHideableColumns().length)) { me.menuDisabled = true; } me.protoEl.unselectable(); }, afterRender: function() { var me = this, triggerEl = me.triggerEl, triggerWidth; me.callParent(arguments); // BrowserBug: Ie8 Strict Mode, this will break the focus for this browser, // must be fixed when focus management will be implemented. if (!Ext.isIE8 || !Ext.isStrict) { me.mon(me.getFocusEl(), { focus: me.onTitleMouseOver, blur: me.onTitleMouseOut, scope: me }); } if (triggerEl && me.self.triggerElWidth === undefined) { triggerEl.setStyle('display', 'block'); me.self.triggerElWidth = triggerEl.getWidth(); triggerEl.setStyle('display', ''); } me.keyNav = new Ext.util.KeyNav(me.el, { enter: me.onEnterKey, down: me.onDownKey, scope: me }); }, // private // Inform the header container about the resize afterComponentLayout: function(width, height, oldWidth, oldHeight) { var me = this, ownerHeaderCt = me.getOwnerHeaderCt(); me.callParent(arguments); if (ownerHeaderCt && (oldWidth != null || me.flex) && width !== oldWidth) { ownerHeaderCt.onHeaderResize(me, width, true); } }, onDestroy: function() { var me = this; // force destroy on the textEl, IE reports a leak Ext.destroy(me.textEl, me.keyNav, me.field); me.keyNav = null; me.callParent(arguments); }, onTitleMouseOver: function() { this.titleEl.addCls(this.hoverCls); }, onTitleMouseOut: function() { this.titleEl.removeCls(this.hoverCls); }, onDownKey: function(e) { if (this.triggerEl) { this.onTitleElClick(e, this.triggerEl.dom || this.el.dom); } }, onEnterKey: function(e) { this.onTitleElClick(e, this.el.dom); }, /** * @private * Double click handler which, if on left or right edges, auto-sizes the column to the left. * @param e The dblclick event */ onTitleElDblClick: function(e, t) { var me = this, prev, leafColumns; // On left edge, resize previous *leaf* column in the grid if (me.isOnLeftEdge(e)) { // Look for the previous visible column header which is a leaf // Note: previousNode can walk out of the container (this may be first child of a group) prev = me.previousNode('gridcolumn:not([hidden]):not([isGroupHeader])'); // If found in the same grid, autosize it if (prev && prev.getOwnerHeaderCt() === me.getOwnerHeaderCt()) { prev.autoSize(); } } // On right edge, resize this column, or last sub-column within it else if (me.isOnRightEdge(e)) { // Click on right but in child container - autosize last leaf column if (me.isGroupHeader && e.getPoint().isContainedBy(me.layout.innerCt)) { leafColumns = me.query('gridcolumn:not([hidden]):not([isGroupHeader])'); this.getOwnerHeaderCt().autoSizeColumn(leafColumns[leafColumns.length - 1]); return; } me.autoSize(); } }, /** * Sizes this Column to fit the max content width. * *Note that group columns shrinkwrap around the size of leaf columns. Auto sizing a group column * autosizes descendant leaf columns.* * @param {Ext.grid.column.Column/Number} The header (or index of header) to auto size. */ autoSize: function() { var me = this, leafColumns, numLeaves, i, headerCt; // Group headers are shrinkwrap width, so autosizing one means autosizing leaf descendants. if (me.isGroupHeader) { leafColumns = me.query('gridcolumn:not([hidden]):not([isGroupHeader])'); numLeaves = leafColumns.length; headerCt = this.getOwnerHeaderCt(); Ext.suspendLayouts(); for (i = 0; i < numLeaves; i++) { headerCt.autoSizeColumn(leafColumns[i]); } Ext.resumeLayouts(true); return; } this.getOwnerHeaderCt().autoSizeColumn(this); }, onTitleElClick: function(e, t) { // The grid's docked HeaderContainer. var me = this, ownerHeaderCt = me.getOwnerHeaderCt(); if (ownerHeaderCt && !ownerHeaderCt.ddLock) { // Firefox doesn't check the current target in a within check. // Therefore we check the target directly and then within (ancestors) if (me.triggerEl && (e.target === me.triggerEl.dom || t === me.triggerEl.dom || e.within(me.triggerEl))) { ownerHeaderCt.onHeaderTriggerClick(me, e, t); // if its not on the left hand edge, sort } else if (e.getKey() || (!me.isOnLeftEdge(e) && !me.isOnRightEdge(e))) { me.toggleSortState(); ownerHeaderCt.onHeaderClick(me, e, t); } } }, onTitleElContextMenu: function(e, t) { // The grid's docked HeaderContainer. var me = this, ownerHeaderCt = me.getOwnerHeaderCt(); if (ownerHeaderCt && !ownerHeaderCt.ddLock) { ownerHeaderCt.onHeaderContextMenu(me, e, t); } }, /** * @private * Process UI events from the view. The owning TablePanel calls this method, relaying events from the TableView * @param {String} type Event type, eg 'click' * @param {Ext.view.Table} view TableView Component * @param {HTMLElement} cell Cell HtmlElement the event took place within * @param {Number} recordIndex Index of the associated Store Model (-1 if none) * @param {Number} cellIndex Cell index within the row * @param {Ext.EventObject} e Original event */ processEvent: function(type, view, cell, recordIndex, cellIndex, e) { return this.fireEvent.apply(this, arguments); }, toggleSortState: function() { var me = this, idx, nextIdx; if (me.sortable) { idx = Ext.Array.indexOf(me.possibleSortStates, me.sortState); nextIdx = (idx + 1) % me.possibleSortStates.length; me.setSortState(me.possibleSortStates[nextIdx]); } }, doSort: function(state) { var tablePanel = this.up('tablepanel'), store = tablePanel.store; // If the owning Panel's store is a NodeStore, this means that we are the unlocked side // of a locked TreeGrid. We must use the TreeStore's sort method because we cannot // reorder the NodeStore - that would break the tree. if (tablePanel.ownerLockable && store.isNodeStore) { store = tablePanel.ownerLockable.lockedGrid.store; } store.sort({ property: this.getSortParam(), direction: state }); }, /** * Returns the parameter to sort upon when sorting this header. By default this returns the dataIndex and will not * need to be overriden in most cases. * @return {String} */ getSortParam: function() { return this.dataIndex; }, setSortState: function(state, skipClear, initial) { var me = this, ascCls = me.ascSortCls, descCls = me.descSortCls, ownerHeaderCt = me.getOwnerHeaderCt(), oldSortState = me.sortState; state = state || null; if (!me.sorting && oldSortState !== state && (me.getSortParam() != null)) { // don't trigger a sort on the first time, we just want to update the UI if (state && !initial) { // when sorting, it will call setSortState on the header again once // refresh is called me.sorting = true; me.doSort(state); me.sorting = false; } switch (state) { case 'DESC': me.addCls(descCls); me.removeCls(ascCls); break; case 'ASC': me.addCls(ascCls); me.removeCls(descCls); break; default: me.removeCls([ascCls, descCls]); } if (ownerHeaderCt && !me.triStateSort && !skipClear) { ownerHeaderCt.clearOtherSortStates(me); } me.sortState = state; // we only want to fire the event if we have a null state when using triStateSort if (me.triStateSort || state != null) { ownerHeaderCt.fireEvent('sortchange', ownerHeaderCt, me, state); } } }, /** * Determines whether the UI should be allowed to offer an option to hide this column. * * A column may *not* be hidden if to do so would leave the grid with no visible columns. * * This is used to determine the enabled/disabled state of header hide menu items. */ isHideable: function() { var result = { hideCandidate: this, result: this.hideable }; if (result.result) { this.ownerCt.bubble(this.hasOtherMenuEnabledChildren, null, [result]); } return result.result; }, // Private bubble function used in determining whether this column is hideable. // Executes in the scope of each component in the bubble sequence hasOtherMenuEnabledChildren: function(result) { var visibleChildren, count; // If we've bubbled out the top of the topmost HeaderContainer without finding a level with at least one visible, // menu-enabled child *which is not the hideCandidate*, no hide! if (!this.isXType('headercontainer')) { result.result = false; return false; } // If we find an ancestor level with at leat one visible, menu-enabled child *which is not the hideCandidate*, // then the hideCandidate is hideable. // Note that we are not using CQ #id matchers - ':not(#' + result.hideCandidate.id + ')' - to exclude // the hideCandidate because CQ queries are cached for the document's lifetime. visibleChildren = this.query('>:not([hidden]):not([menuDisabled])'); count = visibleChildren.length; if (Ext.Array.contains(visibleChildren, result.hideCandidate)) { count--; } if (count) { return false; } // If we go up, it's because the hideCandidate was the only hideable child, so *this* becomes the hide candidate. result.hideCandidate = this; }, /** * Determines whether the UI should be allowed to offer an option to lock or unlock this column. Note * that this includes dragging a column into the opposite side of a {@link Ext.panel.Table#enableLocking lockable} grid. * * A column may *not* be moved from one side to the other of a {@link Ext.panel.Table#enableLocking lockable} grid * if to do so would leave one side with no visible columns. * * This is used to determine the enabled/disabled state of the lock/unlock * menu item used in {@link Ext.panel.Table#enableLocking lockable} grids, and to determine dropppabilty when dragging a header. */ isLockable: function() { var result = { result: this.lockable !== false }; if (result.result) { this.ownerCt.bubble(this.hasMultipleVisibleChildren, null, [result]); } return result.result; }, /* * Determines whether this column is in the locked side of a grid. It may be a descendant node of a locked column * and as such will *not* have the {@link #locked} flag set. */ isLocked: function() { return this.locked || !!this.up('[isColumn][locked]', '[isRootHeader]'); }, // Private bubble function used in determining whether this column is lockable. // Executes in the scope of each component in the bubble sequence hasMultipleVisibleChildren: function(result) { // If we've bubbled out the top of the topmost HeaderContainer without finding a level with more than one visible child, no hide! if (!this.isXType('headercontainer')) { result.result = false; return false; } // If we find an ancestor level with more than one visible child, it's fine to hide if (this.query('>:not([hidden])').length > 1) { return false; } }, hide: function(fromOwner) { var me = this, ownerHeaderCt = me.getOwnerHeaderCt(), owner = me.ownerCt, ownerIsGroup, item, items, len, i; if (!me.isVisible()) { // Already hidden return me; } // If we have no ownerHeaderCt, it's during object construction, so // just set the hidden flag and jump out if (!ownerHeaderCt) { me.callParent(); return me; } // Save our last shown width so we can gain space when shown back into fully flexed HeaderContainer. // If we are, say, flex: 1 and all others are fixed width, then removing will do a layout which will // convert all widths to flexes which will mean this flex value is too small. if (ownerHeaderCt.forceFit) { me.visibleSiblingCount = ownerHeaderCt.getVisibleGridColumns().length - 1; if (me.flex) { me.savedWidth = me.getWidth(); me.flex = null; } } ownerIsGroup = owner.isGroupHeader; // owner is a group, hide call didn't come from the owner if (ownerIsGroup && !fromOwner) { items = owner.query('>:not([hidden])'); // The owner only has one item that isn't hidden and it's me; hide the owner. if (items.length === 1 && items[0] == me) { me.ownerCt.hide(); return; } } Ext.suspendLayouts(); if (me.isGroupHeader) { items = me.items.items; for (i = 0, len = items.length; i < len; i++) { item = items[i]; if (!item.hidden) { item.hide(true); } } } me.callParent(); // Notify owning HeaderContainer ownerHeaderCt.onHeaderHide(me); Ext.resumeLayouts(true); return me; }, show: function(fromOwner, fromChild) { var me = this, ownerHeaderCt = me.getOwnerHeaderCt(), ownerCt = me.ownerCt, items, len, i, item, myWidth, availFlex, totalFlex, oldLen, defaultWidth = Ext.grid.header.Container.prototype.defaultWidth; if (me.isVisible()) { return me; } if (!me.rendered) { me.hidden = false; return; } availFlex = ownerHeaderCt.el.getViewSize().width - (ownerHeaderCt.view.el.dom.scrollHeight > ownerHeaderCt.view.el.dom.clientHeight ? Ext.getScrollbarSize().width : 0); // Size all other columns to accommodate re-shown column if (ownerHeaderCt.forceFit) { // Find all non-flexed visible siblings items = Ext.ComponentQuery.query(':not([flex])', ownerHeaderCt.getVisibleGridColumns()); // Not all siblings have been converted to flex. // The full conversion of all to flex only happens when the headerCt's ColumnLayout detects that there are no flexed children. // Therefore, to force the fit, it converts all widths to flexes. // So as long as we are not in that situation with artificial flexes, original column widths can be restored. if (items.length) { me.width = me.savedWidth || me.width || defaultWidth; } // Showing back into a fully flexed HeaderContainer else { items = ownerHeaderCt.getVisibleGridColumns(); len = items.length; oldLen = me.visibleSiblingCount; // Attempt to restore to a flex equal to saved width. // If no saved width, it's the first show, use the width. // The first show of a flex inside a forceFit container cannot work properly because flex values will // have been allocated as the flexed pixel width. myWidth = (me.savedWidth || me.width || defaultWidth); // Scale the restoration width depending on whether there are now more or fewer visible // siblings than we this column was hidden. // // For example, if this was hidden when there was only one other sibling, it's going to // look VERY greedy now if it tries to claim all the space saved in 'savedWidth'. // // Likewise if there were lots of other columns present when this was hidden, but few now, this would // get squeezed out of existence. myWidth = Math.min(myWidth * (oldLen / len), defaultWidth, Math.max(availFlex - (len * defaultWidth), defaultWidth)); me.width = null; me.flex = myWidth; availFlex -= myWidth; totalFlex = 0; for (i = 0; i < len; i++) { item = items[i]; item.flex = (item.width || item.getWidth()); totalFlex += item.flex; item.width = null; } // Now distribute the flex values so that they all add up to the total available flex *minus the flex of this* // The theory here is that the column should *ideally* return to its original size with its flex value being its // original size and the remaining flex distributed according to width proportions. for (i = 0; i < len; i++) { item = items[i]; item.flex = item.flex / totalFlex * availFlex; } } } Ext.suspendLayouts(); // If a sub header, ensure that the group header is visible if (me.isSubHeader && ownerCt.hidden) { ownerCt.show(false, true); } me.callParent(arguments); // If we've just shown a group with all its sub headers hidden, then show all its sub headers if (me.isGroupHeader && fromChild !== true && !me.query(':not([hidden])').length) { items = me.items.items; for (i = 0, len = items.length; i < len; i++) { item = items[i]; if (item.hidden) { item.show(true); } } } Ext.resumeLayouts(true); // Notify owning HeaderContainer AFTER layout has been flushed so that header and headerCt widths are all correct ownerCt = me.getOwnerHeaderCt(); if (ownerCt) { ownerCt.onHeaderShow(me); } }, getDesiredWidth: function() { var me = this; if (me.rendered && me.componentLayout && me.componentLayout.lastComponentSize) { // headers always have either a width or a flex // because HeaderContainer sets a defaults width // therefore we can ignore the natural width // we use the componentLayout's tracked width so that // we can calculate the desired width when rendered // but not visible because its being obscured by a layout return me.componentLayout.lastComponentSize.width; // Flexed but yet to be rendered this could be the case // where a HeaderContainer and Headers are simply used as data // structures and not rendered. } else if (me.flex) { // this is going to be wrong, the defaultWidth return me.width; } else { return me.width; } }, getCellSelector: function() { return '.' + Ext.baseCSSPrefix + 'grid-cell-' + this.getItemId(); }, getCellInnerSelector: function() { return this.getCellSelector() + ' .' + Ext.baseCSSPrefix + 'grid-cell-inner'; }, isOnLeftEdge: function(e) { return (e.getXY()[0] - this.getX() <= this.handleWidth); }, isOnRightEdge: function(e) { return (this.getX() + this.getWidth() - e.getXY()[0] <= this.handleWidth); }, // Called when the column menu is activated/deactivated. // Change the UI to indicate active/inactive menu setMenuActive: function(isMenuOpen) { this.titleEl[isMenuOpen ? 'addCls' : 'removeCls'](this.headerOpenCls); } // intentionally omit getEditor and setEditor definitions bc we applyIf into columns // when the editing plugin is injected /** * @method getEditor * Retrieves the editing field for editing associated with this header. Returns false if there is no field * associated with the Header the method will return false. If the field has not been instantiated it will be * created. Note: These methods only have an implementation if an Editing plugin has been enabled on the grid. * @param {Object} record The {@link Ext.data.Model Model} instance being edited. * @param {Object} defaultField An object representing a default field to be created * @return {Ext.form.field.Field} field */ /** * @method setEditor * Sets the form field to be used for editing. Note: This method only has an implementation if an Editing plugin has * been enabled on the grid. * @param {Object} field An object representing a field to be created. If no xtype is specified a 'textfield' is * assumed. */ }); /** * A Grid header type which renders an icon, or a series of icons in a grid cell, and offers a scoped click * handler for each icon. * * @example * Ext.create('Ext.data.Store', { * storeId:'employeeStore', * fields:['firstname', 'lastname', 'seniority', 'dep', 'hired'], * data:[ * {firstname:"Michael", lastname:"Scott"}, * {firstname:"Dwight", lastname:"Schrute"}, * {firstname:"Jim", lastname:"Halpert"}, * {firstname:"Kevin", lastname:"Malone"}, * {firstname:"Angela", lastname:"Martin"} * ] * }); * * Ext.create('Ext.grid.Panel', { * title: 'Action Column Demo', * store: Ext.data.StoreManager.lookup('employeeStore'), * columns: [ * {text: 'First Name', dataIndex:'firstname'}, * {text: 'Last Name', dataIndex:'lastname'}, * { * xtype:'actioncolumn', * width:50, * items: [{ * icon: 'extjs/examples/shared/icons/fam/cog_edit.png', // Use a URL in the icon config * tooltip: 'Edit', * handler: function(grid, rowIndex, colIndex) { * var rec = grid.getStore().getAt(rowIndex); * alert("Edit " + rec.get('firstname')); * } * },{ * icon: 'extjs/examples/restful/images/delete.png', * tooltip: 'Delete', * handler: function(grid, rowIndex, colIndex) { * var rec = grid.getStore().getAt(rowIndex); * alert("Terminate " + rec.get('firstname')); * } * }] * } * ], * width: 250, * renderTo: Ext.getBody() * }); * * The action column can be at any index in the columns array, and a grid can have any number of * action columns. */ Ext.define('Ext.grid.column.Action', { extend: Ext.grid.column.Column , alias: ['widget.actioncolumn'], alternateClassName: 'Ext.grid.ActionColumn', /** * @cfg {String} icon * The URL of an image to display as the clickable element in the column. * * Defaults to `{@link Ext#BLANK_IMAGE_URL}`. */ /** * @cfg {String} iconCls * A CSS class to apply to the icon image. To determine the class dynamically, configure the Column with * a `{@link #getClass}` function. */ /** * @cfg {Function} handler * A function called when the icon is clicked. * @cfg {Ext.view.Table} handler.view The owning TableView. * @cfg {Number} handler.rowIndex The row index clicked on. * @cfg {Number} handler.colIndex The column index clicked on. * @cfg {Object} handler.item The clicked item (or this Column if multiple {@link #cfg-items} were not configured). * @cfg {Event} handler.e The click event. * @cfg {Ext.data.Model} handler.record The Record underlying the clicked row. * @cfg {HTMLElement} handler.row The table row clicked upon. */ /** * @cfg {Object} scope * The scope (`this` reference) in which the `{@link #handler}`, `{@link #getClass}`, `{@link #cfg-isDisabled}` and `{@link #getTip}` fuctions are executed. * Defaults to this Column. */ /** * @cfg {String} tooltip * A tooltip message to be displayed on hover. {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must * have been initialized. * * The tooltip may also be determined on a row by row basis by configuring a {@link #getTip} method. */ /** * @cfg {Boolean} disabled * If true, the action will not respond to click events, and will be displayed semi-opaque. * * This Column may also be disabled on a row by row basis by configuring a {@link #cfg-isDisabled} method. */ /** * @cfg {Boolean} [stopSelection=true] * Prevent grid selection upon mousedown. */ /** * @cfg {Function} getClass * A function which returns the CSS class to apply to the icon image. * @cfg {Object} getClass.v The value of the column's configured field (if any). * @cfg {Object} getClass.metadata An object in which you may set the following attributes: * @cfg {String} getClass.metadata.css A CSS class name to add to the cell's TD element. * @cfg {String} getClass.metadata.attr An HTML attribute definition string to apply to the data container * element *within* the table cell (e.g. 'style="color:red;"'). * @cfg {Ext.data.Model} getClass.r The Record providing the data. * @cfg {Number} getClass.rowIndex The row index. * @cfg {Number} getClass.colIndex The column index. * @cfg {Ext.data.Store} getClass.store The Store which is providing the data Model. */ /** * @cfg {Function} isDisabled A function which determines whether the action item for any row is disabled and returns `true` or `false`. * @cfg {Ext.view.Table} isDisabled.view The owning TableView. * @cfg {Number} isDisabled.rowIndex The row index. * @cfg {Number} isDisabled.colIndex The column index. * @cfg {Object} isDisabled.item The clicked item (or this Column if multiple {@link #cfg-items} were not configured). * @cfg {Ext.data.Model} isDisabled.record The Record underlying the row. */ /** * @cfg {Function} getTip A function which returns the tooltip string for any row. * @cfg {Object} getTip.v The value of the column's configured field (if any). * @cfg {Object} getTip.metadata An object in which you may set the following attributes: * @cfg {String} getTip.metadata.css A CSS class name to add to the cell's TD element. * @cfg {String} getTip.metadata.attr An HTML attribute definition string to apply to the data * container element _within_ the table cell (e.g. 'style="color:red;"'). * @cfg {Ext.data.Model} getTip.r The Record providing the data. * @cfg {Number} getTip.rowIndex The row index. * @cfg {Number} getTip.colIndex The column index. * @cfg {Ext.data.Store} getTip.store The Store which is providing the data Model. * */ /** * @cfg {Object[]} items * An Array which may contain multiple icon definitions, each element of which may contain: * * @cfg {String} items.icon The url of an image to display as the clickable element in the column. * * @cfg {String} items.iconCls A CSS class to apply to the icon image. To determine the class dynamically, * configure the item with a `getClass` function. * * @cfg {Function} items.getClass A function which returns the CSS class to apply to the icon image. * @cfg {Object} items.getClass.v The value of the column's configured field (if any). * @cfg {Object} items.getClass.metadata An object in which you may set the following attributes: * @cfg {String} items.getClass.metadata.css A CSS class name to add to the cell's TD element. * @cfg {String} items.getClass.metadata.attr An HTML attribute definition string to apply to the data * container element _within_ the table cell (e.g. 'style="color:red;"'). * @cfg {Ext.data.Model} items.getClass.r The Record providing the data. * @cfg {Number} items.getClass.rowIndex The row index. * @cfg {Number} items.getClass.colIndex The column index. * @cfg {Ext.data.Store} items.getClass.store The Store which is providing the data Model. * * @cfg {Function} items.handler A function called when the icon is clicked. * @cfg {Ext.view.Table} items.handler.view The owning TableView. * @cfg {Number} items.handler.rowIndex The row index clicked on. * @cfg {Number} items.handler.colIndex The column index clicked on. * @cfg {Object} items.handler.item The clicked item (or this Column if multiple {@link #cfg-items} were not configured). * @cfg {Event} items.handler.e The click event. * @cfg {Ext.data.Model} items.handler.record The Record underlying the clicked row. * @cfg {HTMLElement} items.row The table row clicked upon. * * @cfg {Function} items.isDisabled A function which determines whether the action item for any row is disabled and returns `true` or `false`. * @cfg {Ext.view.Table} items.isDisabled.view The owning TableView. * @cfg {Number} items.isDisabled.rowIndex The row index. * @cfg {Number} items.isDisabled.colIndex The column index. * @cfg {Object} items.isDisabled.item The clicked item (or this Column if multiple {@link #cfg-items} were not configured). * @cfg {Ext.data.Model} items.isDisabled.record The Record underlying the row. * * @cfg {Function} items.getTip A function which returns the tooltip string for any row. * @cfg {Object} items.getTip.v The value of the column's configured field (if any). * @cfg {Object} items.getTip.metadata An object in which you may set the following attributes: * @cfg {String} items.getTip.metadata.css A CSS class name to add to the cell's TD element. * @cfg {String} items.getTip.metadata.attr An HTML attribute definition string to apply to the data * container element _within_ the table cell (e.g. 'style="color:red;"'). * @cfg {Ext.data.Model} items.getTip.r The Record providing the data. * @cfg {Number} items.getTip.rowIndex The row index. * @cfg {Number} items.getTip.colIndex The column index. * @cfg {Ext.data.Store} items.getTip.store The Store which is providing the data Model. * * @cfg {Object} items.scope The scope (`this` reference) in which the `handler`, `getClass`, `isDisabled` and `getTip` functions * are executed. Fallback defaults are this Column's configured scope, then this Column. * * @cfg {String} items.tooltip A tooltip message to be displayed on hover. * {@link Ext.tip.QuickTipManager#init Ext.tip.QuickTipManager} must have been initialized. * * The tooltip may also be determined on a row by row basis by configuring a `getTip` method. * * @cfg {Boolean} items.disabled If true, the action will not respond to click events, and will be displayed semi-opaque. * * This item may also be disabled on a row by row basis by configuring an `isDisabled` method. */ /** * @property {Array} items * An array of action items copied from the configured {@link #cfg-items items} configuration. Each will have * an `enable` and `disable` method added which will enable and disable the associated action, and * update the displayed icon accordingly. */ actionIdRe: new RegExp(Ext.baseCSSPrefix + 'action-col-(\\d+)'), /** * @cfg {String} altText * The alt text to use for the image element. */ altText: '', /** * @cfg {String} [menuText=Actions] * Text to display in this column's menu item if no {@link #text} was specified as a header. */ menuText: 'Actions', sortable: false, innerCls: Ext.baseCSSPrefix + 'grid-cell-inner-action-col', constructor: function(config) { var me = this, cfg = Ext.apply({}, config), // Items may be defined on the prototype items = cfg.items || me.items || [me], hasGetClass, i, len; me.origRenderer = cfg.renderer || me.renderer; me.origScope = cfg.scope || me.scope; me.renderer = me.scope = cfg.renderer = cfg.scope = null; // This is a Container. Delete the items config to be reinstated after construction. cfg.items = null; me.callParent([cfg]); // Items is an array property of ActionColumns me.items = items; for (i = 0, len = items.length; i < len; ++i) { if (items[i].getClass) { hasGetClass = true; break; } } // Also need to check for getClass, since it changes how the cell renders if (me.origRenderer || hasGetClass) { me.hasCustomRenderer = true; } }, // Renderer closure iterates through items creating an element for each and tagging with an identifying // class name x-action-col-{n} defaultRenderer: function(v, meta, record, rowIdx, colIdx, store, view){ var me = this, prefix = Ext.baseCSSPrefix, scope = me.origScope || me, items = me.items, len = items.length, i = 0, item, ret, disabled, tooltip; // Allow a configured renderer to create initial value (And set the other values in the "metadata" argument!) // Assign a new variable here, since if we modify "v" it will also modify the arguments collection, meaning // we will pass an incorrect value to getClass/getTip ret = Ext.isFunction(me.origRenderer) ? me.origRenderer.apply(scope, arguments) || '' : ''; meta.tdCls += ' ' + Ext.baseCSSPrefix + 'action-col-cell'; for (; i < len; i++) { item = items[i]; disabled = item.disabled || (item.isDisabled ? item.isDisabled.call(item.scope || scope, view, rowIdx, colIdx, item, record) : false); tooltip = disabled ? null : (item.tooltip || (item.getTip ? item.getTip.apply(item.scope || scope, arguments) : null)); // Only process the item action setup once. if (!item.hasActionConfiguration) { // Apply our documented default to all items item.stopSelection = me.stopSelection; item.disable = Ext.Function.bind(me.disableAction, me, [i], 0); item.enable = Ext.Function.bind(me.enableAction, me, [i], 0); item.hasActionConfiguration = true; } ret += '' + (item.altText || me.altText) + ''; } return ret; }, /** * Enables this ActionColumn's action at the specified index. * @param {Number/Ext.grid.column.Action} index * @param {Boolean} [silent=false] */ enableAction: function(index, silent) { var me = this; if (!index) { index = 0; } else if (!Ext.isNumber(index)) { index = Ext.Array.indexOf(me.items, index); } me.items[index].disabled = false; me.up('tablepanel').el.select('.' + Ext.baseCSSPrefix + 'action-col-' + index).removeCls(me.disabledCls); if (!silent) { me.fireEvent('enable', me); } }, /** * Disables this ActionColumn's action at the specified index. * @param {Number/Ext.grid.column.Action} index * @param {Boolean} [silent=false] */ disableAction: function(index, silent) { var me = this; if (!index) { index = 0; } else if (!Ext.isNumber(index)) { index = Ext.Array.indexOf(me.items, index); } me.items[index].disabled = true; me.up('tablepanel').el.select('.' + Ext.baseCSSPrefix + 'action-col-' + index).addCls(me.disabledCls); if (!silent) { me.fireEvent('disable', me); } }, destroy: function() { delete this.items; delete this.renderer; return this.callParent(arguments); }, /** * @private * Process and refire events routed from the GridView's processEvent method. * Also fires any configured click handlers. By default, cancels the mousedown event to prevent selection. * Returns the event handler's status to allow canceling of GridView's bubbling process. */ processEvent : function(type, view, cell, recordIndex, cellIndex, e, record, row){ var me = this, target = e.getTarget(), match, item, fn, key = type == 'keydown' && e.getKey(), disabled; // If the target was not within a cell (ie it's a keydown event from the View), then // rely on the selection data injected by View.processUIEvent to grab the // first action icon from the selected cell. if (key && !Ext.fly(target).findParent(view.getCellSelector())) { target = Ext.fly(cell).down('.' + Ext.baseCSSPrefix + 'action-col-icon', true); } // NOTE: The statement below tests the truthiness of an assignment. if (target && (match = target.className.match(me.actionIdRe))) { item = me.items[parseInt(match[1], 10)]; disabled = item.disabled || (item.isDisabled ? item.isDisabled.call(item.scope || me.origScope || me, view, recordIndex, cellIndex, item, record) : false); if (item && !disabled) { if (type == 'click' || (key == e.ENTER || key == e.SPACE)) { fn = item.handler || me.handler; if (fn) { fn.call(item.scope || me.origScope || me, view, recordIndex, cellIndex, item, e, record, row); } } else if (type == 'mousedown' && item.stopSelection !== false) { return false; } } } return me.callParent(arguments); }, cascade: function(fn, scope) { fn.call(scope||this, this); }, // Private override because this cannot function as a Container, and it has an items property which is an Array, NOT a MixedCollection. getRefItems: function() { return []; } }); /** * A Column definition class which renders boolean data fields. See the {@link Ext.grid.column.Column#xtype xtype} * config option of {@link Ext.grid.column.Column} for more details. * * @example * Ext.create('Ext.data.Store', { * storeId:'sampleStore', * fields:[ * {name: 'framework', type: 'string'}, * {name: 'rocks', type: 'boolean'} * ], * data:{'items':[ * { 'framework': "Ext JS 4", 'rocks': true }, * { 'framework': "Sencha Touch", 'rocks': true }, * { 'framework': "Ext GWT", 'rocks': true }, * { 'framework': "Other Guys", 'rocks': false } * ]}, * proxy: { * type: 'memory', * reader: { * type: 'json', * root: 'items' * } * } * }); * * Ext.create('Ext.grid.Panel', { * title: 'Boolean Column Demo', * store: Ext.data.StoreManager.lookup('sampleStore'), * columns: [ * { text: 'Framework', dataIndex: 'framework', flex: 1 }, * { * xtype: 'booleancolumn', * text: 'Rocks', * trueText: 'Yes', * falseText: 'No', * dataIndex: 'rocks' * } * ], * height: 200, * width: 400, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.grid.column.Boolean', { extend: Ext.grid.column.Column , alias: ['widget.booleancolumn'], alternateClassName: 'Ext.grid.BooleanColumn', // /** * @cfg {String} trueText * The string returned by the renderer when the column value is not falsey. */ trueText: 'true', // // /** * @cfg {String} falseText * The string returned by the renderer when the column value is falsey (but not undefined). */ falseText: 'false', // /** * @cfg {String} undefinedText * The string returned by the renderer when the column value is undefined. */ undefinedText: ' ', /** * @cfg {Object} renderer * @hide */ /** * @cfg {Object} scope * @hide */ defaultRenderer: function(value){ if (value === undefined) { return this.undefinedText; } if (!value || value === 'false') { return this.falseText; } return this.trueText; } }); /** * A Column subclass which renders a checkbox in each column cell which toggles the truthiness of the associated data field on click. * * Example usage: * * @example * var store = Ext.create('Ext.data.Store', { * fields : ['name', 'email', 'phone', 'active'], * data : { * items : [ * { name : 'Lisa', email : 'lisa@simpsons.com', phone : '555-111-1224', active : true }, * { name : 'Bart', email : 'bart@simpsons.com', phone : '555-222-1234', active : true }, * { name : 'Homer', email : 'home@simpsons.com', phone : '555-222-1244', active : false }, * { name : 'Marge', email : 'marge@simpsons.com', phone : '555-222-1254', active : true } * ] * }, * proxy : { * type : 'memory', * reader : { * type : 'json', * root : 'items' * } * } * }); * * Ext.create('Ext.grid.Panel', { * title : 'Simpsons', * height : 200, * width : 400, * renderTo : Ext.getBody(), * store : store, * columns : [ * { text : 'Name', dataIndex : 'name' }, * { text : 'Email', dataIndex : 'email', flex : 1 }, * { text : 'Phone', dataIndex : 'phone' }, * { xtype : 'checkcolumn', text : 'Active', dataIndex : 'active' } * ] * }); * * The check column can be at any index in the columns array. */ Ext.define('Ext.grid.column.CheckColumn', { extend: Ext.grid.column.Column , alternateClassName: 'Ext.ux.CheckColumn', alias: 'widget.checkcolumn', /** * @cfg * @hide * Overridden from base class. Must center to line up with editor. */ align: 'center', /** * @cfg {Boolean} [stopSelection=true] * Prevent grid selection upon mousedown. */ stopSelection: true, tdCls: Ext.baseCSSPrefix + 'grid-cell-checkcolumn', innerCls: Ext.baseCSSPrefix + 'grid-cell-inner-checkcolumn', clickTargetName: 'el', constructor: function() { this.addEvents( /** * @event beforecheckchange * Fires when before checked state of a row changes. * The change may be vetoed by returning `false` from a listener. * @param {Ext.ux.CheckColumn} this CheckColumn * @param {Number} rowIndex The row index * @param {Boolean} checked True if the box is to be checked */ 'beforecheckchange', /** * @event checkchange * Fires when the checked state of a row changes * @param {Ext.ux.CheckColumn} this CheckColumn * @param {Number} rowIndex The row index * @param {Boolean} checked True if the box is now checked */ 'checkchange' ); this.scope = this; this.callParent(arguments); }, /** * @private * Process and refire events routed from the GridView's processEvent method. */ processEvent: function(type, view, cell, recordIndex, cellIndex, e, record, row) { var me = this, key = type === 'keydown' && e.getKey(), mousedown = type == 'mousedown'; if (!me.disabled && (mousedown || (key == e.ENTER || key == e.SPACE))) { var dataIndex = me.dataIndex, checked = !record.get(dataIndex); // Allow apps to hook beforecheckchange if (me.fireEvent('beforecheckchange', me, recordIndex, checked) !== false) { record.set(dataIndex, checked); me.fireEvent('checkchange', me, recordIndex, checked); // Mousedown on the now nonexistent cell causes the view to blur, so stop it continuing. if (mousedown) { e.stopEvent(); } // Selection will not proceed after this because of the DOM update caused by the record modification // Invoke the SelectionModel unless configured not to do so if (!me.stopSelection) { view.selModel.selectByPosition({ row: recordIndex, column: cellIndex }); } // Prevent the view from propagating the event to the selection model - we have done that job. return false; } else { // Prevent the view from propagating the event to the selection model if configured to do so. return !me.stopSelection; } } else { return me.callParent(arguments); } }, /** * Enables this CheckColumn. * @param {Boolean} [silent=false] */ onEnable: function(silent) { var me = this; me.callParent(arguments); me.up('tablepanel').el.select('.' + Ext.baseCSSPrefix + 'grid-cell-' + me.id).removeCls(me.disabledCls); if (!silent) { me.fireEvent('enable', me); } }, /** * Disables this CheckColumn. * @param {Boolean} [silent=false] */ onDisable: function(silent) { var me = this; me.callParent(arguments); me.up('tablepanel').el.select('.' + Ext.baseCSSPrefix + 'grid-cell-' + me.id).addCls(me.disabledCls); if (!silent) { me.fireEvent('disable', me); } }, // Note: class names are not placed on the prototype bc renderer scope // is not in the header. renderer : function(value, meta) { var cssPrefix = Ext.baseCSSPrefix, cls = [cssPrefix + 'grid-checkcolumn']; if (this.disabled) { meta.tdCls += ' ' + this.disabledCls; } if (value) { cls.push(cssPrefix + 'grid-checkcolumn-checked'); } return ''; } }); /** * A Column definition class which renders a passed date according to the default locale, or a configured * {@link #format}. * * @example * Ext.create('Ext.data.Store', { * storeId:'sampleStore', * fields:[ * { name: 'symbol', type: 'string' }, * { name: 'date', type: 'date' }, * { name: 'change', type: 'number' }, * { name: 'volume', type: 'number' }, * { name: 'topday', type: 'date' } * ], * data:[ * { symbol: "msft", date: '2011/04/22', change: 2.43, volume: 61606325, topday: '04/01/2010' }, * { symbol: "goog", date: '2011/04/22', change: 0.81, volume: 3053782, topday: '04/11/2010' }, * { symbol: "apple", date: '2011/04/22', change: 1.35, volume: 24484858, topday: '04/28/2010' }, * { symbol: "sencha", date: '2011/04/22', change: 8.85, volume: 5556351, topday: '04/22/2010' } * ] * }); * * Ext.create('Ext.grid.Panel', { * title: 'Date Column Demo', * store: Ext.data.StoreManager.lookup('sampleStore'), * columns: [ * { text: 'Symbol', dataIndex: 'symbol', flex: 1 }, * { text: 'Date', dataIndex: 'date', xtype: 'datecolumn', format:'Y-m-d' }, * { text: 'Change', dataIndex: 'change', xtype: 'numbercolumn', format:'0.00' }, * { text: 'Volume', dataIndex: 'volume', xtype: 'numbercolumn', format:'0,000' }, * { text: 'Top Day', dataIndex: 'topday', xtype: 'datecolumn', format:'l' } * ], * height: 200, * width: 450, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.grid.column.Date', { extend: Ext.grid.column.Column , alias: ['widget.datecolumn'], alternateClassName: 'Ext.grid.DateColumn', /** * @cfg {String} format * A formatting string as used by {@link Ext.Date#format} to format a Date for this Column. * * Defaults to the default date from {@link Ext.Date#defaultFormat} which itself my be overridden * in a locale file. */ /** * @cfg {Object} renderer * @hide */ /** * @cfg {Object} scope * @hide */ initComponent: function(){ if (!this.format) { this.format = Ext.Date.defaultFormat; } this.callParent(arguments); }, defaultRenderer: function(value){ return Ext.util.Format.date(value, this.format); } }); /** * A Column definition class which renders a numeric data field according to a {@link #format} string. * * @example * Ext.create('Ext.data.Store', { * storeId:'sampleStore', * fields:[ * { name: 'symbol', type: 'string' }, * { name: 'price', type: 'number' }, * { name: 'change', type: 'number' }, * { name: 'volume', type: 'number' } * ], * data:[ * { symbol: "msft", price: 25.76, change: 2.43, volume: 61606325 }, * { symbol: "goog", price: 525.73, change: 0.81, volume: 3053782 }, * { symbol: "apple", price: 342.41, change: 1.35, volume: 24484858 }, * { symbol: "sencha", price: 142.08, change: 8.85, volume: 5556351 } * ] * }); * * Ext.create('Ext.grid.Panel', { * title: 'Number Column Demo', * store: Ext.data.StoreManager.lookup('sampleStore'), * columns: [ * { text: 'Symbol', dataIndex: 'symbol', flex: 1 }, * { text: 'Current Price', dataIndex: 'price', renderer: Ext.util.Format.usMoney }, * { text: 'Change', dataIndex: 'change', xtype: 'numbercolumn', format:'0.00' }, * { text: 'Volume', dataIndex: 'volume', xtype: 'numbercolumn', format:'0,000' } * ], * height: 200, * width: 400, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.grid.column.Number', { extend: Ext.grid.column.Column , alias: ['widget.numbercolumn'], alternateClassName: 'Ext.grid.NumberColumn', // /** * @cfg {String} format * A formatting string as used by {@link Ext.util.Format#number} to format a numeric value for this Column. */ format : '0,000.00', // /** * @cfg {Object} renderer * @hide */ /** * @cfg {Object} scope * @hide */ defaultRenderer: function(value){ return Ext.util.Format.number(value, this.format); } }); /** * A special type of Grid {@link Ext.grid.column.Column} that provides automatic * row numbering. * * Usage: * * columns: [ * {xtype: 'rownumberer'}, * {text: "Company", flex: 1, sortable: true, dataIndex: 'company'}, * {text: "Price", width: 120, sortable: true, renderer: Ext.util.Format.usMoney, dataIndex: 'price'}, * {text: "Change", width: 120, sortable: true, dataIndex: 'change'}, * {text: "% Change", width: 120, sortable: true, dataIndex: 'pctChange'}, * {text: "Last Updated", width: 120, sortable: true, renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'} * ] * */ Ext.define('Ext.grid.column.RowNumberer', { extend: Ext.grid.column.Column , alternateClassName: 'Ext.grid.RowNumberer', alias: 'widget.rownumberer', /** * @cfg {String} text * Any valid text or HTML fragment to display in the header cell for the row number column. */ text: " ", /** * @cfg {Number} width * The default width in pixels of the row number column. */ width: 23, /** * @cfg {Boolean} sortable * @hide */ sortable: false, /** * @cfg {Boolean} [draggable=false] * False to disable drag-drop reordering of this column. */ draggable: false, // Flag to Lockable to move instances of this column to the locked side. autoLock: true, // May not be moved from its preferred locked side when grid is enableLocking:true lockable: false, align: 'right', constructor : function(config){ var me = this; // Copy the prototype's default width setting into an instance property to provide // a default width which will not be overridden by AbstractContainer.applyDefaults use of Ext.applyIf me.width = me.width; me.callParent(arguments); me.scope = me; }, // private resizable: false, hideable: false, menuDisabled: true, dataIndex: '', cls: Ext.baseCSSPrefix + 'row-numberer', tdCls: Ext.baseCSSPrefix + 'grid-cell-row-numberer ' + Ext.baseCSSPrefix + 'grid-cell-special', innerCls: Ext.baseCSSPrefix + 'grid-cell-inner-row-numberer', rowspan: undefined, // private renderer: function(value, metaData, record, rowIdx, colIdx, store) { var rowspan = this.rowspan, page = store.currentPage, result = record.index; if (rowspan) { metaData.tdAttr = 'rowspan="' + rowspan + '"'; } if (result == null) { result = rowIdx; if (page > 1) { result += (page - 1) * store.pageSize; } } return result + 1; } }); /** * A Column definition class which renders a value by processing a {@link Ext.data.Model Model}'s * {@link Ext.data.Model#persistenceProperty data} using a {@link #tpl configured} * {@link Ext.XTemplate XTemplate}. * * @example * Ext.create('Ext.data.Store', { * storeId:'employeeStore', * fields:['firstname', 'lastname', 'seniority', 'department'], * groupField: 'department', * data:[ * { firstname: "Michael", lastname: "Scott", seniority: 7, department: "Management" }, * { firstname: "Dwight", lastname: "Schrute", seniority: 2, department: "Sales" }, * { firstname: "Jim", lastname: "Halpert", seniority: 3, department: "Sales" }, * { firstname: "Kevin", lastname: "Malone", seniority: 4, department: "Accounting" }, * { firstname: "Angela", lastname: "Martin", seniority: 5, department: "Accounting" } * ] * }); * * Ext.create('Ext.grid.Panel', { * title: 'Column Template Demo', * store: Ext.data.StoreManager.lookup('employeeStore'), * columns: [ * { text: 'Full Name', xtype: 'templatecolumn', tpl: '{firstname} {lastname}', flex:1 }, * { text: 'Department (Yrs)', xtype: 'templatecolumn', tpl: '{department} ({seniority})' } * ], * height: 200, * width: 300, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.grid.column.Template', { extend: Ext.grid.column.Column , alias: ['widget.templatecolumn'], alternateClassName: 'Ext.grid.TemplateColumn', /** * @cfg {String/Ext.XTemplate} tpl * An {@link Ext.XTemplate XTemplate}, or an XTemplate *definition string* to use to process a * {@link Ext.data.Model Model}'s {@link Ext.data.Model#persistenceProperty data} to produce a * column's rendered value. */ /** * @cfg {Object} renderer * @hide */ /** * @cfg {Object} scope * @hide */ initComponent: function(){ var me = this; me.tpl = (!Ext.isPrimitive(me.tpl) && me.tpl.compile) ? me.tpl : new Ext.XTemplate(me.tpl); // Set this here since the template may access any record values, // so we must always run the update for this column me.hasCustomRenderer = true; me.callParent(arguments); }, defaultRenderer: function(value, meta, record) { var data = Ext.apply({}, record.data, record.getAssociatedData()); return this.tpl.apply(data); } }); /** * A feature is a type of plugin that is specific to the {@link Ext.grid.Panel}. It provides several * hooks that allows the developer to inject additional functionality at certain points throughout the * grid creation cycle. This class provides the base template methods that are available to the developer, * it should be extended. * * There are several built in features that extend this class, for example: * * - {@link Ext.grid.feature.Grouping} - Shows grid rows in groups as specified by the {@link Ext.data.Store} * - {@link Ext.grid.feature.RowBody} - Adds a body section for each grid row that can contain markup. * - {@link Ext.grid.feature.Summary} - Adds a summary row at the bottom of the grid with aggregate totals for a column. * * ## Using Features * A feature is added to the grid by specifying it an array of features in the configuration: * * var groupingFeature = Ext.create('Ext.grid.feature.Grouping'); * Ext.create('Ext.grid.Panel', { * // other options * features: [groupingFeature] * }); * * ## Writing Features * * A Feature may add new DOM structure within the structure of a grid. * * A grid is essentially a `
    ` element. A {@link Ext.view.Table TableView} instance uses three {@link Ext.XTemplate XTemplates} * to render the grid, `tableTpl`, `rowTpl`, `cellTpl`. * * * A {@link Ext.view.Table TableView} uses its `tableTpl` to emit the `
    ` and `` HTML tags into its output stream. It also emits a `` which contains a * sizing row. To ender the rows, it invokes {@link Ext.view.Table#renderRows} passing the `rows` member of its data object. * * The `tableTpl`'s data object Looks like this: * { * view: owningTableView, * rows: recordsToRender, * viewStartIndex: indexOfFirstRecordInStore, * tableStyle: styleString * } * * * A {@link Ext.view.Table TableView} uses its `rowTpl` to emit a `` HTML tag to its output stream. To render cells, * it invokes {@link Ext.view.Table#renderCell} passing the `rows` member of its data object. * * The `rowTpl`'s data object looks like this: * * { * view: owningTableView, * record: recordToRender, * recordIndex: indexOfRecordInStore, * columns: arrayOfColumnDefinitions, * itemClasses: arrayOfClassNames, // For outermost row in case of wrapping * rowClasses: arrayOfClassNames, // For internal data bearing row in case of wrapping * rowStyle: styleString * } * * * A {@link Ext.view.Table TableView} uses its `cellTpl` to emit a ` ' + Ext.baseCSSPrefix + 'grid-group-row">', '', '', '', '{%this.nextTpl.applyOut(values, out, parent);%}', '', { priority: 200, syncRowHeights: function(firstRow, secondRow) { firstRow = Ext.fly(firstRow, 'syncDest'); secondRow = Ext.fly(secondRow, 'sycSrc'); var owner = this.owner, firstHd = firstRow.down(owner.eventSelector, true), secondHd, firstSummaryRow = firstRow.down(owner.summaryRowSelector, true), secondSummaryRow, firstHeight, secondHeight; // Sync the heights of header elements in each row if they need it. if (firstHd && (secondHd = secondRow.down(owner.eventSelector, true))) { firstHd.style.height = secondHd.style.height = ''; if ((firstHeight = firstHd.offsetHeight) > (secondHeight = secondHd.offsetHeight)) { Ext.fly(secondHd).setHeight(firstHeight); } else if (secondHeight > firstHeight) { Ext.fly(firstHd).setHeight(secondHeight); } } // Sync the heights of summary row in each row if they need it. if (firstSummaryRow && (secondSummaryRow = secondRow.down(owner.summaryRowSelector, true))) { firstSummaryRow.style.height = secondSummaryRow.style.height = ''; if ((firstHeight = firstSummaryRow.offsetHeight) > (secondHeight = secondSummaryRow.offsetHeight)) { Ext.fly(secondSummaryRow).setHeight(firstHeight); } else if (secondHeight > firstHeight) { Ext.fly(firstSummaryRow).setHeight(secondHeight); } } }, syncContent: function(destRow, sourceRow) { destRow = Ext.fly(destRow, 'syncDest'); sourceRow = Ext.fly(sourceRow, 'sycSrc'); var owner = this.owner, destHd = destRow.down(owner.eventSelector, true), sourceHd = sourceRow.down(owner.eventSelector, true), destSummaryRow = destRow.down(owner.summaryRowSelector, true), sourceSummaryRow = sourceRow.down(owner.summaryRowSelector, true); // Sync the content of header element. if (destHd && sourceHd) { Ext.fly(destHd).syncContent(sourceHd); } // Sync the content of summary row element. if (destSummaryRow && sourceSummaryRow) { Ext.fly(destSummaryRow).syncContent(sourceSummaryRow); } } } ], constructor: function() { this.groupCache = {}; this.callParent(arguments); }, init: function(grid) { var me = this, view = me.view; view.isGrouping = true; // The expensively maintained groupCache is shared between twinned Grouping features. if (me.lockingPartner && me.lockingPartner.groupCache) { me.groupCache = me.lockingPartner.groupCache; } me.mixins.summary.init.call(me); me.callParent(arguments); view.headerCt.on({ columnhide: me.onColumnHideShow, columnshow: me.onColumnHideShow, columnmove: me.onColumnMove, scope: me }); // Add a table level processor view.addTableTpl(me.tableTpl).groupingFeature = me; // Add a row level processor view.addRowTpl(Ext.XTemplate.getTpl(me, 'groupTpl')).groupingFeature = me; view.preserveScrollOnRefresh = true; // Sparse store - we can never collapse groups if (view.store.buffered) { me.collapsible = false; } // If it's a local store we can build a grouped store for use as the view's dataSource else { // Share the GroupStore between both sides of a locked grid if (this.lockingPartner && this.lockingPartner.dataSource) { me.dataSource = view.dataSource = this.lockingPartner.dataSource; } else { me.dataSource = view.dataSource = new Ext.grid.feature.GroupStore(me, view.store); } } me.grid.on({ reconfigure: me.onReconfigure }); view.on({ afterrender: me.afterViewRender, scope: me, single: true }); }, clearGroupCache: function() { var me = this, groupCache = me.groupCache = {}; if (me.lockingPartner) { me.lockingPartner.groupCache = groupCache; } return groupCache; }, vetoEvent: function(record, row, rowIndex, e) { // Do not veto mouseover/mouseout if (e.type !== 'mouseover' && e.type !== 'mouseout' && e.type !== 'mouseenter' && e.type !== 'mouseleave' && e.getTarget(this.eventSelector)) { return false; } }, enable: function() { var me = this, view = me.view, store = view.store, groupToggleMenuItem; me.lastGroupField = me.getGroupField(); view.isGrouping = true; if (me.lastGroupIndex) { me.block(); store.group(me.lastGroupIndex); me.unblock(); } me.callParent(); groupToggleMenuItem = me.view.headerCt.getMenu().down('#groupToggleMenuItem'); if (groupToggleMenuItem) { groupToggleMenuItem.setChecked(true, true); } me.refreshIf(); }, disable: function() { var me = this, view = me.view, store = view.store, groupToggleMenuItem, lastGroup; view.isGrouping = false; lastGroup = store.groupers.first(); if (lastGroup) { me.lastGroupIndex = lastGroup.property; me.block(); store.clearGrouping(); me.unblock(); } me.callParent(); groupToggleMenuItem = me.view.headerCt.getMenu().down('#groupToggleMenuItem'); if (groupToggleMenuItem) { groupToggleMenuItem.setChecked(false, true); } me.refreshIf(); }, refreshIf: function() { var ownerCt = this.grid.ownerCt, view = this.view; if (!view.store.remoteGroup && !this.blockRefresh) { // We are one side of a lockable grid, so refresh the locking view if (ownerCt && ownerCt.lockable) { ownerCt.view.refresh(); } else { view.refresh(); } } }, // Attach events to view afterViewRender: function() { var me = this, view = me.view; view.on({ scope: me, groupclick: me.onGroupClick }); if (me.enableGroupingMenu) { me.injectGroupingMenu(); } me.pruneGroupedHeader(); me.lastGroupField = me.getGroupField(); me.block(); me.onGroupChange(); me.unblock(); }, injectGroupingMenu: function() { var me = this, headerCt = me.view.headerCt; headerCt.showMenuBy = me.showMenuBy; headerCt.getMenuItems = me.getMenuItems(); }, onColumnHideShow: function(headerOwnerCt, header) { var view = this.view, headerCt = view.headerCt, menu = headerCt.getMenu(), groupToggleMenuItem = menu.down('#groupMenuItem'), colCount = headerCt.getGridColumns().length, items, len, i; // "Group by this field" must be disabled if there's only one column left visible. if (groupToggleMenuItem) { if (headerCt.getVisibleGridColumns().length > 1) { groupToggleMenuItem.enable(); } else { groupToggleMenuItem.disable(); } } // header containing TDs have to span all columns, hiddens are just zero width if (view.rendered) { items = view.el.query('.' + this.ctCls); for (i = 0, len = items.length; i < len; ++i) { items[i].colSpan = colCount; } } }, // Update first and last records in groups when column moves // Because of the RowWrap template, this will update the groups' headers and footers onColumnMove: function() { var me = this, store = me.view.store, groups, i, len, groupInfo, firstRec, lastRec; if (store.isGrouped()) { groups = store.getGroups(); len = groups.length; // Iterate through groups, firing updates on boundary records for (i = 0; i < len; i++) { groupInfo = groups[i]; firstRec = groupInfo.children[0]; lastRec = groupInfo.children[groupInfo.children.length - 1]; // Must pass the modifiedFields parameter as null so that the // listener options does not take that place in the arguments list store.fireEvent('update', store, firstRec, 'edit', null); if (lastRec !== firstRec) { store.fireEvent('update', store, lastRec, 'edit', null); } } } }, showMenuBy: function(t, header) { var menu = this.getMenu(), groupMenuItem = menu.down('#groupMenuItem'), groupMenuMeth = header.groupable === false || this.view.headerCt.getVisibleGridColumns().length < 2 ? 'disable' : 'enable', groupToggleMenuItem = menu.down('#groupToggleMenuItem'), isGrouped = this.view.store.isGrouped(); groupMenuItem[groupMenuMeth](); if (groupToggleMenuItem) { groupToggleMenuItem.setChecked(isGrouped, true); groupToggleMenuItem[isGrouped ? 'enable' : 'disable'](); } Ext.grid.header.Container.prototype.showMenuBy.apply(this, arguments); }, getMenuItems: function() { var me = this, groupByText = me.groupByText, disabled = me.disabled || !me.getGroupField(), showGroupsText = me.showGroupsText, enableNoGroups = me.enableNoGroups, getMenuItems = me.view.headerCt.getMenuItems; // runs in the scope of headerCt return function() { // We cannot use the method from HeaderContainer's prototype here // because other plugins or features may already have injected an implementation var o = getMenuItems.call(this); o.push('-', { iconCls: Ext.baseCSSPrefix + 'group-by-icon', itemId: 'groupMenuItem', text: groupByText, handler: me.onGroupMenuItemClick, scope: me }); if (enableNoGroups) { o.push({ itemId: 'groupToggleMenuItem', text: showGroupsText, checked: !disabled, checkHandler: me.onGroupToggleMenuItemClick, scope: me }); } return o; }; }, /** * Group by the header the user has clicked on. * @private */ onGroupMenuItemClick: function(menuItem, e) { var me = this, menu = menuItem.parentMenu, hdr = menu.activeHeader, view = me.view, store = view.store; me.lastGroupIndex = null; me.block(); me.enable(); store.group(hdr.dataIndex); me.pruneGroupedHeader(); me.unblock(); me.refreshIf(); }, block: function(fromPartner) { this.blockRefresh = this.view.blockRefresh = true; if (this.lockingPartner && !fromPartner) { this.lockingPartner.block(true); } }, unblock: function(fromPartner) { this.blockRefresh = this.view.blockRefresh = false; if (this.lockingPartner && !fromPartner) { this.lockingPartner.unblock(true); } }, /** * Turn on and off grouping via the menu * @private */ onGroupToggleMenuItemClick: function(menuItem, checked) { this[checked ? 'enable' : 'disable'](); }, /** * Prunes the grouped header from the header container * @private */ pruneGroupedHeader: function() { var me = this, header = me.getGroupedHeader(); if (me.hideGroupedHeader && header) { Ext.suspendLayouts(); if (me.prunedHeader && me.prunedHeader !== header) { me.prunedHeader.show(); } me.prunedHeader = header; header.hide(); Ext.resumeLayouts(true); } }, getHeaderNode: function(groupName) { return Ext.get(this.createGroupId(groupName)); }, getGroup: function(name) { var cache = this.groupCache, item = cache[name]; if (!item) { item = cache[name] = { isCollapsed: false }; } return item; }, /** * Returns `true` if the named group is expanded. * @param {String} groupName The group name as returned from {@link Ext.data.Store#getGroupString getGroupString}. This is usually the value of * the {@link Ext.data.Store#groupField groupField}. * @return {Boolean} `true` if the group defined by that value is expanded. */ isExpanded: function(groupName) { return !this.getGroup(groupName).isCollapsed; }, /** * Expand a group * @param {String} groupName The group name * @param {Boolean} focus Pass `true` to focus the group after expand. */ expand: function(groupName, focus) { this.doCollapseExpand(false, groupName, focus); }, /** * Expand all groups */ expandAll: function() { var me = this, view = me.view, groupCache = me.groupCache, groupName, lockingPartner = me.lockingPartner, partnerView; // Clear all collapsed flags. // groupCache is shared between two lockingPartners for (groupName in groupCache) { if (groupCache.hasOwnProperty(groupName)) { groupCache[groupName].isCollapsed = false; } } Ext.suspendLayouts(); view.suspendEvent('beforerefresh', 'refresh'); if (lockingPartner) { partnerView = lockingPartner.view partnerView.suspendEvent('beforerefresh', 'refresh'); } me.dataSource.onRefresh(); view.resumeEvent('beforerefresh', 'refresh'); if (lockingPartner) { partnerView.resumeEvent('beforerefresh', 'refresh'); } Ext.resumeLayouts(true); // Fire event for all groups post expand for (groupName in groupCache) { if (groupCache.hasOwnProperty(groupName)) { me.afterCollapseExpand(false, groupName); if (lockingPartner) { lockingPartner.afterCollapseExpand(false, groupName); } } } }, /** * Collapse a group * @param {String} groupName The group name * @param {Boolean} focus Pass `true` to focus the group after expand. */ collapse: function(groupName, focus) { this.doCollapseExpand(true, groupName, focus); }, // private // Returns true if all groups are collapsed isAllCollapsed: function() { var me = this, groupCache = me.groupCache, groupName; // Clear all collapsed flags. // groupCache is shared between two lockingPartners for (groupName in groupCache) { if (groupCache.hasOwnProperty(groupName)) { if (!groupCache[groupName].isCollapsed) { return false; } } } return true; }, // private // Returns true if all groups are expanded isAllExpanded: function() { var me = this, groupCache = me.groupCache, groupName; // Clear all collapsed flags. // groupCache is shared between two lockingPartners for (groupName in groupCache) { if (groupCache.hasOwnProperty(groupName)) { if (groupCache[groupName].isCollapsed) { return false; } } } return true; }, /** * Collapse all groups */ collapseAll: function() { var me = this, view = me.view, groupCache = me.groupCache, groupName, lockingPartner = me.lockingPartner, partnerView; // Set all collapsed flags // groupCache is shared between two lockingPartners for (groupName in groupCache) { if (groupCache.hasOwnProperty(groupName)) { groupCache[groupName].isCollapsed = true; } } Ext.suspendLayouts(); view.suspendEvent('beforerefresh', 'refresh'); if (lockingPartner) { partnerView = lockingPartner.view partnerView.suspendEvent('beforerefresh', 'refresh'); } me.dataSource.onRefresh(); view.resumeEvent('beforerefresh', 'refresh'); if (lockingPartner) { partnerView.resumeEvent('beforerefresh', 'refresh'); } if (lockingPartner && !lockingPartner.isAllCollapsed()) { lockingPartner.collapseAll(); } Ext.resumeLayouts(true); // Fire event for all groups post collapse for (groupName in groupCache) { if (groupCache.hasOwnProperty(groupName)) { me.afterCollapseExpand(true, groupName); if (lockingPartner) { lockingPartner.afterCollapseExpand(true, groupName); } } } }, doCollapseExpand: function(collapsed, groupName, focus) { var me = this, lockingPartner = me.lockingPartner, group = me.groupCache[groupName]; // groupCache is shared between two lockingPartners if (group.isCollapsed != collapsed) { // The GroupStore is shared by partnered Grouping features, so this will refresh both sides. // We only want one layout as a result though, so suspend layouts while refreshing. Ext.suspendLayouts(); if (collapsed) { me.dataSource.collapseGroup(group); } else { me.dataSource.expandGroup(group); } Ext.resumeLayouts(true); // Sync the group state and focus the row if requested. me.afterCollapseExpand(collapsed, groupName, focus); // Sync the lockingPartner's group state. // Do not pass on focus flag. If we were told to focus, we must focus, not the other side. if (lockingPartner) { lockingPartner.afterCollapseExpand(collapsed, groupName, false); } } }, afterCollapseExpand: function(collapsed, groupName, focus) { var me = this, view = me.view, header; header = Ext.get(this.getHeaderNode(groupName)); view.fireEvent(collapsed ? 'groupcollapse' : 'groupexpand', view, header, groupName); if (focus) { header.up(view.getItemSelector()).scrollIntoView(view.el, null, true); } }, onGroupChange: function() { var me = this, field = me.getGroupField(), menuItem, visibleGridColumns, groupingByLastVisibleColumn; if (me.hideGroupedHeader) { if (me.lastGroupField) { menuItem = me.getMenuItem(me.lastGroupField); if (menuItem) { menuItem.setChecked(true); } } if (field) { visibleGridColumns = me.view.headerCt.getVisibleGridColumns(); // See if we are being asked to group by the sole remaining visible column. // If so, then do not hide that column. groupingByLastVisibleColumn = ((visibleGridColumns.length === 1) && (visibleGridColumns[0].dataIndex == field)); menuItem = me.getMenuItem(field); if (menuItem && !groupingByLastVisibleColumn) { menuItem.setChecked(false); } } } me.refreshIf(); me.lastGroupField = field; }, /** * Gets the related menu item for a dataIndex * @private * @return {Ext.grid.header.Container} The header */ getMenuItem: function(dataIndex){ var view = this.view, header = view.headerCt.down('gridcolumn[dataIndex=' + dataIndex + ']'), menu = view.headerCt.getMenu(); return header ? menu.down('menuitem[headerId='+ header.id +']') : null; }, onGroupKey: function(keyCode, event) { var me = this, groupName = me.getGroupName(event.target); if (groupName) { me.onGroupClick(me.view, event.target, groupName, event); } }, /** * Toggle between expanded/collapsed state when clicking on * the group. * @private */ onGroupClick: function(view, rowElement, groupName, e) { var me = this, groupCache = me.groupCache, groupIsCollapsed = !me.isExpanded(groupName), g; if (me.collapsible) { // CTRL means collapse all others if (e.ctrlKey) { Ext.suspendLayouts(); for (g in groupCache) { if (g === groupName) { if (groupIsCollapsed) { me.expand(groupName); } } else { me.doCollapseExpand(true, g, false); } } Ext.resumeLayouts(true); return; } if (groupIsCollapsed) { me.expand(groupName); } else { me.collapse(groupName); } } }, setupRowData: function(record, idx, rowValues) { var me = this, data = me.refreshData, groupInfo = me.groupInfo, header = data.header, groupField = data.groupField, store = me.view.dataSource, grouper, groupName, prev, next; rowValues.isCollapsedGroup = false; rowValues.summaryRecord = null; if (data.doGrouping) { grouper = me.view.store.groupers.first(); // This is a placeholder record which represents a whole collapsed group // It is a special case. if (record.children) { groupName = grouper.getGroupString(record.children[0]); rowValues.isFirstRow = rowValues.isLastRow = true; rowValues.itemClasses.push(me.hdCollapsedCls); rowValues.isCollapsedGroup = true; rowValues.groupInfo = groupInfo; groupInfo.groupField = groupField; groupInfo.name = groupName; groupInfo.groupValue = record.children[0].get(groupField); groupInfo.columnName = header ? header.text : groupField; rowValues.collapsibleCls = me.collapsible ? me.collapsibleCls : me.hdNotCollapsibleCls; rowValues.groupId = me.createGroupId(groupName); groupInfo.rows = groupInfo.children = record.children; if (me.showSummaryRow) { rowValues.summaryRecord = data.summaryData[groupName]; } return; } groupName = grouper.getGroupString(record); // See if the current record is the last in the group rowValues.isFirstRow = idx === 0; if (!rowValues.isFirstRow) { prev = store.getAt(idx - 1); // If the previous row is of a different group, then we're at the first for a new group if (prev) { // Must use Model's comparison because Date objects are never equal rowValues.isFirstRow = !prev.isEqual(grouper.getGroupString(prev), groupName); } } // See if the current record is the last in the group rowValues.isLastRow = idx == store.getTotalCount() - 1; if (!rowValues.isLastRow) { next = store.getAt(idx + 1); if (next) { // Must use Model's comparison because Date objects are never equal rowValues.isLastRow = !next.isEqual(grouper.getGroupString(next), groupName); } } if (rowValues.isFirstRow) { groupInfo.groupField = groupField; groupInfo.name = groupName; groupInfo.groupValue = record.get(groupField); groupInfo.columnName = header ? header.text : groupField; rowValues.collapsibleCls = me.collapsible ? me.collapsibleCls : me.hdNotCollapsibleCls; rowValues.groupId = me.createGroupId(groupName); if (!me.isExpanded(groupName)) { rowValues.itemClasses.push(me.hdCollapsedCls); rowValues.isCollapsedGroup = true; } // We only get passed a GroupStore if the store is not buffered if (store.buffered) { groupInfo.rows = groupInfo.children = []; } else { groupInfo.rows = groupInfo.children = me.getRecordGroup(record).children; } rowValues.groupInfo = groupInfo; } if (rowValues.isLastRow) { // Add the group's summary record to the last record in the group if (me.showSummaryRow) { rowValues.summaryRecord = data.summaryData[groupName]; } } } }, setup: function(rows, rowValues) { var me = this, data = me.refreshData, isGrouping = !me.disabled && me.view.store.isGrouped(); me.skippedRows = 0; if (rowValues.view.bufferedRenderer) { rowValues.view.bufferedRenderer.variableRowHeight = true; } data.groupField = me.getGroupField(); data.header = me.getGroupedHeader(data.groupField); data.doGrouping = isGrouping; rowValues.groupHeaderTpl = Ext.XTemplate.getTpl(me, 'groupHeaderTpl'); if (isGrouping && me.showSummaryRow) { data.summaryData = me.generateSummaryData(); } }, cleanup: function(rows, rowValues) { var data = this.refreshData; rowValues.groupInfo = rowValues.groupHeaderTpl = rowValues.isFirstRow = null; data.groupField = data.header = null; }, getGroupName: function(element) { var me = this, view = me.view, eventSelector = me.eventSelector, parts, targetEl, row; // See if element is, or is within a group header. If so, we can extract its name targetEl = Ext.fly(element).findParent(eventSelector); if (!targetEl) { // Otherwise, navigate up to the row and look down to see if we can find it row = Ext.fly(element).findParent(view.itemSelector); if (row) { targetEl = row.down(eventSelector, true); } } if (targetEl) { parts = targetEl.id.split(view.id + '-hd-'); if (parts.length === 2) { return Ext.htmlDecode(parts[1]); } } }, /** * Returns the group data object for the group to which the passed record belongs **if the Store is grouped**. * * @param {Ext.data.Model} record The record for which to return group information. * @return {Object} A single group data block as returned from {@link Ext.data.Store#getGroups Store.getGroups}. Returns * `undefined` if the Store is not grouped. * */ getRecordGroup: function(record) { var grouper = this.view.store.groupers.first(); if (grouper) { return this.groupCache[grouper.getGroupString(record)]; } }, createGroupId: function(group) { return this.view.id + '-hd-' + Ext.htmlEncode(group); }, createGroupCls: function(group) { return this.view.id + '-' + Ext.htmlEncode(group) + '-item'; }, getGroupField: function(){ return this.view.store.getGroupField(); }, getGroupedHeader: function(groupField) { var me = this, headerCt = me.view.headerCt, partner = me.lockingPartner, selector, header; groupField = groupField || this.getGroupField(); if (groupField) { selector = '[dataIndex=' + groupField + ']'; header = headerCt.down(selector); // The header may exist in the locking partner, so check there as well if (!header && partner) { header = partner.view.headerCt.down(selector); } } return header || null; }, getFireEventArgs: function(type, view, targetEl, e) { return [type, view, targetEl, this.getGroupName(targetEl), e]; }, destroy: function(){ var me = this, dataSource = me.dataSource; me.view = me.prunedHeader = me.grid = me.groupCache = me.dataSource = null; me.callParent(); if (dataSource) { dataSource.bindStore(null); } }, onReconfigure: function(grid, store, columns, oldStore, oldColumns) { var me = grid; if (store && store !== oldStore) { // Grouping involves injecting a dataSource in early if (store.buffered !== oldStore.buffered) { Ext.Error.raise('Cannot reconfigure grouping switching between buffered and non-buffered stores'); } if (store.buffered) { me.bindStore(store); me.dataSource.processStore(store); } } } }); /** * This feature adds an aggregate summary row at the bottom of each group that is provided * by the {@link Ext.grid.feature.Grouping} feature. There are two aspects to the summary: * * ## Calculation * * The summary value needs to be calculated for each column in the grid. This is controlled * by the summaryType option specified on the column. There are several built in summary types, * which can be specified as a string on the column configuration. These call underlying methods * on the store: * * - {@link Ext.data.Store#count count} * - {@link Ext.data.Store#sum sum} * - {@link Ext.data.Store#min min} * - {@link Ext.data.Store#max max} * - {@link Ext.data.Store#average average} * * Alternatively, the summaryType can be a function definition. If this is the case, * the function is called with an array of records to calculate the summary value. * * ## Rendering * * Similar to a column, the summary also supports a summaryRenderer function. This * summaryRenderer is called before displaying a value. The function is optional, if * not specified the default calculated value is shown. The summaryRenderer is called with: * * - value {Object} - The calculated value. * - summaryData {Object} - Contains all raw summary values for the row. * - field {String} - The name of the field we are calculating * * ## Example Usage * * @example * Ext.define('TestResult', { * extend: 'Ext.data.Model', * fields: ['student', 'subject', { * name: 'mark', * type: 'int' * }] * }); * * Ext.create('Ext.grid.Panel', { * width: 200, * height: 240, * renderTo: document.body, * features: [{ * groupHeaderTpl: 'Subject: {name}', * ftype: 'groupingsummary' * }], * store: { * model: 'TestResult', * groupField: 'subject', * data: [{ * student: 'Student 1', * subject: 'Math', * mark: 84 * },{ * student: 'Student 1', * subject: 'Science', * mark: 72 * },{ * student: 'Student 2', * subject: 'Math', * mark: 96 * },{ * student: 'Student 2', * subject: 'Science', * mark: 68 * }] * }, * columns: [{ * dataIndex: 'student', * text: 'Name', * summaryType: 'count', * summaryRenderer: function(value){ * return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : ''); * } * }, { * dataIndex: 'mark', * text: 'Mark', * summaryType: 'average' * }] * }); */ Ext.define('Ext.grid.feature.GroupingSummary', { extend: Ext.grid.feature.Grouping , alias: 'feature.groupingsummary', showSummaryRow: true, vetoEvent: function(record, row, rowIndex, e){ var result = this.callParent(arguments); if (result !== false) { if (e.getTarget(this.summaryRowSelector)) { result = false; } } return result; } }); /** * The rowbody feature enhances the grid's markup to have an additional * tr -> td -> div which spans the entire width of the original row. * * This is useful to to associate additional information with a particular * record in a grid. * * Rowbodies are initially hidden unless you override setupRowData. * * Will expose additional events on the gridview with the prefix of 'rowbody'. * For example: 'rowbodyclick', 'rowbodydblclick', 'rowbodycontextmenu'. * * # Example * * @example * Ext.define('Animal', { * extend: 'Ext.data.Model', * fields: ['name', 'latin', 'desc'] * }); * * Ext.create('Ext.grid.Panel', { * width: 400, * height: 300, * renderTo: Ext.getBody(), * store: { * model: 'Animal', * data: [ * {name: 'Tiger', latin: 'Panthera tigris', * desc: 'The largest cat species, weighing up to 306 kg (670 lb).'}, * {name: 'Roman snail', latin: 'Helix pomatia', * desc: 'A species of large, edible, air-breathing land snail.'}, * {name: 'Yellow-winged darter', latin: 'Sympetrum flaveolum', * desc: 'A dragonfly found in Europe and mid and Northern China.'}, * {name: 'Superb Fairy-wren', latin: 'Malurus cyaneus', * desc: 'Common and familiar across south-eastern Australia.'} * ] * }, * columns: [{ * dataIndex: 'name', * text: 'Common name', * width: 125 * }, { * dataIndex: 'latin', * text: 'Scientific name', * flex: 1 * }], * features: [{ * ftype: 'rowbody', * setupRowData: function(record, rowIndex, rowValues) { * var headerCt = this.view.headerCt, * colspan = headerCt.getColumnCount(); * // Usually you would style the my-body-class in CSS file * return { * rowBody: '
    '+record.get("desc")+'
    ', * rowBodyCls: "my-body-class", * rowBodyColspan: colspan * }; * } * }] * }); */ Ext.define('Ext.grid.feature.RowBody', { extend: Ext.grid.feature.Feature , alias: 'feature.rowbody', rowBodyCls: Ext.baseCSSPrefix + 'grid-row-body', rowBodyHiddenCls: Ext.baseCSSPrefix + 'grid-row-body-hidden', rowBodyTdSelector: 'td.' + Ext.baseCSSPrefix + 'grid-cell-rowbody', eventPrefix: 'rowbody', eventSelector: 'tr.' + Ext.baseCSSPrefix + 'grid-rowbody-tr', tableTpl: { before: function(values, out) { var view = values.view, rowValues = view.rowValues; this.rowBody.setup(values.rows, rowValues); }, after: function(values, out) { var view = values.view, rowValues = view.rowValues; this.rowBody.cleanup(values.rows, rowValues); }, priority: 100 }, extraRowTpl: [ '{%', 'values.view.rowBodyFeature.setupRowData(values.record, values.recordIndex, values);', 'this.nextTpl.applyOut(values, out, parent);', '%}', '', '', '', { priority: 100, syncRowHeights: function(firstRow, secondRow) { var owner = this.owner, firstRowBody = Ext.fly(firstRow).down(owner.eventSelector, true), secondRowBody, firstHeight, secondHeight; // Sync the heights of row body elements in each row if they need it. if (firstRowBody && (secondRowBody = Ext.fly(secondRow).down(owner.eventSelector, true))) { if ((firstHeight = firstRowBody.offsetHeight) > (secondHeight = secondRowBody.offsetHeight)) { Ext.fly(secondRowBody).setHeight(firstHeight); } else if (secondHeight > firstHeight) { Ext.fly(firstRowBody).setHeight(secondHeight); } } }, syncContent: function(destRow, sourceRow) { var owner = this.owner, destRowBody = Ext.fly(destRow).down(owner.eventSelector, true), sourceRowBody; // Sync the heights of row body elements in each row if they need it. if (destRowBody && (sourceRowBody = Ext.fly(sourceRow).down(owner.eventSelector, true))) { Ext.fly(destRowBody).syncContent(sourceRowBody); } } } ], init: function(grid) { var me = this, view = me.view; view.rowBodyFeature = me; // If we are not inside a wrapped row, we must listen for mousedown in the body row to trigger selection. // Also need to remove the body row on removing a record. if (!view.findFeature('rowwrap')) { grid.mon(view, { element: 'el', mousedown: me.onMouseDown, scope: me }); me.mon(grid.getStore(), 'remove', me.onStoreRemove, me); } view.headerCt.on({ columnschanged: me.onColumnsChanged, scope: me }); view.addTableTpl(me.tableTpl).rowBody = me; view.addRowTpl(Ext.XTemplate.getTpl(this, 'extraRowTpl')); me.callParent(arguments); }, onStoreRemove: function(store, model, index){ var view = this.view, node; if (view.rendered) { node = view.getNode(index); if (node) { node = Ext.fly(node).next(this.eventSelector); if (node) { node.remove(); } } } }, // Needed when not used inside a RowWrap to select the data row when mousedown on the body row. onMouseDown: function(e) { var me = this, tableRow = e.getTarget(me.eventSelector); // If we have mousedowned on a row body TR and its previous sibling is a grid row, pass that onto the view for processing if (tableRow && Ext.fly(tableRow = tableRow.previousSibling).is(me.view.getItemSelector())) { e.target = tableRow; me.view.handleEvent(e); } }, getSelectedRow: function(view, rowIndex) { var selectedRow = view.getNode(rowIndex, false); if (selectedRow) { return Ext.fly(selectedRow).down(this.eventSelector); } return null; }, // When columns added/removed, keep row body colspan in sync with number of columns. onColumnsChanged: function(headerCt) { var items = this.view.el.query(this.rowBodyTdSelector), colspan = headerCt.getVisibleGridColumns().length, len = items.length, i; for (i = 0; i < len; ++i) { items[i].colSpan = colspan; } }, /** * @method getAdditionalData * Provides additional data to the prepareData call within the grid view. * The rowbody feature adds 3 additional variables into the grid view's template. * These are rowBodyCls, rowBodyColspan, and rowBody. * @param {Object} data The data for this particular record. * @param {Number} idx The row index for this record. * @param {Ext.data.Model} record The record instance * @param {Object} orig The original result from the prepareData call to massage. */ setupRowData: function(record, rowIndex, rowValues) { if (this.getAdditionalData) { Ext.apply(rowValues, this.getAdditionalData(record.data, rowIndex, record, rowValues)); } }, setup: function(rows, rowValues) { rowValues.rowBodyCls = this.rowBodyCls; rowValues.rowBodyColspan = rowValues.view.getGridColumns().length; }, cleanup: function(rows, rowValues) { rowValues.rowBodyCls = rowValues.rowBodyColspan = rowValues.rowBody = null; } }); /** * @private */ Ext.define('Ext.grid.feature.RowWrap', { extend: Ext.grid.feature.Feature , alias: 'feature.rowwrap', rowWrapTd: 'td.' + Ext.baseCSSPrefix + 'grid-rowwrap', // turn off feature events. hasFeatureEvent: false, tableTpl: { before: function(values, out) { if (values.view.bufferedRenderer) { values.view.bufferedRenderer.variableRowHeight = true; } }, priority: 200 }, wrapTpl: [ '', '', '', { priority: 200 } ], init: function(grid) { var me = this; me.view.addTableTpl(me.tableTpl); me.view.addRowTpl(Ext.XTemplate.getTpl(me, 'wrapTpl')); me.view.headerCt.on({ columnhide: me.onColumnHideShow, columnshow: me.onColumnHideShow, scope: me }); }, // Keep row wtap colspan in sync with number of *visible* columns. onColumnHideShow: function() { var view = this.view, items = view.el.query(this.rowWrapTd), colspan = view.headerCt.getVisibleGridColumns().length, len = items.length, i; for (i = 0; i < len; ++i) { items[i].colSpan = colspan; } } }); /** * This feature is used to place a summary row at the bottom of the grid. If using a grouping, * see {@link Ext.grid.feature.GroupingSummary}. There are 2 aspects to calculating the summaries, * calculation and rendering. * * ## Calculation * The summary value needs to be calculated for each column in the grid. This is controlled * by the summaryType option specified on the column. There are several built in summary types, * which can be specified as a string on the column configuration. These call underlying methods * on the store: * * - {@link Ext.data.Store#count count} * - {@link Ext.data.Store#sum sum} * - {@link Ext.data.Store#min min} * - {@link Ext.data.Store#max max} * - {@link Ext.data.Store#average average} * * Alternatively, the summaryType can be a function definition. If this is the case, * the function is called with an array of records to calculate the summary value. * * ## Rendering * Similar to a column, the summary also supports a summaryRenderer function. This * summaryRenderer is called before displaying a value. The function is optional, if * not specified the default calculated value is shown. The summaryRenderer is called with: * * - value {Object} - The calculated value. * - summaryData {Object} - Contains all raw summary values for the row. * - field {String} - The name of the field we are calculating * * ## Example Usage * * @example * Ext.define('TestResult', { * extend: 'Ext.data.Model', * fields: ['student', { * name: 'mark', * type: 'int' * }] * }); * * Ext.create('Ext.grid.Panel', { * width: 400, * height: 200, * title: 'Summary Test', * style: 'padding: 20px', * renderTo: document.body, * features: [{ * ftype: 'summary' * }], * store: { * model: 'TestResult', * data: [{ * student: 'Student 1', * mark: 84 * },{ * student: 'Student 2', * mark: 72 * },{ * student: 'Student 3', * mark: 96 * },{ * student: 'Student 4', * mark: 68 * }] * }, * columns: [{ * dataIndex: 'student', * text: 'Name', * summaryType: 'count', * summaryRenderer: function(value, summaryData, dataIndex) { * return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : ''); * } * }, { * dataIndex: 'mark', * text: 'Mark', * summaryType: 'average' * }] * }); */ Ext.define('Ext.grid.feature.Summary', { /* Begin Definitions */ extend: Ext.grid.feature.AbstractSummary , alias: 'feature.summary', /** * @cfg {String} dock * Configure `'top'` or `'bottom'` top create a fixed summary row either above or below the scrollable table. * */ dock: undefined, dockedSummaryCls: Ext.baseCSSPrefix + 'docked-summary', panelBodyCls: Ext.baseCSSPrefix + 'summary-', init: function(grid) { var me = this, view = me.view; me.callParent(arguments); if (me.dock) { grid.headerCt.on({ afterlayout: me.onStoreUpdate, scope: me }); grid.on({ beforerender: function() { var tableCls = [me.summaryTableCls]; if (view.columnLines) { tableCls[tableCls.length] = view.ownerCt.colLinesCls; } me.summaryBar = grid.addDocked({ childEls: ['innerCt'], renderTpl: [ '
    ', '
    ` HTML tag to its output stream. * * The `cellTpl's` data object looks like this: * * { * record: recordToRender * column: columnToRender; * recordIndex: indexOfRecordInStore, * columnIndex: columnIndex, * align: columnAlign, * tdCls: classForCell * } * * A Feature may inject its own tableTpl or rowTpl or cellTpl into the {@link Ext.view.Table TableView}'s rendering by * calling {@link Ext.view.Table#addTableTpl} or {@link Ext.view.Table#addRowTpl} or {@link Ext.view.Table#addCellTpl}. * * The passed XTemplate is added *upstream* of the default template for the table element in a link list of XTemplates which contribute * to the element's HTML. It may emit appropriate HTML strings into the output stream *around* a call to * * this.nextTpl.apply(values, out, parent); * * This passes the current value context, output stream and the parent value context to the next XTemplate in the list. * * @abstract */ Ext.define('Ext.grid.feature.Feature', { extend: Ext.util.Observable , alias: 'feature.feature', wrapsItem: false, /* * @property {Boolean} isFeature * `true` in this class to identify an object as an instantiated Feature, or subclass thereof. */ isFeature: true, /** * True when feature is disabled. */ disabled: false, /** * @property {Boolean} * Most features will expose additional events, some may not and will * need to change this to false. */ hasFeatureEvent: true, /** * @property {String} * Prefix to use when firing events on the view. * For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick". */ eventPrefix: null, /** * @property {String} * Selector used to determine when to fire the event with the eventPrefix. */ eventSelector: null, /** * @property {Ext.view.Table} * Reference to the TableView. */ view: null, /** * @property {Ext.grid.Panel} * Reference to the grid panel */ grid: null, constructor: function(config) { this.initialConfig = config; this.callParent(arguments); }, clone: function() { return new this.self(this.initialConfig); }, init: Ext.emptyFn, destroy: function(){ this.clearListeners(); }, /** * Abstract method to be overriden when a feature should add additional * arguments to its event signature. By default the event will fire: * * - view - The underlying Ext.view.Table * - featureTarget - The matched element by the defined {@link #eventSelector} * * The method must also return the eventName as the first index of the array * to be passed to fireEvent. * @template */ getFireEventArgs: function(eventName, view, featureTarget, e) { return [eventName, view, featureTarget, e]; }, vetoEvent: Ext.emptyFn, /** * Enables the feature. */ enable: function() { this.disabled = false; }, /** * Disables the feature. */ disable: function() { this.disabled = true; } }); /** * A small abstract class that contains the shared behaviour for any summary * calculations to be used in the grid. */ Ext.define('Ext.grid.feature.AbstractSummary', { extend: Ext.grid.feature.Feature , alias: 'feature.abstractsummary', summaryRowCls: Ext.baseCSSPrefix + 'grid-row-summary', summaryTableCls: Ext.plainTableCls + ' ' + Ext.baseCSSPrefix + 'grid-table', summaryRowSelector: '.' + Ext.baseCSSPrefix + 'grid-row-summary', // High priority rowTpl interceptor which sees summary rows early, and renders them correctly and then aborts the row rendering chain. // This will only see action when summary rows are being updated and Table.onUpdate->Table.bufferRender renders the individual updated sumary row. summaryRowTpl: { before: function(values, out) { // If a summary record comes through the rendering pipeline, render it simply, and return false from the // before method which aborts the tpl chain if (values.record.isSummary) { this.summaryFeature.outputSummaryRecord(values.record, values, out); return false; } }, priority: 1000 }, /** * @cfg {Boolean} * True to show the summary row. */ showSummaryRow: true, // Listen for store updates. Eg, from an Editor. init: function() { var me = this; me.view.summaryFeature = me; me.rowTpl = me.view.self.prototype.rowTpl; // Add a high priority interceptor which renders summary records simply // This will only see action ona bufferedRender situation where summary records are updated. me.view.addRowTpl(me.summaryRowTpl).summaryFeature = me; }, /** * Toggle whether or not to show the summary row. * @param {Boolean} visible True to show the summary row */ toggleSummaryRow: function(visible) { this.showSummaryRow = !!visible; }, outputSummaryRecord: function(summaryRecord, contextValues, out) { var view = contextValues.view, savedRowValues = view.rowValues, columns = contextValues.columns || view.headerCt.getVisibleGridColumns(), colCount = columns.length, i, column, // Set up a row rendering values object so that we can call the rowTpl directly to inject // the markup of a grid row into the output stream. values = { view: view, record: summaryRecord, rowStyle: '', rowClasses: [ this.summaryRowCls ], itemClasses: [], recordIndex: -1, rowId: view.getRowId(summaryRecord), columns: columns }; // Because we are using the regular row rendering pathway, temporarily swap out the renderer for the summaryRenderer for (i = 0; i < colCount; i++) { column = columns[i]; column.savedRenderer = column.renderer; if (column.summaryRenderer) { column.renderer = column.summaryRenderer; } else if (!column.summaryType) { column.renderer = Ext.emptyFn; } // Summary records may contain values based upon the column's ID if the column is not mapped from a field if (!column.dataIndex) { column.dataIndex = column.id; } } // Use the base template to render a summary row view.rowValues = values; view.self.prototype.rowTpl.applyOut(values, out); view.rowValues = savedRowValues; // Restore regular column renderers for (i = 0; i < colCount; i++) { column = columns[i]; column.renderer = column.savedRenderer; column.savedRenderer = null; } }, /** * Get the summary data for a field. * @private * @param {Ext.data.Store} store The store to get the data from * @param {String/Function} type The type of aggregation. If a function is specified it will * be passed to the stores aggregate function. * @param {String} field The field to aggregate on * @param {Boolean} group True to aggregate in grouped mode * @return {Number/String/Object} See the return type for the store functions. * if the group parameter is `true` An object is returned with a property named for each group who's * value is the summary value. */ getSummary: function(store, type, field, group){ var records = group.records; if (type) { if (Ext.isFunction(type)) { return store.getAggregate(type, null, records, [field]); } switch (type) { case 'count': return records.length; case 'min': return store.getMin(records, field); case 'max': return store.getMax(records, field); case 'sum': return store.getSum(records, field); case 'average': return store.getAverage(records, field); default: return ''; } } }, /** * Used by the Grouping Feature when {@link #showSummaryRow} is `true`. * * Generates group summary data for the whole store. * @private * @return {Object} An object hash keyed by group name containing summary records. */ generateSummaryData: function(){ var me = this, store = me.view.store, groups = store.groups.items, reader = store.proxy.reader, len = groups.length, groupField = me.getGroupField(), data = {}, lockingPartner = me.lockingPartner, i, group, record, root, summaryRows, hasRemote, convertedSummaryRow, remoteData; /** * @cfg {String} [remoteRoot=undefined] * The name of the property which contains the Array of summary objects. * It allows to use server-side calculated summaries. */ if (me.remoteRoot && reader.rawData) { hasRemote = true; remoteData = {}; // reset reader root and rebuild extractors to extract summaries data root = reader.root; reader.root = me.remoteRoot; reader.buildExtractors(true); summaryRows = reader.getRoot(reader.rawData)||[]; len = summaryRows.length; // Ensure the Reader has a data conversion function to convert a raw data row into a Record data hash if (!reader.convertRecordData) { reader.buildExtractors(); } for (i = 0; i < len; ++i) { convertedSummaryRow = {}; // Convert a raw data row into a Record's hash object using the Reader reader.convertRecordData(convertedSummaryRow, summaryRows[i]); remoteData[convertedSummaryRow[groupField]] = convertedSummaryRow; } // restore initial reader configuration reader.root = root; reader.buildExtractors(true); } for (i = 0; i < len; ++i) { group = groups[i]; // Something has changed or it doesn't exist, populate it if (hasRemote || group.isDirty() || !group.hasAggregate()) { if (hasRemote) { record = me.populateRemoteRecord(group, remoteData); } else { record = me.populateRecord(group); } // Clear the dirty state of the group if this is the only Summary, or this is the right hand (normal grid's) summary if (!lockingPartner || (me.view.ownerCt === me.view.ownerCt.ownerLockable.normalGrid)) { group.commit(); } } else { record = group.getAggregateRecord(); } data[group.key] = record; } return data; }, populateRemoteRecord: function(group, data) { var record = group.getAggregateRecord(true), groupData = data[group.key], field; record.beginEdit(); for (field in groupData) { if (groupData.hasOwnProperty(field)) { if (field !== record.idProperty) { record.set(field, groupData[field]); } } } record.endEdit(true); record.commit(true); return record; }, populateRecord: function(group){ var me = this, view = me.grid.ownerLockable ? me.grid.ownerLockable.view : me.view, store = me.view.store, record = group.getAggregateRecord(), // Use the full column set, regardless of locking columns = view.headerCt.getGridColumns(), len = columns.length, i, column, fieldName; record.beginEdit(); for (i = 0; i < len; ++i) { column = columns[i]; // Use the column id if there's no mapping, could be a calculated field fieldName = column.dataIndex || column.id; record.set(fieldName, me.getSummary(store, column.summaryType, fieldName, group)); } record.endEdit(true); record.commit(); return record; } }); /** * Private record store class which takes the place of the view's data store to provide a grouped * view of the data when the Grouping feature is used. * * Relays granular mutation events from the underlying store as refresh events to the view. * * On mutation events from the underlying store, updates the summary rows by firing update events on the corresponding * summary records. * @private */ Ext.define('Ext.grid.feature.GroupStore', { extend: Ext.util.Observable , isStore: true, constructor: function(groupingFeature, store) { var me = this; me.superclass.constructor.apply(me, arguments); me.groupingFeature = groupingFeature; me.bindStore(store); me.processStore(store); me.view.dataSource = me; }, bindStore: function(store) { var me = this; if (me.store) { Ext.destroy(me.storeListeners); me.store = null; } if (store) { me.storeListeners = store.on({ bulkremove: me.onBulkRemove, add: me.onAdd, update: me.onUpdate, refresh: me.onRefresh, clear: me.onClear, scope: me, destroyable: true }); me.store = store; } }, processStore: function(store) { var me = this, groups = store.getGroups(), groupCount = groups.length, i, group, groupPlaceholder, data = me.data, oldGroupCache = me.groupingFeature.groupCache, groupCache = me.groupingFeature.clearGroupCache(), collapseAll = me.groupingFeature.startCollapsed; if (data) { data.clear(); } else { data = me.data = new Ext.util.MixedCollection(false, Ext.data.Store.recordIdFn); } if (store.getCount()) { // Upon first process of a loaded store, clear the "always" collapse" flag me.groupingFeature.startCollapsed = false; for (i = 0; i < groupCount; i++) { // group contains eg // { children: [childRec0, childRec1...], name: } group = groups[i]; // Cache group information by group name groupCache[group.name] = group; group.isCollapsed = collapseAll || (oldGroupCache[group.name] && oldGroupCache[group.name].isCollapsed); // If group is collapsed, then represent it by one dummy row which is never visible, but which acts // as a start and end group trigger. if (group.isCollapsed) { group.placeholder = groupPlaceholder = new store.model(null, 'group-' + group.name + '-placeholder'); groupPlaceholder.set(me.getGroupField(), group.name); groupPlaceholder.rows = groupPlaceholder.children = group.children; groupPlaceholder.isCollapsedPlaceholder = true; data.add(groupPlaceholder); } // Expanded group - add the group's child records. else { data.insert(me.data.length, group.children); } } } }, isCollapsed: function(name) { return this.groupingFeature.groupCache[name].isCollapsed; }, isInCollapsedGroup: function(record) { var groupData; if (this.store.isGrouped() && (groupData = this.groupingFeature.groupCache[record.get(this.getGroupField())])) { return groupData.isCollapsed || false; } return false; }, getCount: function() { return this.data.getCount(); }, getTotalCount: function() { return this.data.getCount(); }, // This class is only created for fully loaded, non-buffered stores rangeCached: function(start, end) { return end < this.getCount(); }, getRange: function(start, end, options) { var result = this.data.getRange(start, end); if (options && options.callback) { options.callback.call(options.scope || this, result, start, end, options); } return result; }, getAt: function(index) { return this.getRange(index, index)[0]; }, getById: function(id) { return this.store.getById(id); }, expandGroup: function(group) { var me = this, startIdx; if (typeof group === 'string') { group = me.groupingFeature.groupCache[group]; } if (group && group.children.length && (startIdx = me.indexOf(group.children[0], true, true)) !== -1) { // Any event handlers must see the new state group.isCollapsed = false; me.isExpandingOrCollapsing = 1; // Remove the collapsed group placeholder record me.data.removeAt(startIdx); me.fireEvent('bulkremove', me, [me.getGroupPlaceholder(group)], [startIdx]); // Insert the child records in its place me.data.insert(startIdx, group.children); me.fireEvent('add', me, group.children, startIdx); me.fireEvent('groupexpand', me, group); me.isExpandingOrCollapsing = 0; } }, collapseGroup: function(group) { var me = this, startIdx, placeholder, i, j, len, removeIndices; if (typeof group === 'string') { group = me.groupingFeature.groupCache[group]; } if (group && (len = group.children.length) && (startIdx = me.indexOf(group.children[0], true)) !== -1) { // Any event handlers must see the new state group.isCollapsed = true; me.isExpandingOrCollapsing = 2; // Remove the group child records me.data.removeRange(startIdx, len); // Indices argument is mandatory and used by views - we MUST build it. removeIndices = new Array(len); for (i = 0, j = startIdx; i < len; i++, j++) { removeIndices[i] = j; } me.fireEvent('bulkremove', me, group.children, removeIndices); // Insert a placeholder record in their place me.data.insert(startIdx, placeholder = me.getGroupPlaceholder(group)); me.fireEvent('add', me, [placeholder], startIdx); me.fireEvent('groupcollapse', me, group); me.isExpandingOrCollapsing = 0; } }, getGroupPlaceholder: function(group) { if (!group.placeholder) { var groupPlaceholder = group.placeholder = new this.store.model(null, 'group-' + group.name + '-placeholder'); groupPlaceholder.set(this.getGroupField(), group.name); groupPlaceholder.rows = groupPlaceholder.children = group.children; groupPlaceholder.isCollapsedPlaceholder = true; } return group.placeholder; }, // Find index of record in group store. // If it's in a collapsed group, then it's -1, not present // Otherwise, loop through groups keeping tally of intervening records. indexOf: function(record, viewOnly, includeCollapsed) { var me = this, groups, groupCount, i, group, groupIndex, result = 0; if (record && (includeCollapsed || !me.isInCollapsedGroup(record))) { groups = me.store.getGroups(); groupCount = groups.length; for (i = 0; i < groupCount; i++) { // group contains eg // { children: [childRec0, childRec1...], name: } group = groups[i]; if (group.name === this.store.getGroupString(record)) { groupIndex = Ext.Array.indexOf(group.children, record); return result + groupIndex; } result += (viewOnly && me.isCollapsed(group.name)) ? 1 : group.children.length; } } return -1; }, /** * Get the index within the entire dataset. From 0 to the totalCount. * * Like #indexOf, this method is effected by filtering. * * @param {Ext.data.Model} record The Ext.data.Model object to find. * @return {Number} The index of the passed Record. Returns -1 if not found. */ indexOfTotal: function(record) { var index = record.index; if (index || index === 0) { return index; } return this.istore.ndexOf(record); }, onRefresh: function(store) { this.processStore(this.store); this.fireEvent('refresh', this); }, onBulkRemove: function(store, records, indices) { this.processStore(this.store); this.fireEvent('refresh', this); }, onClear: function(store, records, startIndex) { this.processStore(this.store); this.fireEvent('clear', this); }, onAdd: function(store, records, startIndex) { this.processStore(this.store); this.fireEvent('refresh', this); }, onUpdate: function(store, record, operation, modifiedFieldNames) { var me = this, groupInfo = me.groupingFeature.getRecordGroup(record), firstRec, lastRec; // The grouping field value has been modified. // This could either move a record from one group to another, or introduce a new group. // Either way, we have to refresh the grid if (store.isGrouped()) { if (modifiedFieldNames && Ext.Array.contains(modifiedFieldNames, me.groupingFeature.getGroupField())) { return me.onRefresh(me.store); } // Fire an update event on the collapsed group placeholder record if (groupInfo.isCollapsed) { me.fireEvent('update', me, groupInfo.placeholder); } // Not in a collapsed group, fire update event on the modified record // and, if in a grouped store, on the first and last records in the group. else { Ext.suspendLayouts(); // Propagate the record's update event me.fireEvent('update', me, record, operation, modifiedFieldNames); // Fire update event on first and last record in group (only once if a single row group) // So that custom header TPL is applied, and the summary row is updated firstRec = groupInfo.children[0]; lastRec = groupInfo.children[groupInfo.children.length - 1]; // Do not pass modifiedFieldNames so that the TableView's shouldUpdateCell call always returns true. if (firstRec !== record) { me.fireEvent('update', me, firstRec, 'edit'); } if (lastRec !== record && lastRec !== firstRec) { me.fireEvent('update', me, lastRec, 'edit'); } Ext.resumeLayouts(true); } } else { // Propagate the record's update event me.fireEvent('update', me, record, operation, modifiedFieldNames); } } }); /** * This feature allows to display the grid rows aggregated into groups as specified by the {@link Ext.data.Store#groupers} * specified on the Store. The group will show the title for the group name and then the appropriate records for the group * underneath. The groups can also be expanded and collapsed. * * ## Extra Events * * This feature adds several extra events that will be fired on the grid to interact with the groups: * * - {@link #groupclick} * - {@link #groupdblclick} * - {@link #groupcontextmenu} * - {@link #groupexpand} * - {@link #groupcollapse} * * ## Menu Augmentation * * This feature adds extra options to the grid column menu to provide the user with functionality to modify the grouping. * This can be disabled by setting the {@link #enableGroupingMenu} option. The option to disallow grouping from being turned off * by the user is {@link #enableNoGroups}. * * ## Controlling Group Text * * The {@link #groupHeaderTpl} is used to control the rendered title for each group. It can modified to customized * the default display. * * ## Example Usage * * @example * var store = Ext.create('Ext.data.Store', { * storeId:'employeeStore', * fields:['name', 'seniority', 'department'], * groupField: 'department', * data: {'employees':[ * { "name": "Michael Scott", "seniority": 7, "department": "Management" }, * { "name": "Dwight Schrute", "seniority": 2, "department": "Sales" }, * { "name": "Jim Halpert", "seniority": 3, "department": "Sales" }, * { "name": "Kevin Malone", "seniority": 4, "department": "Accounting" }, * { "name": "Angela Martin", "seniority": 5, "department": "Accounting" } * ]}, * proxy: { * type: 'memory', * reader: { * type: 'json', * root: 'employees' * } * } * }); * * Ext.create('Ext.grid.Panel', { * title: 'Employees', * store: Ext.data.StoreManager.lookup('employeeStore'), * columns: [ * { text: 'Name', dataIndex: 'name' }, * { text: 'Seniority', dataIndex: 'seniority' } * ], * features: [{ftype:'grouping'}], * width: 200, * height: 275, * renderTo: Ext.getBody() * }); * * **Note:** To use grouping with a grid that has {@link Ext.grid.column.Column#locked locked columns}, you need to supply * the grouping feature as a config object - so the grid can create two instances of the grouping feature. * * @author Nigel White */ Ext.define('Ext.grid.feature.Grouping', { extend: Ext.grid.feature.Feature , mixins: { summary: Ext.grid.feature.AbstractSummary }, alias: 'feature.grouping', eventPrefix: 'group', groupCls: Ext.baseCSSPrefix + 'grid-group-hd', eventSelector: '.' + Ext.baseCSSPrefix + 'grid-group-hd', refreshData: {}, groupInfo: {}, wrapsItem: true, /** * @event groupclick * @param {Ext.view.Table} view * @param {HTMLElement} node * @param {String} group The name of the group * @param {Ext.EventObject} e */ /** * @event groupdblclick * @param {Ext.view.Table} view * @param {HTMLElement} node * @param {String} group The name of the group * @param {Ext.EventObject} e */ /** * @event groupcontextmenu * @param {Ext.view.Table} view * @param {HTMLElement} node * @param {String} group The name of the group * @param {Ext.EventObject} e */ /** * @event groupcollapse * @param {Ext.view.Table} view * @param {HTMLElement} node * @param {String} group The name of the group */ /** * @event groupexpand * @param {Ext.view.Table} view * @param {HTMLElement} node * @param {String} group The name of the group */ /** * @cfg {String/Array/Ext.Template} groupHeaderTpl * A string Template snippet, an array of strings (optionally followed by an object containing Template methods) to be used to construct a Template, or a Template instance. * * - Example 1 (Template snippet): * * groupHeaderTpl: 'Group: {name}' * * - Example 2 (Array): * * groupHeaderTpl: [ * 'Group: ', * '
    {name:this.formatName}
    ', * { * formatName: function(name) { * return Ext.String.trim(name); * } * } * ] * * - Example 3 (Template Instance): * * groupHeaderTpl: Ext.create('Ext.XTemplate', * 'Group: ', * '
    {name:this.formatName}
    ', * { * formatName: function(name) { * return Ext.String.trim(name); * } * } * ) * * @cfg {String} groupHeaderTpl.groupField The field name being grouped by. * @cfg {String} groupHeaderTpl.columnName The column header associated with the field being grouped by *if there is a column for the field*, falls back to the groupField name. * @cfg {Mixed} groupHeaderTpl.groupValue The value of the {@link Ext.data.Store#groupField groupField} for the group header being rendered. * @cfg {String} groupHeaderTpl.renderedGroupValue The rendered value of the {@link Ext.data.Store#groupField groupField} for the group header being rendered, as produced by the column renderer. * @cfg {String} groupHeaderTpl.name An alias for renderedGroupValue * @cfg {Ext.data.Model[]} groupHeaderTpl.rows Deprecated - use children instead. An array containing the child records for the group being rendered. *Not available if the store is {@link Ext.data.Store#buffered buffered}* * @cfg {Ext.data.Model[]} groupHeaderTpl.children An array containing the child records for the group being rendered. *Not available if the store is {@link Ext.data.Store#buffered buffered}* */ groupHeaderTpl: '{columnName}: {name}', /** * @cfg {Number} [depthToIndent=17] * Number of pixels to indent per grouping level */ depthToIndent: 17, collapsedCls: Ext.baseCSSPrefix + 'grid-group-collapsed', hdCollapsedCls: Ext.baseCSSPrefix + 'grid-group-hd-collapsed', hdNotCollapsibleCls: Ext.baseCSSPrefix + 'grid-group-hd-not-collapsible', collapsibleCls: Ext.baseCSSPrefix + 'grid-group-hd-collapsible', ctCls: Ext.baseCSSPrefix + 'group-hd-container', // /** * @cfg {String} [groupByText="Group by this field"] * Text displayed in the grid header menu for grouping by header. */ groupByText : 'Group by this field', // // /** * @cfg {String} [showGroupsText="Show in groups"] * Text displayed in the grid header for enabling/disabling grouping. */ showGroupsText : 'Show in groups', // /** * @cfg {Boolean} [hideGroupedHeader=false] * True to hide the header that is currently grouped. */ hideGroupedHeader : false, /** * @cfg {Boolean} [startCollapsed=false] * True to start all groups collapsed. */ startCollapsed : false, /** * @cfg {Boolean} [enableGroupingMenu=true] * True to enable the grouping control in the header menu. */ enableGroupingMenu : true, /** * @cfg {Boolean} [enableNoGroups=true] * True to allow the user to turn off grouping. */ enableNoGroups : true, /** * @cfg {Boolean} [collapsible=true] * Set to `false` to disable collapsing groups from the UI. * * This is set to `false` when the associated {@link Ext.data.Store store} is * {@link Ext.data.Store#buffered buffered}. */ collapsible: true, // expandTip: 'Click to expand. CTRL key collapses all others', // // collapseTip: 'Click to collapse. CTRL/click collapses all others', // showSummaryRow: false, tableTpl: { before: function(values) { // Do not process if we are disabled, and do not process summary records if (this.groupingFeature.disabled || values.rows.length === 1 && values.rows[0].isSummary) { return; } this.groupingFeature.setup(values.rows, values.view.rowValues); }, after: function(values) { // Do not process if we are disabled, and do not process summary records if (this.groupingFeature.disabled || values.rows.length === 1 && values.rows[0].isSummary) { return; } this.groupingFeature.cleanup(values.rows, values.view.rowValues); }, priority: 200 }, groupTpl: [ '{%', 'var me = this.groupingFeature;', // If grouping is disabled, do not call setupRowData, and do not wrap 'if (me.disabled) {', 'values.needsWrap = false;', '} else {', 'me.setupRowData(values.record, values.recordIndex, values);', 'values.needsWrap = !me.disabled && (values.isFirstRow || values.summaryRecord);', '}', '%}', '', '
    ', '', '{%', // Group title is visible if not locking, or we are the locked side, or the locked side has no columns/ // Use visibility to keep row heights synced without intervention. 'var groupTitleStyle = (!values.view.lockingPartner || (values.view.ownerCt === values.view.ownerCt.ownerLockable.lockedGrid) || (values.view.lockingPartner.headerCt.getVisibleGridColumns().length === 0)) ? "" : "visibility:hidden";', '%}', '
    ', '
    ', '{[values.groupHeaderTpl.apply(values.groupInfo, parent) || " "]}', '
    ', '
    ', '
    ', // Only output the child rows if this is *not* a collapsed group '', ' ', Ext.baseCSSPrefix, 'grid-table-summary"', 'border="0" cellspacing="0" cellpadding="0" style="width:100%">', '{[values.view.renderColumnSizer(out)]}', // Only output the first row if this is *not* a collapsed group '', '{%', 'values.itemClasses.length = 0;', 'this.nextTpl.applyOut(values, out, parent);', '%}', '', '', '{%me.outputSummaryRecord(values.summaryRecord, values, out);%}', '', '
    ', '
    ', '
    ', '
    {rowBody}
    ', '
    ', '', '{[values.view.renderColumnSizer(out)]}', '{%', 'values.itemClasses.length = 0;', 'this.nextTpl.applyOut(values, out, parent)', '%}', '
    ', '
    ', '', '
    ', '
    ' ], style: 'overflow:hidden', itemId: 'summaryBar', cls: [ me.dockedSummaryCls, me.dockedSummaryCls + '-' + me.dock ], xtype: 'component', dock: me.dock, weight: 10000000 })[0]; }, afterrender: function() { grid.body.addCls(me.panelBodyCls + me.dock); view.mon(view.el, { scroll: me.onViewScroll, scope: me }); me.onStoreUpdate(); }, single: true }); // Stretch the innerCt of the summary bar upon headerCt layout grid.headerCt.afterComponentLayout = Ext.Function.createSequence(grid.headerCt.afterComponentLayout, function() { me.summaryBar.innerCt.setWidth(this.getFullWidth() + Ext.getScrollbarSize().width); }); } else { me.view.addFooterFn(me.renderTFoot); } grid.on({ columnmove: me.onStoreUpdate, scope: me }); // On change of data, we have to update the docked summary. view.mon(view.store, { update: me.onStoreUpdate, datachanged: me.onStoreUpdate, scope: me }); }, renderTFoot: function(values, out) { var view = values.view, me = view.findFeature('summary'); if (me.showSummaryRow) { out.push(''); me.outputSummaryRecord(me.createSummaryRecord(view), values, out); out.push(''); } }, vetoEvent: function(record, row, rowIndex, e) { return !e.getTarget(this.summaryRowSelector); }, onViewScroll: function() { this.summaryBar.el.dom.scrollLeft = this.view.el.dom.scrollLeft; }, createSummaryRecord: function(view) { var columns = view.headerCt.getVisibleGridColumns(), info = { records: view.store.getRange() }, colCount = columns.length, i, column, summaryRecord = this.summaryRecord || (this.summaryRecord = new view.store.model(null, view.id + '-summary-record')); // Set the summary field values summaryRecord.beginEdit(); for (i = 0; i < colCount; i++) { column = columns[i]; // In summary records, if there's no dataIndex, then the value in regular rows must come from a renderer. // We set the data value in using the column ID. if (!column.dataIndex) { column.dataIndex = column.id; } summaryRecord.set(column.dataIndex, this.getSummary(view.store, column.summaryType, column.dataIndex, info)); } summaryRecord.endEdit(true); // It's not dirty summaryRecord.commit(true); summaryRecord.isSummary = true; return summaryRecord; }, onStoreUpdate: function() { var me = this, view = me.view, record = me.createSummaryRecord(view), newRowDom = view.createRowElement(record, -1), oldRowDom, partner, p; if (!view.rendered) { return; } // Summary row is inside the docked summaryBar Component if (me.dock) { oldRowDom = me.summaryBar.el.down('.' + me.summaryRowCls, true); } // Summary row is a regular row in a THEAD inside the View. // Downlinked through the summary record's ID' else { oldRowDom = me.view.getNode(record); } if (oldRowDom) { p = oldRowDom.parentNode; p.insertBefore(newRowDom, oldRowDom); p.removeChild(oldRowDom); partner = me.lockingPartner; // For locking grids... // Update summary on other side (unless we have been called from the other side) if (partner && partner.grid.rendered && !me.calledFromLockingPartner) { partner.calledFromLockingPartner = true; partner.onStoreUpdate(); partner.calledFromLockingPartner = false; } } // If docked, the updated row will need sizing because it's outside the View if (me.dock) { me.onColumnHeaderLayout(); } }, // Synchronize column widths in the docked summary Component onColumnHeaderLayout: function() { var view = this.view, columns = view.headerCt.getVisibleGridColumns(), column, len = columns.length, i, summaryEl = this.summaryBar.el, el; for (i = 0; i < len; i++) { column = columns[i]; el = summaryEl.down(view.getCellSelector(column)); if (el) { if (column.hidden) { el.setDisplayed(false); } else { el.setDisplayed(true); el.setWidth(column.width || (column.lastBox ? column.lastBox.width : 100)); } } } } }); /** * Private class which acts as a HeaderContainer for the Lockable which aggregates all columns * from both sides of the Loackable. It is never rendered, it's just used to interrogate the * column collection. * @private */ Ext.define('Ext.grid.locking.HeaderContainer', { extend: Ext.grid.header.Container , constructor: function(lockable) { var me = this, events, event, eventNames = [], lockedGrid = lockable.lockedGrid, normalGrid = lockable.normalGrid; me.lockable = lockable; me.callParent(); // Create the unified column manager for the lockable grid assembly lockedGrid.columnManager.rootColumns = normalGrid.columnManager.rootColumns = lockable.columnManager = me.columnManager = new Ext.grid.ColumnManager(lockedGrid.headerCt, normalGrid.headerCt); // Relay events from both sides' headerCts events = lockedGrid.headerCt.events; for (event in events) { if (events.hasOwnProperty(event)) { eventNames.push(event); } } me.relayEvents(lockedGrid.headerCt, eventNames); me.relayEvents(normalGrid.headerCt, eventNames); }, getRefItems: function() { return this.lockable.lockedGrid.headerCt.getRefItems().concat(this.lockable.normalGrid.headerCt.getRefItems()); }, // This is the function which all other column access methods are based upon // Return the full column set for the whole Lockable assembly getGridColumns: function() { return this.lockable.lockedGrid.headerCt.getGridColumns().concat(this.lockable.normalGrid.headerCt.getGridColumns()); }, // Lockable uses its headerCt to gather column state getColumnsState: function () { var me = this, locked = me.lockable.lockedGrid.headerCt.getColumnsState(), normal = me.lockable.normalGrid.headerCt.getColumnsState(); return locked.concat(normal); }, // Lockable uses its headerCt to apply column state applyColumnsState: function (columns) { var me = this, lockedGrid = me.lockable.lockedGrid, lockedHeaderCt = lockedGrid.headerCt, normalHeaderCt = me.lockable.normalGrid.headerCt, lockedCols = Ext.Array.toValueMap(lockedHeaderCt.items.items, 'headerId'), normalCols = Ext.Array.toValueMap(normalHeaderCt.items.items, 'headerId'), locked = [], normal = [], lockedWidth = 1, length = columns.length, i, existing, lockedDefault, col; for (i = 0; i < length; i++) { col = columns[i]; lockedDefault = lockedCols[col.id]; existing = lockedDefault || normalCols[col.id]; if (existing) { if (existing.applyColumnState) { existing.applyColumnState(col); } if (existing.locked === undefined) { existing.locked = !!lockedDefault; } if (existing.locked) { locked.push(existing); if (!existing.hidden && typeof existing.width == 'number') { lockedWidth += existing.width; } } else { normal.push(existing); } } } // state and config must have the same columns (compare counts for now): if (locked.length + normal.length == lockedHeaderCt.items.getCount() + normalHeaderCt.items.getCount()) { lockedHeaderCt.removeAll(false); normalHeaderCt.removeAll(false); lockedHeaderCt.add(locked); normalHeaderCt.add(normal); lockedGrid.setWidth(lockedWidth); } } }); /** * This class is used internally to provide a single interface when using * a locking grid. Internally, the locking grid creates two separate grids, * so this class is used to map calls appropriately. * @private */ Ext.define('Ext.grid.locking.View', { alternateClassName: 'Ext.grid.LockingView', mixins: { observable: Ext.util.Observable }, /** * @property {Boolean} isLockingView * `true` in this class to identify an object as an instantiated LockingView, or subclass thereof. */ isLockingView: true, eventRelayRe: /^(beforeitem|beforecontainer|item|container|cell|refresh)/, constructor: function(config){ var me = this, eventNames = [], eventRe = me.eventRelayRe, locked = config.locked.getView(), normal = config.normal.getView(), events, event; Ext.apply(me, { lockedView: locked, normalView: normal, lockedGrid: config.locked, normalGrid: config.normal, panel: config.panel }); me.mixins.observable.constructor.call(me, config); // relay events events = locked.events; for (event in events) { if (events.hasOwnProperty(event) && eventRe.test(event)) { eventNames.push(event); } } me.relayEvents(locked, eventNames); me.relayEvents(normal, eventNames); normal.on({ scope: me, itemmouseleave: me.onItemMouseLeave, itemmouseenter: me.onItemMouseEnter }); locked.on({ scope: me, itemmouseleave: me.onItemMouseLeave, itemmouseenter: me.onItemMouseEnter }); me.panel.on({ render: me.onPanelRender, scope: me }); }, onPanelRender: function() { var me = this, mask = me.loadMask, cfg = { target: me.panel, msg: me.loadingText, msgCls: me.loadingCls, useMsg: me.loadingUseMsg, store: me.panel.store }; // Because this is used as a View, it should have an el. Use the owning Lockable's body. // It also has to fire a render event so that Editing plugins can attach listeners me.el = me.panel.body; me.fireEvent('render', me); if (mask) { // either a config object if (Ext.isObject(mask)) { cfg = Ext.apply(cfg, mask); } // Attach the LoadMask to a *Component* so that it can be sensitive to resizing during long loads. // If this DataView is floating, then mask this DataView. // Otherwise, mask its owning Container (or this, if there *is* no owning Container). // LoadMask captures the element upon render. me.loadMask = new Ext.LoadMask(cfg); } }, getGridColumns: function() { var cols = this.lockedGrid.headerCt.getVisibleGridColumns(); return cols.concat(this.normalGrid.headerCt.getVisibleGridColumns()); }, getEl: function(column){ return this.getViewForColumn(column).getEl(); }, getViewForColumn: function(column) { var view = this.lockedView, inLocked; view.headerCt.cascade(function(col){ if (col === column) { inLocked = true; return false; } }); return inLocked ? view : this.normalView; }, onItemMouseEnter: function(view, record){ var me = this, locked = me.lockedView, other = me.normalView, item; if (view.trackOver) { if (view !== locked) { other = locked; } item = other.getNode(record, false); other.highlightItem(item); } }, onItemMouseLeave: function(view, record){ var me = this, locked = me.lockedView, other = me.normalView; if (view.trackOver) { if (view !== locked) { other = locked; } other.clearHighlight(); } }, relayFn: function(name, args){ args = args || []; var view = this.lockedView; view[name].apply(view, args); view = this.normalView; view[name].apply(view, args); }, getSelectionModel: function(){ return this.panel.getSelectionModel(); }, getStore: function(){ return this.panel.store; }, getNode: function(nodeInfo, dataRow) { // default to the normal view return this.normalView.getNode(nodeInfo, dataRow); }, getCell: function(record, column) { var view = this.getViewForColumn(column), row = view.getNode(record, true); return Ext.fly(row).down(column.getCellSelector()); }, indexOf: function(record) { var result = this.lockedView.indexOf(record); if (!result) { result = this.normalView.indexOf(record); } return result; }, focus: function() { var p = this.getSelectionModel().getCurrentPosition(), v = p ? p.view : this.normalView; v.focus(); }, focusRow: function(row) { this.normalView.focusRow(row); }, focusCell: function(position) { position.view.focusCell(position); }, isVisible: function(deep) { return this.panel.isVisible(deep); }, getRecord: function(node) { var result = this.lockedView.getRecord(node); if (!result) { result = this.normalView.getRecord(node); } return result; }, scrollBy: function(){ var normal = this.normalView; normal.scrollBy.apply(normal, arguments); }, addElListener: function(eventName, fn, scope){ this.relayFn('addElListener', arguments); }, refreshNode: function(){ this.relayFn('refreshNode', arguments); }, refresh: function(){ this.relayFn('refresh', arguments); }, bindStore: function(){ this.relayFn('bindStore', arguments); }, addRowCls: function(){ this.relayFn('addRowCls', arguments); }, removeRowCls: function(){ this.relayFn('removeRowCls', arguments); }, destroy: function(){ var me = this, mask = me.loadMask; // Typically the mask unbinding is handled by the view, but // we aren't a normal view, so clear it out here me.clearListeners(); if (mask && mask.bindStore) { mask.bindStore(null); } } }); /** * @private * * Lockable is a private mixin which injects lockable behavior into any * TablePanel subclass such as GridPanel or TreePanel. TablePanel will * automatically inject the Ext.grid.locking.Lockable mixin in when one of the * these conditions are met: * * - The TablePanel has the lockable configuration set to true * - One of the columns in the TablePanel has locked set to true/false * * Each TablePanel subclass must register an alias. It should have an array * of configurations to copy to the 2 separate tablepanel's that will be generated * to note what configurations should be copied. These are named normalCfgCopy and * lockedCfgCopy respectively. * * Columns which are locked must specify a fixed width. They do NOT support a * flex width. * * Configurations which are specified in this class will be available on any grid or * tree which is using the lockable functionality. */ Ext.define('Ext.grid.locking.Lockable', { alternateClassName: 'Ext.grid.Lockable', /** * @cfg {Boolean} syncRowHeight Synchronize rowHeight between the normal and * locked grid view. This is turned on by default. If your grid is guaranteed * to have rows of all the same height, you should set this to false to * optimize performance. */ syncRowHeight: true, /** * @cfg {String} subGridXType The xtype of the subgrid to specify. If this is * not specified lockable will determine the subgrid xtype to create by the * following rule. Use the superclasses xtype if the superclass is NOT * tablepanel, otherwise use the xtype itself. */ /** * @cfg {Object} lockedViewConfig A view configuration to be applied to the * locked side of the grid. Any conflicting configurations between lockedViewConfig * and viewConfig will be overwritten by the lockedViewConfig. */ /** * @cfg {Object} normalViewConfig A view configuration to be applied to the * normal/unlocked side of the grid. Any conflicting configurations between normalViewConfig * and viewConfig will be overwritten by the normalViewConfig. */ headerCounter: 0, /** * @cfg {Number} scrollDelta * Number of pixels to scroll when scrolling the locked section with mousewheel. */ scrollDelta: 40, /** * @cfg {Object} lockedGridConfig * Any special configuration options for the locked part of the grid */ /** * @cfg {Object} normalGridConfig * Any special configuration options for the normal part of the grid */ lockedGridCls: Ext.baseCSSPrefix + 'grid-inner-locked', // i8n text // unlockText: 'Unlock', // // lockText: 'Lock', // // Required for the Lockable Mixin. These are the configurations which will be copied to the // normal and locked sub tablepanels bothCfgCopy: [ 'invalidateScrollerOnRefresh', 'hideHeaders', 'enableColumnHide', 'enableColumnMove', 'enableColumnResize', 'sortableColumns', 'columnLines', 'rowLines' ], normalCfgCopy: [ 'verticalScroller', 'verticalScrollDock', 'verticalScrollerType', 'scroll' ], lockedCfgCopy: [], determineXTypeToCreate: function(lockedSide) { var me = this, typeToCreate, xtypes, xtypesLn, xtype, superxtype; if (me.subGridXType) { typeToCreate = me.subGridXType; } else { // Treeness only moves down into the locked side. // The normal side is always just a grid if (!lockedSide) { return 'gridpanel'; } xtypes = this.getXTypes().split('/'); xtypesLn = xtypes.length; xtype = xtypes[xtypesLn - 1]; superxtype = xtypes[xtypesLn - 2]; if (superxtype !== 'tablepanel') { typeToCreate = superxtype; } else { typeToCreate = xtype; } } return typeToCreate; }, // injectLockable will be invoked before initComponent's parent class implementation // is called, so throughout this method this. are configurations injectLockable: function() { // ensure lockable is set to true in the TablePanel this.lockable = true; // Instruct the TablePanel it already has a view and not to create one. // We are going to aggregate 2 copies of whatever TablePanel we are using this.hasView = true; var me = this, scrollbarHeight = Ext.getScrollbarSize().height, store = me.store = Ext.StoreManager.lookup(me.store), // share the selection model selModel = me.getSelectionModel(), // Hash of {lockedFeatures:[],normalFeatures:[]} allFeatures, // Hash of {topPlugins:[],lockedPlugins:[],normalPlugins:[]} allPlugins, lockedGrid, normalGrid, i, columns, lockedHeaderCt, normalHeaderCt, lockedView, normalView, listeners, bufferedRenderer = me.findPlugin('bufferedrenderer'); allFeatures = me.constructLockableFeatures(); // This is just a "shell" Panel which acts as a Container for the two grids and must not use the features if (me.features) { me.features = null; } // Distribute plugins to whichever Component needs them allPlugins = me.constructLockablePlugins(); me.plugins = allPlugins.topPlugins; lockedGrid = Ext.apply({ id: me.id + '-locked', isLocked: true, ownerLockable: me, xtype: me.determineXTypeToCreate(true), store: store, scrollerOwner: false, // Lockable does NOT support animations for Tree // Because the right side is just a grid, and the grid view doen't animate bulk insertions/removals animate: false, // If the OS does not show a space-taking scrollbar, the locked view can be overflow-y:auto scroll: scrollbarHeight ? false : 'vertical', selModel: selModel, border: false, cls: me.lockedGridCls, isLayoutRoot: function() { return false; }, features: allFeatures.lockedFeatures, plugins: allPlugins.lockedPlugins }, me.lockedGridConfig); normalGrid = Ext.apply({ id: me.id + '-normal', isLocked: false, ownerLockable: me, xtype: me.determineXTypeToCreate(), store: store, scrollerOwner: false, selModel: selModel, border: false, isLayoutRoot: function() { return false; }, features: allFeatures.normalFeatures, plugins: allPlugins.normalPlugins }, me.normalGridConfig); me.addCls(Ext.baseCSSPrefix + 'grid-locked'); // Copy appropriate configurations to the respective aggregated tablepanel instances. // Pass 4th param true to NOT exclude those settings on our prototype. // Delete them from the master tablepanel. Ext.copyTo(normalGrid, me, me.bothCfgCopy, true); Ext.copyTo(lockedGrid, me, me.bothCfgCopy, true); Ext.copyTo(normalGrid, me, me.normalCfgCopy, true); Ext.copyTo(lockedGrid, me, me.lockedCfgCopy, true); for (i = 0; i < me.normalCfgCopy.length; i++) { delete me[me.normalCfgCopy[i]]; } for (i = 0; i < me.lockedCfgCopy.length; i++) { delete me[me.lockedCfgCopy[i]]; } me.addEvents( /** * @event processcolumns * Fires when the configured (or **reconfigured**) column set is split into two depending on the {@link Ext.grid.column.Column#locked locked} flag. * @param {Ext.grid.column.Column[]} lockedColumns The locked columns. * @param {Ext.grid.column.Column[]} normalColumns The normal columns. */ 'processcolumns', /** * @event lockcolumn * Fires when a column is locked. * @param {Ext.grid.Panel} this The gridpanel. * @param {Ext.grid.column.Column} column The column being locked. */ 'lockcolumn', /** * @event unlockcolumn * Fires when a column is unlocked. * @param {Ext.grid.Panel} this The gridpanel. * @param {Ext.grid.column.Column} column The column being unlocked. */ 'unlockcolumn' ); me.addStateEvents(['lockcolumn', 'unlockcolumn']); columns = me.processColumns(me.columns); // Locked grid has a right border. Locked grid must shrinkwrap columns with no horiontal scroll, so // we must increment by the border width: 1px. TODO: Use shrinkWrapDock on the locked grid when it works. lockedGrid.width = columns.lockedWidth + Ext.num(selModel.headerWidth, 0) + (columns.locked.items.length ? 1 : 0); lockedGrid.columns = columns.locked; normalGrid.columns = columns.normal; // normal grid should flex the rest of the width normalGrid.flex = 1; lockedGrid.viewConfig = me.lockedViewConfig || {}; lockedGrid.viewConfig.loadingUseMsg = false; lockedGrid.viewConfig.loadMask = false; // Padding below locked grid body only if there are scrollbars on this system // This takes the place of any spacer element. // Important: The height has to be postprocessed after render to override // the inline border styles injected by automatic component border settings. if (scrollbarHeight) { lockedGrid.viewConfig.style = 'border-bottom:' + scrollbarHeight + 'px solid #f6f6f6;' + (lockedGrid.viewConfig.style || ''); } normalGrid.viewConfig = me.normalViewConfig || {}; normalGrid.viewConfig.loadMask = false; if (me.viewConfig && me.viewConfig.id) { Ext.log.warn('id specified on Lockable viewConfig, it will be shared between both views: "' + me.viewConfig.id + '"'); } Ext.applyIf(lockedGrid.viewConfig, me.viewConfig); Ext.applyIf(normalGrid.viewConfig, me.viewConfig); me.lockedGrid = Ext.ComponentManager.create(lockedGrid); if (me.isTree) { // Tree must not animate because the partner grid is unable to animate me.lockedGrid.getView().animate = false; // When this is a locked tree, the normal side is just a gridpanel, so needs the flat NodeStore normalGrid.store = me.lockedGrid.view.store; // To stay in sync with the tree side; trees don't use deferInitialRefresh by default. Overrideable by user config. normalGrid.deferRowRender = false; // Match configs between sides normalGrid.viewConfig.stripeRows = me.lockedGrid.view.stripeRows; normalGrid.rowLines = me.lockedGrid.rowLines; } // Set up a bidirectional relationship between the two sides of the locked view lockedView = me.lockedGrid.getView(); normalGrid.viewConfig.lockingPartner = lockedView; me.normalGrid = Ext.ComponentManager.create(normalGrid); lockedView.lockingPartner = normalView = me.normalGrid.getView(); me.view = new Ext.grid.locking.View({ loadingText: normalView.loadingText, loadingCls: normalView.loadingCls, loadingUseMsg: normalView.loadingUseMsg, loadMask: me.loadMask !== false, locked: me.lockedGrid, normal: me.normalGrid, panel: me }); // Set up listeners for the locked view. If its SelModel ever scrolls it, the normal view must sync listeners = bufferedRenderer ? {} : { scroll: { fn: me.onLockedViewScroll, element: 'el', scope: me } }; // If there are system scrollbars, we have to monitor the mousewheel and fake a scroll // Also we need to postprocess the border width because of inline border setting styles. // The locked grid needs a bottom border to match with any scrollbar present in the normal grid . // Keep locked section's bottom border width synched if (scrollbarHeight) { me.lockedGrid.on({ afterlayout: me.afterLockedViewLayout, scope: me }); // Ensure the overflow flags have been calculated from the various overflow configs lockedView.getOverflowStyle(); // If the locked view is configured to scoll vertically, force the columns to fit initially. if (lockedView.scrollFlags.y) { me.lockedGrid.headerCt.forceFit = true; } // If the locked view is not configured to scoll vertically, we must listen for mousewheel events to scroll it. else { listeners.mousewheel = { fn: me.onLockedViewMouseWheel, element: 'el', scope: me }; } } lockedView.on(listeners); // Set up listeners for the normal view listeners = bufferedRenderer ? {} : { scroll: { fn: me.onNormalViewScroll, element: 'el', scope: me }, scope: me }; normalView.on(listeners); lockedHeaderCt = me.lockedGrid.headerCt; normalHeaderCt = me.normalGrid.headerCt; // The top grid, and the LockingView both need to have a headerCt which is usable. // It is part of their private API that framework code uses when dealing with a grid or grid view me.headerCt = me.view.headerCt = new Ext.grid.locking.HeaderContainer(me); lockedHeaderCt.lockedCt = true; lockedHeaderCt.lockableInjected = true; normalHeaderCt.lockableInjected = true; lockedHeaderCt.on({ // buffer to wait until multiple adds have fired add: { buffer: 1, scope: me, fn: me.onLockedHeaderAdd }, columnshow: me.onLockedHeaderShow, columnhide: me.onLockedHeaderHide, sortchange: me.onLockedHeaderSortChange, columnresize: me.onLockedHeaderResize, scope: me }); normalHeaderCt.on({ sortchange: me.onNormalHeaderSortChange, scope: me }); me.modifyHeaderCt(); me.items = [me.lockedGrid, me.normalGrid]; me.relayHeaderCtEvents(lockedHeaderCt); me.relayHeaderCtEvents(normalHeaderCt); // The top level Lockable container does not get bound to the store, so we need to programatically add the relayer so that // The filterchange state event is fired. me.storeRelayers = me.relayEvents(store, [ /** * @event filterchange * @inheritdoc Ext.data.Store#filterchange */ 'filterchange' ]); me.layout = { type: 'hbox', align: 'stretch' }; }, getLockingViewConfig: function(){ return { xclass: 'Ext.grid.locking.View', locked: this.lockedGrid, normal: this.normalGrid, panel: this }; }, processColumns: function(columns) { // split apart normal and locked var i, len, column, cp = this.dummyHdrCtr || (this.self.prototype.dummyHdrCtr = new Ext.grid.header.Container()), lockedHeaders = [], normalHeaders = [], lockedHeaderCt = { itemId: 'lockedHeaderCt', stretchMaxPartner: '^^>>#normalHeaderCt', items: lockedHeaders }, normalHeaderCt = { itemId: 'normalHeaderCt', stretchMaxPartner: '^^>>#lockedHeaderCt', items: normalHeaders }, result = { lockedWidth: 0, locked: lockedHeaderCt, normal: normalHeaderCt }; // In case they specified a config object with items... if (Ext.isObject(columns)) { Ext.applyIf(lockedHeaderCt, columns); Ext.applyIf(normalHeaderCt, columns); Ext.apply(cp, columns); columns = columns.items; } for (i = 0, len = columns.length; i < len; ++i) { column = columns[i]; // Use the HeaderContainer object to correctly configure and create the column. // MUST instantiate now because the locked or autoLock config which we read here might be in the prototype. // MUST use a Container instance so that defaults from an object columns config get applied. if (!column.isComponent) { column = cp.lookupComponent(cp.applyDefaults(column)); } // mark the column as processed so that the locked attribute does not // trigger the locked subgrid to try to become a split lockable grid itself. column.processed = true; if (column.locked || column.autoLock) { if (!column.hidden) { result.lockedWidth += this.getColumnWidth(column) || cp.defaultWidth; } lockedHeaders.push(column); } else { normalHeaders.push(column); } if (!column.headerId) { column.headerId = (column.initialConfig || column).id || ('h' + (++this.headerCounter)); } } this.fireEvent('processcolumns', this, lockedHeaders, normalHeaders); return result; }, // Used when calculating total locked column width in processColumns // Use shrinkwrapping of child columns if no top level width. getColumnWidth: function(column) { var result = column.width || 0, subcols, len, i; if (column.flex) { Ext.Error.raise("Columns which are locked do NOT support a flex width. You must set a width on the " + column.text + "column."); } if (!result && column.isGroupHeader) { subcols = column.items.items; len = subcols.length; for (i = 0; i < len; i++) { result += this.getColumnWidth(subcols[i]); } } return result; }, // Due to automatic component border setting using inline style, to create the scrollbar-replacing // bottom border, we have to postprocess the locked view *after* render. // If there are visible normal columns, we do need the fat bottom border. afterLockedViewLayout: function() { var me = this, lockedView = me.lockedGrid.getView(), lockedViewEl = lockedView.el.dom, spacerHeight = (me.normalGrid.headerCt.tooNarrow ? Ext.getScrollbarSize().height : 0); // If locked view is configured to scroll horizontally, and it overflows horizontally, then we do not need the spacer if (lockedView.scrollFlags.x && lockedViewEl.scrollWidth > lockedViewEl.clientWidth) { spacerHeight = 0; } lockedView.el.dom.style.borderBottomWidth = spacerHeight + 'px'; // Legacy IE browsers which cannot be forced to use the sensible border box model. // We have to account in the element's style height for flip-flopping border width if (!Ext.isBorderBox) { lockedView.el.setHeight(lockedView.lastBox.height); } }, /** * @private * Listen for mousewheel events on the locked section which does not scroll. * Scroll it in response, and the other section will automatically sync. */ onLockedViewMouseWheel: function(e) { var me = this, scrollDelta = -me.scrollDelta, deltaY = scrollDelta * e.getWheelDeltas().y, vertScrollerEl = me.lockedGrid.getView().el.dom, verticalCanScrollDown, verticalCanScrollUp; if (!me.ignoreMousewheel) { if (vertScrollerEl) { verticalCanScrollDown = vertScrollerEl.scrollTop !== vertScrollerEl.scrollHeight - vertScrollerEl.clientHeight; verticalCanScrollUp = vertScrollerEl.scrollTop !== 0; } if ((deltaY < 0 && verticalCanScrollUp) || (deltaY > 0 && verticalCanScrollDown)) { e.stopEvent(); // Inhibit processing of any scroll events we *may* cause here. // Some OSs do not fire a scroll event when we set the scrollTop of an overflow:hidden element, // so we invoke the scroll handler programatically below. vertScrollerEl.scrollTop += deltaY; me.normalGrid.getView().el.dom.scrollTop = vertScrollerEl.scrollTop; // Invoke the scroll event handler programatically to sync everything. me.onNormalViewScroll(); } } }, onLockedViewScroll: function() { var me = this, lockedView = me.lockedGrid.getView(), normalView = me.normalGrid.getView(), normalDom = normalView.el.dom, lockedDom = lockedView.el.dom, normalTable, lockedTable; // See onNormalViewScroll if (normalDom.scrollTop !== lockedDom.scrollTop) { normalDom.scrollTop = lockedDom.scrollTop; // For buffered views, the absolute position is important as well as scrollTop if (me.store.buffered) { lockedTable = lockedView.el.child('table', true); normalTable = normalView.el.child('table', true); normalTable.style.position = 'absolute'; normalTable.style.top = lockedTable.style.top; } } }, onNormalViewScroll: function() { var me = this, lockedView = me.lockedGrid.getView(), normalView = me.normalGrid.getView(), normalDom = normalView.el.dom, lockedDom = lockedView.el.dom, normalTable, lockedTable; // When we set the position, it will cause a scroll event on the other view, so we need to // check the top here. We can't just set a flag, like: // if (!me.scrolling) { // me.scrolling = true; // other.scrollTop = this.scrollTop; // me.scrolling = false; // } // The browser waits until the "thread" finishes before setting the // top, so by the time we set scrolling = false it hasn't hit the other // scroll event yet if (normalDom.scrollTop !== lockedDom.scrollTop) { lockedDom.scrollTop = normalDom.scrollTop; // For buffered views, the absolute position is important as well as scrollTop if (me.store.buffered) { lockedTable = lockedView.el.child('table', true); normalTable = normalView.el.child('table', true); lockedTable.style.position = 'absolute'; lockedTable.style.top = normalTable.style.top; } } }, /** * Synchronizes the row heights between the locked and non locked portion of the grid for each * row. If one row is smaller than the other, the height will be increased to match the larger one. */ syncRowHeights: function() { var me = this, i, lockedView = me.lockedGrid.getView(), normalView = me.normalGrid.getView(), lockedRowEls = lockedView.all.slice(), normalRowEls = normalView.all.slice(), ln = lockedRowEls.length, scrollTop; // Ensure there are an equal number of locked and normal rows before synchronization if (normalRowEls.length === ln) { // Loop thru all rows and ask the TableView class to sync the sides. for (i = 0; i < ln; i++) { normalView.syncRowHeights(lockedRowEls[i], normalRowEls[i]); } // Synchronize the scrollTop positions of the two views scrollTop = normalView.el.dom.scrollTop; normalView.el.dom.scrollTop = scrollTop; lockedView.el.dom.scrollTop = scrollTop; } }, // inject Lock and Unlock text // Hide/show Lock/Unlock options modifyHeaderCt: function() { var me = this; me.lockedGrid.headerCt.getMenuItems = me.getMenuItems(me.lockedGrid.headerCt.getMenuItems, true); me.normalGrid.headerCt.getMenuItems = me.getMenuItems(me.normalGrid.headerCt.getMenuItems, false); me.lockedGrid.headerCt.showMenuBy = Ext.Function.createInterceptor(me.lockedGrid.headerCt.showMenuBy, me.showMenuBy); me.normalGrid.headerCt.showMenuBy = Ext.Function.createInterceptor(me.normalGrid.headerCt.showMenuBy, me.showMenuBy); }, onUnlockMenuClick: function() { this.unlock(); }, onLockMenuClick: function() { this.lock(); }, showMenuBy: function(t, header) { var menu = this.getMenu(), unlockItem = menu.down('#unlockItem'), lockItem = menu.down('#lockItem'), sep = unlockItem.prev(); if (header.lockable === false) { sep.hide(); unlockItem.hide(); lockItem.hide(); } else { sep.show(); unlockItem.show(); lockItem.show(); if (!unlockItem.initialConfig.disabled) { unlockItem.setDisabled(header.lockable === false); } if (!lockItem.initialConfig.disabled) { lockItem.setDisabled(!header.isLockable()); } } }, getMenuItems: function(getMenuItems, locked) { var me = this, unlockText = me.unlockText, lockText = me.lockText, unlockCls = Ext.baseCSSPrefix + 'hmenu-unlock', lockCls = Ext.baseCSSPrefix + 'hmenu-lock', unlockHandler = Ext.Function.bind(me.onUnlockMenuClick, me), lockHandler = Ext.Function.bind(me.onLockMenuClick, me); // runs in the scope of headerCt return function() { // We cannot use the method from HeaderContainer's prototype here // because other plugins or features may already have injected an implementation var o = getMenuItems.call(this); o.push('-', { itemId: 'unlockItem', cls: unlockCls, text: unlockText, handler: unlockHandler, disabled: !locked }); o.push({ itemId: 'lockItem', cls: lockCls, text: lockText, handler: lockHandler, disabled: locked }); return o; }; }, /** * @private * Updates the overall view after columns have been resized, or moved from * the locked to unlocked side or vice-versa. * * If all columns are removed from either side, that side must be hidden, and the * sole remaining column owning grid then becomes *the* grid. It must flex to occupy the * whole of the locking view. And it must also allow scrolling. * * If columns are shared between the two sides, the *locked* grid shrinkwraps the * width of the visible locked columns while the normal grid flexes in what space remains. * * @return {Boolean} `true` if there are visible locked columns which need refreshing. * */ syncLockedWidth: function() { var me = this, locked = me.lockedGrid, lockedView = locked.view, lockedViewEl = lockedView.el.dom, normal = me.normalGrid, lockedColCount = locked.headerCt.getVisibleGridColumns().length, normalColCount = normal.headerCt.getVisibleGridColumns().length; Ext.suspendLayouts(); // If there are still visible normal columns, then the normal grid will flex // while we effectively shrinkwrap the width of the locked columns if (normalColCount) { normal.show(); if (lockedColCount) { // The locked grid shrinkwraps the total column width while the normal grid flexes in what remains // UNLESS it has been set to forceFit if (!locked.headerCt.forceFit) { delete locked.flex; // Don't pass the purge flag here locked.setWidth(locked.headerCt.getFullWidth()); } locked.addCls(me.lockedGridCls); locked.show(); } else { // No visible locked columns: hide the locked grid // We also need to trigger a refresh to clear out any // old dom nodes locked.getView().refresh(); locked.hide(); } // Fix it so that the locked view scrolls the way it was initially configured to do. lockedView.el.setStyle(lockedView.getOverflowStyle()); // Ignore mousewheel events if the view is configured to scroll vertically me.ignoreMousewheel = lockedView.scrollFlags.y; } // There are no normal grid columns. The "locked" grid has to be *the* // grid, and cannot have a shrinkwrapped width, but must flex the entire width. else { normal.hide(); // When the normal grid is hidden, we no longer need the bottom border "scrollbar replacement" lockedViewEl.style.borderBottomWidth = '0'; // The locked now becomes *the* grid and has to flex to occupy the full view width locked.flex = 1; delete locked.width; locked.removeCls(me.lockedGridCls); locked.show(); // Fix it so that the "locked" has the same scroll settings as the normal view. // Because it is the only grid view visible now. lockedView.el.setStyle(normal.view.getOverflowStyle()); me.ignoreMousewheel = true; } Ext.resumeLayouts(true); return [lockedColCount, normalColCount]; }, onLockedHeaderAdd: function() { // Columns can be added to the locked grid whwen reconfiguring or during a lock // operation when syncLockedWidth will be called anyway, so allow adding to be ignored if (!this.ignoreAddLockedColumn) { this.syncLockedWidth(); } }, onLockedHeaderResize: function() { this.syncLockedWidth(); }, onLockedHeaderHide: function() { this.syncLockedWidth(); }, onLockedHeaderShow: function() { this.syncLockedWidth(); }, onLockedHeaderSortChange: function(headerCt, header, sortState) { if (sortState) { // no real header, and silence the event so we dont get into an // infinite loop this.normalGrid.headerCt.clearOtherSortStates(null, true); } }, onNormalHeaderSortChange: function(headerCt, header, sortState) { if (sortState) { // no real header, and silence the event so we dont get into an // infinite loop this.lockedGrid.headerCt.clearOtherSortStates(null, true); } }, // going from unlocked section to locked /** * Locks the activeHeader as determined by which menu is open OR a header * as specified. * @param {Ext.grid.column.Column} [header] Header to unlock from the locked section. * Defaults to the header which has the menu open currently. * @param {Number} [toIdx] The index to move the unlocked header to. * Defaults to appending as the last item. * @private */ lock: function(activeHd, toIdx) { var me = this, normalGrid = me.normalGrid, lockedGrid = me.lockedGrid, normalHCt = normalGrid.headerCt, lockedHCt = lockedGrid.headerCt, refreshFlags, ownerCt; activeHd = activeHd || normalHCt.getMenu().activeHeader; ownerCt = activeHd.ownerCt; // isLockable will test for making the locked side too wide if (!activeHd.isLockable()) { return; } // if column was previously flexed, get/set current width // and remove the flex if (activeHd.flex) { activeHd.width = activeHd.getWidth(); activeHd.flex = null; } Ext.suspendLayouts(); ownerCt.remove(activeHd, false); activeHd.locked = true; // Flag to the locked column add listener to do nothing me.ignoreAddLockedColumn = true; if (Ext.isDefined(toIdx)) { lockedHCt.insert(toIdx, activeHd); } else { lockedHCt.add(activeHd); } me.ignoreAddLockedColumn = false; refreshFlags = me.syncLockedWidth(); if (refreshFlags[0]) { lockedGrid.getView().refresh(); } if (refreshFlags[1]) { normalGrid.getView().refresh(); } Ext.resumeLayouts(true); me.fireEvent('lockcolumn', me, activeHd); }, // going from locked section to unlocked /** * Unlocks the activeHeader as determined by which menu is open OR a header * as specified. * @param {Ext.grid.column.Column} [header] Header to unlock from the locked section. * Defaults to the header which has the menu open currently. * @param {Number} [toIdx=0] The index to move the unlocked header to. * @private */ unlock: function(activeHd, toIdx) { var me = this, normalGrid = me.normalGrid, lockedGrid = me.lockedGrid, normalHCt = normalGrid.headerCt, lockedHCt = lockedGrid.headerCt, refreshFlags; // Unlocking; user expectation is that the unlocked column is inserted at the beginning. if (!Ext.isDefined(toIdx)) { toIdx = 0; } activeHd = activeHd || lockedHCt.getMenu().activeHeader; Ext.suspendLayouts(); activeHd.ownerCt.remove(activeHd, false); activeHd.locked = false; normalHCt.insert(toIdx, activeHd); // syncLockedWidth returns visible column counts for both grids. // only refresh what needs refreshing refreshFlags = me.syncLockedWidth(); if (refreshFlags[0]) { lockedGrid.getView().refresh(); } if (refreshFlags[1]) { normalGrid.getView().refresh(); } Ext.resumeLayouts(true); me.fireEvent('unlockcolumn', me, activeHd); }, // we want to totally override the reconfigure behaviour here, since we're creating 2 sub-grids reconfigureLockable: function(store, columns) { var me = this, oldStore = me.store, lockedGrid = me.lockedGrid, normalGrid = me.normalGrid; Ext.suspendLayouts(); if (columns) { lockedGrid.headerCt.removeAll(); normalGrid.headerCt.removeAll(); columns = me.processColumns(columns); // Flag to the locked column add listener to do nothing me.ignoreAddLockedColumn = true; lockedGrid.headerCt.add(columns.locked.items); me.ignoreAddLockedColumn = false; normalGrid.headerCt.add(columns.normal.items); // Ensure locked grid is set up correctly with correct width and bottom border, // and that both grids' visibility and scrollability status is correct me.syncLockedWidth(); } if (store && store !== oldStore) { store = Ext.data.StoreManager.lookup(store); me.store = store; lockedGrid.bindStore(store); normalGrid.bindStore(store); } else { lockedGrid.getView().refresh(); normalGrid.getView().refresh(); } Ext.resumeLayouts(true); }, constructLockableFeatures: function() { var features = this.features, feature, featureClone, lockedFeatures, normalFeatures, i = 0, len; if (features) { lockedFeatures = []; normalFeatures = []; len = features.length; for (; i < len; i++) { feature = features[i]; if (!feature.isFeature) { feature = Ext.create('feature.' + feature.ftype, feature); } switch (feature.lockableScope) { case 'locked': lockedFeatures.push(feature); break; case 'normal': normalFeatures.push(feature); break; default: feature.lockableScope = 'both'; lockedFeatures.push(feature); normalFeatures.push(featureClone = feature.clone()); // When cloned to either side, each gets a "lockingPartner" reference to the other featureClone.lockingPartner = feature; feature.lockingPartner = featureClone; } } } return { normalFeatures: normalFeatures, lockedFeatures: lockedFeatures }; }, constructLockablePlugins: function() { var plugins = this.plugins, plugin, normalPlugin, lockedPlugin, topPlugins, lockedPlugins, normalPlugins, i = 0, len; if (plugins) { topPlugins = []; lockedPlugins = []; normalPlugins = []; len = plugins.length; for (; i < len; i++) { // Plugin will already have been instantiated by the AbstractComponent constructor plugin = plugins[i]; switch (plugin.lockableScope) { case 'both': lockedPlugins.push(lockedPlugin = plugin.clonePlugin()); normalPlugins.push(normalPlugin = plugin.clonePlugin()); // When cloned to both sides, each gets a "lockingPartner" reference to the other lockedPlugin.lockingPartner = normalPlugin; normalPlugin.lockingPartner = lockedPlugin; // If the plugin has to be propagated down to both, a new plugin config object must be given to that side // and this plugin must be destroyed. Ext.destroy(plugin); break; case 'locked': lockedPlugins.push(plugin); break; case 'normal': normalPlugins.push(plugin); break; default: topPlugins.push(plugin); } } } return { topPlugins: topPlugins, normalPlugins: normalPlugins, lockedPlugins: lockedPlugins }; }, destroyLockable: function(){ // The locking view isn't a "real" view, so we need to destroy it manually Ext.destroy(this.view); } }, function() { this.borrow(Ext.AbstractComponent, ['constructPlugin']); }); /** * Used as a view by {@link Ext.tree.Panel TreePanel}. */ Ext.define('Ext.tree.View', { extend: Ext.view.Table , alias: 'widget.treeview', /** * @property {Boolean} isTreeView * `true` in this class to identify an object as an instantiated TreeView, or subclass thereof. */ isTreeView: true, loadingCls: Ext.baseCSSPrefix + 'grid-tree-loading', expandedCls: Ext.baseCSSPrefix + 'grid-tree-node-expanded', leafCls: Ext.baseCSSPrefix + 'grid-tree-node-leaf', expanderSelector: '.' + Ext.baseCSSPrefix + 'tree-expander', checkboxSelector: '.' + Ext.baseCSSPrefix + 'tree-checkbox', expanderIconOverCls: Ext.baseCSSPrefix + 'tree-expander-over', // Class to add to the node wrap element used to hold nodes when a parent is being // collapsed or expanded. During the animation, UI interaction is forbidden by testing // for an ancestor node with this class. nodeAnimWrapCls: Ext.baseCSSPrefix + 'tree-animator-wrap', blockRefresh: true, /** * @cfg {Boolean} * @inheritdoc */ loadMask: false, /** * @cfg {Boolean} rootVisible * False to hide the root node. */ rootVisible: true, /** * @cfg {Boolean} deferInitialRefresh * Must be false for Tree Views because the root node must be rendered in order to be updated with its child nodes. */ deferInitialRefresh: false, /** * @cfg {Boolean} animate * True to enable animated expand/collapse (defaults to the value of {@link Ext#enableFx Ext.enableFx}) */ expandDuration: 250, collapseDuration: 250, toggleOnDblClick: true, stripeRows: false, // fields that will trigger a change in the ui that aren't likely to be bound to a column uiFields: ['expanded', 'loaded', 'checked', 'expandable', 'leaf', 'icon', 'iconCls', 'loading', 'qtip', 'qtitle'], // treeRowTpl which is inserted into thwe rowTpl chain before the base rowTpl. Sets tree-specific classes and attributes treeRowTpl: [ '{%', 'this.processRowValues(values);', 'this.nextTpl.applyOut(values, out, parent);', 'delete values.rowAttr["data-qtip"];', 'delete values.rowAttr["data-qtitle"];', '%}', { priority: 10, processRowValues: function(rowValues) { var record = rowValues.record, view = rowValues.view, qtip = record.get('qtip'), qtitle = record.get('qttle'); rowValues.rowAttr = {}; if (qtip) { rowValues.rowAttr['data-qtip'] = qtip; } if (qtitle) { rowValues.rowAttr['data-qtitle'] = qtitle; } if (record.isExpanded()) { rowValues.rowClasses.push(view.expandedCls); } if (record.isLeaf()) { rowValues.rowClasses.push(view.leafCls); } if (record.isLoading()) { rowValues.rowClasses.push(view.loadingCls); } } } ], initComponent: function() { var me = this, treeStore = me.panel.getStore(), store = me.store; if (me.initialConfig.animate === undefined) { me.animate = Ext.enableFx; } if (!store || store === treeStore) { me.store = store = new Ext.data.NodeStore({ treeStore: treeStore, recursive: true, rootVisible: me.rootVisible }); } if (me.node) { me.setRootNode(me.node); } me.animQueue = {}; me.animWraps = {}; me.addEvents( /** * @event afteritemexpand * Fires after an item has been visually expanded and is visible in the tree. * @param {Ext.data.NodeInterface} node The node that was expanded * @param {Number} index The index of the node * @param {HTMLElement} item The HTML element for the node that was expanded */ 'afteritemexpand', /** * @event afteritemcollapse * Fires after an item has been visually collapsed and is no longer visible in the tree. * @param {Ext.data.NodeInterface} node The node that was collapsed * @param {Number} index The index of the node * @param {HTMLElement} item The HTML element for the node that was collapsed */ 'afteritemcollapse', /** * @event nodedragover * Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. * @param {Ext.data.NodeInterface} targetNode The target node * @param {String} position The drop position, "before", "after" or "append", * @param {Object} dragData Data relating to the drag operation * @param {Ext.EventObject} e The event object for the drag */ 'nodedragover' ); me.callParent(arguments); me.addRowTpl(Ext.XTemplate.getTpl(me, 'treeRowTpl')); }, onBeforeFill: function(treeStore, fillRoot) { this.store.suspendEvents(); }, onFillComplete: function(treeStore, fillRoot, newNodes) { var me = this, store = me.store, start = store.indexOf(newNodes[0]); store.resumeEvents(); // Always update the current node, since the load may be triggered // by .load() directly instead of .expand() on the node fillRoot.triggerUIUpdate(); // In the cases of expand, the records might not be in the store yet, // so jump out early and expand will handle it later if (!newNodes.length || start === -1) { return; } // Insert new nodes into the view me.onAdd(me.store, newNodes, start); me.refreshPartner(); }, onBeforeSort: function() { this.store.suspendEvents(); }, onSort: function(o) { // The store will fire sort events for the nodes that bubble from the tree. // We only want the final one when sorting is completed, fired by the store if (o.isStore) { this.store.resumeEvents(); this.refresh(); this.refreshPartner(); } }, refreshPartner: function() { var partner = this.lockingPartner; if (partner) { partner.refresh(); } }, getMaskStore: function() { return this.panel.getStore(); }, afterRender: function() { var me = this; me.callParent(arguments); me.el.on({ scope: me, delegate: me.expanderSelector, mouseover: me.onExpanderMouseOver, mouseout: me.onExpanderMouseOut, click: { delegate: me.checkboxSelector, fn: me.onCheckboxChange, scope: me } }); }, afterComponentLayout: function() { this.callParent(arguments); var stretcher = this.stretcher; if (stretcher) { stretcher.setWidth((this.getWidth() - Ext.getScrollbarSize().width)); } }, processUIEvent: function(e) { // If the clicked node is part of an animation, ignore the click. // This is because during a collapse animation, the associated Records // will already have been removed from the Store, and the event is not processable. if (e.getTarget('.' + this.nodeAnimWrapCls, this.el)) { return false; } return this.callParent(arguments); }, onClear: function() { this.store.removeAll(); }, setRootNode: function(node) { var me = this; me.store.setNode(node); me.node = node; }, onCheckboxChange: function(e, t) { var me = this, item = e.getTarget(me.getItemSelector(), me.getTargetEl()); if (item) { me.onCheckChange(me.getRecord(item)); } }, onCheckChange: function(record) { var checked = record.get('checked'); if (Ext.isBoolean(checked)) { checked = !checked; record.set('checked', checked); this.fireEvent('checkchange', record, checked); } }, getChecked: function() { var checked = []; this.node.cascadeBy(function(rec){ if (rec.get('checked')) { checked.push(rec); } }); return checked; }, isItemChecked: function(rec) { return rec.get('checked'); }, /** * @private */ createAnimWrap: function(record, index) { var me = this, node = me.getNode(record), tmpEl, nodeEl, columnSizer = []; me.renderColumnSizer(columnSizer); nodeEl = Ext.get(node); tmpEl = nodeEl.insertSibling({ tag: 'tr', html: [ '', '
    ', // Table has to have correct classes to get sized by the dynamic CSS rules '', columnSizer.join(''), '
    ', '
    ', '' ].join('') }, 'after'); return { record: record, node: node, el: tmpEl, expanding: false, collapsing: false, animating: false, animateEl: tmpEl.down('div'), targetEl: tmpEl.down('tbody') }; }, /** * @private * Returns the animation wrapper element for the specified parent node, used to wrap the child nodes as * they slide up or down during expand/collapse. * * @param parent The parent node to be expanded or collapsed * * @param [bubble=true] If the passed parent node does not already have a wrap element created, by default * this function will bubble up to each parent node looking for a valid wrap element to reuse, returning * the first one it finds. This is the appropriate behavior, e.g., for the collapse direction, so that the * entire expanded set of branch nodes can collapse as a single unit. * * However for expanding each parent node should instead always create its own animation wrap if one * doesn't exist, so that its children can expand independently of any other nodes -- this is crucial * when executing the "expand all" behavior. If multiple nodes attempt to reuse the same ancestor wrap * element concurrently during expansion it will lead to problems as the first animation to complete will * delete the wrap el out from under other running animations. For that reason, when expanding you should * always pass `bubble: false` to be on the safe side. * * If the passed parent has no wrap (or there is no valid ancestor wrap after bubbling), this function * will return null and the calling code should then call {@link #createAnimWrap} if needed. * * @return {Ext.Element} The wrapping element as created in {@link #createAnimWrap}, or null */ getAnimWrap: function(parent, bubble) { if (!this.animate) { return null; } var wraps = this.animWraps, wrap = wraps[parent.internalId]; if (bubble !== false) { while (!wrap && parent) { parent = parent.parentNode; if (parent) { wrap = wraps[parent.internalId]; } } } return wrap; }, doAdd: function(records, index) { // If we are adding records which have a parent that is currently expanding // lets add them to the animation wrap var me = this, nodes = me.bufferRender(records, index, true), record = records[0], parent = record.parentNode, all = me.all, relativeIndex, animWrap = me.getAnimWrap(parent), targetEl, children, len; if (!animWrap || !animWrap.expanding) { return me.callParent(arguments); } // We need the parent that has the animWrap, not the node's parent parent = animWrap.record; // If there is an anim wrap we do our special magic logic targetEl = animWrap.targetEl; children = targetEl.dom.childNodes; len = children.length; // The relative index is the index in the full flat collection minus the index of the wraps parent relativeIndex = index - me.indexInStore(parent) - 1; // If we are adding records to the wrap that have a higher relative index then there are currently children // it means we have to append the nodes to the wrap if (!len || relativeIndex >= len) { targetEl.appendChild(nodes); } // If there are already more children then the relative index it means we are adding child nodes of // some expanded node in the anim wrap. In this case we have to insert the nodes in the right location else { Ext.fly(children[relativeIndex]).insertSibling(nodes, 'before', true); } // We also have to update the node cache of the DataView all.insert(index, nodes); // If we were in an animation we need to now change the animation // because the targetEl just got higher. if (animWrap.isAnimating) { me.onExpand(parent); } }, onRemove : function(ds, records, indexes) { var me = this, empty, i; if (me.viewReady) { empty = me.store.getCount() === 0; // Nothing left, just refresh the view. if (empty) { me.refresh(); } else { // Remove in reverse order so that indices remain correct for (i = indexes.length - 1; i >= 0; --i) { me.doRemove(records[i], indexes[i]); } } // Only loop through firing the event if there's anyone listening if (me.hasListeners.itemremove) { for (i = indexes.length - 1; i >= 0; --i) { me.fireEvent('itemremove', records[i], indexes[i]); } } } }, doRemove: function(record, index) { // If we are adding records which have a parent that is currently expanding // lets add them to the animation wrap var me = this, all = me.all, animWrap = me.getAnimWrap(record), item = all.item(index), node = item ? item.dom : null; if (!node || !animWrap || !animWrap.collapsing) { return me.callParent(arguments); } // Insert the item at the beginning of the animate el - child nodes are removed // in reverse order so that the index can be used. animWrap.targetEl.dom.insertBefore(node, animWrap.targetEl.dom.firstChild); all.removeElement(index); }, onBeforeExpand: function(parent, records, index) { var me = this, animWrap; if (me.rendered && me.all.getCount() && me.animate) { if (me.getNode(parent)) { animWrap = me.getAnimWrap(parent, false); if (!animWrap) { animWrap = me.animWraps[parent.internalId] = me.createAnimWrap(parent); animWrap.animateEl.setHeight(0); } else if (animWrap.collapsing) { // If we expand this node while it is still expanding then we // have to remove the nodes from the animWrap. animWrap.targetEl.select(me.itemSelector).remove(); } animWrap.expanding = true; animWrap.collapsing = false; } } }, onExpand: function(parent) { var me = this, queue = me.animQueue, id = parent.getId(), node = me.getNode(parent), index = node ? me.indexOf(node) : -1, animWrap, animateEl, targetEl, fromHeight = Ext.isIEQuirks ? 1 : 0 // Quirks mode on IE seems to have issues with 0; if (me.singleExpand) { me.ensureSingleExpand(parent); } // The item is not visible yet if (index === -1) { return; } animWrap = me.getAnimWrap(parent, false); if (!animWrap) { parent.isExpandingOrCollapsing = false; me.fireEvent('afteritemexpand', parent, index, node); me.refreshSize(); return; } animateEl = animWrap.animateEl; targetEl = animWrap.targetEl; animateEl.stopAnimation(); queue[id] = true; // Must set element height because animation does not set initial condition until first tick has elapsed animateEl.dom.style.height = fromHeight + 'px'; animateEl.animate({ from: { height: fromHeight }, to: { height: targetEl.getHeight() }, duration: me.expandDuration, listeners: { afteranimate: function() { // Move all the nodes out of the anim wrap to their proper location // Must do this in afteranimate because lastframe does not fire if the // animation is stopped. var items = targetEl.query(me.itemSelector); if (items.length) { animWrap.el.insertSibling(items, 'before', true); } animWrap.el.remove(); me.refreshSize(); delete me.animWraps[animWrap.record.internalId]; delete queue[id]; } }, callback: function() { parent.isExpandingOrCollapsing = false; me.fireEvent('afteritemexpand', parent, index, node); } }); animWrap.isAnimating = true; }, // Triggered by the NodeStore's onNodeCollapse event. onBeforeCollapse: function(parent, records, index, callback, scope) { var me = this, animWrap; if (me.rendered && me.all.getCount()) { if (me.animate) { // Only process if the collapsing node is in the UI. // A node may be collapsed as part of a recursive ancestor collapse, and if it // has already been removed from the UI by virtue of an ancestor being collapsed, we should not do anything. if (Ext.Array.contains(parent.stores, me.store)) { animWrap = me.getAnimWrap(parent); if (!animWrap) { animWrap = me.animWraps[parent.internalId] = me.createAnimWrap(parent, index); } else if (animWrap.expanding) { // If we collapse this node while it is still expanding then we // have to remove the nodes from the animWrap. animWrap.targetEl.select(this.itemSelector).remove(); } animWrap.expanding = false; animWrap.collapsing = true; animWrap.callback = callback; animWrap.scope = scope; } } else { // Cache any passed callback for use in the onCollapse post collapse handler non-animated codepath me.onCollapseCallback = callback; me.onCollapseScope = scope; } } }, onCollapse: function(parent) { var me = this, queue = me.animQueue, id = parent.getId(), node = me.getNode(parent), index = node ? me.indexOf(node) : -1, animWrap = me.getAnimWrap(parent), animateEl; // If the collapsed node is already removed from the UI // by virtue of being a descendant of a collapsed node, then // we have nothing to do here. if (!me.all.getCount() || !Ext.Array.contains(parent.stores, me.store)) { return; } // Not animating, all items will have been added, so updateLayout and resume layouts if (!animWrap) { parent.isExpandingOrCollapsing = false; me.fireEvent('afteritemcollapse', parent, index, node); me.refreshSize(); // Call any collapse callback cached in the onBeforeCollapse handler Ext.callback(me.onCollapseCallback, me.onCollapseScope); me.onCollapseCallback = me.onCollapseScope = null; return; } animateEl = animWrap.animateEl; queue[id] = true; animateEl.stopAnimation(); animateEl.animate({ to: { height: Ext.isIEQuirks ? 1 : 0 // Quirks mode on IE seems to have issues with 0 }, duration: me.collapseDuration, listeners: { afteranimate: function() { // In case lastframe did not fire because the animation was stopped. animWrap.el.remove(); me.refreshSize(); delete me.animWraps[animWrap.record.internalId]; delete queue[id]; } }, callback: function() { parent.isExpandingOrCollapsing = false; me.fireEvent('afteritemcollapse', parent, index, node); // Call any collapse callback cached in the onBeforeCollapse handler Ext.callback(animWrap.callback, animWrap.scope); animWrap.callback = animWrap.scope = null; } }); animWrap.isAnimating = true; }, /** * Checks if a node is currently undergoing animation * @private * @param {Ext.data.Model} node The node * @return {Boolean} True if the node is animating */ isAnimating: function(node) { return !!this.animQueue[node.getId()]; }, /** * Expands a record that is loaded in the view. * * If an animated collapse or expand of the record is in progress, this call will be ignored. * @param {Ext.data.Model} record The record to expand * @param {Boolean} [deep] True to expand nodes all the way down the tree hierarchy. * @param {Function} [callback] The function to run after the expand is completed * @param {Object} [scope] The scope of the callback function. */ expand: function(record, deep, callback, scope) { var me = this, doAnimate = !!me.animate, result; // Block toggling if we are already animating an expand or collapse operation. if (!doAnimate || !record.isExpandingOrCollapsing) { if (!record.isLeaf()) { record.isExpandingOrCollapsing = doAnimate; } // Need to suspend layouts because the expand process makes multiple changes to the UI // in addition to inserting new nodes. Folder and elbow images have to change, so we // need to coalesce all resulting layouts. Ext.suspendLayouts(); result = record.expand(deep, callback, scope); Ext.resumeLayouts(true); return result; } }, /** * Collapses a record that is loaded in the view. * * If an animated collapse or expand of the record is in progress, this call will be ignored. * @param {Ext.data.Model} record The record to collapse * @param {Boolean} [deep] True to collapse nodes all the way up the tree hierarchy. * @param {Function} [callback] The function to run after the collapse is completed * @param {Object} [scope] The scope of the callback function. */ collapse: function(record, deep, callback, scope) { var me = this, doAnimate = !!me.animate; // Block toggling if we are already animating an expand or collapse operation. if (!doAnimate || !record.isExpandingOrCollapsing) { if (!record.isLeaf()) { record.isExpandingOrCollapsing = doAnimate; } return record.collapse(deep, callback, scope); } }, /** * Toggles a record between expanded and collapsed. * * If an animated collapse or expand of the record is in progress, this call will be ignored. * @param {Ext.data.Model} record * @param {Boolean} [deep] True to collapse nodes all the way up the tree hierarchy. * @param {Function} [callback] The function to run after the expand/collapse is completed * @param {Object} [scope] The scope of the callback function. */ toggle: function(record, deep, callback, scope) { if (record.isExpanded()) { this.collapse(record, deep, callback, scope); } else { this.expand(record, deep, callback, scope); } }, onItemDblClick: function(record, item, index) { var me = this, editingPlugin = me.editingPlugin; me.callParent(arguments); if (me.toggleOnDblClick && record.isExpandable() && !(editingPlugin && editingPlugin.clicksToEdit === 2)) { me.toggle(record); } }, onBeforeItemMouseDown: function(record, item, index, e) { if (e.getTarget(this.expanderSelector, item)) { return false; } return this.callParent(arguments); }, onItemClick: function(record, item, index, e) { if (e.getTarget(this.expanderSelector, item) && record.isExpandable()) { this.toggle(record, e.ctrlKey); return false; } return this.callParent(arguments); }, onExpanderMouseOver: function(e, t) { e.getTarget(this.cellSelector, 10, true).addCls(this.expanderIconOverCls); }, onExpanderMouseOut: function(e, t) { e.getTarget(this.cellSelector, 10, true).removeCls(this.expanderIconOverCls); }, getStoreListeners: function(){ var me = this, listeners = me.callParent(arguments); return Ext.apply(listeners, { beforeexpand: me.onBeforeExpand, expand: me.onExpand, beforecollapse: me.onBeforeCollapse, collapse: me.onCollapse, write: me.onStoreWrite, datachanged: me.onStoreDataChanged }); }, onBindStore: function(){ var me = this, treeStore = me.getTreeStore(); me.callParent(arguments); me.mon(treeStore, { scope: me, beforefill: me.onBeforeFill, fillcomplete: me.onFillComplete }); if (!treeStore.remoteSort) { // If we're local sorting, we don't want the view to be // continually updated during the sort process me.mon(treeStore, { scope: me, beforesort: me.onBeforeSort, sort: me.onSort }); } }, onUnbindStore: function(){ var me = this, treeStore = me.getTreeStore(); me.callParent(arguments); me.mun(treeStore, { scope: me, beforefill: me.onBeforeFill, fillcomplete: me.onFillComplete }); if (!treeStore.remoteSort) { me.mun(treeStore, { scope: me, beforesort: me.onBeforeSort, sort: me.onSort }); } }, /** * Gets the base TreeStore from the bound TreePanel. */ getTreeStore: function() { return this.panel.store; }, ensureSingleExpand: function(node) { var parent = node.parentNode; if (parent) { parent.eachChild(function(child) { if (child !== node && child.isExpanded()) { child.collapse(); } }); } }, shouldUpdateCell: function(record, column, changedFieldNames){ if (changedFieldNames) { var i = 0, len = changedFieldNames.length; for (; i < len; ++i) { if (Ext.Array.contains(this.uiFields, changedFieldNames[i])) { return true; } } } return this.callParent(arguments); }, /** * Re-fires the NodeStore's "write" event as a TreeStore event * @private * @param {Ext.data.NodeStore} store * @param {Ext.data.Operation} operation */ onStoreWrite: function(store, operation) { var treeStore = this.panel.store; treeStore.fireEvent('write', treeStore, operation); }, /** * Re-fires the NodeStore's "datachanged" event as a TreeStore event * @private * @param {Ext.data.NodeStore} store * @param {Ext.data.Operation} operation */ onStoreDataChanged: function(store, operation) { var treeStore = this.panel.store; treeStore.fireEvent('datachanged', treeStore); } }); /** * @private * A set of overrides required by the presence of the BufferedRenderer plugin. * * These overrides of Ext.tree.View take into account the affect of a buffered renderer and * divert execution from the default course where necessary. */ Ext.define('Ext.grid.plugin.BufferedRendererTreeView', { override: 'Ext.tree.View', onRemove: function(store, records, indices) { var me = this; // Using buffered rendering - removal (eg folder node collapse) // Has to refresh the view if (me.rendered && me.bufferedRenderer) { me.refreshView(); } // No BufferedRenderer preent else { me.callParent([store, records, indices]); } } }); /** * Implements buffered rendering of a grid, allowing users can scroll * through thousands of records without the performance penalties of * renderering all the records on screen at once. * * The number of rows rendered outside the visible area, and the * buffering of pages of data from the remote server for immediate * rendering upon scroll can be controlled by configuring the plugin. * * You can tell it to create a larger table to provide more scrolling * before new rows need to be added to the leading edge of the table. * * var myStore = Ext.create('Ext.data.Store', { * // ... * pageSize: 100, * // ... * }); * * var grid = Ext.create('Ext.grid.Panel', { * // ... * autoLoad: true, * plugins: { * ptype: 'bufferedrenderer', * trailingBufferZone: 20, // Keep 20 rows rendered in the table behind scroll * leadingBufferZone: 50 // Keep 50 rows rendered in the table ahead of scroll * }, * // ... * }); * * ## Implementation notes * * This class monitors scrolling of the {@link Ext.view.Table * TableView} within a {@link Ext.grid.Panel GridPanel} to render a small section of * the dataset. * */ Ext.define('Ext.grid.plugin.BufferedRenderer', { extend: Ext.AbstractPlugin , alias: 'plugin.bufferedrenderer', lockableScope: 'both', /** * @cfg {Number} * @deprecated This config is now ignored. */ percentageFromEdge: 0.35, /** * @cfg {Boolean} [variableRowHeight=false] * Configure as `true` if the row heights are not all the same height as the first row. Only configure this is needed - this will be if the * rows contain unpredictably sized data, or you have changed the cell's text overflow stype to `'wrap'`. */ variableRowHeight: false, /** * @cfg {Number} * The zone which causes new rows to be appended to the view. As soon as the edge * of the rendered grid is this number of rows from the edge of the viewport, the view is moved. */ numFromEdge: 8, /** * @cfg {Number} * The number of extra rows to render on the trailing side of scrolling * **outside the {@link #numFromEdge}** buffer as scrolling proceeds. */ trailingBufferZone: 10, /** * @cfg {Number} * The number of extra rows to render on the leading side of scrolling * **outside the {@link #numFromEdge}** buffer as scrolling proceeds. */ leadingBufferZone: 20, /** * @cfg {Boolean} [synchronousRender=true] * By default, on detection of a scroll event which brings the end of the rendered table within * `{@link #numFromEdge}` rows of the grid viewport, if the required rows are available in the Store, * the BufferedRenderer will render rows from the Store *immediately* before returning from the event handler. * This setting helps avoid the impression of whitespace appearing during scrolling. * * Set this to `true` to defer the render until the scroll event handler exits. This allows for faster * scrolling, but also allows whitespace to be more easily scrolled into view. * */ synchronousRender: true, /** * @cfg {Number} * This is the time in milliseconds to buffer load requests when scrolling the PagingScrollbar. */ scrollToLoadBuffer: 200, // private. Initial value of zero. viewSize: 0, // private. Start at default value rowHeight: 21, /** * @property {Number} position * Current pixel scroll position of the associated {@link Ext.view.Table View}. */ position: 0, lastScrollDirection: 1, bodyTop: 0, // Initialize this as a plugin init: function(grid) { var me = this, view = grid.view, viewListeners = { scroll: { fn: me.onViewScroll, element: 'el', scope: me }, boxready: me.onViewResize, resize: me.onViewResize, refresh: me.onViewRefresh, scope: me, destroyable: true }; // If we are using default row heights, then do not sync row heights for efficiency if (!me.variableRowHeight && grid.ownerLockable) { grid.ownerLockable.syncRowHeight = false; } // If we are going to be handling a NodeStore then it's driven by node addition and removal, *not* refreshing. // The view overrides required above change the view's onAdd and onRemove behaviour to call onDataRefresh when necessary. if (grid.isTree || grid.ownerLockable && grid.ownerLockable.isTree) { view.blockRefresh = false; view.loadMask = true; } if (view.positionBody) { viewListeners.refresh = me.onViewRefresh; } me.grid = grid; me.view = view; view.bufferedRenderer = me; view.preserveScrollOnRefresh = true; me.bindStore(view.dataSource); view.getViewRange = function() { return me.getViewRange(); }; me.position = 0; me.gridListeners = grid.on('reconfigure', me.onReconfigure, me); me.viewListeners = view.on(viewListeners); }, bindStore: function(store) { var me = this; if (me.store) { me.unbindStore(); } me.storeListeners = store.on({ scope: me, clear: me.onStoreClear, destroyable: true }); me.store = store; // If the view has acquired a size, calculate a new view size and scroll range when the store changes. if (me.view.componentLayout.layoutCount) { me.onViewResize(me.view, 0, me.view.getHeight()); } }, onReconfigure: function(grid, store){ if (store && store !== this.store) { this.bindStore(store); } }, unbindStore: function() { this.storeListeners.destroy(); this.store = null; }, onStoreClear: function() { var me = this; // Do not do anything if view is not rendered, or if the reason for cache clearing is store destruction if (me.view.rendered && !me.store.isDestroyed) { // Temporarily disable scroll monitoring until the scroll event caused by any following *change* of scrollTop has fired. // Otherwise it will attempt to process a scroll on a stale view if (me.scrollTop !== 0) { me.ignoreNextScrollEvent = true; me.view.el.dom.scrollTop = me.bodyTop = me.scrollTop = 0; } me.position = me.scrollHeight = 0; me.lastScrollDirection = me.scrollOffset = null; // MUST delete, not null out because the calculation checks hasOwnProperty delete me.rowHeight; } }, onViewRefresh: function() { var me = this, view = me.view, oldScrollHeight = me.scrollHeight, scrollHeight; // View has rows, delete the rowHeight property to trigger a recalculation when scrollRange is calculated if (view.all.getCount()) { // We need to calculate the table size based upon the new viewport size and current row height // It tests hasOwnProperty so must delete the property to make it recalculate. delete me.rowHeight; } // Calculates scroll range. Also calculates rowHeight if we do not have an own rowHeight property. // That will be the case if the view contains some rows. scrollHeight = me.getScrollHeight(); if (!oldScrollHeight || scrollHeight != oldScrollHeight) { me.stretchView(view, scrollHeight); } if (me.scrollTop !== view.el.dom.scrollTop) { // The view may have refreshed and scrolled to the top, for example // on a sort. If so, it's as if we scrolled to the top, so we'll simulate // it here. me.onViewScroll(); } else { me.setBodyTop(me.bodyTop); // With new data, the height may have changed, so recalculate the rowHeight and viewSize. if (view.all.getCount()) { me.viewSize = 0; me.onViewResize(view, null, view.getHeight()); } } }, onViewResize: function(view, width, height, oldWidth, oldHeight) { // Only process first layout (the boxready event) or height resizes. if (!oldHeight || height !== oldHeight) { var me = this, newViewSize; // Recalculate the view size in rows now that the grid view has changed height newViewSize = Math.ceil(height / me.rowHeight) + me.trailingBufferZone + me.leadingBufferZone; me.viewSize = me.setViewSize(newViewSize); } }, stretchView: function(view, scrollRange) { var me = this, recordCount = (me.store.buffered ? me.store.getTotalCount() : me.store.getCount()); if (me.stretcher) { me.stretcher.dom.style.marginTop = (scrollRange - 1) + 'px'; } else { var el = view.el; // If the view has already been refreshed by the time we get here (eg, the grid, has undergone a reconfigure operation - which performs a refresh), // keep it informed of fixed nodes which it must leave alone on refresh. if (view.refreshCounter) { view.fixedNodes++; } // If this is the last page, correct the scroll range to be just enough to fit. if (recordCount && (me.view.all.endIndex === recordCount - 1)) { scrollRange = me.bodyTop + view.body.dom.offsetHeight; } this.stretcher = el.createChild({ style: { width: '1px', height: '1px', 'marginTop': (scrollRange - 1) + 'px', left: 0, position: 'absolute' } }, el.dom.firstChild); } }, setViewSize: function(viewSize) { if (viewSize !== this.viewSize) { // Must be set for getFirstVisibleRowIndex to work this.scrollTop = this.view.el.dom.scrollTop; var me = this, store = me.store, elCount = me.view.all.getCount(), start, end, lockingPartner = me.lockingPartner; me.viewSize = store.viewSize = viewSize; // If a store loads before we have calculated a viewSize, it loads me.defaultViewSize records. // This may be larger or smaller than the final viewSize so the store needs adjusting when the view size is calculated. if (elCount) { start = me.view.all.startIndex; end = Math.min(start + viewSize - 1, (store.buffered ? store.getTotalCount() : store.getCount()) - 1); // While rerendering our range, the locking partner must not sync if (lockingPartner) { lockingPartner.disable(); } me.renderRange(start, end); if (lockingPartner) { lockingPartner.enable(); } } } return viewSize; }, getViewRange: function() { var me = this, rows = me.view.all, store = me.store; if (store.data.getCount()) { return store.getRange(rows.startIndex, rows.startIndex + (me.viewSize || me.store.defaultViewSize) - 1); } else { return []; } }, /** * Scrolls to and optionlly selects the specified row index **in the total dataset**. * * @param {Number} recordIdx The zero-based position in the dataset to scroll to. * @param {Boolean} doSelect Pass as `true` to select the specified row. * @param {Function} callback A function to call when the row has been scrolled to. * @param {Number} callback.recordIdx The resulting record index (may have changed if the passed index was outside the valid range). * @param {Ext.data.Model} callback.record The resulting record from the store. * @param {Object} scope The scope (`this` reference) in which to execute the callback. Defaults to this BufferedRenderer. * */ scrollTo: function(recordIdx, doSelect, callback, scope) { var me = this, view = me.view, viewDom = view.el.dom, store = me.store, total = store.buffered ? store.getTotalCount() : store.getCount(), startIdx, endIdx, targetRec, targetRow, tableTop; // Sanitize the requested record recordIdx = Math.min(Math.max(recordIdx, 0), total - 1); // Calculate view start index startIdx = Math.max(Math.min(recordIdx - ((me.leadingBufferZone + me.trailingBufferZone) / 2), total - me.viewSize + 1), 0); tableTop = startIdx * me.rowHeight; endIdx = Math.min(startIdx + me.viewSize - 1, total - 1); store.getRange(startIdx, endIdx, { callback: function(range, start, end) { me.renderRange(start, end, true); targetRec = store.data.getRange(recordIdx, recordIdx)[0]; targetRow = view.getNode(targetRec, false); view.body.dom.style.top = tableTop + 'px'; me.position = me.scrollTop = viewDom.scrollTop = tableTop = Math.min(Math.max(0, tableTop - view.body.getOffsetsTo(targetRow)[1]), viewDom.scrollHeight - viewDom.clientHeight); // https://sencha.jira.com/browse/EXTJSIV-7166 IE 6, 7 and 8 won't scroll all the way down first time if (Ext.isIE) { viewDom.scrollTop = tableTop; } if (doSelect) { view.selModel.select(targetRec); } if (callback) { callback.call(scope||me, recordIdx, targetRec); } } }); }, onViewScroll: function(e, t) { var me = this, store = me.store, totalCount = (store.buffered ? store.getTotalCount() : store.getCount()), vscrollDistance, scrollDirection, scrollTop = me.scrollTop = me.view.el.dom.scrollTop, scrollHandled = false; // Flag set when the scrollTop is programatically set to zero upon cache clear. // We must not attempt to process that as a scroll event. if (me.ignoreNextScrollEvent) { me.ignoreNextScrollEvent = false; return; } // Only check for nearing the edge if we are enabled, and if there is overflow beyond our view bounds. // If there is no paging to be done (Store's dataset is all in memory) we will be disabled. if (!(me.disabled || totalCount < me.viewSize)) { vscrollDistance = scrollTop - me.position; scrollDirection = vscrollDistance > 0 ? 1 : -1; // Moved at leat 20 pixels, or cvhanged direction, so test whether the numFromEdge is triggered if (Math.abs(vscrollDistance) >= 20 || (scrollDirection !== me.lastScrollDirection)) { me.lastScrollDirection = scrollDirection; me.handleViewScroll(me.lastScrollDirection); scrollHandled = true; } } // Keep other side synced immediately if there was no rendering work to do. if (!scrollHandled) { if (me.lockingPartner && me.lockingPartner.scrollTop !== scrollTop) { me.lockingPartner.view.el.dom.scrollTop = scrollTop; } } }, handleViewScroll: function(direction) { var me = this, rows = me.view.all, store = me.store, viewSize = me.viewSize, totalCount = (store.buffered ? store.getTotalCount() : store.getCount()), requestStart, requestEnd; // We're scrolling up if (direction == -1) { // If table starts at record zero, we have nothing to do if (rows.startIndex) { if ((me.getFirstVisibleRowIndex() - rows.startIndex) < me.numFromEdge) { requestStart = Math.max(0, me.getLastVisibleRowIndex() + me.trailingBufferZone - viewSize); } } } // We're scrolling down else { // If table ends at last record, we have nothing to do if (rows.endIndex < totalCount - 1) { if ((rows.endIndex - me.getLastVisibleRowIndex()) < me.numFromEdge) { requestStart = Math.max(0, me.getFirstVisibleRowIndex() - me.trailingBufferZone); } } } // We scrolled close to the edge and the Store needs reloading if (requestStart != null) { requestEnd = Math.min(requestStart + viewSize - 1, totalCount - 1); // If calculated view range has moved, then render it if (requestStart !== rows.startIndex || requestEnd !== rows.endIndex) { me.renderRange(requestStart, requestEnd); return; } } // If we did not have to render, then just sync the partner's scroll position if (me.lockingPartner && me.lockingPartner.view.el && me.lockingPartner.scrollTop !== me.scrollTop) { me.lockingPartner.view.el.dom.scrollTop = me.scrollTop; } }, renderRange: function(start, end, forceSynchronous) { var me = this, store = me.store; // If range is avaliable synchronously, process it now. if (store.rangeCached(start, end)) { me.cancelLoad(); if (me.synchronousRender || forceSynchronous) { me.onRangeFetched(null, start, end); } else { if (!me.renderTask) { me.renderTask = new Ext.util.DelayedTask(me.onRangeFetched, me, null, false); } // Render the new range very soon after this scroll event handler exits. // If scrolling very quickly, a few more scroll events may fire before // the render takes place. Each one will just *update* the arguments with which // the pending invocation is called. me.renderTask.delay(1, null, null, [null, start, end]); } } // Required range is not in the prefetch buffer. Ask the store to prefetch it. else { me.attemptLoad(start, end); } }, onRangeFetched: function(range, start, end, fromLockingPartner) { var me = this, view = me.view, oldStart, rows = view.all, removeCount, increment = 0, calculatedTop = start * me.rowHeight, top, lockingPartner = me.lockingPartner; // View may have been destroyed since the DelayedTask was kicked off. if (view.isDestroyed) { return; } // If called as a callback from the Store, the range will be passed, if called from renderRange, it won't if (!range) { range = me.store.getRange(start, end); // Store may have been cleared since the DelayedTask was kicked off. if (!range) { return; } } // No overlapping nodes, we'll need to render the whole range if (start > rows.endIndex || end < rows.startIndex) { rows.clear(true); top = calculatedTop; } if (!rows.getCount()) { view.doAdd(range, start); } // Moved down the dataset (content moved up): remove rows from top, add to end else if (end > rows.endIndex) { removeCount = Math.max(start - rows.startIndex, 0); // We only have to bump the table down by the height of removed rows if rows are not a standard size if (me.variableRowHeight) { increment = rows.item(rows.startIndex + removeCount, true).offsetTop; } rows.scroll(Ext.Array.slice(range, rows.endIndex + 1 - start), 1, removeCount, start, end); // We only have to bump the table down by the height of removed rows if rows are not a standard size if (me.variableRowHeight) { // Bump the table downwards by the height scraped off the top top = me.bodyTop + increment; } else { top = calculatedTop; } } // Moved up the dataset: remove rows from end, add to top else { removeCount = Math.max(rows.endIndex - end, 0); oldStart = rows.startIndex; rows.scroll(Ext.Array.slice(range, 0, rows.startIndex - start), -1, removeCount, start, end); // We only have to bump the table up by the height of top-added rows if rows are not a standard size if (me.variableRowHeight) { // Bump the table upwards by the height added to the top top = me.bodyTop - rows.item(oldStart, true).offsetTop; } else { top = calculatedTop; } } // The position property is the scrollTop value *at which the table was last correct* // MUST be set at table render/adjustment time me.position = me.scrollTop; // Position the table element. top will be undefined if fixed row height, so table position will // be calculated. if (view.positionBody) { me.setBodyTop(top, calculatedTop); } // Sync the other side to exactly the same range from the dataset. // Then ensure that we are still at exactly the same scroll position. if (lockingPartner && !lockingPartner.disabled && !fromLockingPartner) { lockingPartner.onRangeFetched(range, start, end, true); if (lockingPartner.scrollTop !== me.scrollTop) { lockingPartner.view.el.dom.scrollTop = me.scrollTop; } } }, setBodyTop: function(bodyTop, calculatedTop) { var me = this, view = me.view, store = me.store, body = view.body.dom, delta; bodyTop = Math.floor(bodyTop); // See if there's a difference between the calculated top and the requested top. // This can be caused by non-standard row heights introduced by features or non-standard // data in rows. if (calculatedTop !== undefined) { delta = bodyTop - calculatedTop; bodyTop = calculatedTop; } body.style.position = 'absolute'; body.style.top = (me.bodyTop = bodyTop) + 'px'; // Adjust scrollTop to keep user-perceived position the same in the case of the calculated position not matching where the actual position was. // Set position property so that scroll handler does not fire in response. if (delta) { me.scrollTop = me.position = view.el.dom.scrollTop -= delta; } // If this is the last page, correct the scroll range to be just enough to fit. if (view.all.endIndex === (store.buffered ? store.getTotalCount() : store.getCount()) - 1) { me.stretchView(view, me.bodyTop + body.offsetHeight); } }, getFirstVisibleRowIndex: function(startRow, endRow, viewportTop, viewportBottom) { var me = this, view = me.view, rows = view.all, elements = rows.elements, clientHeight = view.el.dom.clientHeight, target, targetTop; // If variableRowHeight, we have to search for the first row who's bottom edge is within the viewport if (rows.getCount() && me.variableRowHeight) { if (!arguments.length) { startRow = rows.startIndex; endRow = rows.endIndex; viewportTop = me.scrollTop; viewportBottom = viewportTop + clientHeight; // Teleported so that body is outside viewport: Use rowHeight calculation if (me.bodyTop > viewportBottom || me.bodyTop + view.body.getHeight() < viewportTop) { return Math.floor(me.scrollTop / me.rowHeight); } // In first, non-recursive call, begin targetting the most likely first row target = startRow + Math.min(me.numFromEdge + ((me.lastScrollDirection == -1) ? me.leadingBufferZone : me.trailingBufferZone), Math.floor((endRow - startRow) / 2)); } else { target = startRow + Math.floor((endRow - startRow) / 2); } targetTop = me.bodyTop + elements[target].offsetTop; // If target is entirely above the viewport, chop downwards if (targetTop + elements[target].offsetHeight < viewportTop) { return me.getFirstVisibleRowIndex(target + 1, endRow, viewportTop, viewportBottom); } // Target is first if (targetTop <= viewportTop) { return target; } // Not narrowed down to 1 yet; chop upwards else if (target !== startRow) { return me.getFirstVisibleRowIndex(startRow, target - 1, viewportTop, viewportBottom); } } return Math.floor(me.scrollTop / me.rowHeight); }, getLastVisibleRowIndex: function(startRow, endRow, viewportTop, viewportBottom) { var me = this, view = me.view, rows = view.all, elements = rows.elements, clientHeight = view.el.dom.clientHeight, target, targetTop, targetBottom; // If variableRowHeight, we have to search for the first row who's bottom edge is below the bottom of the viewport if (rows.getCount() && me.variableRowHeight) { if (!arguments.length) { startRow = rows.startIndex; endRow = rows.endIndex; viewportTop = me.scrollTop; viewportBottom = viewportTop + clientHeight; // Teleported so that body is outside viewport: Use rowHeight calculation if (me.bodyTop > viewportBottom || me.bodyTop + view.body.getHeight() < viewportTop) { return Math.floor(me.scrollTop / me.rowHeight) + Math.ceil(clientHeight / me.rowHeight); } // In first, non-recursive call, begin targetting the most likely last row target = endRow - Math.min(me.numFromEdge + ((me.lastScrollDirection == 1) ? me.leadingBufferZone : me.trailingBufferZone), Math.floor((endRow - startRow) / 2)); } else { target = startRow + Math.floor((endRow - startRow) / 2); } targetTop = me.bodyTop + elements[target].offsetTop; // If target is entirely below the viewport, chop upwards if (targetTop > viewportBottom) { return me.getLastVisibleRowIndex(startRow, target - 1, viewportTop, viewportBottom); } targetBottom = targetTop + elements[target].offsetHeight; // Target is last if (targetBottom >= viewportBottom) { return target; } // Not narrowed down to 1 yet; chop downwards else if (target !== endRow) { return me.getLastVisibleRowIndex(target + 1, endRow, viewportTop, viewportBottom); } } return me.getFirstVisibleRowIndex() + Math.ceil(clientHeight / me.rowHeight); }, getScrollHeight: function() { var me = this, view = me.view, store = me.store, doCalcHeight = !me.hasOwnProperty('rowHeight'), storeCount = me.store.getCount(); if (!storeCount) { return 0; } if (doCalcHeight) { if (view.all.getCount()) { me.rowHeight = Math.floor(view.body.getHeight() / view.all.getCount()); } } return this.scrollHeight = Math.floor((store.buffered ? store.getTotalCount() : store.getCount()) * me.rowHeight); }, attemptLoad: function(start, end) { var me = this; if (me.scrollToLoadBuffer) { if (!me.loadTask) { me.loadTask = new Ext.util.DelayedTask(me.doAttemptLoad, me, []); } me.loadTask.delay(me.scrollToLoadBuffer, me.doAttemptLoad, me, [start, end]); } else { me.store.getRange(start, end, { callback: me.onRangeFetched, scope: me, fireEvent: false }); } }, cancelLoad: function() { if (this.loadTask) { this.loadTask.cancel(); } }, doAttemptLoad: function(start, end) { this.store.getRange(start, end, { callback: this.onRangeFetched, scope: this, fireEvent: false }); }, destroy: function() { var me = this, view = me.view; if (view && view.el) { view.el.un('scroll', me.onViewScroll, me); // un does not understand the element options } // Remove listeners from old grid, view and store Ext.destroy(me.viewListeners, me.storeListeners, me.gridListeners); } }); /** * This class provides an abstract grid editing plugin on selected {@link Ext.grid.column.Column columns}. * The editable columns are specified by providing an {@link Ext.grid.column.Column#editor editor} * in the {@link Ext.grid.column.Column column configuration}. * * **Note:** This class should not be used directly. See {@link Ext.grid.plugin.CellEditing} and * {@link Ext.grid.plugin.RowEditing}. */ Ext.define('Ext.grid.plugin.Editing', { alias: 'editing.editing', extend: Ext.AbstractPlugin , mixins: { observable: Ext.util.Observable }, /** * @cfg {Number} clicksToEdit * The number of clicks on a grid required to display the editor. * The only accepted values are **1** and **2**. */ clicksToEdit: 2, /** * @cfg {String} triggerEvent * The event which triggers editing. Supercedes the {@link #clicksToEdit} configuration. Maybe one of: * * * cellclick * * celldblclick * * cellfocus * * rowfocus */ triggerEvent: undefined, relayedEvents: [ 'beforeedit', 'edit', 'validateedit', 'canceledit' ], // @private defaultFieldXType: 'textfield', // cell, row, form editStyle: '', constructor: function(config) { var me = this; me.addEvents( /** * @event beforeedit * Fires before editing is triggered. Return false from event handler to stop the editing. * * @param {Ext.grid.plugin.Editing} editor * @param {Object} context The editing context with the following properties: * @param {Ext.grid.Panel} context.grid The owning grid Panel. * @param {Ext.data.Model} context.record The record being edited. * @param {String} context.field The name of the field being edited. * @param {Mixed} context.value The field's current value. * @param {HTMLElement} context.row The grid row element. * @param {Ext.grid.column.Column} context.column The Column being edited. * @param {Number} context.rowIdx The index of the row being edited. * @param {Number} context.colIdx The index of the column being edited. * @param {Boolean} context.cancel Set this to `true` to cancel the edit or return false from your handler. * @param {Mixed} context.originalValue Alias for value (only when using {@link Ext.grid.plugin.CellEditing CellEditing}). */ 'beforeedit', /** * @event edit * Fires after a editing. Usage example: * * grid.on('edit', function(editor, e) { * // commit the changes right after editing finished * e.record.commit(); * }); * * @param {Ext.grid.plugin.Editing} editor * @param {Object} context The editing context with the following properties: * @param {Ext.grid.Panel} context.grid The owning grid Panel. * @param {Ext.data.Model} context.record The record being edited. * @param {String} context.field The name of the field being edited. * @param {Mixed} context.value The field's current value. * @param {HTMLElement} context.row The grid row element. * @param {Ext.grid.column.Column} context.column The Column being edited. * @param {Number} context.rowIdx The index of the row being edited. * @param {Number} context.colIdx The index of the column being edited. */ 'edit', /** * @event validateedit * Fires after editing, but before the value is set in the record. Return false from event handler to * cancel the change. * * Usage example showing how to remove the red triangle (dirty record indicator) from some records (not all). By * observing the grid's validateedit event, it can be cancelled if the edit occurs on a targeted row (for example) * and then setting the field's new value in the Record directly: * * grid.on('validateedit', function(editor, e) { * var myTargetRow = 6; * * if (e.rowIdx == myTargetRow) { * e.cancel = true; * e.record.data[e.field] = e.value; * } * }); * * @param {Ext.grid.plugin.Editing} editor * @param {Object} context The editing context with the following properties: * @param {Ext.grid.Panel} context.grid The owning grid Panel. * @param {Ext.data.Model} context.record The record being edited. * @param {String} context.field The name of the field being edited. * @param {Mixed} context.value The field's current value. * @param {HTMLElement} context.row The grid row element. * @param {Ext.grid.column.Column} context.column The Column being edited. * @param {Number} context.rowIdx The index of the row being edited. * @param {Number} context.colIdx The index of the column being edited. */ 'validateedit', /** * @event canceledit * Fires when the user started editing but then cancelled the edit. * @param {Ext.grid.plugin.Editing} editor * @param {Object} context The editing context with the following properties: * @param {Ext.grid.Panel} context.grid The owning grid Panel. * @param {Ext.data.Model} context.record The record being edited. * @param {String} context.field The name of the field being edited. * @param {Mixed} context.value The field's current value. * @param {HTMLElement} context.row The grid row element. * @param {Ext.grid.column.Column} context.column The Column being edited. * @param {Number} context.rowIdx The index of the row being edited. * @param {Number} context.colIdx The index of the column being edited. */ 'canceledit' ); me.callParent(arguments); me.mixins.observable.constructor.call(me); // TODO: Deprecated, remove in 5.0 me.on("edit", function(editor, e) { me.fireEvent("afteredit", editor, e); }); }, // @private init: function(grid) { var me = this; me.grid = grid; me.view = grid.view; me.initEvents(); // Set up fields at render and reconfigure time me.mon(grid, { reconfigure: me.onReconfigure, scope: me, beforerender: { fn: me.onReconfigure, single: true, scope: me } }); grid.relayEvents(me, me.relayedEvents); // If the editable grid is owned by a lockable, relay up another level. if (me.grid.ownerLockable) { me.grid.ownerLockable.relayEvents(me, me.relayedEvents); } // Marks the grid as editable, so that the SelectionModel // can make appropriate decisions during navigation grid.isEditable = true; grid.editingPlugin = grid.view.editingPlugin = me; }, /** * Fires after the grid is reconfigured * @private */ onReconfigure: function() { var grid = this.grid; // In a Lockable assembly, the owner's view aggregates all grid columns across both sides. // We grab all columns here. grid = grid.ownerLockable ? grid.ownerLockable : grid; this.initFieldAccessors(grid.getView().getGridColumns()); }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { var me = this, grid = me.grid; Ext.destroy(me.keyNav); // Clear all listeners from all our events, clear all managed listeners we added to other Observables me.clearListeners(); if (grid) { me.removeFieldAccessors(grid.columnManager.getColumns()); grid.editingPlugin = grid.view.editingPlugin = me.grid = me.view = me.editor = me.keyNav = null; } }, // @private getEditStyle: function() { return this.editStyle; }, // @private initFieldAccessors: function(columns) { // If we have been passed a group header, process its leaf headers if (columns.isGroupHeader) { columns = columns.getGridColumns(); } // Ensure we are processing an array else if (!Ext.isArray(columns)) { columns = [columns]; } var me = this, c, cLen = columns.length, column; for (c = 0; c < cLen; c++) { column = columns[c]; if (!column.getEditor) { column.getEditor = function(record, defaultField) { return me.getColumnField(this, defaultField); }; } if (!column.hasEditor) { column.hasEditor = function() { return me.hasColumnField(this); }; } if (!column.setEditor) { column.setEditor = function(field) { me.setColumnField(this, field); }; } } }, // @private removeFieldAccessors: function(columns) { // If we have been passed a group header, process its leaf headers if (columns.isGroupHeader) { columns = columns.getGridColumns(); } // Ensure we are processing an array else if (!Ext.isArray(columns)) { columns = [columns]; } var c, cLen = columns.length, column; for (c = 0; c < cLen; c++) { column = columns[c]; column.getEditor = column.hasEditor = column.setEditor = null; } }, // @private // remaps to the public API of Ext.grid.column.Column.getEditor getColumnField: function(columnHeader, defaultField) { var field = columnHeader.field; if (!(field && field.isFormField)) { field = columnHeader.field = this.createColumnField(columnHeader, defaultField); } return field; }, // @private // remaps to the public API of Ext.grid.column.Column.hasEditor hasColumnField: function(columnHeader) { return !!columnHeader.field; }, // @private // remaps to the public API of Ext.grid.column.Column.setEditor setColumnField: function(columnHeader, field) { columnHeader.field = field; columnHeader.field = this.createColumnField(columnHeader); }, createColumnField: function(columnHeader, defaultField) { var field = columnHeader.field; if (!field && columnHeader.editor) { field = columnHeader.editor; columnHeader.editor = null; } if (!field && defaultField) { field = defaultField; } if (field) { if (field.isFormField) { field.column = columnHeader; } else { if (Ext.isString(field)) { field = { name: columnHeader.dataIndex, xtype: field, column: columnHeader }; } else { field = Ext.apply({ name: columnHeader.dataIndex, column: columnHeader }, field); } field = Ext.ComponentManager.create(field, this.defaultFieldXType); } columnHeader.field = field; } return field; }, // @private initEvents: function() { var me = this; me.initEditTriggers(); me.initCancelTriggers(); }, // @abstract initCancelTriggers: Ext.emptyFn, // @private initEditTriggers: function() { var me = this, view = me.view; // Listen for the edit trigger event. if (me.triggerEvent == 'cellfocus') { me.mon(view, 'cellfocus', me.onCellFocus, me); } else if (me.triggerEvent == 'rowfocus') { me.mon(view, 'rowfocus', me.onRowFocus, me); } else { // Prevent the View from processing when the SelectionModel focuses. // This is because the SelectionModel processes the mousedown event, and // focusing causes a scroll which means that the subsequent mouseup might // take place at a different document XY position, and will therefore // not trigger a click. // This Editor must call the View's focusCell method directly when we recieve a request to edit if (view.getSelectionModel().isCellModel) { view.onCellFocus = Ext.Function.bind(me.beforeViewCellFocus, me); } // Listen for whichever click event we are configured to use me.mon(view, me.triggerEvent || ('cell' + (me.clicksToEdit === 1 ? 'click' : 'dblclick')), me.onCellClick, me); } // add/remove header event listeners need to be added immediately because // columns can be added/removed before render me.initAddRemoveHeaderEvents() // wait until render to initialize keynav events since they are attached to an element view.on('render', me.initKeyNavHeaderEvents, me, {single: true}); }, // Override of View's method so that we can pre-empt the View's processing if the view is being triggered by a mousedown beforeViewCellFocus: function(position) { // Pass call on to view if the navigation is from the keyboard, or we are not going to edit this cell. if (this.view.selModel.keyNavigation || !this.editing || !this.isCellEditable || !this.isCellEditable(position.row, position.columnHeader)) { this.view.focusCell.apply(this.view, arguments); } }, // @private Used if we are triggered by the rowfocus event onRowFocus: function(record, row, rowIdx) { this.startEdit(row, 0); }, // @private Used if we are triggered by the cellfocus event onCellFocus: function(record, cell, position) { this.startEdit(position.row, position.column); }, // @private Used if we are triggered by a cellclick event onCellClick: function(view, cell, colIdx, record, row, rowIdx, e) { // cancel editing if the element that was clicked was a tree expander if(!view.expanderSelector || !e.getTarget(view.expanderSelector)) { this.startEdit(record, view.ownerCt.columnManager.getHeaderAtIndex(colIdx)); } }, initAddRemoveHeaderEvents: function(){ var me = this; me.mon(me.grid.headerCt, { scope: me, add: me.onColumnAdd, remove: me.onColumnRemove, columnmove: me.onColumnMove }); }, initKeyNavHeaderEvents: function() { var me = this; me.keyNav = Ext.create('Ext.util.KeyNav', me.view.el, { enter: me.onEnterKey, esc: me.onEscKey, scope: me }); }, // @private onColumnAdd: function(ct, column) { this.initFieldAccessors(column); }, // @private onColumnRemove: function(ct, column) { this.removeFieldAccessors(column); }, // @private // Inject field accessors on move because if the move FROM the main headerCt and INTO a grouped header, // the accessors will have been deleted but not added. They are added conditionally. onColumnMove: function(headerCt, column, fromIdx, toIdx) { this.initFieldAccessors(column); }, // @private onEnterKey: function(e) { var me = this, grid = me.grid, selModel = grid.getSelectionModel(), record, pos, columnHeader; // Calculate editing start position from SelectionModel if there is a selection // Note that the condition below tests the result of an assignment to the "pos" variable. if (selModel.getCurrentPosition && (pos = selModel.getCurrentPosition())) { record = pos.record; columnHeader = pos.columnHeader; } // RowSelectionModel else { record = selModel.getLastSelected(); columnHeader = grid.columnManager.getHeaderAtIndex(0); } // If there was a selection to provide a starting context... if (record && columnHeader) { me.startEdit(record, columnHeader); } }, // @private onEscKey: function(e) { return this.cancelEdit(); }, /** * @private * @template * Template method called before editing begins. * @param {Object} context The current editing context * @return {Boolean} Return false to cancel the editing process */ beforeEdit: Ext.emptyFn, /** * Starts editing the specified record, using the specified Column definition to define which field is being edited. * @param {Ext.data.Model/Number} record The Store data record which backs the row to be edited, or index of the record in Store. * @param {Ext.grid.column.Column/Number} columnHeader The Column object defining the column to be edited, or index of the column. */ startEdit: function(record, columnHeader) { var me = this, context, layoutView = me.grid.lockable ? me.grid : me.view; // The view must have had a layout to show the editor correctly, defer until that time. // In case a grid's startup code invokes editing immediately. if (!layoutView.componentLayoutCounter) { layoutView.on({ boxready: Ext.Function.bind(me.startEdit, me, [record, columnHeader]), single: true }); return false; } // If grid collapsed, or view not truly visible, don't even calculate a context - we cannot edit if (me.grid.collapsed || !me.grid.view.isVisible(true)) { return false; } context = me.getEditingContext(record, columnHeader); if (context == null) { return false; } if (!me.preventBeforeCheck) { if (me.beforeEdit(context) === false || me.fireEvent('beforeedit', me, context) === false || context.cancel) { return false; } } /** * @property {Boolean} editing * Set to `true` while the editing plugin is active and an Editor is visible. */ me.editing = true; return context; }, // TODO: Have this use a new class Ext.grid.CellContext for use here, and in CellSelectionModel /** * @private * Collects all information necessary for any subclasses to perform their editing functions. * @param record * @param columnHeader * @returns {Object/undefined} The editing context based upon the passed record and column */ getEditingContext: function(record, columnHeader) { var me = this, grid = me.grid, view = me.view, gridRow = view.getNode(record, true), rowIdx, colIdx; // An intervening listener may have deleted the Record if (!gridRow) { return; } // Coerce the column index to the closest visible column columnHeader = grid.columnManager.getVisibleHeaderClosestToIndex(Ext.isNumber(columnHeader) ? columnHeader : columnHeader.getVisibleIndex()); // No corresponding column. Possible if all columns have been moved to the other side of a lockable grid pair if (!columnHeader) { return; } colIdx = columnHeader.getVisibleIndex(); if (Ext.isNumber(record)) { // look up record if numeric row index was passed rowIdx = record; record = view.getRecord(gridRow); } else { rowIdx = view.indexOf(gridRow); } // The record may be removed from the store but the view // not yet updated, so check it exists if (!record) { return; } return { grid : grid, view : view, store : view.dataSource, record : record, field : columnHeader.dataIndex, value : record.get(columnHeader.dataIndex), row : gridRow, column : columnHeader, rowIdx : rowIdx, colIdx : colIdx }; }, /** * Cancels any active edit that is in progress. */ cancelEdit: function() { var me = this; me.editing = false; me.fireEvent('canceledit', me, me.context); }, /** * Completes the edit if there is an active edit in progress. */ completeEdit: function() { var me = this; if (me.editing && me.validateEdit()) { me.fireEvent('edit', me, me.context); } me.context = null; me.editing = false; }, // @abstract validateEdit: function() { var me = this, context = me.context; return me.fireEvent('validateedit', me, context) !== false && !context.cancel; } }); /** * The Ext.grid.plugin.CellEditing plugin injects editing at a cell level for a Grid. Only a single * cell will be editable at a time. The field that will be used for the editor is defined at the * {@link Ext.grid.column.Column#editor editor}. The editor can be a field instance or a field configuration. * * If an editor is not specified for a particular column then that cell will not be editable and it will * be skipped when activated via the mouse or the keyboard. * * The editor may be shared for each column in the grid, or a different one may be specified for each column. * An appropriate field type should be chosen to match the data structure that it will be editing. For example, * to edit a date, it would be useful to specify {@link Ext.form.field.Date} as the editor. * * ## Example * * A grid with editor for the name and the email columns: * * @example * Ext.create('Ext.data.Store', { * storeId:'simpsonsStore', * fields:['name', 'email', 'phone'], * data:{'items':[ * {"name":"Lisa", "email":"lisa@simpsons.com", "phone":"555-111-1224"}, * {"name":"Bart", "email":"bart@simpsons.com", "phone":"555-222-1234"}, * {"name":"Homer", "email":"home@simpsons.com", "phone":"555-222-1244"}, * {"name":"Marge", "email":"marge@simpsons.com", "phone":"555-222-1254"} * ]}, * proxy: { * type: 'memory', * reader: { * type: 'json', * root: 'items' * } * } * }); * * Ext.create('Ext.grid.Panel', { * title: 'Simpsons', * store: Ext.data.StoreManager.lookup('simpsonsStore'), * columns: [ * {header: 'Name', dataIndex: 'name', editor: 'textfield'}, * {header: 'Email', dataIndex: 'email', flex:1, * editor: { * xtype: 'textfield', * allowBlank: false * } * }, * {header: 'Phone', dataIndex: 'phone'} * ], * selType: 'cellmodel', * plugins: [ * Ext.create('Ext.grid.plugin.CellEditing', { * clicksToEdit: 1 * }) * ], * height: 200, * width: 400, * renderTo: Ext.getBody() * }); * * This requires a little explanation. We're passing in `store` and `columns` as normal, but * we also specify a {@link Ext.grid.column.Column#field field} on two of our columns. For the * Name column we just want a default textfield to edit the value, so we specify 'textfield'. * For the Email column we customized the editor slightly by passing allowBlank: false, which * will provide inline validation. * * To support cell editing, we also specified that the grid should use the 'cellmodel' * {@link Ext.grid.Panel#selType selType}, and created an instance of the CellEditing plugin, * which we configured to activate each editor after a single click. * */ Ext.define('Ext.grid.plugin.CellEditing', { alias: 'plugin.cellediting', extend: Ext.grid.plugin.Editing , lockableScope: 'both', /** * @event beforeedit * Fires before cell editing is triggered. Return false from event handler to stop the editing. * * @param {Ext.grid.plugin.CellEditing} editor * @param {Object} e An edit event with the following properties: * * - grid - The grid * - record - The record being edited * - field - The field name being edited * - value - The value for the field being edited. * - row - The grid table row * - column - The grid {@link Ext.grid.column.Column Column} defining the column that is being edited. * - rowIdx - The row index that is being edited * - colIdx - The column index that is being edited * - cancel - Set this to true to cancel the edit or return false from your handler. */ /** * @event edit * Fires after a cell is edited. Usage example: * * grid.on('edit', function(editor, e) { * // commit the changes right after editing finished * e.record.commit(); * }); * * @param {Ext.grid.plugin.CellEditing} editor * @param {Object} e An edit event with the following properties: * * - grid - The grid * - record - The record that was edited * - field - The field name that was edited * - value - The value being set * - originalValue - The original value for the field, before the edit. * - row - The grid table row * - column - The grid {@link Ext.grid.column.Column Column} defining the column that was edited. * - rowIdx - The row index that was edited * - colIdx - The column index that was edited */ /** * @event validateedit * Fires after a cell is edited, but before the value is set in the record. Return false from event handler to * cancel the change. * * Usage example showing how to remove the red triangle (dirty record indicator) from some records (not all). By * observing the grid's validateedit event, it can be cancelled if the edit occurs on a targeted row (for * example) and then setting the field's new value in the Record directly: * * grid.on('validateedit', function(editor, e) { * var myTargetRow = 6; * * if (e.row == myTargetRow) { * e.cancel = true; * e.record.data[e.field] = e.value; * } * }); * * @param {Ext.grid.plugin.CellEditing} editor * @param {Object} e An edit event with the following properties: * * - grid - The grid * - record - The record being edited * - field - The field name being edited * - value - The value being set * - originalValue - The original value for the field, before the edit. * - row - The grid table row * - column - The grid {@link Ext.grid.column.Column Column} defining the column that is being edited. * - rowIdx - The row index that is being edited * - colIdx - The column index that is being edited * - cancel - Set this to true to cancel the edit or return false from your handler. */ /** * @event canceledit * Fires when the user started editing a cell but then cancelled the edit. * @param {Ext.grid.plugin.CellEditing} editor * @param {Object} e An edit event with the following properties: * * - grid - The grid * - record - The record that was edited * - field - The field name that was edited * - value - The value being set * - row - The grid table row * - column - The grid {@link Ext.grid.column.Column Column} defining the column that was edited. * - rowIdx - The row index that was edited * - colIdx - The column index that was edited */ init: function(grid) { var me = this, lockingPartner = me.lockingPartner; me.callParent(arguments); // Share editor apparatus with lockingPartner becuse columns may move from side to side if (lockingPartner) { if (lockingPartner.editors) { me.editors = lockingPartner.editors; } else { me.editors = lockingPartner.editors = new Ext.util.MixedCollection(false, function(editor) { return editor.editorId; }); } } else { me.editors = new Ext.util.MixedCollection(false, function(editor) { return editor.editorId; }); } }, onReconfigure: function(grid, store, columns){ // Only reconfigure editors if passed a new set of columns if (columns) { this.editors.clear(); } this.callParent(); }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { var me = this; if (me.editors) { me.editors.each(Ext.destroy, Ext); me.editors.clear(); } me.callParent(arguments); }, onBodyScroll: function() { var me = this, ed = me.getActiveEditor(), scroll = me.view.el.getScroll(); // Scroll happened during editing... // If editing is on the other side of a lockable, then ignore it if (ed && ed.editing && ed.editingPlugin === me) { // Terminate editing only on vertical scroll. Horiz scroll can be caused by tabbing between cells. if (scroll.top !== me.scroll.top) { if (ed.field) { if (ed.field.triggerBlur) { ed.field.triggerBlur(); } else { ed.field.blur(); } } } // Horiz scroll just requires that the editor be realigned. else { ed.realign(); } } me.scroll = scroll; }, // @private // Template method called from base class's initEvents initCancelTriggers: function() { var me = this, grid = me.grid, view = grid.view; me.mon(view, 'bodyscroll', me.onBodyScroll, me); me.mon(grid, { columnresize: me.cancelEdit, columnmove: me.cancelEdit, scope: me }); }, isCellEditable: function(record, columnHeader) { var me = this, context = me.getEditingContext(record, columnHeader); if (me.grid.view.isVisible(true) && context) { columnHeader = context.column; record = context.record; if (columnHeader && me.getEditor(record, columnHeader)) { return true; } } }, /** * Starts editing the specified record, using the specified Column definition to define which field is being edited. * @param {Ext.data.Model/Number} record The Store data record which backs the row to be edited, or index of the record. * @param {Ext.grid.column.Column/Number} columnHeader The Column object defining the column to be edited, or index of the column. * @return {Boolean} `true` if editing was started, `false` otherwise. */ startEdit: function(record, columnHeader, /* private */ context) { var me = this, ed; if (!context) { me.preventBeforeCheck = true; context = me.callParent(arguments); delete me.preventBeforeCheck; if (context === false) { return false; } } // Cancel editing if EditingContext could not be found (possibly because record has been deleted by an intervening listener), // or if the grid view is not currently visible if (context && me.grid.view.isVisible(true)) { record = context.record; columnHeader = context.column; // Complete the edit now, before getting the editor's target cell DOM element. // Completing the edit hides the editor, causes a row update and sets up a delayed focus on the row. // Also allows any post-edit events to take effect before continuing me.completeEdit(); // See if the field is editable for the requested record if (columnHeader && !columnHeader.getEditor(record)) { return false; } // Switch to new context *after* completing the current edit me.context = context; context.originalValue = context.value = record.get(columnHeader.dataIndex); if (me.beforeEdit(context) === false || me.fireEvent('beforeedit', me, context) === false || context.cancel) { return false; } ed = me.getEditor(record, columnHeader); // Whether we are going to edit or not, ensure the edit cell is scrolled into view me.grid.view.cancelFocus(); me.view.scrollCellIntoView(me.getCell(record, columnHeader)); if (ed) { me.showEditor(ed, context, context.value); return true; } return false; } }, showEditor: function(ed, context, value) { var me = this, record = context.record, columnHeader = context.column, sm = me.grid.getSelectionModel(), selection = sm.getCurrentPosition(), otherView = selection && selection.view; // Selection is for another view. // This can happen in a lockable grid where there are two grids, each with a separate Editing plugin if (otherView && otherView !== me.view) { return me.lockingPartner.showEditor(ed, me.lockingPartner.getEditingContext(selection.record, selection.columnHeader), value); } me.setEditingContext(context); me.setActiveEditor(ed); me.setActiveRecord(record); me.setActiveColumn(columnHeader); // Select cell on edit only if it's not the currently selected cell if (sm.selectByPosition && (!selection || selection.column !== context.colIdx || selection.row !== context.rowIdx)) { sm.selectByPosition({ row: context.rowIdx, column: context.colIdx, view: me.view }); } ed.startEdit(me.getCell(record, columnHeader), value, context); me.editing = true; me.scroll = me.view.el.getScroll(); }, completeEdit: function() { var activeEd = this.getActiveEditor(); if (activeEd) { activeEd.completeEdit(); this.editing = false; } }, // internal getters/setters setEditingContext: function(context) { this.context = context; if (this.lockingPartner) { this.lockingPartner.context = context; } }, setActiveEditor: function(ed) { this.activeEditor = ed; if (this.lockingPartner) { this.lockingPartner.activeEditor = ed; } }, getActiveEditor: function() { return this.activeEditor; }, setActiveColumn: function(column) { this.activeColumn = column; if (this.lockingPartner) { this.lockingPartner.activeColumn = column; } }, getActiveColumn: function() { return this.activeColumn; }, setActiveRecord: function(record) { this.activeRecord = record; if (this.lockingPartner) { this.lockingPartner.activeRecord = record; } }, getActiveRecord: function() { return this.activeRecord; }, getEditor: function(record, column) { var me = this, editors = me.editors, editorId = column.getItemId(), editor = editors.getByKey(editorId), // Add to top level grid if we are editing one side of a locking system editorOwner = me.grid.ownerLockable || me.grid; if (!editor) { editor = column.getEditor(record); if (!editor) { return false; } // Allow them to specify a CellEditor in the Column if (editor instanceof Ext.grid.CellEditor) { editor.floating = true; } // But if it's just a Field, wrap it. else { editor = new Ext.grid.CellEditor({ floating: true, editorId: editorId, field: editor }); } // Add the Editor as a floating child of the grid editorOwner.add(editor); editor.on({ scope: me, specialkey: me.onSpecialKey, complete: me.onEditComplete, canceledit: me.cancelEdit }); column.on('removed', me.cancelActiveEdit, me); editors.add(editor); } if (column.isTreeColumn) { editor.isForTree = column.isTreeColumn; editor.addCls(Ext.baseCSSPrefix + 'tree-cell-editor') } editor.grid = me.grid; // Keep upward pointer correct for each use - editors are shared between locking sides editor.editingPlugin = me; return editor; }, cancelActiveEdit: function(column){ var context = this.context if (context && context.column === column) { this.cancelEdit(); } }, // inherit docs setColumnField: function(column, field) { var ed = this.editors.getByKey(column.getItemId()); Ext.destroy(ed, column.field); this.editors.removeAtKey(column.getItemId()); this.callParent(arguments); }, /** * Gets the cell (td) for a particular record and column. * @param {Ext.data.Model} record * @param {Ext.grid.column.Column} column * @private */ getCell: function(record, column) { return this.grid.getView().getCell(record, column); }, onSpecialKey: function(ed, field, e) { var sm; if (e.getKey() === e.TAB) { e.stopEvent(); if (ed) { // Allow the field to act on tabs before onEditorTab, which ends // up calling completeEdit. This is useful for picker type fields. ed.onEditorTab(e); } sm = ed.up('tablepanel').getSelectionModel(); if (sm.onEditorTab) { return sm.onEditorTab(ed.editingPlugin, e); } } }, onEditComplete : function(ed, value, startValue) { var me = this, activeColumn = me.getActiveColumn(), context = me.context, record; if (activeColumn) { record = context.record; me.setActiveEditor(null); me.setActiveColumn(null); me.setActiveRecord(null); context.value = value; if (!me.validateEdit()) { return; } // Only update the record if the new value is different than the // startValue. When the view refreshes its el will gain focus if (!record.isEqual(value, startValue)) { record.set(activeColumn.dataIndex, value); } // Restore focus back to the view. // Use delay so that if we are completing due to tabbing, we can cancel the focus task context.view.focus(false, true); me.fireEvent('edit', me, context); me.editing = false; } }, /** * Cancels any active editing. */ cancelEdit: function() { var me = this, activeEd = me.getActiveEditor(); me.setActiveEditor(null); me.setActiveColumn(null); me.setActiveRecord(null); if (activeEd) { activeEd.cancelEdit(); me.context.view.focus(); me.callParent(arguments); return; } // If we aren't editing, return true to allow the event to bubble return true; }, /** * Starts editing by position (row/column) * @param {Object} position A position with keys of row and column. */ startEditByPosition: function(position) { // If a raw {row:0, column:0} object passed. if (!position.isCellContext) { position = new Ext.grid.CellContext(this.view).setPosition(position); } // Coerce the edit column to the closest visible column position.setColumn(this.view.getHeaderCt().getVisibleHeaderClosestToIndex(position.column).getIndex()); return this.startEdit(position.record, position.columnHeader); } }); Ext.define('Ext.grid.plugin.DivRenderer', { alias: 'plugin.divrenderer', extend: Ext.AbstractPlugin , tableTpl: [ '
    ', '{%', 'values.view.renderRows(values.rows, values.viewStartIndex, out);', '%}', '
    ', { priority: 0 } ], rowTpl: [ '{%', 'var dataRowCls = values.recordIndex === -1 ? "" : " ' + Ext.baseCSSPrefix + 'grid-data-row";', '%}', '
    ', '' + '{%', 'parent.view.renderCell(values, parent.record, parent.recordIndex, xindex - 1, out, parent)', '%}', '', '
    ', { priority: 0 } ], cellTpl: [ '
    ', '
    {style}">{value}
    ', '
    ', { priority: 0 } ], selectors: { // Outer table bodySelector: 'div', // Element which contains rows nodeContainerSelector: 'div', // view item (may be a wrapper) itemSelector: 'dl.' + Ext.baseCSSPrefix + 'grid-row', // row which contains cells as opposed to wrapping rows dataRowSelector: 'dl.' + Ext.baseCSSPrefix + 'grid-data-row', // cell cellSelector: 'dt.' + Ext.baseCSSPrefix + 'grid-cell', innerSelector: 'div.' + Ext.baseCSSPrefix + 'grid-cell-inner', getNodeContainerSelector: function() { return this.getBodySelector(); }, getNodeContainer: function() { return this.el.getById(this.id + '-table', true); } }, init: function(grid) { var view = grid.getView(); view.tableTpl = Ext.XTemplate.getTpl(this, 'tableTpl'); view.rowTpl = Ext.XTemplate.getTpl(this, 'rowTpl'); view.cellTpl = Ext.XTemplate.getTpl(this, 'cellTpl'); Ext.apply(view, this.selectors); } }); /** * This plugin provides drag and/or drop functionality for a {@link Ext.grid.View GridView}. * * It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a {@link * Ext.grid.View GridView} and loads the data object which is passed to a cooperating {@link Ext.dd.DragZone DragZone}'s * methods with the following properties: * * - `copy` : {@link Boolean} * * The value of the {@link Ext.grid.View GridView}'s `copy` property, or `true` if the GridView was configured with `allowCopy: true` _and_ * the control key was pressed when the drag operation was begun. * * - `view` : {@link Ext.grid.View GridView} * * The source GridView from which the drag originated. * * - `ddel` : HtmlElement * * The drag proxy element which moves with the mouse * * - `item` : HtmlElement * * The GridView node upon which the mousedown event was registered. * * - `records` : {@link Array} * * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source {@link Ext.grid.View GridView}. * * It also creates a specialized instance of {@link Ext.dd.DropZone} which cooperates with other DropZones which are * members of the same ddGroup which processes such data objects. * * Adding this plugin to a view means that two new events may be fired from the client GridView, `{@link #beforedrop * beforedrop}` and `{@link #drop drop}` * * @example * Ext.create('Ext.data.Store', { * storeId:'simpsonsStore', * fields:['name'], * data: [["Lisa"], ["Bart"], ["Homer"], ["Marge"]], * proxy: { * type: 'memory', * reader: 'array' * } * }); * * Ext.create('Ext.grid.Panel', { * store: 'simpsonsStore', * columns: [ * {header: 'Name', dataIndex: 'name', flex: true} * ], * viewConfig: { * plugins: { * ptype: 'gridviewdragdrop', * dragText: 'Drag and drop to reorganize' * } * }, * height: 200, * width: 400, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.grid.plugin.DragDrop', { extend: Ext.AbstractPlugin , alias: 'plugin.gridviewdragdrop', /** * @event beforedrop * **This event is fired through the GridView. Add listeners to the {@link Ext.grid.View GridView} object** * * Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView. * * Returning `false` to this event signals that the drop gesture was invalid, and if the drag proxy will animate * back to the point from which the drag began. * * The dropHandlers parameter can be used to defer the processing of this event. For example to wait for the result of * a message box confirmation or an asynchronous server call. See the details of this property for more information. * * @example * view.on('beforedrop', function(node, data, overModel, dropPosition, dropHandlers) { * // Defer the handling * dropHandlers.wait = true; * Ext.MessageBox.confirm('Drop', 'Are you sure', function(btn){ * if (btn === 'yes') { * dropHandlers.processDrop(); * } else { * dropHandlers.cancelDrop(); * } * }); * }); * * Any other return value continues with the data transfer operation, unless the wait property is set. * * @param {HTMLElement} node The {@link Ext.grid.View GridView} node **if any** over which the mouse was positioned. * * Any other return value continues with the data transfer operation. * * @param {Object} data The data object gathered at mousedown time by the cooperating * {@link Ext.dd.DragZone DragZone}'s {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following * properties: * @param {Boolean} data.copy The value of the GridView's `copy` property, or `true` if the GridView was configured with * `allowCopy: true` and the control key was pressed when the drag operation was begun * @param {Ext.grid.View} data.view The source GridView from which the drag originated. * @param {HTMLElement} data.ddel The drag proxy element which moves with the mouse * @param {HTMLElement} data.item The GridView node upon which the mousedown event was registered. * @param {Ext.data.Model[]} data.records An Array of {@link Ext.data.Model Model}s representing the selected data being * dragged from the source GridView. * * @param {Ext.data.Model} overModel The Model over which the drop gesture took place. * * @param {String} dropPosition `"before"` or `"after"` depending on whether the mouse is above or below the midline * of the node. * * @param {Object} dropHandlers * This parameter allows the developer to control when the drop action takes place. It is useful if any asynchronous * processing needs to be completed before performing the drop. This object has the following properties: * * @param {Boolean} dropHandlers.wait Indicates whether the drop should be deferred. Set this property to true to defer the drop. * @param {Function} dropHandlers.processDrop A function to be called to complete the drop operation. * @param {Function} dropHandlers.cancelDrop A function to be called to cancel the drop operation. */ /** * @event drop * **This event is fired through the GridView. Add listeners to the GridView object** Fired when a drop operation * has been completed and the data has been moved or copied. * * @param {HTMLElement} node The GridView node **if any** over which the mouse was positioned. * * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone * DragZone}'s {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties: * * - `copy` : {@link Boolean} * * The value of the GridView's `copy` property, or `true` if the GridView was configured with `allowCopy: true` and * the control key was pressed when the drag operation was begun * * - `view` : {@link Ext.grid.View GridView} * * The source GridView from which the drag originated. * * - `ddel` : HtmlElement * * The drag proxy element which moves with the mouse * * - `item` : HtmlElement * * The {@link Ext.grid.View GridView}{@link Ext.grid.View GridView} node upon which the mousedown event was registered. * * - `records` : {@link Array} * * An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView. * * @param {Ext.data.Model} overModel The Model over which the drop gesture took place. * * @param {String} dropPosition `"before"` or `"after"` depending on whether the mouse is above or below the midline * of the node. */ // /** * @cfg * The text to show while dragging. * * Two placeholders can be used in the text: * * - `{0}` The number of selected items. * - `{1}` 's' when more than 1 items (only useful for English). */ dragText : '{0} selected row{1}', // /** * @cfg {String} ddGroup * A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and * DropZone used by this plugin will only interact with other drag drop objects in the same group. */ ddGroup : "GridDD", /** * @cfg {String} dragGroup * The {@link #ddGroup} to which the DragZone will belong. * * This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other * Drag/DropZones which are members of the same {@link #ddGroup}. */ /** * @cfg {String} dropGroup * The {@link #ddGroup} to which the DropZone will belong. * * This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other * Drag/DropZones which are members of the same {@link #ddGroup}. */ /** * @cfg {Boolean} enableDrop * `false` to disallow the View from accepting drop gestures. */ enableDrop: true, /** * @cfg {Boolean} enableDrag * `false` to disallow dragging items from the View. */ enableDrag: true, /** * `true` to register this container with the Scrollmanager for auto scrolling during drag operations. * A {@link Ext.dd.ScrollManager} configuration may also be passed. * @cfg {Object/Boolean} containerScroll */ containerScroll: false, init : function(view) { view.on('render', this.onViewRender, this, {single: true}); }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { Ext.destroy(this.dragZone, this.dropZone); }, enable: function() { var me = this; if (me.dragZone) { me.dragZone.unlock(); } if (me.dropZone) { me.dropZone.unlock(); } me.callParent(); }, disable: function() { var me = this; if (me.dragZone) { me.dragZone.lock(); } if (me.dropZone) { me.dropZone.lock(); } me.callParent(); }, onViewRender : function(view) { var me = this, scrollEl; if (me.enableDrag) { if (me.containerScroll) { scrollEl = view.getEl(); } me.dragZone = new Ext.view.DragZone({ view: view, ddGroup: me.dragGroup || me.ddGroup, dragText: me.dragText, containerScroll: me.containerScroll, scrollEl: scrollEl }); } if (me.enableDrop) { me.dropZone = new Ext.grid.ViewDropZone({ view: view, ddGroup: me.dropGroup || me.ddGroup }); } } }); /** * The Ext.grid.plugin.RowEditing plugin injects editing at a row level for a Grid. When editing begins, * a small floating dialog will be shown for the appropriate row. Each editable column will show a field * for editing. There is a button to save or cancel all changes for the edit. * * The field that will be used for the editor is defined at the * {@link Ext.grid.column.Column#editor editor}. The editor can be a field instance or a field configuration. * If an editor is not specified for a particular column then that column won't be editable and the value of * the column will be displayed. To provide a custom renderer for non-editable values, use the * {@link Ext.grid.column.Column#editRenderer editRenderer} configuration on the column. * * The editor may be shared for each column in the grid, or a different one may be specified for each column. * An appropriate field type should be chosen to match the data structure that it will be editing. For example, * to edit a date, it would be useful to specify {@link Ext.form.field.Date} as the editor. * * @example * Ext.create('Ext.data.Store', { * storeId:'simpsonsStore', * fields:['name', 'email', 'phone'], * data: [ * {"name":"Lisa", "email":"lisa@simpsons.com", "phone":"555-111-1224"}, * {"name":"Bart", "email":"bart@simpsons.com", "phone":"555-222-1234"}, * {"name":"Homer", "email":"home@simpsons.com", "phone":"555-222-1244"}, * {"name":"Marge", "email":"marge@simpsons.com", "phone":"555-222-1254"} * ] * }); * * Ext.create('Ext.grid.Panel', { * title: 'Simpsons', * store: Ext.data.StoreManager.lookup('simpsonsStore'), * columns: [ * {header: 'Name', dataIndex: 'name', editor: 'textfield'}, * {header: 'Email', dataIndex: 'email', flex:1, * editor: { * xtype: 'textfield', * allowBlank: false * } * }, * {header: 'Phone', dataIndex: 'phone'} * ], * selType: 'rowmodel', * plugins: [ * Ext.create('Ext.grid.plugin.RowEditing', { * clicksToEdit: 1 * }) * ], * height: 200, * width: 400, * renderTo: Ext.getBody() * }); * */ Ext.define('Ext.grid.plugin.RowEditing', { extend: Ext.grid.plugin.Editing , alias: 'plugin.rowediting', lockableScope: 'top', editStyle: 'row', /** * @cfg {Boolean} autoCancel * `true` to automatically cancel any pending changes when the row editor begins editing a new row. * `false` to force the user to explicitly cancel the pending changes. */ autoCancel: true, /** * @cfg {Number} clicksToMoveEditor * The number of clicks to move the row editor to a new row while it is visible and actively editing another row. * This will default to the same value as {@link Ext.grid.plugin.Editing#clicksToEdit clicksToEdit}. */ /** * @cfg {Boolean} errorSummary * True to show a {@link Ext.tip.ToolTip tooltip} that summarizes all validation errors present * in the row editor. Set to false to prevent the tooltip from showing. */ errorSummary: true, constructor: function() { var me = this; me.callParent(arguments); if (!me.clicksToMoveEditor) { me.clicksToMoveEditor = me.clicksToEdit; } me.autoCancel = !!me.autoCancel; }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { Ext.destroy(this.editor); this.callParent(arguments); }, /** * Starts editing the specified record, using the specified Column definition to define which field is being edited. * @param {Ext.data.Model} record The Store data record which backs the row to be edited. * @param {Ext.data.Model} columnHeader The Column object defining the column to be edited. * @return {Boolean} `true` if editing was started, `false` otherwise. */ startEdit: function(record, columnHeader) { var me = this, editor = me.getEditor(), context; if (editor.beforeEdit() !== false) { context = me.callParent(arguments); if (context) { me.context = context; // If editing one side of a lockable grid, cancel any edit on the other side. if (me.lockingPartner) { me.lockingPartner.cancelEdit(); } editor.startEdit(context.record, context.column, context); return true; } } return false; }, // @private cancelEdit: function() { var me = this; if (me.editing) { me.getEditor().cancelEdit(); me.callParent(arguments); return; } // If we aren't editing, return true to allow the event to bubble return true; }, // @private completeEdit: function() { var me = this; if (me.editing && me.validateEdit()) { me.editing = false; me.fireEvent('edit', me, me.context); } }, // @private validateEdit: function() { var me = this, editor = me.editor, context = me.context, record = context.record, newValues = {}, originalValues = {}, editors = editor.query('>[isFormField]'), e, eLen = editors.length, name, item; for (e = 0; e < eLen; e++) { item = editors[e]; name = item.name; newValues[name] = item.getValue(); originalValues[name] = record.get(name); } Ext.apply(context, { newValues : newValues, originalValues : originalValues }); return me.callParent(arguments) && me.getEditor().completeEdit(); }, // @private getEditor: function() { var me = this; if (!me.editor) { me.editor = me.initEditor(); } return me.editor; }, // @private initEditor: function() { return new Ext.grid.RowEditor(this.initEditorConfig()); }, initEditorConfig: function(){ var me = this, grid = me.grid, view = me.view, headerCt = grid.headerCt, btns = ['saveBtnText', 'cancelBtnText', 'errorsText', 'dirtyText'], b, bLen = btns.length, cfg = { autoCancel: me.autoCancel, errorSummary: me.errorSummary, fields: headerCt.getGridColumns(), hidden: true, view: view, // keep a reference.. editingPlugin: me }, item; for (b = 0; b < bLen; b++) { item = btns[b]; if (Ext.isDefined(me[item])) { cfg[item] = me[item]; } } return cfg; }, // @private initEditTriggers: function() { var me = this, view = me.view, moveEditorEvent = me.clicksToMoveEditor === 1 ? 'click' : 'dblclick'; me.callParent(arguments); if (me.clicksToMoveEditor !== me.clicksToEdit) { me.mon(view, 'cell' + moveEditorEvent, me.moveEditorByClick, me); } view.on({ render: function() { me.mon(me.grid.headerCt, { scope: me, columnresize: me.onColumnResize, columnhide: me.onColumnHide, columnshow: me.onColumnShow }); }, single: true }); }, startEditByClick: function() { var me = this; if (!me.editing || me.clicksToMoveEditor === me.clicksToEdit) { me.callParent(arguments); } }, moveEditorByClick: function() { var me = this; if (me.editing) { me.superclass.onCellClick.apply(me, arguments); } }, // @private onColumnAdd: function(ct, column) { if (column.isHeader) { var me = this, editor; me.initFieldAccessors(column); // Only inform the editor about a new column if the editor has already been instantiated, // so do not use getEditor which instantiates the editor if not present. editor = me.editor; if (editor && editor.onColumnAdd) { editor.onColumnAdd(column); } } }, // @private onColumnRemove: function(ct, column) { if (column.isHeader) { var me = this, editor = me.getEditor(); if (editor && editor.onColumnRemove) { editor.onColumnRemove(ct, column); } me.removeFieldAccessors(column); } }, // @private onColumnResize: function(ct, column, width) { if (column.isHeader) { var me = this, editor = me.getEditor(); if (editor && editor.onColumnResize) { editor.onColumnResize(column, width); } } }, // @private onColumnHide: function(ct, column) { // no isHeader check here since its already a columnhide event. var me = this, editor = me.getEditor(); if (editor && editor.onColumnHide) { editor.onColumnHide(column); } }, // @private onColumnShow: function(ct, column) { // no isHeader check here since its already a columnshow event. var me = this, editor = me.getEditor(); if (editor && editor.onColumnShow) { editor.onColumnShow(column); } }, // @private onColumnMove: function(ct, column, fromIdx, toIdx) { // no isHeader check here since its already a columnmove event. var me = this, editor = me.getEditor(); // Inject field accessors on move because if the move FROM the main headerCt and INTO a grouped header, // the accessors will have been deleted but not added. They are added conditionally. me.initFieldAccessors(column); if (editor && editor.onColumnMove) { // Must adjust the toIdx to account for removal if moving rightwards // because RowEditor.onColumnMove just calls Container.move which does not do this. editor.onColumnMove(column, fromIdx, toIdx); } }, // @private setColumnField: function(column, field) { var me = this, editor = me.getEditor(); editor.removeField(column); me.callParent(arguments); me.getEditor().setField(column); } }); // feature idea to enable Ajax loading and then the content // cache would actually make sense. Should we dictate that they use // data or support raw html as well? /** * Plugin (ptype = 'rowexpander') that adds the ability to have a Column in a grid which enables * a second row body which expands/contracts. The expand/contract behavior is configurable to react * on clicking of the column, double click of the row, and/or hitting enter while a row is selected. */ Ext.define('Ext.grid.plugin.RowExpander', { extend: Ext.AbstractPlugin , lockableScope: 'normal', alias: 'plugin.rowexpander', rowBodyTpl: null, /** * @cfg {Boolean} expandOnEnter * true to toggle selected row(s) between expanded/collapsed when the enter * key is pressed (defaults to true). */ expandOnEnter: true, /** * @cfg {Boolean} expandOnDblClick * true to toggle a row between expanded/collapsed when double clicked * (defaults to true). */ expandOnDblClick: true, /** * @cfg {Boolean} selectRowOnExpand * true to select a row when clicking on the expander icon * (defaults to false). */ selectRowOnExpand: false, rowBodyTrSelector: '.x-grid-rowbody-tr', rowBodyHiddenCls: 'x-grid-row-body-hidden', rowCollapsedCls: 'x-grid-row-collapsed', addCollapsedCls: { before: function(values, out) { var me = this.rowExpander; if (!me.recordsExpanded[values.record.internalId]) { values.itemClasses.push(me.rowCollapsedCls); } }, priority: 500 }, /** * @event expandbody * **Fired through the grid's View** * @param {HTMLElement} rowNode The <tr> element which owns the expanded row. * @param {Ext.data.Model} record The record providing the data. * @param {HTMLElement} expandRow The <tr> element containing the expanded data. */ /** * @event collapsebody * **Fired through the grid's View.** * @param {HTMLElement} rowNode The <tr> element which owns the expanded row. * @param {Ext.data.Model} record The record providing the data. * @param {HTMLElement} expandRow The <tr> element containing the expanded data. */ setCmp: function(grid) { var me = this, rowBodyTpl, features; me.callParent(arguments); me.recordsExpanded = {}; if (!me.rowBodyTpl) { Ext.Error.raise("The 'rowBodyTpl' config is required and is not defined."); } me.rowBodyTpl = Ext.XTemplate.getTpl(me, 'rowBodyTpl'); rowBodyTpl = this.rowBodyTpl; features = [{ ftype: 'rowbody', lockableScope: 'normal', recordsExpanded: me.recordsExpanded, rowBodyHiddenCls: me.rowBodyHiddenCls, rowCollapsedCls: me.rowCollapsedCls, setupRowData: me.getRowBodyFeatureData, setup: me.setup, getRowBodyContents: function(record) { return rowBodyTpl.applyTemplate(record.getData()); } },{ ftype: 'rowwrap', lockableScope: 'normal' }]; if (grid.features) { grid.features = Ext.Array.push(features, grid.features); } else { grid.features = features; } // NOTE: features have to be added before init (before Table.initComponent) }, init: function(grid) { var me = this, reconfigurable = grid, view, lockedView; me.callParent(arguments); me.grid = grid; view = me.view = grid.getView(); // Columns have to be added in init (after columns has been used to create the headerCt). // Otherwise, shared column configs get corrupted, e.g., if put in the prototype. me.addExpander(); // Bind to view for key and mouse events // Add row processor which adds collapsed class me.bindView(view); view.addRowTpl(me.addCollapsedCls).rowExpander = me; // If the owning grid is lockable, then disable row height syncing - we do it here. // Also ensure the collapsed class is applied to the locked side by adding a row processor. if (grid.ownerLockable) { // If our client grid is the normal side of a lockable grid, we listen to its lockable owner's beforereconfigure reconfigurable = grid.ownerLockable; reconfigurable.syncRowHeight = false; lockedView = reconfigurable.lockedGrid.getView(); // Bind to locked view for key and mouse events // Add row processor which adds collapsed class me.bindView(lockedView); lockedView.addRowTpl(me.addCollapsedCls).rowExpander = me; // Refresh row heights of expended rows on the locked (non body containing) side upon lock & unlock. // The locked side's expanded rows will collapse back because there's no body there reconfigurable.mon(reconfigurable, 'columnschanged', me.refreshRowHeights, me); reconfigurable.mon(reconfigurable.store, 'datachanged', me.refreshRowHeights, me); } reconfigurable.on('beforereconfigure', me.beforeReconfigure, me); if (grid.ownerLockable && !grid.rowLines) { // grids without row lines can gain a border when focused. When they do, the // stylesheet adjusts the padding of the cells so that the height of the row // does not change. It is necessary to refresh the row heights for lockable // grids on focus to keep the height of the expander cells in sync. view.on('rowfocus', me.refreshRowHeights, me); } }, beforeReconfigure: function(grid, store, columns, oldStore, oldColumns) { var expander = this.getHeaderConfig(); expander.locked = true; columns.unshift(expander); }, /** * @private * Inject the expander column into the correct grid. * * If we are expanding the normal side of a lockable grid, poke the column into the locked side */ addExpander: function() { var me = this, expanderGrid = me.grid, expanderHeader = me.getHeaderConfig(); // If this is the normal side of a lockable grid, find the other side. if (expanderGrid.ownerLockable) { expanderGrid = expanderGrid.ownerLockable.lockedGrid; expanderGrid.width += expanderHeader.width; } expanderGrid.headerCt.insert(0, expanderHeader); }, getRowBodyFeatureData: function(record, idx, rowValues) { var me = this me.self.prototype.setupRowData.apply(me, arguments); rowValues.rowBody = me.getRowBodyContents(record); rowValues.rowBodyCls = me.recordsExpanded[record.internalId] ? '' : me.rowBodyHiddenCls; }, setup: function(rows, rowValues){ var me = this; me.self.prototype.setup.apply(me, arguments); // If we are lockable, the expander column is moved into the locked side, so we don't have to span it if (!me.grid.ownerLockable) { rowValues.rowBodyColspan -= 1; } }, bindView: function(view) { if (this.expandOnEnter) { view.on('itemkeydown', this.onKeyDown, this); } if (this.expandOnDblClick) { view.on('itemdblclick', this.onDblClick, this); } }, onKeyDown: function(view, record, row, rowIdx, e) { if (e.getKey() == e.ENTER) { var ds = view.store, sels = view.getSelectionModel().getSelection(), ln = sels.length, i = 0; for (; i < ln; i++) { rowIdx = ds.indexOf(sels[i]); this.toggleRow(rowIdx, sels[i]); } } }, onDblClick: function(view, record, row, rowIdx, e) { this.toggleRow(rowIdx, record); }, toggleRow: function(rowIdx, record) { var me = this, view = me.view, rowNode = view.getNode(rowIdx), row = Ext.fly(rowNode, '_rowExpander'), nextBd = row.down(me.rowBodyTrSelector, true), isCollapsed = row.hasCls(me.rowCollapsedCls), addOrRemoveCls = isCollapsed ? 'removeCls' : 'addCls', ownerLock, rowHeight, fireView; // Suspend layouts because of possible TWO views having their height change Ext.suspendLayouts(); row[addOrRemoveCls](me.rowCollapsedCls); Ext.fly(nextBd)[addOrRemoveCls](me.rowBodyHiddenCls); me.recordsExpanded[record.internalId] = isCollapsed; view.refreshSize(); // Sync the height and class of the row on the locked side if (me.grid.ownerLockable) { ownerLock = me.grid.ownerLockable; fireView = ownerLock.getView(); view = ownerLock.lockedGrid.view; rowHeight = row.getHeight(); row = Ext.fly(view.getNode(rowIdx), '_rowExpander'); row.setHeight(rowHeight); row[addOrRemoveCls](me.rowCollapsedCls); view.refreshSize(); } else { fireView = view; } fireView.fireEvent(isCollapsed ? 'expandbody' : 'collapsebody', row.dom, record, nextBd); // Coalesce laying out due to view size changes Ext.resumeLayouts(true); }, // refreshRowHeights often gets called in the middle of some complex processing. // For example, it's called on the store's datachanged event, but it must execute // *after* other objects interested in datachanged have done their job. // Or it's called on column lock/unlock, but that could be just the start of a cross-container // drag/drop of column headers which then moves the column into its final place. // So this throws execution forwards until the idle event. refreshRowHeights: function() { Ext.globalEvents.on({ idle: this.doRefreshRowHeights, scope: this, single: true }); }, doRefreshRowHeights: function() { var me = this, recordsExpanded = me.recordsExpanded, key, record, lockedView = me.grid.ownerLockable.lockedGrid.view, normalView = me.grid.ownerLockable.normalGrid.view, normalRow, lockedRow, lockedHeight, normalHeight; for (key in recordsExpanded) { if (recordsExpanded.hasOwnProperty(key)) { record = this.view.store.data.get(key); lockedRow = lockedView.getNode(record, false); normalRow = normalView.getNode(record, false); lockedRow.style.height = normalRow.style.height = ''; lockedHeight = lockedRow.offsetHeight; normalHeight = normalRow.offsetHeight; if (normalHeight > lockedHeight) { lockedRow.style.height = normalHeight + 'px'; } else if (lockedHeight > normalHeight) { normalRow.style.height = lockedHeight + 'px'; } } } }, getHeaderConfig: function() { var me = this; return { width: 24, lockable: false, sortable: false, resizable: false, draggable: false, hideable: false, menuDisabled: true, tdCls: Ext.baseCSSPrefix + 'grid-cell-special', innerCls: Ext.baseCSSPrefix + 'grid-cell-inner-row-expander', renderer: function(value, metadata) { // Only has to span 2 rows if it is not in a lockable grid. if (!me.grid.ownerLockable) { metadata.tdAttr += ' rowspan="2"'; } return '
    '; }, processEvent: function(type, view, cell, rowIndex, cellIndex, e, record) { if (type == "mousedown" && e.getTarget('.x-grid-row-expander')) { me.toggleRow(rowIndex, record); return me.selectRowOnExpand; } } }; } }); /** * A specialized grid implementation intended to mimic the traditional property grid as typically seen in * development IDEs. Each row in the grid represents a property of some object, and the data is stored * as a set of name/value pairs in {@link Ext.grid.property.Property Properties}. By default, the editors * shown are inferred from the data in the cell. More control over this can be specified by using the * {@link #sourceConfig} option. Example usage: * * @example * Ext.create('Ext.grid.property.Grid', { * title: 'Properties Grid', * width: 300, * renderTo: Ext.getBody(), * source: { * "(name)": "My Object", * "Created": Ext.Date.parse('10/15/2006', 'm/d/Y'), * "Available": false, * "Version": 0.01, * "Description": "A test object" * } * }); */ Ext.define('Ext.grid.property.Grid', { extend: Ext.grid.Panel , alias: 'widget.propertygrid', alternateClassName: 'Ext.grid.PropertyGrid', /** * @cfg {Object} sourceConfig * This option allows various configurations to be set for each field in the property grid. * None of these configurations are required * * ####displayName * A custom name to appear as label for this field. If specified, the display name will be shown * in the name column instead of the property name. Example usage: * * new Ext.grid.property.Grid({ * source: { * clientIsAvailable: true * }, * sourceConfig: { * clientIsAvailable: { * // Custom name different to the field * displayName: 'Available' * } * } * }); * * ####renderer * A function used to transform the underlying value before it is displayed in the grid. * By default, the grid supports strongly-typed rendering of strings, dates, numbers and booleans using built-in form editors, * but any custom type can be supported and associated with the type of the value. Example usage: * * new Ext.grid.property.Grid({ * source: { * clientIsAvailable: true * }, * sourceConfig: { * clientIsAvailable: { * // Custom renderer to change the color based on the value * renderer: function(v){ * var color = v ? 'green' : 'red'; * return '' + v + ''; * } * } * } * }); * * ####type * Used to explicitly specify the editor type for a particular value. By default, the type is * automatically inferred from the value. See {@link #inferTypes}. Accepted values are: * * - 'date' * - 'boolean' * - 'number' * - 'string' * * For more advanced control an editor configuration can be passed (see the next section). * Example usage: * * new Ext.grid.property.Grid({ * source: { * attending: null * }, * sourceConfig: { * attending: { * // Force the type to be a numberfield, a null value would otherwise default to a textfield * type: 'number' * } * } * }); * * ####editor * Allows the grid to support additional types of editable fields. By default, the grid supports strongly-typed editing * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and * associated with a custom input control by specifying a custom editor. Example usage * * new Ext.grid.property.Grid({ * // Data object containing properties to edit * source: { * evtStart: '10:00 AM' * }, * * sourceConfig: { * evtStart: { * editor: Ext.create('Ext.form.field.Time', {selectOnFocus: true}), * displayName: 'Start Time' * } * } * }); */ /** * @cfg {Object} propertyNames * An object containing custom property name/display name pairs. * If specified, the display name will be shown in the name column instead of the property name. * @deprecated See {@link #sourceConfig} displayName */ /** * @cfg {Object} source * A data object to use as the data source of the grid (see {@link #setSource} for details). */ /** * @cfg {Object} customEditors * An object containing name/value pairs of custom editor type definitions that allow * the grid to support additional types of editable fields. By default, the grid supports strongly-typed editing * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and * associated with a custom input control by specifying a custom editor. The name of the editor * type should correspond with the name of the property that will use the editor. Example usage: * * var grid = new Ext.grid.property.Grid({ * * // Custom editors for certain property names * customEditors: { * evtStart: Ext.create('Ext.form.TimeField', {selectOnFocus: true}) * }, * * // Displayed name for property names in the source * propertyNames: { * evtStart: 'Start Time' * }, * * // Data object containing properties to edit * source: { * evtStart: '10:00 AM' * } * }); * @deprecated See {@link #sourceConfig} editor */ /** * @cfg {Object} customRenderers * An object containing name/value pairs of custom renderer type definitions that allow * the grid to support custom rendering of fields. By default, the grid supports strongly-typed rendering * of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and * associated with the type of the value. The name of the renderer type should correspond with the name of the property * that it will render. Example usage: * * var grid = Ext.create('Ext.grid.property.Grid', { * customRenderers: { * Available: function(v){ * if (v) { * return 'Yes'; * } else { * return 'No'; * } * } * }, * source: { * Available: true * } * }); * @deprecated See {@link #sourceConfig} renderer */ /** * @cfg {String} valueField * The name of the field from the property store to use as the value field name. * This may be useful if you do not configure the property Grid from an object, but use your own store configuration. */ valueField: 'value', /** * @cfg {String} nameField * The name of the field from the property store to use as the property field name. * This may be useful if you do not configure the property Grid from an object, but use your own store configuration. */ nameField: 'name', /** * @cfg {Boolean} inferTypes * True to automatically infer the {@link #sourceConfig type} based on the initial value passed * for each field. This ensures the editor remains the correct type even if the value is blanked * and becomes empty. */ inferTypes: true, /** * @cfg {Number/String} [nameColumnWidth=115] * Specify the width for the name column. The value column will take any remaining space. */ // private config overrides enableColumnMove: false, columnLines: true, stripeRows: false, trackMouseOver: false, clicksToEdit: 1, enableHdMenu: false, gridCls: Ext.baseCSSPrefix + 'property-grid', // private initComponent : function(){ var me = this; me.source = me.source || {}; me.addCls(me.gridCls); me.plugins = me.plugins || []; // Enable cell editing. Inject a custom startEdit which always edits column 1 regardless of which column was clicked. me.plugins.push(new Ext.grid.plugin.CellEditing({ clicksToEdit: me.clicksToEdit, // Inject a startEdit which always edits the value column startEdit: function(record, column) { // Maintainer: Do not change this 'this' to 'me'! It is the CellEditing object's own scope. return this.self.prototype.startEdit.call(this, record, me.headerCt.child('#' + me.valueField)); } })); me.selModel = { selType: 'cellmodel', onCellSelect: function(position) { if (position.column != 1) { position.column = 1; } return this.self.prototype.onCellSelect.call(this, position); } }; me.sourceConfig = Ext.apply({}, me.sourceConfig); // Create a property.Store from the source object unless configured with a store if (!me.store) { me.propStore = me.store = new Ext.grid.property.Store(me, me.source); } me.configure(me.sourceConfig); if (me.sortableColumns) { me.store.sort('name', 'ASC'); } me.columns = new Ext.grid.property.HeaderContainer(me, me.store); me.addEvents( /** * @event beforepropertychange * Fires before a property value changes. Handlers can return false to cancel the property change * (this will internally call {@link Ext.data.Model#reject} on the property's record). * @param {Object} source The source data object for the grid (corresponds to the same object passed in * as the {@link #source} config property). * @param {String} recordId The record's id in the data store * @param {Object} value The current edited property value * @param {Object} oldValue The original property value prior to editing */ 'beforepropertychange', /** * @event propertychange * Fires after a property value has changed. * @param {Object} source The source data object for the grid (corresponds to the same object passed in * as the {@link #source} config property). * @param {String} recordId The record's id in the data store * @param {Object} value The current edited property value * @param {Object} oldValue The original property value prior to editing */ 'propertychange' ); me.callParent(); // Inject a custom implementation of walkCells which only goes up or down me.getView().walkCells = this.walkCells; // Set up our default editor set for the 4 atomic data types me.editors = { 'date' : new Ext.grid.CellEditor({ field: new Ext.form.field.Date({selectOnFocus: true})}), 'string' : new Ext.grid.CellEditor({ field: new Ext.form.field.Text({selectOnFocus: true})}), 'number' : new Ext.grid.CellEditor({ field: new Ext.form.field.Number({selectOnFocus: true})}), 'boolean' : new Ext.grid.CellEditor({ field: new Ext.form.field.ComboBox({ editable: false, store: [[ true, me.headerCt.trueText ], [false, me.headerCt.falseText ]] })}) }; // Track changes to the data so we can fire our events. me.store.on('update', me.onUpdate, me); }, configure: function(config){ var me = this, store = me.store, i = 0, len = me.store.getCount(), nameField = me.nameField, valueField = me.valueField, name, value, rec, type; me.configureLegacy(config); if (me.inferTypes) { for (; i < len; ++i) { rec = store.getAt(i); name = rec.get(nameField); if (!me.getConfig(name, 'type')) { value = rec.get(valueField); if (Ext.isDate(value)) { type = 'date'; } else if (Ext.isNumber(value)) { type = 'number'; } else if (Ext.isBoolean(value)) { type = 'boolean'; } else { type = 'string'; } me.setConfig(name, 'type', type); } } } }, getConfig: function(fieldName, key, defaultValue) { var config = this.sourceConfig[fieldName], out; if (config) { out = config[key]; } return out || defaultValue; }, setConfig: function(fieldName, key, value) { var sourceCfg = this.sourceConfig, o = sourceCfg[fieldName]; if (!o) { o = sourceCfg[fieldName] = { __copied: true }; } else if (!o.__copied) { o = Ext.apply({ __copied: true }, o); sourceCfg[fieldName] = o; } o[key] = value; return value; }, // to be deprecated in 4.2 configureLegacy: function(config){ var me = this, o, key, value; me.copyLegacyObject(config, me.customRenderers, 'renderer'); me.copyLegacyObject(config, me.customEditors, 'editor'); me.copyLegacyObject(config, me.propertyNames, 'displayName'); // exclude types since it's new if (me.customRenderers || me.customEditors || me.propertyNames) { if (Ext.global.console && Ext.global.console.warn) { Ext.global.console.warn(this.$className, 'customRenderers, customEditors & propertyNames have been consolidated into a new config, see "sourceConfig". These configurations will be deprecated.'); } } }, copyLegacyObject: function(config, o, keyName){ var key, value; for (key in o) { if (o.hasOwnProperty(key)) { if (!config[key]) { config[key] = {}; } config[key][keyName] = o[key]; } } }, // @private onUpdate : function(store, record, operation) { var me = this, v, oldValue; if (me.rendered && operation == Ext.data.Model.EDIT) { v = record.get(me.valueField); oldValue = record.modified.value; if (me.fireEvent('beforepropertychange', me.source, record.getId(), v, oldValue) !== false) { if (me.source) { me.source[record.getId()] = v; } record.commit(); me.fireEvent('propertychange', me.source, record.getId(), v, oldValue); } else { record.reject(); } } }, // Custom implementation of walkCells which only goes up and down. walkCells: function(pos, direction, e, preventWrap, verifierFn, scope) { if (direction == 'left') { direction = 'up'; } else if (direction == 'right') { direction = 'down'; } pos = Ext.view.Table.prototype.walkCells.call(this, pos, direction, e, preventWrap, verifierFn, scope); if (pos && !pos.column) { pos.column = 1; } return pos; }, // @private // Returns the correct editor type for the property type, or a custom one keyed by the property name getCellEditor : function(record, column) { var me = this, propName = record.get(me.nameField), val = record.get(me.valueField), editor = me.getConfig(propName, 'editor'), type = me.getConfig(propName, 'type'), editors = me.editors; // A custom editor was found. If not already wrapped with a CellEditor, wrap it, and stash it back // If it's not even a Field, just a config object, instantiate it before wrapping it. if (editor) { if (!(editor instanceof Ext.grid.CellEditor)) { if (!(editor instanceof Ext.form.field.Base)) { editor = Ext.ComponentManager.create(editor, 'textfield'); } editor = me.setConfig(propName, 'editor', new Ext.grid.CellEditor({ field: editor })); } } else if (type) { switch (type) { case 'date': editor = editors.date; break; case 'number': editor = editors.number; break; case 'boolean': editor = me.editors['boolean']; break; default: editor = editors.string; } } else if (Ext.isDate(val)) { editor = editors.date; } else if (Ext.isNumber(val)) { editor = editors.number; } else if (Ext.isBoolean(val)) { editor = editors['boolean']; } else { editor = editors.string; } // Give the editor a unique ID because the CellEditing plugin caches them editor.editorId = propName; return editor; }, beforeDestroy: function() { var me = this; me.callParent(); me.destroyEditors(me.editors); me.destroyEditors(me.customEditors); delete me.source; }, destroyEditors: function (editors) { for (var ed in editors) { if (editors.hasOwnProperty(ed)) { Ext.destroy(editors[ed]); } } }, /** * Sets the source data object containing the property data. The data object can contain one or more name/value * pairs representing all of the properties of an object to display in the grid, and this data will automatically * be loaded into the grid's {@link #store}. The values should be supplied in the proper data type if needed, * otherwise string type will be assumed. If the grid already contains data, this method will replace any * existing data. See also the {@link #source} config value. Example usage: * * grid.setSource({ * "(name)": "My Object", * "Created": Ext.Date.parse('10/15/2006', 'm/d/Y'), // date type * "Available": false, // boolean type * "Version": .01, // decimal type * "Description": "A test object" * }); * * @param {Object} source The data object. * @param {Object} [sourceConfig] A new {@link #sourceConfig object}. If this argument is not passed * the current configuration will be re-used. To reset the config, pass `null` or an empty object literal. */ setSource: function(source, sourceConfig) { var me = this; me.source = source; if (sourceConfig !== undefined) { me.sourceConfig = Ext.apply({}, sourceConfig); me.configure(me.sourceConfig); } me.propStore.setSource(source); }, /** * Gets the source data object containing the property data. See {@link #setSource} for details regarding the * format of the data object. * @return {Object} The data object. */ getSource: function() { return this.propStore.getSource(); }, /** * Sets the value of a property. * @param {String} prop The name of the property to set. * @param {Object} value The value to test. * @param {Boolean} [create=false] `true` to create the property if it doesn't already exist. */ setProperty: function(prop, value, create) { this.propStore.setValue(prop, value, create); }, /** * Removes a property from the grid. * @param {String} prop The name of the property to remove. */ removeProperty: function(prop) { this.propStore.remove(prop); } /** * @cfg {Object} store * @private */ /** * @cfg {Object} columns * @private */ }); /** * A custom HeaderContainer for the {@link Ext.grid.property.Grid}. * Generally it should not need to be used directly. */ Ext.define('Ext.grid.property.HeaderContainer', { extend: Ext.grid.header.Container , alternateClassName: 'Ext.grid.PropertyColumnModel', nameWidth: 115, // @private strings used for locale support // nameText : 'Name', // // valueText : 'Value', // // dateFormat : 'm/j/Y', // // trueText: 'true', // // falseText: 'false', // // @private nameColumnCls: Ext.baseCSSPrefix + 'grid-property-name', nameColumnInnerCls: Ext.baseCSSPrefix + 'grid-cell-inner-property-name', /** * Creates new HeaderContainer. * @param {Ext.grid.property.Grid} grid The grid this store will be bound to * @param {Object} source The source data config object */ constructor : function(grid, store) { var me = this; me.grid = grid; me.store = store; me.callParent([{ isRootHeader: true, enableColumnResize: Ext.isDefined(grid.enableColumnResize) ? grid.enableColumnResize : me.enableColumnResize, enableColumnMove: Ext.isDefined(grid.enableColumnMove) ? grid.enableColumnMove : me.enableColumnMove, items: [{ header: me.nameText, width: grid.nameColumnWidth || me.nameWidth, sortable: grid.sortableColumns, dataIndex: grid.nameField, renderer: Ext.Function.bind(me.renderProp, me), itemId: grid.nameField, menuDisabled :true, tdCls: me.nameColumnCls, innerCls: me.nameColumnInnerCls }, { header: me.valueText, renderer: Ext.Function.bind(me.renderCell, me), getEditor: Ext.Function.bind(me.getCellEditor, me), sortable: grid.sortableColumns, flex: 1, fixed: true, dataIndex: grid.valueField, itemId: grid.valueField, menuDisabled: true }] }]); }, getCellEditor: function(record){ return this.grid.getCellEditor(record, this); }, // @private // Render a property name cell renderProp : function(v) { return this.getPropertyName(v); }, // @private // Render a property value cell renderCell : function(val, meta, rec) { var me = this, grid = me.grid, renderer = grid.getConfig(rec.get(grid.nameField), 'renderer'), result = val; if (renderer) { return renderer.apply(me, arguments); } if (Ext.isDate(val)) { result = me.renderDate(val); } else if (Ext.isBoolean(val)) { result = me.renderBool(val); } return Ext.util.Format.htmlEncode(result); }, // @private renderDate : Ext.util.Format.date, // @private renderBool : function(bVal) { return this[bVal ? 'trueText' : 'falseText']; }, // @private // Renders custom property names instead of raw names if defined in the Grid getPropertyName : function(name) { return this.grid.getConfig(name, 'displayName', name); } }); /** * A specific {@link Ext.data.Model} type that represents a name/value pair and is made to work with the * {@link Ext.grid.property.Grid}. Typically, Properties do not need to be created directly as they can be * created implicitly by simply using the appropriate data configs either via the * {@link Ext.grid.property.Grid#source} config property or by calling {@link Ext.grid.property.Grid#setSource}. * However, if the need arises, these records can also be created explicitly as shown below. Example usage: * * var rec = new Ext.grid.property.Property({ * name: 'birthday', * value: Ext.Date.parse('17/06/1962', 'd/m/Y') * }); * // Add record to an already populated grid * grid.store.addSorted(rec); * * @constructor * Creates new property. * @param {Object} config A data object in the format: * @param {String/String[]} config.name A name or names for the property. * @param {Mixed/Mixed[]} config.value A value or values for the property. * The specified value's type will be read automatically by the grid to determine the type of editor to use when * displaying it. * @return {Object} */ Ext.define('Ext.grid.property.Property', { extend: Ext.data.Model , alternateClassName: 'Ext.PropGridProperty', fields: [{ name: 'name', type: 'string' }, { name: 'value' }], idProperty: 'name' }); /** * A custom {@link Ext.data.Store} for the {@link Ext.grid.property.Grid}. This class handles the mapping * between the custom data source objects supported by the grid and the {@link Ext.grid.property.Property} format * used by the {@link Ext.data.Store} base class. */ Ext.define('Ext.grid.property.Store', { extend: Ext.data.Store , alternateClassName: 'Ext.grid.PropertyStore', sortOnLoad: false, /** * Creates new property store. * @param {Ext.grid.Panel} grid The grid this store will be bound to * @param {Object} source The source data config object */ constructor : function(grid, source){ var me = this; me.grid = grid; me.source = source; me.callParent([{ data: source, model: Ext.grid.property.Property, proxy: me.getProxy() }]); }, // Return a singleton, customized Proxy object which configures itself with a custom Reader getProxy: function() { if (!this.proxy) { Ext.grid.property.Store.prototype.proxy = new Ext.data.proxy.Memory({ model: Ext.grid.property.Property, reader: this.getReader() }); } return this.proxy; }, // Return a singleton, customized Reader object which reads Ext.grid.property.Property records from an object. getReader: function() { if (!this.reader) { Ext.grid.property.Store.prototype.reader = new Ext.data.reader.Reader({ model: Ext.grid.property.Property, buildExtractors: Ext.emptyFn, read: function(dataObject) { return this.readRecords(dataObject); }, readRecords: function(dataObject) { var val, propName, result = { records: [], success: true }; for (propName in dataObject) { if (dataObject.hasOwnProperty(propName)) { val = dataObject[propName]; if (this.isEditableValue(val)) { result.records.push(new Ext.grid.property.Property({ name: propName, value: val }, propName)); } } } result.total = result.count = result.records.length; return new Ext.data.ResultSet(result); }, // @private isEditableValue: function(val){ return Ext.isPrimitive(val) || Ext.isDate(val) || val === null; } }); } return this.reader; }, // @protected // Should only be called by the grid. Use grid.setSource instead. setSource : function(dataObject) { var me = this; me.source = dataObject; me.suspendEvents(); me.removeAll(); me.proxy.data = dataObject; me.load(); me.resumeEvents(); me.fireEvent('datachanged', me); me.fireEvent('refresh', me); }, // @private getProperty : function(row) { return Ext.isNumber(row) ? this.getAt(row) : this.getById(row); }, // @private setValue : function(prop, value, create){ var me = this, rec = me.getRec(prop); if (rec) { rec.set('value', value); me.source[prop] = value; } else if (create) { // only create if specified. me.source[prop] = value; rec = new Ext.grid.property.Property({name: prop, value: value}, prop); me.add(rec); } }, // @private remove : function(prop) { var rec = this.getRec(prop); if (rec) { this.callParent([rec]); delete this.source[prop]; } }, // @private getRec : function(prop) { return this.getById(prop); }, // @protected // Should only be called by the grid. Use grid.getSource instead. getSource : function() { return this.source; } }); /** * This class provides a DOM ClassList API to buffer access to an element's class. * Instances of this class are created by {@link Ext.layout.ContextItem#getClassList}. */ Ext.define('Ext.layout.ClassList', (function () { var splitWords = Ext.String.splitWords, toMap = Ext.Array.toMap; return { dirty: false, constructor: function (owner) { this.owner = owner; this.map = toMap(this.classes = splitWords(owner.el.className)); }, /** * Adds a single class to the class list. */ add: function (cls) { var me = this; if (!me.map[cls]) { me.map[cls] = true; me.classes.push(cls); if (!me.dirty) { me.dirty = true; me.owner.markDirty(); } } }, /** * Adds one or more classes in an array or space-delimited string to the class list. */ addMany: function (classes) { Ext.each(splitWords(classes), this.add, this); }, contains: function (cls) { return this.map[cls]; }, flush: function () { this.owner.el.className = this.classes.join(' '); this.dirty = false; }, /** * Removes a single class from the class list. */ remove: function (cls) { var me = this; if (me.map[cls]) { delete me.map[cls]; me.classes = Ext.Array.filter(me.classes, function (c) { return c != cls; }); if (!me.dirty) { me.dirty = true; me.owner.markDirty(); } } }, /** * Removes one or more classes in an array or space-delimited string from the class * list. */ removeMany: function (classes) { var me = this, remove = toMap(splitWords(classes)); me.classes = Ext.Array.filter(me.classes, function (c) { if (!remove[c]) { return true; } delete me.map[c]; if (!me.dirty) { me.dirty = true; me.owner.markDirty(); } return false; }); } }; }())); /** * An internal Queue class. * @private */ Ext.define('Ext.util.Queue', { constructor: function() { this.clear(); }, add : function(obj) { var me = this, key = me.getKey(obj); if (!me.map[key]) { ++me.length; me.items.push(obj); me.map[key] = obj; } return obj; }, /** * Removes all items from the collection. */ clear : function(){ var me = this, items = me.items; me.items = []; me.map = {}; me.length = 0; return items; }, contains: function (obj) { var key = this.getKey(obj); return this.map.hasOwnProperty(key); }, /** * Returns the number of items in the collection. * @return {Number} the number of items in the collection. */ getCount : function(){ return this.length; }, getKey : function(obj){ return obj.id; }, /** * Remove an item from the collection. * @param {Object} obj The item to remove. * @return {Object} The item removed or false if no item was removed. */ remove : function(obj){ var me = this, key = me.getKey(obj), items = me.items, index; if (me.map[key]) { index = Ext.Array.indexOf(items, obj); Ext.Array.erase(items, index, 1); delete me.map[key]; --me.length; } return obj; } }); /** * This class manages state information for a component or element during a layout. * * # Blocks * * A "block" is a required value that is preventing further calculation. When a layout has * encountered a situation where it cannot possibly calculate results, it can associate * itself with the context item and missing property so that it will not be rescheduled * until that property is set. * * Blocks are a one-shot registration. Once the property changes, the block is removed. * * Be careful with blocks. If *any* further calculations can be made, a block is not the * right choice. * * # Triggers * * Whenever any call to {@link #getProp}, {@link #getDomProp}, {@link #hasProp} or * {@link #hasDomProp} is made, the current layout is automatically registered as being * dependent on that property in the appropriate state. Any changes to the property will * trigger the layout and it will be queued in the {@link Ext.layout.Context}. * * Triggers, once added, remain for the entire layout. Any changes to the property will * reschedule all unfinished layouts in their trigger set. * * @private */ Ext.define('Ext.layout.ContextItem', { heightModel: null, widthModel: null, sizeModel: null, /** * There are several cases that allow us to skip (opt out) of laying out a component * and its children as long as its `lastBox` is not marked as `invalid`. If anything * happens to change things, the `lastBox` is marked as `invalid` by `updateLayout` * as it ascends the component hierarchy. * * @property {Boolean} optOut * @private * @readonly */ optOut: false, ownerSizePolicy: null, // plaed here by AbstractComponent.getSizeModel boxChildren: null, boxParent: null, isBorderBoxValue: null, children: [], dirty: null, // The number of dirty properties dirtyCount: 0, hasRawContent: true, isContextItem: true, isTopLevel: false, consumersContentHeight: 0, consumersContentWidth: 0, consumersContainerHeight: 0, consumersContainerWidth: 0, consumersHeight: 0, consumersWidth: 0, ownerCtContext: null, remainingChildDimensions: 0, // the current set of property values: props: null, /** * @property {Object} state * State variables that are cleared when invalidated. Only applies to component items. */ state: null, /** * @property {Boolean} wrapsComponent * True if this item wraps a Component (rather than an Element). * @readonly */ wrapsComponent: false, constructor: function (config) { var me = this, sizeModels = Ext.layout.SizeModel.sizeModels, configured = sizeModels.configured, shrinkWrap = sizeModels.shrinkWrap, el, lastBox, ownerCt, ownerCtContext, props, sizeModel, target, lastWidth, lastHeight, sameWidth, sameHeight, widthModel, heightModel, optOut; Ext.apply(me, config); el = me.el; me.id = el.id; // These hold collections of layouts that are either blocked or triggered by sets // to our properties (either ASAP or after flushing to the DOM). All of them have // the same structure: // // me.blocks = { // width: { // 'layout-1001': layout1001 // } // } // // The property name is the primary key which yields an object keyed by layout id // with the layout instance as the value. This prevents duplicate entries for one // layout and gives O(1) access to the layout instance when we need to iterate and // process them. // // me.blocks = {}; // me.domBlocks = {}; // me.domTriggers = {}; // me.triggers = {}; me.flushedProps = {}; me.props = props = {}; // the set of cached styles for the element: me.styles = {}; target = me.target; if (!target.isComponent) { lastBox = el.lastBox; } else { me.wrapsComponent = true; me.framing = target.frameSize || null; me.isComponentChild = target.ownerLayout && target.ownerLayout.isComponentLayout; lastBox = target.lastBox; // These items are created top-down, so the ContextItem of our ownerCt should // be available (if it is part of this layout run). ownerCt = target.ownerCt; if (ownerCt && (ownerCtContext = ownerCt.el && me.context.items[ownerCt.el.id])) { me.ownerCtContext = ownerCtContext; } // If our ownerCtContext is in the run, it will have a SizeModel that we use to // optimize the determination of our sizeModel. me.sizeModel = sizeModel = target.getSizeModel(ownerCtContext && ownerCtContext.widthModel.pairsByHeightOrdinal[ownerCtContext.heightModel.ordinal]); // NOTE: The initial determination of sizeModel is valid (thankfully) and is // needed to cope with adding components to a layout run on-the-fly (e.g., in // the menu overflow handler of a box layout). Since this is the case, we do // not need to recompute the sizeModel in init unless it is a "full" init (as // our ownerCt's sizeModel could have changed in that case). me.widthModel = widthModel = sizeModel.width; me.heightModel = heightModel = sizeModel.height; // The lastBox is populated early but does not get an "invalid" property // until layout has occurred. The "false" value is placed in the lastBox // by Component.finishedLayout. if (lastBox && lastBox.invalid === false) { sameWidth = (target.width === (lastWidth = lastBox.width)); sameHeight = (target.height === (lastHeight = lastBox.height)); if (widthModel === shrinkWrap && heightModel === shrinkWrap) { optOut = true; } else if (widthModel === configured && sameWidth) { optOut = heightModel === shrinkWrap || (heightModel === configured && sameHeight); } if (optOut) { // Flag this component and capture its last size... me.optOut = true; props.width = lastWidth; props.height = lastHeight; } } } me.lastBox = lastBox; }, /** * Clears all properties on this object except (perhaps) those not calculated by this * component. This is more complex than it would seem because a layout can decide to * invalidate its results and run the component's layouts again, but since some of the * values may be calculated by the container, care must be taken to preserve those * values. * * @param {Boolean} full True if all properties are to be invalidated, false to keep * those calculated by the ownerCt. * @return {Mixed} A value to pass as the first argument to {@link #initContinue}. * @private */ init: function (full, options) { var me = this, oldProps = me.props, oldDirty = me.dirty, ownerCtContext = me.ownerCtContext, ownerLayout = me.target.ownerLayout, firstTime = !me.state, ret = full || firstTime, children, i, n, ownerCt, sizeModel, target, oldHeightModel = me.heightModel, oldWidthModel = me.widthModel, newHeightModel, newWidthModel, remainingCount = 0; me.dirty = me.invalid = false; me.props = {}; // Reset the number of child dimensions since the children will add their part: me.remainingChildDimensions = 0; if (me.boxChildren) { me.boxChildren.length = 0; // keep array (more GC friendly) } if (!firstTime) { me.clearAllBlocks('blocks'); me.clearAllBlocks('domBlocks'); } // For Element wrappers, we are done... if (!me.wrapsComponent) { return ret; } // From here on, we are only concerned with Component wrappers... target = me.target; me.state = {}; // only Component wrappers need a "state" if (firstTime) { // This must occur before we proceed since it can do many things (like add // child items perhaps): if (target.beforeLayout && target.beforeLayout !== Ext.emptyFn) { target.beforeLayout(); } // Determine the ownerCtContext if we aren't given one. Normally the firstTime // we meet a component is before the context is run, but it is possible for // components to be added to a run that is already in progress. If so, we have // to lookup the ownerCtContext since the odds are very high that the new // component is a child of something already in the run. It is currently // unsupported to drag in the owner of a running component (needs testing). if (!ownerCtContext && (ownerCt = target.ownerCt)) { ownerCtContext = me.context.items[ownerCt.el.id]; } if (ownerCtContext) { me.ownerCtContext = ownerCtContext; me.isBoxParent = target.ownerLayout.isItemBoxParent(me); } else { me.isTopLevel = true; // this is used by initAnimation... } me.frameBodyContext = me.getEl('frameBody'); } else { ownerCtContext = me.ownerCtContext; // In theory (though untested), this flag can change on-the-fly... me.isTopLevel = !ownerCtContext; // Init the children element items since they may have dirty state (no need to // do this the firstTime). children = me.children; for (i = 0, n = children.length; i < n; ++i) { children[i].init(true); } } // We need to know how we will determine content size: containers can look at the // results of their items but non-containers or item-less containers with just raw // markup need to be measured in the DOM: me.hasRawContent = !(target.isContainer && target.items.items.length > 0); if (full) { // We must null these out or getSizeModel will assume they are the correct, // dynamic size model and return them (the previous dynamic sizeModel). me.widthModel = me.heightModel = null; sizeModel = target.getSizeModel(ownerCtContext && ownerCtContext.widthModel.pairsByHeightOrdinal[ownerCtContext.heightModel.ordinal]); if (firstTime) { me.sizeModel = sizeModel; } me.widthModel = sizeModel.width; me.heightModel = sizeModel.height; // if we are a container child (e.g., not a docked item), and this is a full // init, that means our parent was invalidated, and therefore both our width // and our height are included in remainingChildDimensions if (ownerCtContext && !me.isComponentChild) { ownerCtContext.remainingChildDimensions += 2; } } else if (oldProps) { // these are almost always calculated by the ownerCt (we might need to track // this at some point more carefully): me.recoverProp('x', oldProps, oldDirty); me.recoverProp('y', oldProps, oldDirty); // if these are calculated by the ownerCt, don't trash them: if (me.widthModel.calculated) { me.recoverProp('width', oldProps, oldDirty); } else if ('width' in oldProps) { ++remainingCount; } if (me.heightModel.calculated) { me.recoverProp('height', oldProps, oldDirty); } else if ('height' in oldProps) { ++remainingCount; } // if we are a container child and this is not a full init, that means our // parent was not invalidated and therefore only the dimensions that were // set last time and removed from remainingChildDimensions last time, need to // be added back to remainingChildDimensions. This only needs to happen for // properties that we don't recover above (model=calculated) if (ownerCtContext && !me.isComponentChild) { ownerCtContext.remainingChildDimensions += remainingCount; } } if (oldProps && ownerLayout && ownerLayout.manageMargins) { me.recoverProp('margin-top', oldProps, oldDirty); me.recoverProp('margin-right', oldProps, oldDirty); me.recoverProp('margin-bottom', oldProps, oldDirty); me.recoverProp('margin-left', oldProps, oldDirty); } // Process any invalidate options present. These can only come from explicit calls // to the invalidate() method. if (options) { // Consider a container box with wrapping text. If the box is made wider, the // text will take up less height (until there is no more wrapping). Conversely, // if the box is made narrower, the height starts to increase due to wrapping. // // Imposing a minWidth constraint would increase the width. This may decrease // the height. If the box is shrinkWrap, however, the width will already be // such that there is no wrapping, so the height will not further decrease. // Since the height will also not increase if we widen the box, there is no // problem simultaneously imposing a minHeight or maxHeight constraint. // // When we impose as maxWidth constraint, however, we are shrinking the box // which may increase the height. If we are imposing a maxHeight constraint, // that is fine because a further increased height will still need to be // constrained. But if we are imposing a minHeight constraint, we cannot know // whether the increase in height due to wrapping will be greater than the // minHeight. If we impose a minHeight constraint at the same time, then, we // could easily be locking in the wrong height. // // It is important to note that this logic applies to simultaneously *adding* // both a maxWidth and a minHeight constraint. It is perfectly fine to have // a state with both constraints, but we cannot add them both at once. newHeightModel = options.heightModel; newWidthModel = options.widthModel; if (newWidthModel && newHeightModel && oldWidthModel && oldHeightModel) { if (oldWidthModel.shrinkWrap && oldHeightModel.shrinkWrap) { if (newWidthModel.constrainedMax && newHeightModel.constrainedMin) { newHeightModel = null; } } } // Apply size model updates (if any) and state updates (if any). if (newWidthModel) { me.widthModel = newWidthModel; } if (newHeightModel) { me.heightModel = newHeightModel; } if (options.state) { Ext.apply(me.state, options.state); } } return ret; }, /** * @private */ initContinue: function (full) { var me = this, ownerCtContext = me.ownerCtContext, comp = me.target, widthModel = me.widthModel, hierarchyState = comp.getHierarchyState(), boxParent; if (widthModel.fixed) { // calculated or configured hierarchyState.inShrinkWrapTable = false; } else { delete hierarchyState.inShrinkWrapTable; } if (full) { if (ownerCtContext && widthModel.shrinkWrap) { boxParent = ownerCtContext.isBoxParent ? ownerCtContext : ownerCtContext.boxParent; if (boxParent) { boxParent.addBoxChild(me); } } else if (widthModel.natural) { me.boxParent = ownerCtContext; } } return full; }, /** * @private */ initDone: function(containerLayoutDone) { var me = this, props = me.props, state = me.state; // These properties are only set when they are true: if (me.remainingChildDimensions === 0) { props.containerChildrenSizeDone = true; } if (containerLayoutDone) { props.containerLayoutDone = true; } if (me.boxChildren && me.boxChildren.length && me.widthModel.shrinkWrap) { // set a very large width to allow the children to measure their natural // widths (this is cleared once all children have been measured): me.el.setWidth(10000); // don't run layouts for this component until we clear this width... state.blocks = (state.blocks || 0) + 1; } }, /** * @private */ initAnimation: function() { var me = this, target = me.target, ownerCtContext = me.ownerCtContext; if (ownerCtContext && ownerCtContext.isTopLevel) { // See which properties we are supposed to animate to their new state. // If there are any, queue ourself to be animated by the owning Context me.animatePolicy = target.ownerLayout.getAnimatePolicy(me); } else if (!ownerCtContext && target.isCollapsingOrExpanding && target.animCollapse) { // Collapsing/expnding a top level Panel with animation. We need to fabricate // an animatePolicy depending on which dimension the collapse is using, // isCollapsingOrExpanding is set during the collapse/expand process. me.animatePolicy = target.componentLayout.getAnimatePolicy(me); } if (me.animatePolicy) { me.context.queueAnimation(me); } }, /** * Queue the addition of a class name (or array of class names) to this ContextItem's target when next flushed. */ addCls: function(newCls) { this.getClassList().addMany(newCls); }, /** * Queue the removal of a class name (or array of class names) from this ContextItem's target when next flushed. */ removeCls: function(removeCls) { this.getClassList().removeMany(removeCls); }, /** * Adds a block. * * @param {String} name The name of the block list ('blocks' or 'domBlocks'). * @param {Ext.layout.Layout} layout The layout that is blocked. * @param {String} propName The property name that blocked the layout (e.g., 'width'). * @private */ addBlock: function (name, layout, propName) { var me = this, collection = me[name] || (me[name] = {}), blockedLayouts = collection[propName] || (collection[propName] = {}); if (!blockedLayouts[layout.id]) { blockedLayouts[layout.id] = layout; ++layout.blockCount; ++me.context.blockCount; } }, addBoxChild: function (boxChildItem) { var me = this, children, widthModel = boxChildItem.widthModel; boxChildItem.boxParent = this; // Children that are widthModel.auto (regardless of heightModel) that measure the // DOM (by virtue of hasRawContent), need to wait for their "box parent" to be sized. // If they measure too early, they will be wrong results. In the widthModel.shrinkWrap // case, the boxParent "crushes" the child. In the case of widthModel.natural, the // boxParent's width is likely a key part of the child's width (e.g., "50%" or just // normal block-level behavior of 100% width) boxChildItem.measuresBox = widthModel.shrinkWrap ? boxChildItem.hasRawContent : widthModel.natural; if (boxChildItem.measuresBox) { children = me.boxChildren; if (children) { children.push(boxChildItem); } else { me.boxChildren = [ boxChildItem ]; } } }, /** * Adds x and y values from a props object to a styles object as "left" and "top" values. * Overridden to add the x property as "right" in rtl mode. * @property {Object} styles A styles object for an Element * @property {Object} props A ContextItem props object * @return {Number} count The number of styles that were set. * @private */ addPositionStyles: function(styles, props) { var x = props.x, y = props.y, count = 0; if (x !== undefined) { styles.left = x + 'px'; ++count; } if (y !== undefined) { styles.top = y + 'px'; ++count; } return count; }, /** * Adds a trigger. * * @param {String} propName The property name that triggers the layout (e.g., 'width'). * @param {Boolean} inDom True if the trigger list is `domTriggers`, false if `triggers`. * @private */ addTrigger: function (propName, inDom) { var me = this, name = inDom ? 'domTriggers' : 'triggers', collection = me[name] || (me[name] = {}), context = me.context, layout = context.currentLayout, triggers = collection[propName] || (collection[propName] = {}); if (!triggers[layout.id]) { triggers[layout.id] = layout; ++layout.triggerCount; triggers = context.triggers[inDom ? 'dom' : 'data']; (triggers[layout.id] || (triggers[layout.id] = [])).push({ item: this, prop: propName }); if (me.props[propName] !== undefined) { if (!inDom || !(me.dirty && (propName in me.dirty))) { ++layout.firedTriggers; } } } }, boxChildMeasured: function () { var me = this, state = me.state, count = (state.boxesMeasured = (state.boxesMeasured || 0) + 1); if (count == me.boxChildren.length) { // all of our children have measured themselves, so we can clear the width // and resume layouts for this component... state.clearBoxWidth = 1; ++me.context.progressCount; me.markDirty(); } }, borderNames: [ 'border-top-width', 'border-right-width', 'border-bottom-width', 'border-left-width'], marginNames: [ 'margin-top', 'margin-right', 'margin-bottom', 'margin-left' ], paddingNames: [ 'padding-top', 'padding-right', 'padding-bottom', 'padding-left' ], trblNames: [ 'top', 'right', 'bottom', 'left' ], cacheMissHandlers: { borderInfo: function (me) { var info = me.getStyles(me.borderNames, me.trblNames); info.width = info.left + info.right; info.height = info.top + info.bottom; return info; }, marginInfo: function (me) { var info = me.getStyles(me.marginNames, me.trblNames); info.width = info.left + info.right; info.height = info.top + info.bottom; return info; }, paddingInfo: function (me) { // if this context item's target is a framed component the padding is on the frameBody, not on the main el var item = me.frameBodyContext || me, info = item.getStyles(me.paddingNames, me.trblNames); info.width = info.left + info.right; info.height = info.top + info.bottom; return info; } }, checkCache: function (entry) { return this.cacheMissHandlers[entry](this); }, clearAllBlocks: function (name) { var collection = this[name], propName; if (collection) { for (propName in collection) { this.clearBlocks(name, propName); } } }, /** * Removes any blocks on a property in the specified set. Any layouts that were blocked * by this property and are not still blocked (by other properties) will be rescheduled. * * @param {String} name The name of the block list ('blocks' or 'domBlocks'). * @param {String} propName The property name that blocked the layout (e.g., 'width'). * @private */ clearBlocks: function (name, propName) { var collection = this[name], blockedLayouts = collection && collection[propName], context, layout, layoutId; if (blockedLayouts) { delete collection[propName]; context = this.context; for (layoutId in blockedLayouts) { layout = blockedLayouts[layoutId]; --context.blockCount; if (! --layout.blockCount && !layout.pending && !layout.done) { context.queueLayout(layout); } } } }, /** * Registers a layout in the block list for the given property. Once the property is * set in the {@link Ext.layout.Context}, the layout is unblocked. * * @param {Ext.layout.Layout} layout * @param {String} propName The property name that blocked the layout (e.g., 'width'). */ block: function (layout, propName) { this.addBlock('blocks', layout, propName); }, /** * Registers a layout in the DOM block list for the given property. Once the property * flushed to the DOM by the {@link Ext.layout.Context}, the layout is unblocked. * * @param {Ext.layout.Layout} layout * @param {String} propName The property name that blocked the layout (e.g., 'width'). */ domBlock: function (layout, propName) { this.addBlock('domBlocks', layout, propName); }, /** * Reschedules any layouts associated with a given trigger. * * @param {String} name The name of the trigger list ('triggers' or 'domTriggers'). * @param {String} propName The property name that triggers the layout (e.g., 'width'). * @private */ fireTriggers: function (name, propName) { var collection = this[name], triggers = collection && collection[propName], context = this.context, layout, layoutId; if (triggers) { for (layoutId in triggers) { layout = triggers[layoutId]; ++layout.firedTriggers; if (!layout.done && !layout.blockCount && !layout.pending) { context.queueLayout(layout); } } } }, /** * Flushes any updates in the dirty collection to the DOM. This is only called if there * are dirty entries because this object is only added to the flushQueue of the * {@link Ext.layout.Context} when entries become dirty. */ flush: function () { var me = this, dirty = me.dirty, state = me.state, targetEl = me.el; me.dirtyCount = 0; // Flush added/removed classes if (me.classList && me.classList.dirty) { me.classList.flush(); } // Set any queued DOM attributes if ('attributes' in me) { targetEl.set(me.attributes); delete me.attributes; } // Set any queued DOM HTML content if ('innerHTML' in me) { targetEl.innerHTML = me.innerHTML; delete me.innerHTML; } if (state && state.clearBoxWidth) { state.clearBoxWidth = 0; me.el.setStyle('width', null); if (! --state.blocks) { me.context.queueItemLayouts(me); } } if (dirty) { delete me.dirty; me.writeProps(dirty, true); } }, /** * @private */ flushAnimations: function() { var me = this, animateFrom = me.previousSize, target, targetAnim, duration, animateProps, anim, changeCount, j, propsLen, propName, oldValue, newValue; // Only animate if the Component has been previously layed out: first layout should not animate if (animateFrom) { target = me.target; targetAnim = target.layout && target.layout.animate; if (targetAnim) { duration = Ext.isNumber(targetAnim) ? targetAnim : targetAnim.duration; } animateProps = Ext.Object.getKeys(me.animatePolicy); // Create an animation block using the targetAnim configuration to provide defaults. // They may want custom duration, or easing, or listeners. anim = Ext.apply({}, { from: {}, to: {}, duration: duration || Ext.fx.Anim.prototype.duration }, targetAnim); for (changeCount = 0, j = 0, propsLen = animateProps.length; j < propsLen; j++) { propName = animateProps[j]; oldValue = animateFrom[propName]; newValue = me.peek(propName); if (oldValue != newValue) { propName = me.translateProps[propName]||propName; anim.from[propName] = oldValue; anim.to[propName] = newValue; ++changeCount; } } // If any values have changed, kick off animation from the cached old values to the new values if (changeCount) { // It'a Panel being collapsed. rollback, and then fix the class name string if (me.isCollapsingOrExpanding === 1) { target.componentLayout.undoLayout(me); } // Otherwise, undo just the animated properties so the animation can proceed from the old layout. else { me.writeProps(anim.from); } me.el.animate(anim); Ext.fx.Manager.getFxQueue(me.el.id)[0].on({ afteranimate: function() { if (me.isCollapsingOrExpanding === 1) { target.componentLayout.redoLayout(me); target.afterCollapse(true); } else if (me.isCollapsingOrExpanding === 2) { target.afterExpand(true); } } }); } } }, /** * Gets the border information for the element as an object with left, top, right and * bottom properties holding border size in pixels. This object is only read from the * DOM on first request and is cached. * @return {Object} */ getBorderInfo: function () { var me = this, info = me.borderInfo; if (!info) { me.borderInfo = info = me.checkCache('borderInfo'); } return info; }, /** * Returns a ClassList-like object to buffer access to this item's element's classes. */ getClassList: function () { return this.classList || (this.classList = new Ext.layout.ClassList(this)); }, /** * @member Ext.layout.ContextItem * Returns the context item for an owned element. This should only be called on a * component's item. The list of child items is used to manage invalidating calculated * results. * @param {String/Ext.dom.Element} nameOrEl The element or the name of an owned element * @param {Ext.layout.container.Container/Ext.Component} [owner] The owner of the * named element if the passed "nameOrEl" parameter is a String. Defaults to this * ContextItem's "target" property. For more details on owned elements see * {@link Ext.Component#cfg-childEls childEls} and * {@link Ext.Component#renderSelectors renderSelectors} * @return {Ext.layout.ContextItem} */ getEl: function (nameOrEl, owner) { var me = this, src, el, elContext; if (nameOrEl) { if (nameOrEl.dom) { el = nameOrEl; } else { src = me.target; if (owner) { src = owner; } el = src[nameOrEl]; if (typeof el == 'function') { // ex 'getTarget' el = el.call(src); if (el === me.el) { return this; // comp.getTarget() often returns comp.el } } } if (el) { elContext = me.context.getEl(me, el); } } return elContext || null; }, /** * Gets the "frame" information for the element as an object with left, top, right and * bottom properties holding border+framing size in pixels. This object is calculated * on first request and is cached. * @return {Object} */ getFrameInfo: function () { var me = this, info = me.frameInfo, framing, border; if (!info) { framing = me.framing; border = me.getBorderInfo(); me.frameInfo = info = framing ? { top : framing.top + border.top, right : framing.right + border.right, bottom: framing.bottom + border.bottom, left : framing.left + border.left, width : framing.width + border.width, height: framing.height + border.height } : border; } return info; }, /** * Gets the margin information for the element as an object with left, top, right and * bottom properties holding margin size in pixels. This object is only read from the * DOM on first request and is cached. * @return {Object} */ getMarginInfo: function () { var me = this, info = me.marginInfo, comp, manageMargins, margins, ownerLayout, ownerLayoutId; if (!info) { if (!me.wrapsComponent) { info = me.checkCache('marginInfo'); } else { comp = me.target; ownerLayout = comp.ownerLayout; ownerLayoutId = ownerLayout ? ownerLayout.id : null; manageMargins = ownerLayout && ownerLayout.manageMargins; // Option #1 for configuring margins on components is the "margin" config // property. When supplied, this config is written to the DOM during the // render process (see AbstractComponent#initStyles). // // Option #2 is available to some layouts (e.g., Box, Border, Fit) that // handle margin calculations themselves. These layouts support a "margins" // config property on their items and they have a "defaultMargins" config // property. These margin values are added to the "natural" margins read // from the DOM and 0's are written to the DOM after they are added. // To avoid having to do all this on every layout, we cache the results on // the component in the (private) "margin$" property. We identify the cache // results as belonging to the appropriate ownerLayout in case items are // moved around. info = comp.margin$; if (info && info.ownerId !== ownerLayoutId) { // got one but from the wrong owner info = null; // if (manageMargins) { // TODO: clear inline margins (the 0's we wrote last time)??? // } } if (!info) { // if (no cache) // CSS margins are only checked if there isn't a margin property on the component info = me.parseMargins(comp, comp.margin) || me.checkCache('marginInfo'); // Some layouts also support margins and defaultMargins, e.g. Fit, Border, Box if (manageMargins) { margins = me.parseMargins(comp, comp.margins, ownerLayout.defaultMargins); if (margins) { // if (using 'margins' and/or 'defaultMargins') // margin and margins can both be present at the same time and must be combined info = { top: info.top + margins.top, right: info.right + margins.right, bottom: info.bottom + margins.bottom, left: info.left + margins.left }; } me.setProp('margin-top', 0); me.setProp('margin-right', 0); me.setProp('margin-bottom', 0); me.setProp('margin-left', 0); } // cache the layout margins and tag them with the layout id: info.ownerId = ownerLayoutId; comp.margin$ = info; } info.width = info.left + info.right; info.height = info.top + info.bottom; } me.marginInfo = info; } return info; }, /** * clears the margin cache so that marginInfo get re-read from the dom on the next call to getMarginInfo() * This is needed in some special cases where the margins have changed since the last layout, making the cached * values invalid. For example collapsed window headers have different margin than expanded ones. */ clearMarginCache: function() { delete this.marginInfo; delete this.target.margin$; }, /** * Gets the padding information for the element as an object with left, top, right and * bottom properties holding padding size in pixels. This object is only read from the * DOM on first request and is cached. * @return {Object} */ getPaddingInfo: function () { var me = this, info = me.paddingInfo; if (!info) { me.paddingInfo = info = me.checkCache('paddingInfo'); } return info; }, /** * Gets a property of this object. Also tracks the current layout as dependent on this * property so that changes to it will trigger the layout to be recalculated. * @param {String} propName The property name that blocked the layout (e.g., 'width'). * @return {Object} The property value or undefined if not yet set. */ getProp: function (propName) { var me = this, result = me.props[propName]; me.addTrigger(propName); return result; }, /** * Gets a property of this object if it is correct in the DOM. Also tracks the current * layout as dependent on this property so that DOM writes of it will trigger the * layout to be recalculated. * @param {String} propName The property name (e.g., 'width'). * @return {Object} The property value or undefined if not yet set or is dirty. */ getDomProp: function (propName) { var me = this, result = (me.dirty && (propName in me.dirty)) ? undefined : me.props[propName]; me.addTrigger(propName, true); return result; }, /** * Returns a style for this item. Each style is read from the DOM only once on first * request and is then cached. If the value is an integer, it is parsed automatically * (so '5px' is not returned, but rather 5). * * @param {String} styleName The CSS style name. * @return {Object} The value of the DOM style (parsed as necessary). */ getStyle: function (styleName) { var me = this, styles = me.styles, info, value; if (styleName in styles) { value = styles[styleName]; } else { info = me.styleInfo[styleName]; value = me.el.getStyle(styleName); if (info && info.parseInt) { value = parseInt(value, 10) || 0; } styles[styleName] = value; } return value; }, /** * Returns styles for this item. Each style is read from the DOM only once on first * request and is then cached. If the value is an integer, it is parsed automatically * (so '5px' is not returned, but rather 5). * * @param {String[]} styleNames The CSS style names. * @param {String[]} [altNames] The alternate names for the returned styles. If given, * these names must correspond one-for-one to the `styleNames`. * @return {Object} The values of the DOM styles (parsed as necessary). */ getStyles: function (styleNames, altNames) { var me = this, styleCache = me.styles, values = {}, hits = 0, n = styleNames.length, i, missing, missingAltNames, name, info, styleInfo, styles, value; altNames = altNames || styleNames; // We are optimizing this for all hits or all misses. If we hit on all styles, we // don't create a missing[]. If we miss on all styles, we also don't create one. for (i = 0; i < n; ++i) { name = styleNames[i]; if (name in styleCache) { values[altNames[i]] = styleCache[name]; ++hits; if (i && hits==1) { // if (first hit was after some misses) missing = styleNames.slice(0, i); missingAltNames = altNames.slice(0, i); } } else if (hits) { (missing || (missing = [])).push(name); (missingAltNames || (missingAltNames = [])).push(altNames[i]); } } if (hits < n) { missing = missing || styleNames; missingAltNames = missingAltNames || altNames; styleInfo = me.styleInfo; styles = me.el.getStyle(missing); for (i = missing.length; i--; ) { name = missing[i]; info = styleInfo[name]; value = styles[name]; if (info && info.parseInt) { value = parseInt(value, 10) || 0; } values[missingAltNames[i]] = value; styleCache[name] = value; } } return values; }, /** * Returns true if the given property has been set. This is equivalent to calling * {@link #getProp} and not getting an undefined result. In particular, this call * registers the current layout to be triggered by changes to this property. * * @param {String} propName The property name (e.g., 'width'). * @return {Boolean} */ hasProp: function (propName) { return this.getProp(propName) != null; }, /** * Returns true if the given property is correct in the DOM. This is equivalent to * calling {@link #getDomProp} and not getting an undefined result. In particular, * this call registers the current layout to be triggered by flushes of this property. * * @param {String} propName The property name (e.g., 'width'). * @return {Boolean} */ hasDomProp: function (propName) { return this.getDomProp(propName) != null; }, /** * Invalidates the component associated with this item. The layouts for this component * and all of its contained items will be re-run after first clearing any computed * values. * * If state needs to be carried forward beyond the invalidation, the `options` parameter * can be used. * * @param {Object} options An object describing how to handle the invalidation. * @param {Object} options.state An object to {@link Ext#apply} to the {@link #state} * of this item after invalidation clears all other properties. * @param {Function} options.before A function to call after the context data is cleared * and before the {@link Ext.layout.Layout#beginLayoutCycle} methods are called. * @param {Ext.layout.ContextItem} options.before.item This ContextItem. * @param {Object} options.before.options The options object passed to {@link #invalidate}. * @param {Function} options.after A function to call after the context data is cleared * and after the {@link Ext.layout.Layout#beginLayoutCycle} methods are called. * @param {Ext.layout.ContextItem} options.after.item This ContextItem. * @param {Object} options.after.options The options object passed to {@link #invalidate}. * @param {Object} options.scope The scope to use when calling the callback functions. */ invalidate: function (options) { this.context.queueInvalidate(this, options); }, markDirty: function () { if (++this.dirtyCount == 1) { // our first dirty property... queue us for flush this.context.queueFlush(this); } }, onBoxMeasured: function () { var boxParent = this.boxParent, state = this.state; if (boxParent && boxParent.widthModel.shrinkWrap && !state.boxMeasured && this.measuresBox) { // since an autoWidth boxParent is holding a width on itself to allow each // child to measure state.boxMeasured = 1; // best to only call once per child boxParent.boxChildMeasured(); } }, parseMargins: function (comp, margins, defaultMargins) { if (margins === true) { margins = 5; } var type = typeof margins, ret; if (type == 'string' || type == 'number') { ret = comp.parseBox(margins); } else if (margins || defaultMargins) { ret = { top: 0, right: 0, bottom: 0, left: 0 }; // base defaults if (defaultMargins) { Ext.apply(ret, this.parseMargins(comp, defaultMargins)); // + layout defaults } if (margins) { margins = Ext.apply(ret, comp.parseBox(margins)); // + config } } return ret; }, peek: function (propName) { return this.props[propName]; }, /** * Recovers a property value from the last computation and restores its value and * dirty state. * * @param {String} propName The name of the property to recover. * @param {Object} oldProps The old "props" object from which to recover values. * @param {Object} oldDirty The old "dirty" object from which to recover state. */ recoverProp: function (propName, oldProps, oldDirty) { var me = this, props = me.props, dirty; if (propName in oldProps) { props[propName] = oldProps[propName]; if (oldDirty && propName in oldDirty) { dirty = me.dirty || (me.dirty = {}); dirty[propName] = oldDirty[propName]; } } }, redo: function(deep) { var me = this, items, len, i; me.revertProps(me.props); if (deep && me.wrapsComponent) { // Rollback the state of child Components if (me.childItems) { for (i = 0, items = me.childItems, len = items.length; i < len; i++) { items[i].redo(deep); } } // Rollback the state of child Elements for (i = 0, items = me.children, len = items.length; i < len; i++) { items[i].redo(); } } }, /** * Removes a cached ContextItem that was created using {@link #getEl}. It may be * necessary to call this method if the dom reference for owned element changes so * that {@link #getEl} can be called again to reinitialize the ContextItem with the * new element. * @param {String/Ext.dom.Element} nameOrEl The element or the name of an owned element * @param {Ext.layout.container.Container/Ext.Component} [owner] The owner of the * named element if the passed "nameOrEl" parameter is a String. Defaults to this * ContextItem's "target" property. */ removeEl: function(nameOrEl, owner) { var me = this, src, el; if (nameOrEl) { if (nameOrEl.dom) { el = nameOrEl; } else { src = me.target; if (owner) { src = owner; } el = src[nameOrEl]; if (typeof el == 'function') { // ex 'getTarget' el = el.call(src); if (el === me.el) { return this; // comp.getTarget() often returns comp.el } } } if (el) { me.context.removeEl(me, el); } } }, revertProps: function (props) { var name, flushed = this.flushedProps, reverted = {}; for (name in props) { if (flushed.hasOwnProperty(name)) { reverted[name] = props[name]; } } this.writeProps(reverted); }, /** * Queue the setting of a DOM attribute on this ContextItem's target when next flushed. */ setAttribute: function(name, value) { var me = this; if (!me.attributes) { me.attributes = {}; } me.attributes[name] = value; me.markDirty(); }, setBox: function (box) { var me = this; if ('left' in box) { me.setProp('x', box.left); } if ('top' in box) { me.setProp('y', box.top); } // if sizeModel says we should not be setting these, the appropriate calls will be // null operations... otherwise, we must set these values, so what we have in box // is what we go with (undefined, NaN and no change are handled at a lower level): me.setSize(box.width, box.height); }, /** * Sets the contentHeight property. If the component uses raw content, then only the * measured height is acceptable. * * Calculated values can sometimes be NaN or undefined, which generally mean the * calculation is not done. To indicate that such as value was passed, 0 is returned. * Otherwise, 1 is returned. * * If the caller is not measuring (i.e., they are calculating) and the component has raw * content, 1 is returned indicating that the caller is done. */ setContentHeight: function (height, measured) { if (!measured && this.hasRawContent) { return 1; } return this.setProp('contentHeight', height); }, /** * Sets the contentWidth property. If the component uses raw content, then only the * measured width is acceptable. * * Calculated values can sometimes be NaN or undefined, which generally means that the * calculation is not done. To indicate that such as value was passed, 0 is returned. * Otherwise, 1 is returned. * * If the caller is not measuring (i.e., they are calculating) and the component has raw * content, 1 is returned indicating that the caller is done. */ setContentWidth: function (width, measured) { if (!measured && this.hasRawContent) { return 1; } return this.setProp('contentWidth', width); }, /** * Sets the contentWidth and contentHeight properties. If the component uses raw content, * then only the measured values are acceptable. * * Calculated values can sometimes be NaN or undefined, which generally means that the * calculation is not done. To indicate that either passed value was such a value, false * returned. Otherwise, true is returned. * * If the caller is not measuring (i.e., they are calculating) and the component has raw * content, true is returned indicating that the caller is done. */ setContentSize: function (width, height, measured) { return this.setContentWidth(width, measured) + this.setContentHeight(height, measured) == 2; }, /** * Sets a property value. This will unblock and/or trigger dependent layouts if the * property value is being changed. Values of NaN and undefined are not accepted by * this method. * * @param {String} propName The property name (e.g., 'width'). * @param {Object} value The new value of the property. * @param {Boolean} dirty Optionally specifies if the value is currently in the DOM * (default is `true` which indicates the value is not in the DOM and must be flushed * at some point). * @return {Number} 1 if this call specified the property value, 0 if not. */ setProp: function (propName, value, dirty) { var me = this, valueType = typeof value, borderBox, info; if (valueType == 'undefined' || (valueType === 'number' && isNaN(value))) { return 0; } if (me.props[propName] === value) { return 1; } me.props[propName] = value; ++me.context.progressCount; if (dirty === false) { // if the prop is equivalent to what is in the DOM (we won't be writing it), // we need to clear hard blocks (domBlocks) on that property. me.fireTriggers('domTriggers', propName); me.clearBlocks('domBlocks', propName); } else { info = me.styleInfo[propName]; if (info) { if (!me.dirty) { me.dirty = {}; } if (propName == 'width' || propName == 'height') { borderBox = me.isBorderBoxValue; if (borderBox === null) { me.isBorderBoxValue = borderBox = !!me.el.isBorderBox(); } if (!borderBox) { me.borderInfo || me.getBorderInfo(); me.paddingInfo || me.getPaddingInfo(); } } me.dirty[propName] = value; me.markDirty(); } } // we always clear soft blocks on set me.fireTriggers('triggers', propName); me.clearBlocks('blocks', propName); return 1; }, /** * Sets the height and constrains the height to min/maxHeight range. * * @param {Number} height The height. * @param {Boolean} [dirty=true] Specifies if the value is currently in the DOM. A * value of `false` indicates that the value is already in the DOM. * @return {Number} The actual height after constraining. */ setHeight: function (height, dirty /*, private {Boolean} force */) { var me = this, comp = me.target, ownerCtContext = me.ownerCtContext, frameBody, frameInfo, min, oldHeight, rem; if (height < 0) { height = 0; } if (!me.wrapsComponent) { if (!me.setProp('height', height, dirty)) { return NaN; } } else { min = me.collapsedVert ? 0 : (comp.minHeight || 0); height = Ext.Number.constrain(height, min, comp.maxHeight); oldHeight = me.props.height; if (!me.setProp('height', height, dirty)) { return NaN; } // if we are a container child, since the height is now known we can decrement // the number of remainingChildDimensions that the ownerCtContext is waiting on. if (ownerCtContext && !me.isComponentChild && isNaN(oldHeight)) { rem = --ownerCtContext.remainingChildDimensions; if (!rem) { // if there are 0 remainingChildDimensions set containerChildrenSizeDone // on the ownerCtContext to indicate that all of its children's dimensions // are known ownerCtContext.setProp('containerChildrenSizeDone', true); } } frameBody = me.frameBodyContext; if (frameBody){ frameInfo = me.getFrameInfo(); frameBody.setHeight(height - frameInfo.height, dirty); } } return height; }, /** * Sets the height and constrains the width to min/maxWidth range. * * @param {Number} width The width. * @param {Boolean} [dirty=true] Specifies if the value is currently in the DOM. A * value of `false` indicates that the value is already in the DOM. * @return {Number} The actual width after constraining. */ setWidth: function (width, dirty /*, private {Boolean} force */) { var me = this, comp = me.target, ownerCtContext = me.ownerCtContext, frameBody, frameInfo, min, oldWidth, rem; if (width < 0) { width = 0; } if (!me.wrapsComponent) { if (!me.setProp('width', width, dirty)) { return NaN; } } else { min = me.collapsedHorz ? 0 : (comp.minWidth || 0); width = Ext.Number.constrain(width, min, comp.maxWidth); oldWidth = me.props.width if (!me.setProp('width', width, dirty)) { return NaN; } // if we are a container child, since the width is now known we can decrement // the number of remainingChildDimensions that the ownerCtContext is waiting on. if (ownerCtContext && !me.isComponentChild && isNaN(oldWidth)) { rem = --ownerCtContext.remainingChildDimensions; if (!rem) { // if there are 0 remainingChildDimensions set containerChildrenSizeDone // on the ownerCtContext to indicate that all of its children's dimensions // are known ownerCtContext.setProp('containerChildrenSizeDone', true); } } //if ((frameBody = me.target.frameBody) && (frameBody = me.getEl(frameBody))){ frameBody = me.frameBodyContext; if (frameBody) { frameInfo = me.getFrameInfo(); frameBody.setWidth(width - frameInfo.width, dirty); } /*if (owner.frameMC) { frameContext = ownerContext.frameContext || (ownerContext.frameContext = ownerContext.getEl('frameMC')); width += (frameContext.paddingInfo || frameContext.getPaddingInfo()).width; }*/ } return width; }, setSize: function (width, height, dirty) { this.setWidth(width, dirty); this.setHeight(height, dirty); }, translateProps: { x: 'left', y: 'top' }, undo: function(deep) { var me = this, items, len, i; me.revertProps(me.lastBox); if (deep && me.wrapsComponent) { // Rollback the state of child Components if (me.childItems) { for (i = 0, items = me.childItems, len = items.length; i < len; i++) { items[i].undo(deep); } } // Rollback the state of child Elements for (i = 0, items = me.children, len = items.length; i < len; i++) { items[i].undo(); } } }, unsetProp: function (propName) { var dirty = this.dirty; delete this.props[propName]; if (dirty) { delete dirty[propName]; } }, writeProps: function(dirtyProps, flushing) { if (!(dirtyProps && typeof dirtyProps == 'object')) { Ext.Logger.warn('writeProps expected dirtyProps to be an object'); return; } var me = this, el = me.el, styles = {}, styleCount = 0, // used as a boolean, the exact count doesn't matter styleInfo = me.styleInfo, info, propName, numericValue, width = dirtyProps.width, height = dirtyProps.height, isBorderBox = me.isBorderBoxValue, target = me.target, max = Math.max, paddingWidth = 0, paddingHeight = 0, hasWidth, hasHeight, isAbsolute, scrollbarSize, style, targetEl; // Process non-style properties: if ('displayed' in dirtyProps) { el.setDisplayed(dirtyProps.displayed); } // Unblock any hard blocks (domBlocks) and copy dom styles into 'styles' for (propName in dirtyProps) { if (flushing) { me.fireTriggers('domTriggers', propName); me.clearBlocks('domBlocks', propName); me.flushedProps[propName] = 1; } info = styleInfo[propName]; if (info && info.dom) { // Numeric dirty values should have their associated suffix added if (info.suffix && (numericValue = parseInt(dirtyProps[propName], 10))) { styles[propName] = numericValue + info.suffix; } // Non-numeric (eg "auto") go in unchanged. else { styles[propName] = dirtyProps[propName]; } ++styleCount; } } // convert x/y into setPosition (for a component) or left/top styles (for an el) if ('x' in dirtyProps || 'y' in dirtyProps) { if (target.isComponent) { target.setPosition(dirtyProps.x, dirtyProps.y); } else { // we wrap an element, so convert x/y to styles: styleCount += me.addPositionStyles(styles, dirtyProps); } } // Support for the content-box box model... if (!isBorderBox && (width > 0 || height > 0)) { // no need to subtract from 0 // The width and height values assume the border-box box model, // so we must remove the padding & border to calculate the content-box. if (!(me.borderInfo && me.paddingInfo)) { throw Error("Needed to have gotten the borderInfo and paddingInfo when the width or height was setProp'd"); } if(!me.frameBodyContext) { // Padding needs to be removed only if the element is not framed. paddingWidth = me.paddingInfo.width; paddingHeight = me.paddingInfo.height; } if (width) { width = max(parseInt(width, 10) - (me.borderInfo.width + paddingWidth), 0); styles.width = width + 'px'; ++styleCount; } if (height) { height = max(parseInt(height, 10) - (me.borderInfo.height + paddingHeight), 0); styles.height = height + 'px'; ++styleCount; } } // IE9 strict subtracts the scrollbar size from the element size when the element // is absolutely positioned and uses box-sizing: border-box. To workaround this // issue we have to add the the scrollbar size. // // See http://social.msdn.microsoft.com/Forums/da-DK/iewebdevelopment/thread/47c5148f-a142-4a99-9542-5f230c78cb3b // if (me.wrapsComponent && Ext.isIE9 && Ext.isStrict) { // when we set a width and we have a vertical scrollbar (overflowY), we need // to add the scrollbar width... conversely for the height and overflowX if ((hasWidth = width !== undefined && me.hasOverflowY) || (hasHeight = height !== undefined && me.hasOverflowX)) { // check that the component is absolute positioned and border-box: isAbsolute = me.isAbsolute; if (isAbsolute === undefined) { isAbsolute = false; targetEl = me.target.getTargetEl(); style = targetEl.getStyle('position'); if (style == 'absolute') { style = targetEl.getStyle('box-sizing'); isAbsolute = (style == 'border-box'); } me.isAbsolute = isAbsolute; // cache it } if (isAbsolute) { scrollbarSize = Ext.getScrollbarSize(); if (hasWidth) { width = parseInt(width, 10) + scrollbarSize.width; styles.width = width + 'px'; ++styleCount; } if (hasHeight) { height = parseInt(height, 10) + scrollbarSize.height; styles.height = height + 'px'; ++styleCount; } } } } // we make only one call to setStyle to allow it to optimize itself: if (styleCount) { el.setStyle(styles); } } }, function () { var px = { dom: true, parseInt: true, suffix: 'px' }, isDom = { dom: true }, faux = { dom: false }; // If a property exists in styleInfo, it participates in some way with the DOM. It may // be virtualized (like 'x' and y') and be indirect, but still requires a flush cycle // to reach the DOM. Properties (like 'contentWidth' and 'contentHeight') have no real // presence in the DOM and hence have no flush intanglements. // // For simple styles, the object value on the right contains properties that help in // decoding values read by getStyle and preparing values to pass to setStyle. // this.prototype.styleInfo = { containerChildrenSizeDone: faux, containerLayoutDone: faux, displayed: faux, done: faux, x: faux, y: faux, // For Ext.grid.ColumnLayout columnWidthsDone: faux, left: px, top: px, right: px, bottom: px, width: px, height: px, 'border-top-width': px, 'border-right-width': px, 'border-bottom-width': px, 'border-left-width': px, 'margin-top': px, 'margin-right': px, 'margin-bottom': px, 'margin-left': px, 'padding-top': px, 'padding-right': px, 'padding-bottom': px, 'padding-left': px, 'line-height': isDom, display: isDom }; }); /** * Manages context information during a layout. * * # Algorithm * * This class performs the following jobs: * * - Cache DOM reads to avoid reading the same values repeatedly. * - Buffer DOM writes and flush them as a block to avoid read/write interleaving. * - Track layout dependencies so each layout does not have to figure out the source of * its dependent values. * - Intelligently run layouts when the values on which they depend change (a trigger). * - Allow layouts to avoid processing when required values are unavailable (a block). * * Work done during layout falls into either a "read phase" or a "write phase" and it is * essential to always be aware of the current phase. Most methods in * {@link Ext.layout.Layout Layout} are called during a read phase: * {@link Ext.layout.Layout#calculate calculate}, * {@link Ext.layout.Layout#completeLayout completeLayout} and * {@link Ext.layout.Layout#finalizeLayout finalizeLayout}. The exceptions to this are * {@link Ext.layout.Layout#beginLayout beginLayout}, * {@link Ext.layout.Layout#beginLayoutCycle beginLayoutCycle} and * {@link Ext.layout.Layout#finishedLayout finishedLayout} which are called during * a write phase. While {@link Ext.layout.Layout#finishedLayout finishedLayout} is called * a write phase, it is really intended to be a catch-all for post-processing after a * layout run. * * In a read phase, it is OK to read the DOM but this should be done using the appropriate * {@link Ext.layout.ContextItem ContextItem} where possible since that provides a cache * to avoid redundant reads. No writes should be made to the DOM in a read phase! Instead, * the values should be written to the proper ContextItem for later write-back. * * The rules flip-flop in a write phase. The only difference is that ContextItem methods * like {@link Ext.layout.ContextItem#getStyle getStyle} will still read the DOM unless the * value was previously read. This detail is unknowable from the outside of ContextItem, so * read calls to ContextItem should also be avoided in a write phase. * * Calculating interdependent layouts requires a certain amount of iteration. In a given * cycle, some layouts will contribute results that allow other layouts to proceed. The * general flow then is to gather all of the layouts (both component and container) in a * component tree and queue them all for processing. The initial queue order is bottom-up * and component layout first, then container layout (if applicable) for each component. * * This initial step also calls the beginLayout method on all layouts to clear any values * from the DOM that might interfere with calculations and measurements. In other words, * this is a "write phase" and reads from the DOM should be strictly avoided. * * Next the layout enters into its iterations or "cycles". Each cycle consists of calling * the {@link Ext.layout.Layout#calculate calculate} method on all layouts in the * {@link #layoutQueue}. These calls are part of a "read phase" and writes to the DOM should * be strictly avoided. * * # Considerations * * **RULE 1**: Respect the read/write cycles. Always use the {@link Ext.layout.ContextItem#getProp getProp} * or {@link Ext.layout.ContextItem#getDomProp getDomProp} methods to get calculated values; * only use the {@link Ext.layout.ContextItem#getStyle getStyle} method to read styles; use * {@link Ext.layout.ContextItem#setProp setProp} to set DOM values. Some reads will, of * course, still go directly to the DOM, but if there is a method in * {@link Ext.layout.ContextItem ContextItem} to do a certain job, it should be used instead * of a lower-level equivalent. * * The basic logic flow in {@link Ext.layout.Layout#calculate calculate} consists of gathering * values by calling {@link Ext.layout.ContextItem#getProp getProp} or * {@link Ext.layout.ContextItem#getDomProp getDomProp}, calculating results and publishing * them by calling {@link Ext.layout.ContextItem#setProp setProp}. It is important to realize * that {@link Ext.layout.ContextItem#getProp getProp} will return `undefined` if the value * is not yet known. But the act of calling the method is enough to track the fact that the * calling layout depends (in some way) on this value. In other words, the calling layout is * "triggered" by the properties it requests. * * **RULE 2**: Avoid calling {@link Ext.layout.ContextItem#getProp getProp} unless the value * is needed. Gratuitous calls cause inefficiency because the layout will appear to depend on * values that it never actually uses. This applies equally to * {@link Ext.layout.ContextItem#getDomProp getDomProp} and the test-only methods * {@link Ext.layout.ContextItem#hasProp hasProp} and {@link Ext.layout.ContextItem#hasDomProp hasDomProp}. * * Because {@link Ext.layout.ContextItem#getProp getProp} can return `undefined`, it is often * the case that subsequent math will produce NaN's. This is usually not a problem as the * NaN's simply propagate along and result in final results that are NaN. Both `undefined` * and NaN are ignored by {@link Ext.layout.ContextItem#setProp}, so it is often not necessary * to even know that this is happening. It does become important for determining if a layout * is not done or if it might lead to publishing an incorrect (but not NaN or `undefined`) * value. * * **RULE 3**: If a layout has not calculated all the values it is required to calculate, it * must set {@link Ext.layout.Layout#done done} to `false` before returning from * {@link Ext.layout.Layout#calculate calculate}. This value is always `true` on entry because * it is simpler to detect the incomplete state rather than the complete state (especially up * and down a class hierarchy). * * **RULE 4**: A layout must never publish an incomplete (wrong) result. Doing so would cause * dependent layouts to run their calculations on those wrong values, producing more wrong * values and some layouts may even incorrectly flag themselves as {@link Ext.layout.Layout#done done} * before the correct values are determined and republished. Doing this will poison the * calculations. * * **RULE 5**: Each value should only be published by one layout. If multiple layouts attempt * to publish the same values, it would be nearly impossible to avoid breaking **RULE 4**. To * help detect this problem, the layout diagnostics will trap on an attempt to set a value * from different layouts. * * Complex layouts can produce many results as part of their calculations. These values are * important for other layouts to proceed and need to be published by the earliest possible * call to {@link Ext.layout.Layout#calculate} to avoid unnecessary cycles and poor performance. It is * also possible, however, for some results to be related in a way such that publishing them * may be an all-or-none proposition (typically to avoid breaking *RULE 4*). * * **RULE 6**: Publish results as soon as they are known to be correct rather than wait for * all values to be calculated. Waiting for everything to be complete can lead to deadlock. * The key here is not to forget **RULE 4** in the process. * * Some layouts depend on certain critical values as part of their calculations. For example, * HBox depends on width and cannot do anything until the width is known. In these cases, it * is best to use {@link Ext.layout.ContextItem#block block} or * {@link Ext.layout.ContextItem#domBlock domBlock} and thereby avoid processing the layout * until the needed value is available. * * **RULE 7**: Use {@link Ext.layout.ContextItem#block block} or * {@link Ext.layout.ContextItem#domBlock domBlock} when values are required to make progress. * This will mimize wasted recalculations. * * **RULE 8**: Blocks should only be used when no forward progress can be made. If even one * value could still be calculated, a block could result in a deadlock. * * Historically, layouts have been invoked directly by component code, sometimes in places * like an `afterLayout` method for a child component. With the flexibility now available * to solve complex, iterative issues, such things should be done in a responsible layout * (be it component or container). * * **RULE 9**: Use layouts to solve layout issues and don't wait for the layout to finish to * perform further layouts. This is especially important now that layouts process entire * component trees and not each layout in isolation. * * # Sequence Diagram * * The simplest sequence diagram for a layout run looks roughly like this: * * Context Layout 1 Item 1 Layout 2 Item 2 * | | | | | * ---->X-------------->X | | | * run X---------------|-----------|---------->X | * X beginLayout | | | | * X | | | | * A X-------------->X | | | * X calculate X---------->X | | * X C X getProp | | | * B X X---------->X | | * X | setProp | | | * X | | | | * D X---------------|-----------|---------->X | * X calculate | | X---------->X * X | | | setProp | * E X | | | | * X---------------|-----------|---------->X | * X completeLayout| | F | | * X | | | | * G X | | | | * H X-------------->X | | | * X calculate X---------->X | | * X I X getProp | | | * X X---------->X | | * X | setProp | | | * J X-------------->X | | | * X completeLayout| | | | * X | | | | * K X-------------->X | | | * X---------------|-----------|---------->X | * X finalizeLayout| | | | * X | | | | * L X-------------->X | | | * X---------------|-----------|---------->X | * X finishedLayout| | | | * X | | | | * M X-------------->X | | | * X---------------|-----------|---------->X | * X notifyOwner | | | | * N | | | | | * - - - - - * * * Notes: * * **A.** This is a call from the {@link #run} method to the {@link #runCycle} method. * Each layout in the queue will have its {@link Ext.layout.Layout#calculate calculate} * method called. * * **B.** After each {@link Ext.layout.Layout#calculate calculate} method is called the * {@link Ext.layout.Layout#done done} flag is checked to see if the Layout has completed. * If it has completed and that layout object implements a * {@link Ext.layout.Layout#completeLayout completeLayout} method, this layout is queued to * receive its call. Otherwise, the layout will be queued again unless there are blocks or * triggers that govern its requeueing. * * **C.** The call to {@link Ext.layout.ContextItem#getProp getProp} is made to the Item * and that will be tracked as a trigger (keyed by the name of the property being requested). * Changes to this property will cause this layout to be requeued. The call to * {@link Ext.layout.ContextItem#setProp setProp} will place a value in the item and not * directly into the DOM. * * **D.** Call the other layouts now in the first cycle (repeat **B** and **C** for each * layout). * * **E.** After completing a cycle, if progress was made (new properties were written to * the context) and if the {@link #layoutQueue} is not empty, the next cycle is run. If no * progress was made or no layouts are ready to run, all buffered values are written to * the DOM (a flush). * * **F.** After flushing, any layouts that were marked as {@link Ext.layout.Layout#done done} * that also have a {@link Ext.layout.Layout#completeLayout completeLayout} method are called. * This can cause them to become no longer done (see {@link #invalidate}). As with * {@link Ext.layout.Layout#calculate calculate}, this is considered a "read phase" and * direct DOM writes should be avoided. * * **G.** Flushing and calling any pending {@link Ext.layout.Layout#completeLayout completeLayout} * methods will likely trigger layouts that called {@link Ext.layout.ContextItem#getDomProp getDomProp} * and unblock layouts that have called {@link Ext.layout.ContextItem#domBlock domBlock}. * These variants are used when a layout needs the value to be correct in the DOM and not * simply known. If this does not cause at least one layout to enter the queue, we have a * layout FAILURE. Otherwise, we continue with the next cycle. * * **H.** Call {@link Ext.layout.Layout#calculate calculate} on any layouts in the queue * at the start of this cycle. Just a repeat of **B** through **G**. * * **I.** Once the layout has calculated all that it is resposible for, it can leave itself * in the {@link Ext.layout.Layout#done done} state. This is the value on entry to * {@link Ext.layout.Layout#calculate calculate} and must be cleared in that call if the * layout has more work to do. * * **J.** Now that all layouts are done, flush any DOM values and * {@link Ext.layout.Layout#completeLayout completeLayout} calls. This can again cause * layouts to become not done, and so we will be back on another cycle if that happens. * * **K.** After all layouts are done, call the {@link Ext.layout.Layout#finalizeLayout finalizeLayout} * method on any layouts that have one. As with {@link Ext.layout.Layout#completeLayout completeLayout}, * this can cause layouts to become no longer done. This is less desirable than using * {@link Ext.layout.Layout#completeLayout completeLayout} because it will cause all * {@link Ext.layout.Layout#finalizeLayout finalizeLayout} methods to be called again * when we think things are all wrapped up. * * **L.** After finishing the last iteration, layouts that have a * {@link Ext.layout.Layout#finishedLayout finishedLayout} method will be called. This * call will only happen once per run and cannot cause layouts to be run further. * * **M.** After calling finahedLayout, layouts that have a * {@link Ext.layout.Layout#notifyOwner notifyOwner} method will be called. This * call will only happen once per run and cannot cause layouts to be run further. * * **N.** One last flush to make sure everything has been written to the DOM. * * # Inter-Layout Collaboration * * Many layout problems require collaboration between multiple layouts. In some cases, this * is as simple as a component's container layout providing results used by its component * layout or vise-versa. A slightly more distant collaboration occurs in a box layout when * stretchmax is used: the child item's component layout provides results that are consumed * by the ownerCt's box layout to determine the size of the children. * * The various forms of interdependence between a container and its children are described by * each components' {@link Ext.AbstractComponent#getSizeModel size model}. * * To facilitate this collaboration, the following pairs of properties are published to the * component's {@link Ext.layout.ContextItem ContextItem}: * * - width/height: These hold the final size of the component. The layout indicated by the * {@link Ext.AbstractComponent#getSizeModel size model} is responsible for setting these. * - contentWidth/contentHeight: These hold size information published by the container * layout or from DOM measurement. These describe the content only. These values are * used by the component layout to determine the outer width/height when that component * is {@link Ext.AbstractComponent#shrinkWrap shrink-wrapped}. They are also used to * determine overflow. All container layouts must publish these values for dimensions * that are shrink-wrapped. If a component has raw content (not container items), the * componentLayout must publish these values instead. * * @private */ Ext.define('Ext.layout.Context', { remainingLayouts: 0, /** * @property {Number} state One of these values: * * - 0 - Before run * - 1 - Running * - 2 - Run complete */ state: 0, constructor: function (config) { var me = this; Ext.apply(me, config); // holds the ContextItem collection, keyed by element id me.items = {}; // a collection of layouts keyed by layout id me.layouts = {}; // the number of blocks of any kind: me.blockCount = 0; // the number of cycles that have been run: me.cycleCount = 0; // the number of flushes to the DOM: me.flushCount = 0; // the number of layout calculate calls: me.calcCount = 0; me.animateQueue = me.newQueue(); me.completionQueue = me.newQueue(); me.finalizeQueue = me.newQueue(); me.finishQueue = me.newQueue(); me.flushQueue = me.newQueue(); me.invalidateData = {}; /** * @property {Ext.util.Queue} layoutQueue * List of layouts to perform. */ me.layoutQueue = me.newQueue(); // this collection is special because we ensure that there are no parent/child pairs // present, only distinct top-level components me.invalidQueue = []; me.triggers = { data: { /* layoutId: [ { item: contextItem, prop: propertyName } ] */ }, dom: {} }; }, callLayout: function (layout, methodName) { this.currentLayout = layout; layout[methodName](this.getCmp(layout.owner)); }, cancelComponent: function (comp, isChild, isDestroying) { var me = this, components = comp, isArray = !comp.isComponent, length = isArray ? components.length : 1, i, k, klen, items, layout, newQueue, oldQueue, entry, temp, ownerCtContext; for (i = 0; i < length; ++i) { if (isArray) { comp = components[i]; } // If the component is being destroyed, remove the component's ContextItem from its parent's contextItem.childItems array if (isDestroying && comp.ownerCt) { ownerCtContext = this.items[comp.ownerCt.el.id]; if (ownerCtContext) { Ext.Array.remove(ownerCtContext.childItems, me.getCmp(comp)); } } if (!isChild) { oldQueue = me.invalidQueue; klen = oldQueue.length; if (klen) { me.invalidQueue = newQueue = []; for (k = 0; k < klen; ++k) { entry = oldQueue[k]; temp = entry.item.target; if (temp != comp && !temp.isDescendant(comp)) { newQueue.push(entry); } } } } layout = comp.componentLayout; me.cancelLayout(layout); if (layout.getLayoutItems) { items = layout.getLayoutItems(); if (items.length) { me.cancelComponent(items, true); } } if (comp.isContainer && !comp.collapsed) { layout = comp.layout; me.cancelLayout(layout); items = layout.getVisibleItems(); if (items.length) { me.cancelComponent(items, true); } } } }, cancelLayout: function (layout) { var me = this; me.completionQueue.remove(layout); me.finalizeQueue.remove(layout); me.finishQueue.remove(layout); me.layoutQueue.remove(layout); if (layout.running) { me.layoutDone(layout); } layout.ownerContext = null; }, clearTriggers: function (layout, inDom) { var id = layout.id, collection = this.triggers[inDom ? 'dom' : 'data'], triggers = collection && collection[id], length = (triggers && triggers.length) || 0, i, item, trigger; for (i = 0; i < length; ++i) { trigger = triggers[i]; item = trigger.item; collection = inDom ? item.domTriggers : item.triggers; delete collection[trigger.prop][id]; } }, /** * Flushes any pending writes to the DOM by calling each ContextItem in the flushQueue. */ flush: function () { var me = this, items = me.flushQueue.clear(), length = items.length, i; if (length) { ++me.flushCount; for (i = 0; i < length; ++i) { items[i].flush(); } } }, flushAnimations: function() { var me = this, items = me.animateQueue.clear(), len = items.length, i; if (len) { for (i = 0; i < len; i++) { // Each Component may refuse to participate in animations. // This is used by the BoxReorder plugin which drags a Component, // during which that Component must be exempted from layout positioning. if (items[i].target.animate !== false) { items[i].flushAnimations(); } } // Ensure the first frame fires now to avoid a browser repaint with the elements in the "to" state // before they are returned to their "from" state by the animation. Ext.fx.Manager.runner(); } }, flushInvalidates: function () { var me = this, queue = me.invalidQueue, length = queue && queue.length, comp, components, entry, i; me.invalidQueue = []; if (length) { components = []; for (i = 0; i < length; ++i) { comp = (entry = queue[i]).item.target; // we filter out-of-body components here but allow them into the queue to // ensure that their child components are coalesced out (w/no additional // cost beyond our normal effort to avoid parent/child components in the // queue) if (!comp.container.isDetachedBody) { components.push(comp); if (entry.options) { me.invalidateData[comp.id] = entry.options; } } } me.invalidate(components, null); } }, flushLayouts: function (queueName, methodName, dontClear) { var me = this, layouts = dontClear ? me[queueName].items : me[queueName].clear(), length = layouts.length, i, layout; if (length) { for (i = 0; i < length; ++i) { layout = layouts[i]; if (!layout.running) { me.callLayout(layout, methodName); } } me.currentLayout = null; } }, /** * Returns the ContextItem for a component. * @param {Ext.Component} cmp */ getCmp: function (cmp) { return this.getItem(cmp, cmp.el); }, /** * Returns the ContextItem for an element. * @param {Ext.layout.ContextItem} parent * @param {Ext.dom.Element} el */ getEl: function (parent, el) { var item = this.getItem(el, el); if (!item.parent) { item.parent = parent; // all items share an empty children array (to avoid null checks), so we can // only push on to the children array if there is already something there (we // copy-on-write): if (parent.children.length) { parent.children.push(item); } else { parent.children = [ item ]; // now parent has its own children[] (length=1) } } return item; }, getItem: function (target, el) { var id = el.id, items = this.items, item = items[id] || (items[id] = new Ext.layout.ContextItem({ context: this, target: target, el: el })); return item; }, handleFailure: function () { // This method should never be called, but is need when layouts fail (hence the // "should never"). We just disconnect any of the layouts from the run and return // them to the state they would be in had the layout completed properly. var layouts = this.layouts, layout, key; Ext.failedLayouts = (Ext.failedLayouts || 0) + 1; for (key in layouts) { layout = layouts[key]; if (layouts.hasOwnProperty(key)) { layout.running = false; layout.ownerContext = null; } } if (Ext.repoDevMode && !this.pageAnalyzerMode) { Ext.Error.raise('Layout run failed'); } else { Ext.log.error('Layout run failed'); } }, /** * Invalidates one or more components' layouts (component and container). This can be * called before run to identify the components that need layout or during the run to * restart the layout of a component. This is called internally to flush any queued * invalidations at the start of a cycle. If called during a run, it is not expected * that new components will be introduced to the layout. * * @param {Ext.Component/Array} components An array of Components or a single Component. * @param {Boolean} full True if all properties should be invalidated, otherwise only * those calculated by the component should be invalidated. */ invalidate: function (components, full) { var me = this, isArray = !components.isComponent, containerLayoutDone, firstTime, i, comp, item, items, length, componentLayout, layout, invalidateOptions, token; for (i = 0, length = isArray ? components.length : 1; i < length; ++i) { comp = isArray ? components[i] : components; if (comp.rendered && !comp.hidden) { item = me.getCmp(comp); // Layout optimizations had to be disabled because they break // Dock layout behavior. // if (item.optOut) { // continue; // } componentLayout = comp.componentLayout; firstTime = !componentLayout.ownerContext; layout = (comp.isContainer && !comp.collapsed) ? comp.layout : null; // Extract any invalidate() options for this item. invalidateOptions = me.invalidateData[item.id]; delete me.invalidateData[item.id]; // We invalidate the contextItem's in a top-down manner so that SizeModel // info for containers is available to their children. This is a critical // optimization since sizeModel determination often requires knowing the // sizeModel of the ownerCt. If this weren't cached as we descend, this // would be an O(N^2) operation! (where N=number of components, or 300+/- // in Themes) token = item.init(full, invalidateOptions); if (invalidateOptions) { me.processInvalidate(invalidateOptions, item, 'before'); } // Allow the component layout a chance to effect its size model before we // recurse down the component hierarchy (since children need to know the // size model of their ownerCt). if (componentLayout.beforeLayoutCycle) { componentLayout.beforeLayoutCycle(item); } if (layout && layout.beforeLayoutCycle) { // allow the container layout take a peek as well. Table layout can // influence its children's styling due to the interaction of nesting // table-layout:fixed and auto inside each other without intervening // elements of known size. layout.beforeLayoutCycle(item); } // Finish up the item-level processing that is based on the size model of // the component. token = item.initContinue(token); // Start this state variable at true, since that is the value we want if // they do not apply (i.e., no work of this kind on which to wait). containerLayoutDone = true; // A ComponentLayout MUST implement getLayoutItems to allow its children // to be collected. Ext.container.Container does this, but non-Container // Components which manage Components as part of their structure (e.g., // HtmlEditor) must still return child Components via getLayoutItems. if (componentLayout.getLayoutItems) { componentLayout.renderChildren(); items = componentLayout.getLayoutItems(); if (items.length) { me.invalidate(items, true); } } if (layout) { containerLayoutDone = false; layout.renderChildren(); items = layout.getVisibleItems(); if (items.length) { me.invalidate(items, true); } } // Finish the processing that requires the size models of child items to // be determined (and some misc other stuff). item.initDone(containerLayoutDone); // Inform the layouts that we are about to begin (or begin again) now that // the size models of the component and its children are setup. me.resetLayout(componentLayout, item, firstTime); if (layout) { me.resetLayout(layout, item, firstTime); } // This has to occur after the component layout has had a chance to begin // so that we can determine what kind of animation might be needed. TODO- // move this determination into the layout itself. item.initAnimation(); if (invalidateOptions) { me.processInvalidate(invalidateOptions, item, 'after'); } } } me.currentLayout = null; }, layoutDone: function (layout) { var ownerContext = layout.ownerContext; layout.running = false; // Once a component layout completes, we can mark it as "done". if (layout.isComponentLayout) { if (ownerContext.measuresBox) { ownerContext.onBoxMeasured(); // be sure to release our boxParent } ownerContext.setProp('done', true); } else { ownerContext.setProp('containerLayoutDone', true); } --this.remainingLayouts; ++this.progressCount; // a layout completion is progress }, newQueue: function () { return new Ext.util.Queue(); }, processInvalidate: function (options, item, name) { // When calling a callback, the currentLayout needs to be adjusted so // that whichever layout caused the invalidate is the currentLayout... if (options[name]) { var me = this, currentLayout = me.currentLayout; me.currentLayout = options.layout || null; options[name](item, options); me.currentLayout = currentLayout; } }, /** * Queues a ContextItem to have its {@link Ext.layout.ContextItem#flushAnimations} method called. * * @param {Ext.layout.ContextItem} item * @private */ queueAnimation: function (item) { this.animateQueue.add(item); }, /** * Queues a layout to have its {@link Ext.layout.Layout#completeLayout} method called. * * @param {Ext.layout.Layout} layout * @private */ queueCompletion: function (layout) { this.completionQueue.add(layout); }, /** * Queues a layout to have its {@link Ext.layout.Layout#finalizeLayout} method called. * * @param {Ext.layout.Layout} layout * @private */ queueFinalize: function (layout) { this.finalizeQueue.add(layout); }, /** * Queues a ContextItem for the next flush to the DOM. This should only be called by * the {@link Ext.layout.ContextItem} class. * * @param {Ext.layout.ContextItem} item * @private */ queueFlush: function (item) { this.flushQueue.add(item); }, chainFns: function (oldOptions, newOptions, funcName) { var me = this, oldLayout = oldOptions.layout, newLayout = newOptions.layout, oldFn = oldOptions[funcName], newFn = newOptions[funcName]; // Call newFn last so it can get the final word on things... also, the "this" // pointer will be passed correctly by createSequence with oldFn first. return function (contextItem) { var prev = me.currentLayout; if (oldFn) { me.currentLayout = oldLayout; oldFn.call(oldOptions.scope || oldOptions, contextItem, oldOptions); } me.currentLayout = newLayout; newFn.call(newOptions.scope || newOptions, contextItem, newOptions); me.currentLayout = prev; }; }, /** * Queue a component (and its tree) to be invalidated on the next cycle. * * @param {Ext.Component/Ext.layout.ContextItem} item The component or ContextItem to invalidate. * @param {Object} options An object describing how to handle the invalidation (see * {@link Ext.layout.ContextItem#invalidate} for details). * @private */ queueInvalidate: function (item, options) { var me = this, newQueue = [], oldQueue = me.invalidQueue, index = oldQueue.length, comp, old, oldComp, oldOptions, oldState; if (item.isComponent) { item = me.getCmp(comp = item); } else { comp = item.target; } item.invalid = true; // See if comp is contained by any component already in the queue (ignore comp if // that is the case). Eliminate any components in the queue that are contained by // comp (by not adding them to newQueue). while (index--) { old = oldQueue[index]; oldComp = old.item.target; if (comp.isDescendant(oldComp)) { return; // oldComp contains comp, so this invalidate is redundant } if (oldComp == comp) { // if already in the queue, update the options... if (!(oldOptions = old.options)) { old.options = options; } else if (options) { if (options.widthModel) { oldOptions.widthModel = options.widthModel; } if (options.heightModel) { oldOptions.heightModel = options.heightModel; } if (!(oldState = oldOptions.state)) { oldOptions.state = options.state; } else if (options.state) { Ext.apply(oldState, options.state); } if (options.before) { oldOptions.before = me.chainFns(oldOptions, options, 'before'); } if (options.after) { oldOptions.after = me.chainFns(oldOptions, options, 'after'); } } // leave the old queue alone now that we've update this comp's entry... return; } if (!oldComp.isDescendant(comp)) { newQueue.push(old); // comp does not contain oldComp } // else if (oldComp isDescendant of comp) skip } // newQueue contains only those components not a descendant of comp // to get here, comp must not be a child of anything already in the queue, so it // needs to be added along with its "options": newQueue.push({ item: item, options: options }); me.invalidQueue = newQueue; }, queueItemLayouts: function (item) { var comp = item.isComponent ? item : item.target, layout = comp.componentLayout; if (!layout.pending && !layout.invalid && !layout.done) { this.queueLayout(layout); } layout = comp.layout; if (layout && !layout.pending && !layout.invalid && !layout.done) { this.queueLayout(layout); } }, /** * Queues a layout for the next calculation cycle. This should not be called if the * layout is done, blocked or already in the queue. The only classes that should call * this method are this class and {@link Ext.layout.ContextItem}. * * @param {Ext.layout.Layout} layout The layout to add to the queue. * @private */ queueLayout: function (layout) { this.layoutQueue.add(layout); layout.pending = true; }, /** * Removes the ContextItem for an element from the cache and from the parent's * "children" array. * @param {Ext.layout.ContextItem} parent * @param {Ext.dom.Element} el */ removeEl: function (parent, el) { var id = el.id, children = parent.children, items = this.items; if(children) { Ext.Array.remove(children, items[id]); } delete items[id]; }, /** * Resets the given layout object. This is called at the start of the run and can also * be called during the run by calling {@link #invalidate}. */ resetLayout: function (layout, ownerContext, firstTime) { var me = this; me.currentLayout = layout; layout.done = false; layout.pending = true; layout.firedTriggers = 0; me.layoutQueue.add(layout); if (firstTime) { me.layouts[layout.id] = layout; // track the layout for this run by its id layout.running = true; if (layout.finishedLayout) { me.finishQueue.add(layout); } // reset or update per-run counters: ++me.remainingLayouts; ++layout.layoutCount; // the number of whole layouts run for the layout layout.ownerContext = ownerContext; layout.beginCount = 0; // the number of beginLayout calls layout.blockCount = 0; // the number of blocks set for the layout layout.calcCount = 0; // the number of times calculate is called layout.triggerCount = 0; // the number of triggers set for the layout if (!layout.initialized) { layout.initLayout(); } layout.beginLayout(ownerContext); } else { ++layout.beginCount; if (!layout.running) { // back into the mahem with this one: ++me.remainingLayouts; layout.running = true; if (layout.isComponentLayout) { // this one is fun... if we call setProp('done', false) that would still // trigger/unblock layouts, but what layouts are really looking for with // this property is for it to go to true, not just be set to a value... ownerContext.unsetProp('done'); } // and it needs to be removed from the completion and/or finalize queues... me.completionQueue.remove(layout); me.finalizeQueue.remove(layout); } } layout.beginLayoutCycle(ownerContext, firstTime); }, /** * Runs the layout calculations. This can be called only once on this object. * @return {Boolean} True if all layouts were completed, false if not. */ run: function () { var me = this, flushed = false, watchDog = 100; me.flushInvalidates(); me.state = 1; me.totalCount = me.layoutQueue.getCount(); // We may start with unflushed data placed by beginLayout calls. Since layouts may // use setProp as a convenience, even in a write phase, we don't want to transition // to a read phase with unflushed data since we can write it now "cheaply". Also, // these value could easily be needed in the DOM in order to really get going with // the calculations. In particular, fixed (configured) dimensions fall into this // category. me.flush(); // While we have layouts that have not completed... while ((me.remainingLayouts || me.invalidQueue.length) && watchDog--) { if (me.invalidQueue.length) { me.flushInvalidates(); } // if any of them can run right now, run them if (me.runCycle()) { flushed = false; // progress means we probably need to flush something // but not all progress appears in the flushQueue (e.g. 'contentHeight') } else if (!flushed) { // as long as we are making progress, flush updates to the DOM and see if // that triggers or unblocks any layouts... me.flush(); flushed = true; // all flushed now, so more progress is required me.flushLayouts('completionQueue', 'completeLayout'); } else if (!me.invalidQueue.length) { // after a flush, we must make progress or something is WRONG me.state = 2; break; } if (!(me.remainingLayouts || me.invalidQueue.length)) { me.flush(); me.flushLayouts('completionQueue', 'completeLayout'); me.flushLayouts('finalizeQueue', 'finalizeLayout'); } } return me.runComplete(); }, runComplete: function () { var me = this; me.state = 2; if (me.remainingLayouts) { me.handleFailure(); return false; } me.flush(); // Call finishedLayout on all layouts, but do not clear the queue. me.flushLayouts('finishQueue', 'finishedLayout', true); // Call notifyOwner on all layouts and then clear the queue. me.flushLayouts('finishQueue', 'notifyOwner'); me.flush(); // in case any setProp calls were made me.flushAnimations(); return true; }, /** * Performs one layout cycle by calling each layout in the layout queue. * @return {Boolean} True if some progress was made, false if not. * @protected */ runCycle: function () { var me = this, layouts = me.layoutQueue.clear(), length = layouts.length, i; ++me.cycleCount; // This value is incremented by ContextItem#setProp whenever new values are set // (thereby detecting forward progress): me.progressCount = 0; for (i = 0; i < length; ++i) { me.runLayout(me.currentLayout = layouts[i]); } me.currentLayout = null; return me.progressCount > 0; }, /** * Runs one layout as part of a cycle. * @private */ runLayout: function (layout) { var me = this, ownerContext = me.getCmp(layout.owner); layout.pending = false; if (ownerContext.state.blocks) { return; } // We start with the assumption that the layout will finish and if it does not, it // must clear this flag. It turns out this is much simpler than knowing when a layout // is done (100% correctly) when base classes and derived classes are collaborating. // Knowing that some part of the layout is not done is much more obvious. layout.done = true; ++layout.calcCount; ++me.calcCount; layout.calculate(ownerContext); if (layout.done) { me.layoutDone(layout); if (layout.completeLayout) { me.queueCompletion(layout); } if (layout.finalizeLayout) { me.queueFinalize(layout); } } else if (!layout.pending && !layout.invalid && !(layout.blockCount + layout.triggerCount - layout.firedTriggers)) { // A layout that is not done and has no blocks or triggers that will queue it // automatically, must be queued now: me.queueLayout(layout); } }, /** * Set the size of a component, element or composite or an array of components or elements. * @param {Ext.Component/Ext.Component[]/Ext.dom.Element/Ext.dom.Element[]/Ext.dom.CompositeElement} items * The item(s) to size. * @param {Number} width The new width to set (ignored if undefined or NaN). * @param {Number} height The new height to set (ignored if undefined or NaN). */ setItemSize: function(item, width, height) { var items = item, len = 1, contextItem, i; // NOTE: we don't pre-check for validity because: // - maybe only one dimension is valid // - the diagnostics layer will track the setProp call to help find who is trying // (but failing) to set a property // - setProp already checks this anyway if (item.isComposite) { items = item.elements; len = items.length; item = items[0]; } else if (!item.dom && !item.el) { // array by process of elimination len = items.length; item = items[0]; } // else len = 1 and items = item (to avoid error on "items[++i]") for (i = 0; i < len; ) { contextItem = this.get(item); contextItem.setSize(width, height); item = items[++i]; // this accomodation avoids making an array of 1 } } }); // @define Ext.layout.SizePolicy /** * This class describes how a layout will interact with a component it manages. * * There are special instances of this class stored as static properties to avoid object * instantiation. All instances of this class should be treated as readonly objects. * * @class Ext.layout.SizePolicy * @protected */ /** * @property {Boolean} readsWidth * Indicates that the `width` of the component is consumed. * @readonly */ /** * @property {Boolean} readsHeight * Indicates that the `height` of the component is consumed. * @readonly */ /** * @property {Boolean} setsWidth * Indicates that the `width` of the component will be set (i.e., calculated). * @readonly */ /** * @property {Boolean} setsHeight * Indicates that the `height` of the component will be set (i.e., calculated). * @readonly */ /** * Component layout for components which maintain an inner body element which must be resized to synchronize with the * Component size. * @private */ Ext.define('Ext.layout.component.Body', { /* Begin Definitions */ alias: ['layout.body'], extend: Ext.layout.component.Auto , /* End Definitions */ type: 'body', beginLayout: function (ownerContext) { this.callParent(arguments); ownerContext.bodyContext = ownerContext.getEl('body'); }, beginLayoutCycle: function(ownerContext, firstCycle){ var me = this, lastWidthModel = me.lastWidthModel, lastHeightModel = me.lastHeightModel, body = me.owner.body; me.callParent(arguments); if (lastWidthModel && lastWidthModel.fixed && ownerContext.widthModel.shrinkWrap) { body.setWidth(null); } if (lastHeightModel && lastHeightModel.fixed && ownerContext.heightModel.shrinkWrap) { body.setHeight(null); } }, // Padding is exciting here because we have 2 el's: owner.el and owner.body. Content // size always includes the padding of the targetEl, which should be owner.body. But // it is common to have padding on owner.el also (such as a panel header), so we need // to do some more padding work if targetContext is not owner.el. The base class has // already handled the ownerContext's frameInfo (border+framing) so all that is left // is padding. calculateOwnerHeightFromContentHeight: function (ownerContext, contentHeight) { var height = this.callParent(arguments); if (ownerContext.targetContext != ownerContext) { height += ownerContext.getPaddingInfo().height; } return height; }, calculateOwnerWidthFromContentWidth: function (ownerContext, contentWidth) { var width = this.callParent(arguments); if (ownerContext.targetContext != ownerContext) { width += ownerContext.getPaddingInfo().width; } return width; }, measureContentWidth: function (ownerContext) { return ownerContext.bodyContext.setWidth(ownerContext.bodyContext.el.dom.offsetWidth, false); }, measureContentHeight: function (ownerContext) { return ownerContext.bodyContext.setHeight(ownerContext.bodyContext.el.dom.offsetHeight, false); }, publishInnerHeight: function (ownerContext, height) { var innerHeight = height - ownerContext.getFrameInfo().height, targetContext = ownerContext.targetContext; if (targetContext != ownerContext) { innerHeight -= ownerContext.getPaddingInfo().height; } // return the value here, it may get used in a subclass return ownerContext.bodyContext.setHeight(innerHeight, !ownerContext.heightModel.natural); }, publishInnerWidth: function (ownerContext, width) { var innerWidth = width - ownerContext.getFrameInfo().width, targetContext = ownerContext.targetContext; if (targetContext != ownerContext) { innerWidth -= ownerContext.getPaddingInfo().width; } ownerContext.bodyContext.setWidth(innerWidth, !ownerContext.widthModel.natural); } }); /** * Component layout for Ext.form.FieldSet components * @private */ Ext.define('Ext.layout.component.FieldSet', { extend: Ext.layout.component.Body , alias: ['layout.fieldset'], type: 'fieldset', defaultCollapsedWidth: 100, beforeLayoutCycle: function (ownerContext) { if (ownerContext.target.collapsed) { ownerContext.heightModel = this.sizeModels.shrinkWrap; } }, beginLayoutCycle: function (ownerContext) { var target = ownerContext.target, lastSize; this.callParent(arguments); // Each time we begin (2nd+ would be due to invalidate) we need to publish the // known contentHeight if we are collapsed: // if (target.collapsed) { ownerContext.setContentHeight(0); // if we're collapsed, ignore a minHeight because it's likely going to // be greater than the collapsed height ownerContext.restoreMinHeight = target.minHeight; delete target.minHeight; // If we are also shrinkWrap width, we must provide a contentWidth (since the // container layout is not going to run). // if (ownerContext.widthModel.shrinkWrap) { lastSize = target.lastComponentSize; ownerContext.setContentWidth((lastSize && lastSize.contentWidth) || this.defaultCollapsedWidth); } } }, finishedLayout: function(ownerContext) { var owner = this.owner, restore = ownerContext.restoreMinHeight; this.callParent(arguments); if (restore) { owner.minHeight = restore; } }, calculateOwnerHeightFromContentHeight: function (ownerContext, contentHeight) { var border = ownerContext.getBorderInfo(), legend = ownerContext.target.legend; // Height of fieldset is content height plus top border width (which is either the // legend height or top border width) plus bottom border width return ownerContext.getProp('contentHeight') + ownerContext.getPaddingInfo().height + // In IE8m and IEquirks the top padding is on the body el ((Ext.isIEQuirks || Ext.isIE8m) ? ownerContext.bodyContext.getPaddingInfo().top : 0) + (legend ? legend.getHeight() : border.top) + border.bottom; }, publishInnerHeight: function (ownerContext, height) { // Subtract the legend off here and pass it up to the body // We do this because we don't want to set an incorrect body height // and then setting it again with the correct value var legend = ownerContext.target.legend; if (legend) { height -= legend.getHeight(); } this.callParent([ownerContext, height]); }, getLayoutItems : function() { var legend = this.owner.legend; return legend ? [legend] : []; } }); /** * @private */ Ext.define('Ext.layout.component.field.Slider', { /* Begin Definitions */ alias: ['layout.sliderfield'], extend: Ext.layout.component.field.Field , /* End Definitions */ type: 'sliderfield', beginLayout: function(ownerContext) { this.callParent(arguments); ownerContext.endElContext = ownerContext.getEl('endEl'); ownerContext.innerElContext = ownerContext.getEl('innerEl'); ownerContext.bodyElContext = ownerContext.getEl('bodyEl'); }, publishInnerHeight: function (ownerContext, height) { var innerHeight = height - this.measureLabelErrorHeight(ownerContext), endElPad, inputPad; if (this.owner.vertical) { endElPad = ownerContext.endElContext.getPaddingInfo(); inputPad = ownerContext.inputContext.getPaddingInfo(); ownerContext.innerElContext.setHeight(innerHeight - inputPad.height - endElPad.height); } else { ownerContext.bodyElContext.setHeight(innerHeight); } }, publishInnerWidth: function (ownerContext, width) { if (!this.owner.vertical) { var endElPad = ownerContext.endElContext.getPaddingInfo(), inputPad = ownerContext.inputContext.getPaddingInfo(); ownerContext.innerElContext.setWidth(width - inputPad.left - endElPad.right - ownerContext.labelContext.getProp('width')); } }, beginLayoutFixed: function(ownerContext, width, suffix) { var me = this, ieInputWidthAdjustment = me.ieInputWidthAdjustment; if (ieInputWidthAdjustment) { // adjust for IE 6/7 strict content-box model // RTL: This might have to be padding-left unless the senses of the padding styles switch when in RTL mode. me.owner.bodyEl.setStyle('padding-right', ieInputWidthAdjustment + 'px'); } me.callParent(arguments); } }); /** * This is a layout that inherits the anchoring of {@link Ext.layout.container.Anchor} and adds the * ability for x/y positioning using the standard x and y component config options. * * This class is intended to be extended or created via the {@link Ext.container.Container#layout layout} * configuration property. See {@link Ext.container.Container#layout} for additional details. * * @example * Ext.create('Ext.form.Panel', { * title: 'Absolute Layout', * width: 300, * height: 275, * layout: { * type: 'absolute' * // layout-specific configs go here * //itemCls: 'x-abs-layout-item', * }, * url:'save-form.php', * defaultType: 'textfield', * items: [{ * x: 10, * y: 10, * xtype:'label', * text: 'Send To:' * },{ * x: 80, * y: 10, * name: 'to', * anchor:'90%' // anchor width by percentage * },{ * x: 10, * y: 40, * xtype:'label', * text: 'Subject:' * },{ * x: 80, * y: 40, * name: 'subject', * anchor: '90%' // anchor width by percentage * },{ * x:0, * y: 80, * xtype: 'textareafield', * name: 'msg', * anchor: '100% 100%' // anchor width and height * }], * renderTo: Ext.getBody() * }); */ Ext.define('Ext.layout.container.Absolute', { /* Begin Definitions */ alias: 'layout.absolute', extend: Ext.layout.container.Anchor , alternateClassName: 'Ext.layout.AbsoluteLayout', /* End Definitions */ targetCls: Ext.baseCSSPrefix + 'abs-layout-ct', itemCls: Ext.baseCSSPrefix + 'abs-layout-item', /** * @cfg {Boolean} ignoreOnContentChange * True indicates that changes to one item in this layout do not effect the layout in * general. This may need to be set to false if {@link Ext.Component#autoScroll} * is enabled for the container. */ ignoreOnContentChange: true, type: 'absolute', // private adjustWidthAnchor: function(value, childContext) { var padding = this.targetPadding, x = childContext.getStyle('left'); return value - x + padding.left; }, // private adjustHeightAnchor: function(value, childContext) { var padding = this.targetPadding, y = childContext.getStyle('top'); return value - y + padding.top; }, isItemLayoutRoot: function (item) { return this.ignoreOnContentChange || this.callParent(arguments); }, isItemShrinkWrap: function (item) { return true; }, beginLayout: function (ownerContext) { var me = this, target = me.getTarget(); me.callParent(arguments); // Do not set position: relative; when the absolute layout target is the body if (target.dom !== document.body) { target.position(); } me.targetPadding = ownerContext.targetContext.getPaddingInfo(); }, isItemBoxParent: function (itemContext) { return true; }, onContentChange: function () { if (this.ignoreOnContentChange) { return false; } return this.callParent(arguments); }, calculateContentSize: function (ownerContext, dimensions) { var me = this, containerDimensions = (dimensions || 0) | ((ownerContext.widthModel.shrinkWrap ? 1 : 0) | (ownerContext.heightModel.shrinkWrap ? 2 : 0)), calcWidth = (containerDimensions & 1) || undefined, calcHeight = (containerDimensions & 2) || undefined, childItems = ownerContext.childItems, length = childItems.length, contentHeight = 0, contentWidth = 0, needed = 0, props = ownerContext.props, targetPadding, child, childContext, height, i, margins, width; if (calcWidth) { if (isNaN(props.contentWidth)) { ++needed; } else { calcWidth = undefined; } } if (calcHeight) { if (isNaN(props.contentHeight)) { ++needed; } else { calcHeight = undefined; } } if (needed) { for (i = 0; i < length; ++i) { childContext = childItems[i]; child = childContext.target; height = calcHeight && childContext.getProp('height'); width = calcWidth && childContext.getProp('width'); margins = childContext.getMarginInfo(); height += margins.bottom; width += margins.right; contentHeight = Math.max(contentHeight, (child.y || 0) + height); contentWidth = Math.max(contentWidth, (child.x || 0) + width); if (isNaN(contentHeight) && isNaN(contentWidth)) { me.done = false; return; } } if (calcWidth || calcHeight) { targetPadding = ownerContext.targetContext.getPaddingInfo(); } if (calcWidth && !ownerContext.setContentWidth(contentWidth + targetPadding.width)) { me.done = false; } if (calcHeight && !ownerContext.setContentHeight(contentHeight + targetPadding.height)) { me.done = false; } /* add a '/' to turn on this log ('//* enables, '/*' disables) if (me.done) { var el = ownerContext.targetContext.el.dom; Ext.log(this.owner.id, '.contentSize: ', contentWidth, 'x', contentHeight, ' => scrollSize: ', el.scrollWidth, 'x', el.scrollHeight); }/**/ } } }); /** * This is a layout that manages multiple Panels in an expandable accordion style such that by default only * one Panel can be expanded at any given time (set {@link #multi} config to have more open). Each Panel has * built-in support for expanding and collapsing. * * Note: Only Ext Panels and all subclasses of Ext.panel.Panel may be used in an accordion layout Container. * * @example * Ext.create('Ext.panel.Panel', { * title: 'Accordion Layout', * width: 300, * height: 300, * defaults: { * // applied to each contained panel * bodyStyle: 'padding:15px' * }, * layout: { * // layout-specific configs go here * type: 'accordion', * titleCollapse: false, * animate: true, * activeOnTop: true * }, * items: [{ * title: 'Panel 1', * html: 'Panel content!' * },{ * title: 'Panel 2', * html: 'Panel content!' * },{ * title: 'Panel 3', * html: 'Panel content!' * }], * renderTo: Ext.getBody() * }); */ Ext.define('Ext.layout.container.Accordion', { extend: Ext.layout.container.VBox , alias: ['layout.accordion'], alternateClassName: 'Ext.layout.AccordionLayout', targetCls: Ext.baseCSSPrefix + 'accordion-layout-ct', itemCls: [Ext.baseCSSPrefix + 'box-item', Ext.baseCSSPrefix + 'accordion-item'], align: 'stretch', /** * @cfg {Boolean} fill * True to adjust the active item's height to fill the available space in the container, false to use the * item's current height, or auto height if not explicitly set. */ fill : true, /** * @cfg {Boolean} autoWidth * Child Panels have their width actively managed to fit within the accordion's width. * @removed This config is ignored in ExtJS 4 */ /** * @cfg {Boolean} titleCollapse * True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow * expand/collapse only when the toggle tool button is clicked. When set to false, * {@link #hideCollapseTool} should be false also. An explicit {@link Ext.panel.Panel#titleCollapse} declared * on the panel will override this setting. */ titleCollapse : true, /** * @cfg {Boolean} hideCollapseTool * True to hide the contained Panels' collapse/expand toggle buttons, false to display them. * When set to true, {@link #titleCollapse} is automatically set to true. */ hideCollapseTool : false, /** * @cfg {Boolean} collapseFirst * True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools * in the contained Panels' title bars, false to render it last. By default, this will use the * {@link Ext.panel.Panel#collapseFirst} setting on the panel. If the config option is specified on the layout, * it will override the panel value. */ collapseFirst : undefined, /** * @cfg {Boolean} animate * True to slide the contained panels open and closed during expand/collapse using animation, false to open and * close directly with no animation. Note: The layout performs animated collapsing * and expanding, *not* the child Panels. */ animate : true, /** * @cfg {Boolean} activeOnTop * Only valid when {@link #multi} is `false` and {@link #animate} is `false`. * * True to swap the position of each panel as it is expanded so that it becomes the first item in the container, * false to keep the panels in the rendered order. */ activeOnTop : false, /** * @cfg {Boolean} multi * Set to true to enable multiple accordion items to be open at once. */ multi: false, defaultAnimatePolicy: { y: true, height: true }, constructor: function() { var me = this; me.callParent(arguments); if (!me.multi && me.animate) { me.animatePolicy = Ext.apply({}, me.defaultAnimatePolicy); } else { me.animatePolicy = null; } }, beforeRenderItems: function (items) { var me = this, ln = items.length, i = 0, owner = me.owner, collapseFirst = me.collapseFirst, hasCollapseFirst = Ext.isDefined(collapseFirst), expandedItem = me.getExpanded(true)[0], multi = me.multi, comp; for (; i < ln; i++) { comp = items[i]; if (!comp.rendered) { // Set up initial properties for Panels in an accordion. if (!multi || comp.collapsible !== false) { comp.collapsible = true; } if (comp.collapsible) { if (hasCollapseFirst) { comp.collapseFirst = collapseFirst; } if (me.hideCollapseTool) { comp.hideCollapseTool = me.hideCollapseTool; comp.titleCollapse = true; } else if (me.titleCollapse && comp.titleCollapse === undefined) { // Only force titleCollapse if we don't explicitly // set one on the child panel comp.titleCollapse = me.titleCollapse; } } delete comp.hideHeader; delete comp.width; comp.title = comp.title || ' '; comp.addBodyCls(Ext.baseCSSPrefix + 'accordion-body'); // If only one child Panel is allowed to be expanded // then collapse all except the first one found with collapsed:false // If we have hasExpanded set, we've already done this if (!multi) { if (expandedItem) { comp.collapsed = expandedItem !== comp; } else if (comp.hasOwnProperty('collapsed') && comp.collapsed === false) { expandedItem = comp; } else { comp.collapsed = true; } // If only one child Panel may be expanded, then intercept expand/show requests. owner.mon(comp, { show: me.onComponentShow, beforeexpand: me.onComponentExpand, beforecollapse: me.onComponentCollapse, scope: me }); } // Need to still check this outside multi because we don't want // a single item to be able to collapse owner.mon(comp, 'beforecollapse', me.onComponentCollapse, me); comp.headerOverCls = Ext.baseCSSPrefix + 'accordion-hd-over'; } } // If no collapsed:false Panels found, make the first one expanded. if (!multi) { if (!expandedItem) { if (ln) { items[0].collapsed = false; } } else if (me.activeOnTop) { expandedItem.collapsed = false; me.configureItem(expandedItem); if (owner.items.indexOf(expandedItem) > 0) { owner.insert(0, expandedItem); } } } }, getItemsRenderTree: function(items) { this.beforeRenderItems(items); return this.callParent(arguments); }, renderItems : function(items, target) { this.beforeRenderItems(items); this.callParent(arguments); }, configureItem: function(item) { this.callParent(arguments); // We handle animations for the expand/collapse of items. // Items do not have individual borders item.animCollapse = item.border = false; // If filling available space, all Panels flex. if (this.fill) { item.flex = 1; } }, beginLayout: function (ownerContext) { this.callParent(arguments); this.updatePanelClasses(ownerContext); }, updatePanelClasses: function(ownerContext) { var children = ownerContext.visibleItems, ln = children.length, siblingCollapsed = true, i, child, header; for (i = 0; i < ln; i++) { child = children[i]; header = child.header; header.addCls(Ext.baseCSSPrefix + 'accordion-hd'); if (siblingCollapsed) { header.removeCls(Ext.baseCSSPrefix + 'accordion-hd-sibling-expanded'); } else { header.addCls(Ext.baseCSSPrefix + 'accordion-hd-sibling-expanded'); } if (i + 1 == ln && child.collapsed) { header.addCls(Ext.baseCSSPrefix + 'accordion-hd-last-collapsed'); } else { header.removeCls(Ext.baseCSSPrefix + 'accordion-hd-last-collapsed'); } siblingCollapsed = child.collapsed; } }, // When a Component expands, adjust the heights of the other Components to be just enough to accommodate // their headers. // The expanded Component receives the only flex value, and so gets all remaining space. onComponentExpand: function(toExpand) { var me = this, owner = me.owner, multi = me.multi, animate = me.animate, moveToTop = !multi && !me.animate && me.activeOnTop, expanded, expandedCount, i, previousValue; if (!me.processing) { me.processing = true; previousValue = owner.deferLayouts; owner.deferLayouts = true; expanded = multi ? [] : me.getExpanded(); expandedCount = expanded.length; // Collapse all other expanded child items (Won't loop if multi is true) for (i = 0; i < expandedCount; i++) { expanded[i].collapse(); } if (moveToTop) { // Prevent extra layout when moving the item Ext.suspendLayouts(); owner.insert(0, toExpand); Ext.resumeLayouts(); } owner.deferLayouts = previousValue; me.processing = false; } }, onComponentCollapse: function(comp) { var me = this, owner = me.owner, toExpand, expanded, previousValue; if (me.owner.items.getCount() === 1) { // do not allow collapse if there is only one item return false; } if (!me.processing) { me.processing = true; previousValue = owner.deferLayouts; owner.deferLayouts = true; toExpand = comp.next() || comp.prev(); // If we are allowing multi, and the "toCollapse" component is NOT the only expanded Component, // then ask the box layout to collapse it to its header. if (me.multi) { expanded = me.getExpanded(); // If the collapsing Panel is the only expanded one, expand the following Component. // All this is handling fill: true, so there must be at least one expanded, if (expanded.length === 1) { toExpand.expand(); } } else if (toExpand) { toExpand.expand(); } owner.deferLayouts = previousValue; me.processing = false; } }, onComponentShow: function(comp) { // Showing a Component means that you want to see it, so expand it. this.onComponentExpand(comp); }, getExpanded: function(explicitCheck){ var items = this.owner.items.items, len = items.length, i = 0, out = [], add, item; for (; i < len; ++i) { item = items[i]; if (explicitCheck) { add = item.hasOwnProperty('collapsed') && item.collapsed === false; } else { add = !item.collapsed; } if (add) { out.push(item); } } return out; } }); /** * This class functions **between siblings of a {@link Ext.layout.container.VBox VBox} or {@link Ext.layout.container.HBox HBox} * layout** to resize both immediate siblings. * * A Splitter will preserve the flex ratio of any flexed siblings it is required to resize. It does this by setting the `flex` property of *all* flexed siblings * to equal their pixel size. The actual numerical `flex` property in the Components will change, but the **ratio** to the total flex value will be preserved. * * A Splitter may be configured to show a centered mini-collapse tool orientated to collapse the {@link #collapseTarget}. * The Splitter will then call that sibling Panel's {@link Ext.panel.Panel#method-collapse collapse} or {@link Ext.panel.Panel#method-expand expand} method * to perform the appropriate operation (depending on the sibling collapse state). To create the mini-collapse tool but take care * of collapsing yourself, configure the splitter with `{@link #performCollapse}: false`. */ Ext.define('Ext.resizer.Splitter', { extend: Ext.Component , alias: 'widget.splitter', childEls: [ 'collapseEl' ], renderTpl: [ '', '
     ', '
    ', '
    ' ], baseCls: Ext.baseCSSPrefix + 'splitter', collapsedClsInternal: Ext.baseCSSPrefix + 'splitter-collapsed', // Default to tree, allow internal classes to disable resizing canResize: true, /** * @cfg {Boolean} collapsible * True to show a mini-collapse tool in the Splitter to toggle expand and collapse on the {@link #collapseTarget} Panel. * Defaults to the {@link Ext.panel.Panel#collapsible collapsible} setting of the Panel. */ collapsible: false, /** * @cfg {Boolean} performCollapse * Set to false to prevent this Splitter's mini-collapse tool from managing the collapse * state of the {@link #collapseTarget}. */ /** * @cfg {Boolean} collapseOnDblClick * True to enable dblclick to toggle expand and collapse on the {@link #collapseTarget} Panel. */ collapseOnDblClick: true, /** * @cfg {Number} defaultSplitMin * Provides a default minimum width or height for the two components * that the splitter is between. */ defaultSplitMin: 40, /** * @cfg {Number} defaultSplitMax * Provides a default maximum width or height for the two components * that the splitter is between. */ defaultSplitMax: 1000, /** * @cfg {String} collapsedCls * A class to add to the splitter when it is collapsed. See {@link #collapsible}. */ /** * @cfg {String/Ext.panel.Panel} collapseTarget * A string describing the relative position of the immediate sibling Panel to collapse. May be 'prev' or 'next'. * * Or the immediate sibling Panel to collapse. * * The orientation of the mini-collapse tool will be inferred from this setting. * * **Note that only Panels may be collapsed.** */ collapseTarget: 'next', /** * @property {String} orientation * Orientation of this Splitter. `'vertical'` when used in an hbox layout, `'horizontal'` * when used in a vbox layout. */ horizontal: false, vertical: false, /** * @cfg {Number} size * The size of the splitter. This becomes the height for vertical splitters and * width for horizontal splitters. */ size: 5, /** * Returns the config object (with an `xclass` property) for the splitter tracker. This * is overridden by {@link Ext.resizer.BorderSplitter BorderSplitter} to create a * {@link Ext.resizer.BorderSplitterTracker BorderSplitterTracker}. * @protected */ getTrackerConfig: function () { return { xclass: 'Ext.resizer.SplitterTracker', el: this.el, splitter: this }; }, beforeRender: function() { var me = this, target = me.getCollapseTarget(); me.callParent(); if (target.collapsed) { me.addCls(me.collapsedClsInternal); } if (!me.canResize) { me.addCls(me.baseCls + '-noresize'); } Ext.applyIf(me.renderData, { collapseDir: me.getCollapseDirection(), collapsible: me.collapsible || target.collapsible }); me.protoEl.unselectable(); }, onRender: function() { var me = this, collapseEl; me.callParent(arguments); // Add listeners on the mini-collapse tool unless performCollapse is set to false if (me.performCollapse !== false) { if (me.renderData.collapsible) { me.mon(me.collapseEl, 'click', me.toggleTargetCmp, me); } if (me.collapseOnDblClick) { me.mon(me.el, 'dblclick', me.toggleTargetCmp, me); } } // Ensure the mini collapse icon is set to the correct direction when the target is collapsed/expanded by any means me.mon(me.getCollapseTarget(), { collapse: me.onTargetCollapse, expand: me.onTargetExpand, beforeexpand: me.onBeforeTargetExpand, beforecollapse: me.onBeforeTargetCollapse, scope: me }); if (me.canResize) { me.tracker = Ext.create(me.getTrackerConfig()); // Relay the most important events to our owner (could open wider later): me.relayEvents(me.tracker, [ 'beforedragstart', 'dragstart', 'dragend' ]); } collapseEl = me.collapseEl; if (collapseEl) { collapseEl.lastCollapseDirCls = me.collapseDirProps[me.collapseDirection].cls; } }, getCollapseDirection: function() { var me = this, dir = me.collapseDirection, collapseTarget, idx, items, type; if (!dir) { collapseTarget = me.collapseTarget; if (collapseTarget.isComponent) { dir = collapseTarget.collapseDirection; } if (!dir) { // Avoid duplication of string tests. // Create a two bit truth table of the configuration of the Splitter: // Collapse Target | orientation // 0 0 = next, horizontal // 0 1 = next, vertical // 1 0 = prev, horizontal // 1 1 = prev, vertical type = me.ownerCt.layout.type; if (collapseTarget.isComponent) { items = me.ownerCt.items; idx = Number(items.indexOf(collapseTarget) === items.indexOf(me) - 1) << 1 | Number(type === 'hbox'); } else { idx = Number(me.collapseTarget === 'prev') << 1 | Number(type === 'hbox'); } // Read the data out the truth table dir = ['bottom', 'right', 'top', 'left'][idx]; } me.collapseDirection = dir; } me.setOrientation((dir === 'top' || dir === 'bottom') ? 'horizontal' : 'vertical'); return dir; }, getCollapseTarget: function() { var me = this; return me.collapseTarget.isComponent ? me.collapseTarget : me.collapseTarget === 'prev' ? me.previousSibling() : me.nextSibling(); }, setCollapseEl: function(display){ var el = this.collapseEl; if (el) { el.setDisplayed(display); } }, onBeforeTargetExpand: function(target) { this.setCollapseEl('none'); }, onBeforeTargetCollapse: function(){ this.setCollapseEl('none'); }, onTargetCollapse: function(target) { this.el.addCls([this.collapsedClsInternal, this.collapsedCls]); this.setCollapseEl(''); }, onTargetExpand: function(target) { this.el.removeCls([this.collapsedClsInternal, this.collapsedCls]); this.setCollapseEl(''); }, collapseDirProps: { top: { cls: Ext.baseCSSPrefix + 'layout-split-top' }, right: { cls: Ext.baseCSSPrefix + 'layout-split-right' }, bottom: { cls: Ext.baseCSSPrefix + 'layout-split-bottom' }, left: { cls: Ext.baseCSSPrefix + 'layout-split-left' } }, orientationProps: { horizontal: { opposite: 'vertical', fixedAxis: 'height', stretchedAxis: 'width' }, vertical: { opposite: 'horizontal', fixedAxis: 'width', stretchedAxis: 'height' } }, applyCollapseDirection: function () { var me = this, collapseEl = me.collapseEl, collapseDirProps = me.collapseDirProps[me.collapseDirection], cls; if (collapseEl) { cls = collapseEl.lastCollapseDirCls; if (cls) { collapseEl.removeCls(cls); } collapseEl.addCls(collapseEl.lastCollapseDirCls = collapseDirProps.cls); } }, applyOrientation: function () { var me = this, orientation = me.orientation, orientationProps = me.orientationProps[orientation], defaultSize = me.size, fixedSizeProp = orientationProps.fixedAxis, stretchSizeProp = orientationProps.stretchedAxis, cls = me.baseCls + '-'; me[orientation] = true; me[orientationProps.opposite] = false; if (!me.hasOwnProperty(fixedSizeProp) || me[fixedSizeProp] === '100%') { me[fixedSizeProp] = defaultSize; } if (!me.hasOwnProperty(stretchSizeProp) || me[stretchSizeProp] === defaultSize) { me[stretchSizeProp] = '100%'; } me.removeCls(cls + orientationProps.opposite); me.addCls(cls + orientation); }, setOrientation: function (orientation) { var me = this; if (me.orientation !== orientation) { me.orientation = orientation; me.applyOrientation(); } }, updateOrientation: function () { delete this.collapseDirection; // recompute this.getCollapseDirection(); this.applyCollapseDirection(); }, toggleTargetCmp: function(e, t) { var cmp = this.getCollapseTarget(), placeholder = cmp.placeholder, toggle; // We can only toggle the target if it offers the expand/collapse API if (Ext.isFunction(cmp.expand) && Ext.isFunction(cmp.collapse)) { if (placeholder && !placeholder.hidden) { toggle = true; } else { toggle = !cmp.hidden; } if (toggle) { if (cmp.collapsed) { cmp.expand(); } else if (cmp.collapseDirection) { cmp.collapse(); } else { cmp.collapse(this.renderData.collapseDir); } } } }, /* * Work around IE bug. %age margins do not get recalculated on element resize unless repaint called. */ setSize: function() { var me = this; me.callParent(arguments); if (Ext.isIE && me.el) { me.el.repaint(); } }, beforeDestroy: function(){ Ext.destroy(this.tracker); this.callParent(); } }); /** * Private utility class for Ext.layout.container.Border. * @private */ Ext.define('Ext.resizer.BorderSplitter', { extend: Ext.resizer.Splitter , alias: 'widget.bordersplitter', // must be configured in by the border layout: collapseTarget: null, getTrackerConfig: function () { var trackerConfig = this.callParent(); trackerConfig.xclass = 'Ext.resizer.BorderSplitterTracker'; return trackerConfig; } }); /** * This is a multi-pane, application-oriented UI layout style that supports multiple nested panels, automatic bars * between regions and built-in {@link Ext.panel.Panel#collapsible expanding and collapsing} of regions. * * This class is intended to be extended or created via the `layout:'border'` {@link Ext.container.Container#layout} * config, and should generally not need to be created directly via the new keyword. * * @example * Ext.create('Ext.panel.Panel', { * width: 500, * height: 300, * title: 'Border Layout', * layout: 'border', * items: [{ * title: 'South Region is resizable', * region: 'south', // position for region * xtype: 'panel', * height: 100, * split: true, // enable resizing * margins: '0 5 5 5' * },{ * // xtype: 'panel' implied by default * title: 'West Region is collapsible', * region:'west', * xtype: 'panel', * margins: '5 0 0 5', * width: 200, * collapsible: true, // make collapsible * id: 'west-region-container', * layout: 'fit' * },{ * title: 'Center Region', * region: 'center', // center region is required, no width/height specified * xtype: 'panel', * layout: 'fit', * margins: '5 5 0 0' * }], * renderTo: Ext.getBody() * }); * * # Notes * * - When using the split option, the layout will automatically insert a {@link Ext.resizer.Splitter} * into the appropriate place. This will modify the underlying * {@link Ext.container.Container#property-items items} collection in the container. * * - Any Container using the Border layout **must** have a child item with `region:'center'`. * The child item in the center region will always be resized to fill the remaining space * not used by the other regions in the layout. * * - Any child items with a region of `west` or `east` may be configured with either an initial * `width`, or a {@link Ext.layout.container.Box#flex} value, or an initial percentage width * **string** (Which is simply divided by 100 and used as a flex value). * The 'center' region has a flex value of `1`. * * - Any child items with a region of `north` or `south` may be configured with either an initial * `height`, or a {@link Ext.layout.container.Box#flex} value, or an initial percentage height * **string** (Which is simply divided by 100 and used as a flex value). * The 'center' region has a flex value of `1`. * * - **There is no BorderLayout.Region class in ExtJS 4.0+** */ Ext.define('Ext.layout.container.Border', { extend: Ext.layout.container.Container , alias: 'layout.border', alternateClassName: 'Ext.layout.BorderLayout', targetCls: Ext.baseCSSPrefix + 'border-layout-ct', itemCls: [Ext.baseCSSPrefix + 'border-item', Ext.baseCSSPrefix + 'box-item'], type: 'border', isBorderLayout: true, /** * @cfg {Boolean} split * This configuration option is to be applied to the **child `items`** managed by this layout. * Each region with `split:true` will get a {@link Ext.resizer.BorderSplitter Splitter} that * allows for manual resizing of the container. Except for the `center` region. */ /** * @cfg {Boolean} [splitterResize=true] * This configuration option is to be applied to the **child `items`** managed by this layout and * is used in conjunction with {@link #split}. By default, when specifying {@link #split}, the region * can be dragged to be resized. Set this option to false to show the split bar but prevent resizing. */ /** * @cfg {Number/String/Object} padding * Sets the padding to be applied to all child items managed by this layout. * * This property can be specified as a string containing space-separated, numeric * padding values. The order of the sides associated with each value matches the way * CSS processes padding values: * * - If there is only one value, it applies to all sides. * - If there are two values, the top and bottom borders are set to the first value * and the right and left are set to the second. * - If there are three values, the top is set to the first value, the left and right * are set to the second, and the bottom is set to the third. * - If there are four values, they apply to the top, right, bottom, and left, * respectively. * */ padding: undefined, percentageRe: /(\d+)%/, horzMarginProp: 'left', padOnContainerProp: 'left', padNotOnContainerProp: 'right', /** * Reused meta-data objects that describe axis properties. * @private */ axisProps: { horz: { borderBegin: 'west', borderEnd: 'east', horizontal: true, posProp: 'x', sizeProp: 'width', sizePropCap: 'Width' }, vert: { borderBegin: 'north', borderEnd: 'south', horizontal: false, posProp: 'y', sizeProp: 'height', sizePropCap: 'Height' } }, // @private centerRegion: null, manageMargins: true, panelCollapseAnimate: true, panelCollapseMode: 'placeholder', /** * @cfg {Object} regionWeights * The default weights to assign to regions in the border layout. These values are * used when a region does not contain a `weight` property. This object must have * properties for all regions ("north", "south", "east" and "west"). * * **IMPORTANT:** Since this is an object, changing its properties will impact ALL * instances of Border layout. If this is not desired, provide a replacement object as * a config option instead: * * layout: { * type: 'border', * regionWeights: { * west: 20, * north: 10, * south: -10, * east: -20 * } * } * * The region with the highest weight is assigned space from the border before other * regions. Regions of equal weight are assigned space based on their position in the * owner's items list (first come, first served). */ regionWeights: { north: 20, south: 10, center: 0, west: -10, east: -20 }, //---------------------------------- // Layout processing /** * Creates the axis objects for the layout. These are only missing size information * which is added during {@link #calculate}. * @private */ beginAxis: function (ownerContext, regions, name) { var me = this, props = me.axisProps[name], isVert = !props.horizontal, sizeProp = props.sizeProp, totalFlex = 0, childItems = ownerContext.childItems, length = childItems.length, center, i, childContext, centerFlex, comp, region, match, size, type, target, placeholder; for (i = 0; i < length; ++i) { childContext = childItems[i]; comp = childContext.target; childContext.layoutPos = {}; if (comp.region) { childContext.region = region = comp.region; childContext.isCenter = comp.isCenter; childContext.isHorz = comp.isHorz; childContext.isVert = comp.isVert; childContext.weight = comp.weight || me.regionWeights[region] || 0; regions[comp.id] = childContext; if (comp.isCenter) { center = childContext; centerFlex = comp.flex; ownerContext.centerRegion = center; continue; } if (isVert !== childContext.isVert) { continue; } // process regions "isVert ? north||south : east||center||west" childContext.reverseWeighting = (region == props.borderEnd); size = comp[sizeProp]; type = typeof size; if (!comp.collapsed) { if (type == 'string' && (match = me.percentageRe.exec(size))) { childContext.percentage = parseInt(match[1], 10); } else if (comp.flex) { totalFlex += childContext.flex = comp.flex; } } } } // Special cases for a collapsed center region if (center) { target = center.target; if ((placeholder = target.placeholderFor)) { if (!centerFlex && isVert === placeholder.collapsedVertical()) { // The center region is a placeholder, collapsed in this axis centerFlex = 0; center.collapseAxis = name; } } else if (target.collapsed && (isVert === target.collapsedVertical())) { // The center region is a collapsed header, collapsed in this axis centerFlex = 0; center.collapseAxis = name; } } if (centerFlex == null) { // If we still don't have a center flex, default to 1 centerFlex = 1; } totalFlex += centerFlex; return Ext.apply({ before : isVert ? 'top' : 'left', totalFlex : totalFlex }, props); }, beginLayout: function (ownerContext) { var me = this, items = me.getLayoutItems(), pad = me.padding, type = typeof pad, padOnContainer = false, childContext, item, length, i, regions, collapseTarget, doShow, hidden, region; // We sync the visibility state of splitters with their region: if (pad) { if (type == 'string' || type == 'number') { pad = Ext.util.Format.parseBox(pad); } } else { pad = ownerContext.getEl('getTargetEl').getPaddingInfo(); padOnContainer = true; } ownerContext.outerPad = pad; ownerContext.padOnContainer = padOnContainer; for (i = 0, length = items.length; i < length; ++i) { item = items[i]; collapseTarget = me.getSplitterTarget(item); if (collapseTarget) { // if (splitter) doShow = undefined; hidden = !!item.hidden; if (!collapseTarget.split) { if (collapseTarget.isCollapsingOrExpanding) { doShow = !!collapseTarget.collapsed; } } else if (hidden !== collapseTarget.hidden) { doShow = !collapseTarget.hidden; } if (doShow) { item.show(); } else if (doShow === false) { item.hide(); } } } // The above synchronized visibility of splitters with their regions, so we need // to make this call after that so that childItems and visibleItems are correct: // me.callParent(arguments); items = ownerContext.childItems; length = items.length; regions = {}; ownerContext.borderAxisHorz = me.beginAxis(ownerContext, regions, 'horz'); ownerContext.borderAxisVert = me.beginAxis(ownerContext, regions, 'vert'); // Now that weights are assigned to the region's contextItems, we assign those // same weights to the contextItem for the splitters. We also cross link the // contextItems for the collapseTarget and its splitter. for (i = 0; i < length; ++i) { childContext = items[i]; collapseTarget = me.getSplitterTarget(childContext.target); if (collapseTarget) { // if (splitter) region = regions[collapseTarget.id] if (!region) { // if the region was hidden it will not be part of childItems, and // so beginAxis() won't add it to the regions object, so we have // to create the context item here. region = ownerContext.getEl(collapseTarget.el, me); region.region = collapseTarget.region; } childContext.collapseTarget = collapseTarget = region; childContext.weight = collapseTarget.weight; childContext.reverseWeighting = collapseTarget.reverseWeighting; collapseTarget.splitter = childContext; childContext.isHorz = collapseTarget.isHorz; childContext.isVert = collapseTarget.isVert; } } // Now we want to sort the childItems by their weight. me.sortWeightedItems(items, 'reverseWeighting'); me.setupSplitterNeighbors(items); }, calculate: function (ownerContext) { var me = this, containerSize = me.getContainerSize(ownerContext), childItems = ownerContext.childItems, length = childItems.length, horz = ownerContext.borderAxisHorz, vert = ownerContext.borderAxisVert, pad = ownerContext.outerPad, padOnContainer = ownerContext.padOnContainer, i, childContext, childMargins, size, horzPercentTotal, vertPercentTotal; horz.begin = pad[me.padOnContainerProp]; vert.begin = pad.top; // If the padding is already on the container we need to add it to the space // If not on the container, it's "virtual" padding. horzPercentTotal = horz.end = horz.flexSpace = containerSize.width + (padOnContainer ? pad[me.padOnContainerProp] : -pad[me.padNotOnContainerProp]); vertPercentTotal = vert.end = vert.flexSpace = containerSize.height + (padOnContainer ? pad.top : -pad.bottom); // Reduce flexSpace on each axis by the fixed/auto sized dimensions of items that // aren't flexed along that axis. for (i = 0; i < length; ++i) { childContext = childItems[i]; childMargins = childContext.getMarginInfo(); // Margins are always fixed size and must be removed from the space used for percentages and flexes if (childContext.isHorz || childContext.isCenter) { horz.addUnflexed(childMargins.width); horzPercentTotal -= childMargins.width; } if (childContext.isVert || childContext.isCenter) { vert.addUnflexed(childMargins.height); vertPercentTotal -= childMargins.height; } // Fixed size components must have their sizes removed from the space used for flex if (!childContext.flex && !childContext.percentage) { if (childContext.isHorz || (childContext.isCenter && childContext.collapseAxis === 'horz')) { size = childContext.getProp('width'); horz.addUnflexed(size); // splitters should not count towards percentages if (childContext.collapseTarget) { horzPercentTotal -= size; } } else if (childContext.isVert || (childContext.isCenter && childContext.collapseAxis === 'vert')) { size = childContext.getProp('height'); vert.addUnflexed(size); // splitters should not count towards percentages if (childContext.collapseTarget) { vertPercentTotal -= size; } } // else ignore center since it is fully flexed } } for (i = 0; i < length; ++i) { childContext = childItems[i]; childMargins = childContext.getMarginInfo(); // Calculate the percentage sizes. After this calculation percentages are very similar to fixed sizes if (childContext.percentage) { if (childContext.isHorz) { size = Math.ceil(horzPercentTotal * childContext.percentage / 100); size = childContext.setWidth(size); horz.addUnflexed(size); } else if (childContext.isVert) { size = Math.ceil(vertPercentTotal * childContext.percentage / 100); size = childContext.setHeight(size); vert.addUnflexed(size); } // center shouldn't have a percentage but if it does it should be ignored } } // If we haven't gotten sizes for all unflexed dimensions on an axis, the flexSpace // will be NaN so we won't be calculating flexed dimensions until that is resolved. for (i = 0; i < length; ++i) { childContext = childItems[i]; if (!childContext.isCenter) { me.calculateChildAxis(childContext, horz); me.calculateChildAxis(childContext, vert); } } // Once all items are placed, the final size of the center can be determined. If we // can determine both width and height, we are done. We use '+' instead of '&&' to // avoid short-circuiting (we want to call both): if (me.finishAxis(ownerContext, vert) + me.finishAxis(ownerContext, horz) < 2) { me.done = false; } else { // Size information is published as we place regions but position is hard to do // that way (while avoiding published multiple times) so we publish all the // positions at the end. me.finishPositions(childItems); } }, /** * Performs the calculations for a region on a specified axis. * @private */ calculateChildAxis: function (childContext, axis) { var collapseTarget = childContext.collapseTarget, setSizeMethod = 'set' + axis.sizePropCap, sizeProp = axis.sizeProp, childMarginSize = childContext.getMarginInfo()[sizeProp], region, isBegin, flex, pos, size; if (collapseTarget) { // if (splitter) region = collapseTarget.region; } else { region = childContext.region; flex = childContext.flex; } isBegin = region == axis.borderBegin; if (!isBegin && region != axis.borderEnd) { // a north/south region on the horizontal axis or an east/west region on the // vertical axis: stretch to fill remaining space: childContext[setSizeMethod](axis.end - axis.begin - childMarginSize); pos = axis.begin; } else { if (flex) { size = Math.ceil(axis.flexSpace * (flex / axis.totalFlex)); size = childContext[setSizeMethod](size); } else if (childContext.percentage) { // Like getProp but without registering a dependency - we calculated the size, we don't depend on it size = childContext.peek(sizeProp); } else { size = childContext.getProp(sizeProp); } size += childMarginSize; if (isBegin) { pos = axis.begin; axis.begin += size; } else { axis.end = pos = axis.end - size; } } childContext.layoutPos[axis.posProp] = pos; }, /** * Finishes the calculations on an axis. This basically just assigns the remaining * space to the center region. * @private */ finishAxis: function (ownerContext, axis) { var size = axis.end - axis.begin, center = ownerContext.centerRegion; if (center) { center['set' + axis.sizePropCap](size - center.getMarginInfo()[axis.sizeProp]); center.layoutPos[axis.posProp] = axis.begin; } return Ext.isNumber(size) ? 1 : 0; }, /** * Finishes by setting the positions on the child items. * @private */ finishPositions: function (childItems) { var length = childItems.length, index, childContext, marginProp = this.horzMarginProp; for (index = 0; index < length; ++index) { childContext = childItems[index]; childContext.setProp('x', childContext.layoutPos.x + childContext.marginInfo[marginProp]); childContext.setProp('y', childContext.layoutPos.y + childContext.marginInfo.top); } }, getLayoutItems: function() { var owner = this.owner, ownerItems = (owner && owner.items && owner.items.items) || [], length = ownerItems.length, items = [], i = 0, ownerItem, placeholderFor; for (; i < length; i++) { ownerItem = ownerItems[i]; placeholderFor = ownerItem.placeholderFor; // There are a couple of scenarios where we do NOT want an item to // be included in the layout items: // // 1. If the item is floated. This can happen when a region's header // is clicked to "float" the item, then another region's header or // is clicked quickly before the first floated region has had a // chance to slide out. When this happens, the second click triggers // a layout, the purpose of which is to determine what the size of the // second region will be after it is floated, so it can be animated // to that size. In this case the existing floated item should not be // included in the layout items because it will not be visible once // it's slideout animation has completed. // // 2. If the item is a placeholder for a panel that is currently // being expanded. Similar to scenario 1, a second layout can be // triggered by another panel being expanded/collapsed/floated before // the first panel has finished it's expand animation. If this is the // case we do not want the placeholder to be included in the layout // items because it will not be once the panel has finished expanding. // // If the component is hidden, we need none of these shenanigans if (ownerItem.hidden || ((!ownerItem.floated || ownerItem.isCollapsingOrExpanding === 2) && !(placeholderFor && placeholderFor.isCollapsingOrExpanding === 2))) { items.push(ownerItem); } } return items; }, getPlaceholder: function (comp) { return comp.getPlaceholder && comp.getPlaceholder(); }, getSplitterTarget: function (splitter) { var collapseTarget = splitter.collapseTarget; if (collapseTarget && collapseTarget.collapsed) { return collapseTarget.placeholder || collapseTarget; } return collapseTarget; }, isItemBoxParent: function (itemContext) { return true; }, isItemShrinkWrap: function (item) { return true; }, //---------------------------------- // Event handlers /** * Inserts the splitter for a given region. A reference to the splitter is also stored * on the component as "splitter". * @private */ insertSplitter: function (item, index, hidden, splitterCfg) { var region = item.region, splitter = Ext.apply({ xtype: 'bordersplitter', collapseTarget: item, id: item.id + '-splitter', hidden: hidden, canResize: item.splitterResize !== false, splitterFor: item }, splitterCfg), at = index + ((region === 'south' || region === 'east') ? 0 : 1); if (item.collapseMode === 'mini') { splitter.collapsedCls = item.collapsedCls; } item.splitter = this.owner.add(at, splitter); }, /** * Called when a region (actually when any component) is added to the container. The * region is decorated with some helpful properties (isCenter, isHorz, isVert) and its * splitter is added if its "split" property is true. * @private */ onAdd: function (item, index) { var me = this, placeholderFor = item.placeholderFor, region = item.region, split, hidden, cfg; me.callParent(arguments); if (region) { Ext.apply(item, me.regionFlags[region]); if (item.initBorderRegion) { // This method should always be present but perhaps the override is being // excluded. item.initBorderRegion(); } if (region === 'center') { if (me.centerRegion) { Ext.Error.raise("Cannot have multiple center regions in a BorderLayout."); } me.centerRegion = item; } else { split = item.split; hidden = !!item.hidden; if (typeof split === 'object') { cfg = split; split = true; } if ((item.isHorz || item.isVert) && (split || item.collapseMode == 'mini')) { me.insertSplitter(item, index, hidden || !split, cfg); } } if (!item.hasOwnProperty('collapseMode')) { item.collapseMode = me.panelCollapseMode; } if (!item.hasOwnProperty('animCollapse')) { if (item.collapseMode !== 'placeholder') { // other collapse modes do not animate nicely in a border layout, so // default them to off: item.animCollapse = false; } else { item.animCollapse = me.panelCollapseAnimate; } } } else if (placeholderFor) { Ext.apply(item, me.regionFlags[placeholderFor.region]); item.region = placeholderFor.region; item.weight = placeholderFor.weight; } }, onDestroy: function() { this.centerRegion = null; this.callParent(); }, onRemove: function (item) { var me = this, region = item.region, splitter = item.splitter; if (region) { if (item.isCenter) { me.centerRegion = null; } delete item.isCenter; delete item.isHorz; delete item.isVert; if (splitter) { me.owner.doRemove(splitter, true); // avoid another layout delete item.splitter; } } me.callParent(arguments); }, //---------------------------------- // Misc regionMeta: { center: { splitterDelta: 0 }, north: { splitterDelta: 1 }, south: { splitterDelta: -1 }, west: { splitterDelta: 1 }, east: { splitterDelta: -1 } }, /** * Flags and configs that get set of regions based on their `region` property. * @private */ regionFlags: { center: { isCenter: true, isHorz: false, isVert: false }, north: { isCenter: false, isHorz: false, isVert: true, collapseDirection: 'top' }, south: { isCenter: false, isHorz: false, isVert: true, collapseDirection: 'bottom' }, west: { isCenter: false, isHorz: true, isVert: false, collapseDirection: 'left' }, east: { isCenter: false, isHorz: true, isVert: false, collapseDirection: 'right' } }, setupSplitterNeighbors: function (items) { var edgeRegions = { //north: null, //south: null, //east: null, //west: null }, length = items.length, touchedRegions = this.touchedRegions, i, j, center, count, edge, comp, region, splitter, touched; for (i = 0; i < length; ++i) { comp = items[i].target; region = comp.region; if (comp.isCenter) { center = comp; } else if (region) { touched = touchedRegions[region]; for (j = 0, count = touched.length; j < count; ++j) { edge = edgeRegions[touched[j]]; if (edge) { edge.neighbors.push(comp); } } if (comp.placeholderFor) { // placeholder, so grab the splitter for the actual panel splitter = comp.placeholderFor.splitter; } else { splitter = comp.splitter; } if (splitter) { splitter.neighbors = []; } edgeRegions[region] = splitter; } } if (center) { touched = touchedRegions.center; for (j = 0, count = touched.length; j < count; ++j) { edge = edgeRegions[touched[j]]; if (edge) { edge.neighbors.push(center); } } } }, /** * Lists the regions that would consider an interior region a neighbor. For example, * a north region would consider an east or west region its neighbords (as well as * an inner north region). * @private */ touchedRegions: { center: [ 'north', 'south', 'east', 'west' ], north: [ 'north', 'east', 'west' ], south: [ 'south', 'east', 'west' ], east: [ 'east', 'north', 'south' ], west: [ 'west', 'north', 'south' ] }, sizePolicies: { vert: { readsWidth: 0, readsHeight: 1, setsWidth: 1, setsHeight: 0 }, horz: { readsWidth: 1, readsHeight: 0, setsWidth: 0, setsHeight: 1 }, flexAll: { readsWidth: 0, readsHeight: 0, setsWidth: 1, setsHeight: 1 } }, getItemSizePolicy: function (item) { var me = this, policies = this.sizePolicies, collapseTarget, size, policy, placeholderFor; if (item.isCenter) { placeholderFor = item.placeholderFor; if (placeholderFor) { if (placeholderFor.collapsedVertical()) { return policies.vert; } return policies.horz; } if (item.collapsed) { if (item.collapsedVertical()) { return policies.vert; } return policies.horz; } return policies.flexAll; } collapseTarget = item.collapseTarget; if (collapseTarget) { return collapseTarget.isVert ? policies.vert : policies.horz; } if (item.region) { if (item.isVert) { size = item.height; policy = policies.vert; } else { size = item.width; policy = policies.horz; } if (item.flex || (typeof size == 'string' && me.percentageRe.test(size))) { return policies.flexAll; } return policy; } return me.autoSizePolicy; } }, function () { var methods = { addUnflexed: function (px) { this.flexSpace = Math.max(this.flexSpace - px, 0); } }, props = this.prototype.axisProps; Ext.apply(props.horz, methods); Ext.apply(props.vert, methods); }); /** * This layout manages multiple child Components, each fitted to the Container, where only a single child Component can be * visible at any given time. This layout style is most commonly used for wizards, tab implementations, etc. * This class is intended to be extended or created via the layout:'card' {@link Ext.container.Container#layout} config, * and should generally not need to be created directly via the new keyword. * * The CardLayout's focal method is {@link #setActiveItem}. Since only one panel is displayed at a time, * the only way to move from one Component to the next is by calling setActiveItem, passing the next panel to display * (or its id or index). The layout itself does not provide a user interface for handling this navigation, * so that functionality must be provided by the developer. * * To change the active card of a container, call the setActiveItem method of its layout: * * @example * var p = Ext.create('Ext.panel.Panel', { * layout: 'card', * items: [ * { html: 'Card 1' }, * { html: 'Card 2' } * ], * renderTo: Ext.getBody() * }); * * p.getLayout().setActiveItem(1); * * The {@link Ext.Component#beforedeactivate beforedeactivate} and {@link Ext.Component#beforeactivate beforeactivate} * events can be used to prevent a card from activating or deactivating by returning `false`. * * @example * var active = 0; * var main = Ext.create('Ext.panel.Panel', { * renderTo: Ext.getBody(), * width: 200, * height: 200, * layout: 'card', * tbar: [{ * text: 'Next', * handler: function(){ * var layout = main.getLayout(); * ++active; * layout.setActiveItem(active); * active = main.items.indexOf(layout.getActiveItem()); * } * }], * items: [{ * title: 'P1' * }, { * title: 'P2' * }, { * title: 'P3', * listeners: { * beforeactivate: function(){ * return false; * } * } * }] * }); * * In the following example, a simplistic wizard setup is demonstrated. A button bar is added * to the footer of the containing panel to provide navigation buttons. The buttons will be handled by a * common navigation routine. Note that other uses of a CardLayout (like a tab control) would require a * completely different implementation. For serious implementations, a better approach would be to extend * CardLayout to provide the custom functionality needed. * * @example * var navigate = function(panel, direction){ * // This routine could contain business logic required to manage the navigation steps. * // It would call setActiveItem as needed, manage navigation button state, handle any * // branching logic that might be required, handle alternate actions like cancellation * // or finalization, etc. A complete wizard implementation could get pretty * // sophisticated depending on the complexity required, and should probably be * // done as a subclass of CardLayout in a real-world implementation. * var layout = panel.getLayout(); * layout[direction](); * Ext.getCmp('move-prev').setDisabled(!layout.getPrev()); * Ext.getCmp('move-next').setDisabled(!layout.getNext()); * }; * * Ext.create('Ext.panel.Panel', { * title: 'Example Wizard', * width: 300, * height: 200, * layout: 'card', * bodyStyle: 'padding:15px', * defaults: { * // applied to each contained panel * border: false * }, * // just an example of one possible navigation scheme, using buttons * bbar: [ * { * id: 'move-prev', * text: 'Back', * handler: function(btn) { * navigate(btn.up("panel"), "prev"); * }, * disabled: true * }, * '->', // greedy spacer so that the buttons are aligned to each side * { * id: 'move-next', * text: 'Next', * handler: function(btn) { * navigate(btn.up("panel"), "next"); * } * } * ], * // the panels (or "cards") within the layout * items: [{ * id: 'card-0', * html: '

    Welcome to the Wizard!

    Step 1 of 3

    ' * },{ * id: 'card-1', * html: '

    Step 2 of 3

    ' * },{ * id: 'card-2', * html: '

    Congratulations!

    Step 3 of 3 - Complete

    ' * }], * renderTo: Ext.getBody() * }); */ Ext.define('Ext.layout.container.Card', { /* Begin Definitions */ extend: Ext.layout.container.Fit , alternateClassName: 'Ext.layout.CardLayout', alias: 'layout.card', /* End Definitions */ type: 'card', hideInactive: true, /** * @cfg {Boolean} deferredRender * True to render each contained item at the time it becomes active, false to render all contained items * as soon as the layout is rendered (defaults to false). If there is a significant amount of content or * a lot of heavy controls being rendered into panels that are not displayed by default, setting this to * true might improve performance. */ deferredRender : false, getRenderTree: function () { var me = this, activeItem = me.getActiveItem(); if (activeItem) { // If they veto the activate, we have no active item if (activeItem.hasListeners.beforeactivate && activeItem.fireEvent('beforeactivate', activeItem) === false) { // We must null our activeItem reference, AND the one in our owning Container. // Because upon layout invalidation, renderChildren will use this.getActiveItem which // uses this.activeItem || this.owner.activeItem activeItem = me.activeItem = me.owner.activeItem = null; } // Item is to be the active one. Fire event after it is first layed out else if (activeItem.hasListeners.activate) { activeItem.on({ boxready: function() { activeItem.fireEvent('activate', activeItem); }, single: true }); } if (me.deferredRender) { if (activeItem) { return me.getItemsRenderTree([activeItem]); } } else { return me.callParent(arguments); } } }, renderChildren: function () { var me = this, active = me.getActiveItem(); if (!me.deferredRender) { me.callParent(); } else if (active) { // ensure the active item is configured for the layout me.renderItems([active], me.getRenderTarget()); } }, isValidParent : function(item, target, position) { // Note: Card layout does not care about order within the target because only one is ever visible. // We only care whether the item is a direct child of the target. var itemEl = item.el ? item.el.dom : Ext.getDom(item); return (itemEl && itemEl.parentNode === (target.dom || target)) || false; }, /** * Return the active (visible) component in the layout. * @returns {Ext.Component} */ getActiveItem: function() { var me = this, // Ensure the calculated result references a Component result = me.parseActiveItem(me.activeItem || (me.owner && me.owner.activeItem)); // Sanitize the result in case the active item is no longer there. if (result && me.owner.items.indexOf(result) != -1) { me.activeItem = result; } else { me.activeItem = null; } return me.activeItem; }, // @private parseActiveItem: function(item) { if (item && item.isComponent) { return item; } else if (typeof item == 'number' || item === undefined) { return this.getLayoutItems()[item || 0]; } else { return this.owner.getComponent(item); } }, // @private. Called before both dynamic render, and bulk render. // Ensure that the active item starts visible, and inactive ones start invisible configureItem: function(item) { if (item === this.getActiveItem()) { item.hidden = false; } else { item.hidden = true; } this.callParent(arguments); }, onRemove: function(component) { var me = this; if (component === me.activeItem) { me.activeItem = null; } }, // @private getAnimation: function(newCard, owner) { var newAnim = (newCard || {}).cardSwitchAnimation; if (newAnim === false) { return false; } return newAnim || owner.cardSwitchAnimation; }, /** * Return the active (visible) component in the layout to the next card * @returns {Ext.Component} The next component or false. */ getNext: function() { var wrap = arguments[0], items = this.getLayoutItems(), index = Ext.Array.indexOf(items, this.activeItem); return items[index + 1] || (wrap ? items[0] : false); }, /** * Sets the active (visible) component in the layout to the next card * @return {Ext.Component} the activated component or false when nothing activated. */ next: function() { var anim = arguments[0], wrap = arguments[1]; return this.setActiveItem(this.getNext(wrap), anim); }, /** * Return the active (visible) component in the layout to the previous card * @returns {Ext.Component} The previous component or false. */ getPrev: function() { var wrap = arguments[0], items = this.getLayoutItems(), index = Ext.Array.indexOf(items, this.activeItem); return items[index - 1] || (wrap ? items[items.length - 1] : false); }, /** * Sets the active (visible) component in the layout to the previous card * @return {Ext.Component} the activated component or false when nothing activated. */ prev: function() { var anim = arguments[0], wrap = arguments[1]; return this.setActiveItem(this.getPrev(wrap), anim); }, /** * Makes the given card active. * * var card1 = Ext.create('Ext.panel.Panel', {itemId: 'card-1'}); * var card2 = Ext.create('Ext.panel.Panel', {itemId: 'card-2'}); * var panel = Ext.create('Ext.panel.Panel', { * layout: 'card', * activeItem: 0, * items: [card1, card2] * }); * // These are all equivalent * panel.getLayout().setActiveItem(card2); * panel.getLayout().setActiveItem('card-2'); * panel.getLayout().setActiveItem(1); * * @param {Ext.Component/Number/String} newCard The component, component {@link Ext.Component#id id}, * {@link Ext.Component#itemId itemId}, or index of component. * @return {Ext.Component} the activated component or false when nothing activated. * False is returned also when trying to activate an already active card. */ setActiveItem: function(newCard) { var me = this, owner = me.owner, oldCard = me.activeItem, rendered = owner.rendered, newIndex; newCard = me.parseActiveItem(newCard); newIndex = owner.items.indexOf(newCard); // If the card is not a child of the owner, then add it. // Without doing a layout! if (newIndex == -1) { newIndex = owner.items.items.length; Ext.suspendLayouts(); newCard = owner.add(newCard); Ext.resumeLayouts(); } // Is this a valid, different card? if (newCard && oldCard != newCard) { // Fire the beforeactivate and beforedeactivate events on the cards if (newCard.fireEvent('beforeactivate', newCard, oldCard) === false) { return false; } if (oldCard && oldCard.fireEvent('beforedeactivate', oldCard, newCard) === false) { return false; } if (rendered) { Ext.suspendLayouts(); // If the card has not been rendered yet, now is the time to do so. if (!newCard.rendered) { me.renderItem(newCard, me.getRenderTarget(), owner.items.length); } if (oldCard) { if (me.hideInactive) { oldCard.hide(); oldCard.hiddenByLayout = true; } oldCard.fireEvent('deactivate', oldCard, newCard); } // Make sure the new card is shown if (newCard.hidden) { newCard.show(); } // Layout needs activeItem to be correct, so set it if the show has not been vetoed if (!newCard.hidden) { me.activeItem = newCard; } Ext.resumeLayouts(true); } else { me.activeItem = newCard; } newCard.fireEvent('activate', newCard, oldCard); return me.activeItem; } return false; } }); /** * This is the layout style of choice for creating structural layouts in a multi-column format where the width of each * column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content. This * class is intended to be extended or created via the layout:'column' {@link Ext.container.Container#layout} config, * and should generally not need to be created directly via the new keyword. * * ColumnLayout does not have any direct config options (other than inherited ones), but it does support a specific * config property of `columnWidth` that can be included in the config of any panel added to it. The layout will use * the columnWidth (if present) or width of each panel during layout to determine how to size each panel. If width or * columnWidth is not specified for a given panel, its width will default to the panel's width (or auto). * * The width property is always evaluated as pixels, and must be a number greater than or equal to 1. The columnWidth * property is always evaluated as a percentage, and must be a decimal value greater than 0 and less than 1 (e.g., .25). * * The basic rules for specifying column widths are pretty simple. The logic makes two passes through the set of * contained panels. During the first layout pass, all panels that either have a fixed width or none specified (auto) * are skipped, but their widths are subtracted from the overall container width. * * During the second pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages * based on the total **remaining** container width. In other words, percentage width panels are designed to fill * the space left over by all the fixed-width and/or auto-width panels. Because of this, while you can specify any * number of columns with different percentages, the columnWidths must always add up to 1 (or 100%) when added * together, otherwise your layout may not render as expected. * * @example * // All columns are percentages -- they must add up to 1 * Ext.create('Ext.panel.Panel', { * title: 'Column Layout - Percentage Only', * width: 350, * height: 250, * layout:'column', * items: [{ * title: 'Column 1', * columnWidth: 0.25 * },{ * title: 'Column 2', * columnWidth: 0.55 * },{ * title: 'Column 3', * columnWidth: 0.20 * }], * renderTo: Ext.getBody() * }); * * // Mix of width and columnWidth -- all columnWidth values must add up * // to 1. The first column will take up exactly 120px, and the last two * // columns will fill the remaining container width. * * Ext.create('Ext.Panel', { * title: 'Column Layout - Mixed', * width: 350, * height: 250, * layout:'column', * items: [{ * title: 'Column 1', * width: 120 * },{ * title: 'Column 2', * columnWidth: 0.7 * },{ * title: 'Column 3', * columnWidth: 0.3 * }], * renderTo: Ext.getBody() * }); */ Ext.define('Ext.layout.container.Column', { extend: Ext.layout.container.Auto , alias: ['layout.column'], alternateClassName: 'Ext.layout.ColumnLayout', type: 'column', itemCls: Ext.baseCSSPrefix + 'column', targetCls: Ext.baseCSSPrefix + 'column-layout-ct', // Columns with a columnWidth have their width managed. columnWidthSizePolicy: { readsWidth: 0, readsHeight: 1, setsWidth: 1, setsHeight: 0 }, createsInnerCt: true, manageOverflow: true, isItemShrinkWrap: function(ownerContext){ return true; }, getItemSizePolicy: function (item, ownerSizeModel) { if (item.columnWidth) { if (!ownerSizeModel) { ownerSizeModel = this.owner.getSizeModel(); } if (!ownerSizeModel.width.shrinkWrap) { return this.columnWidthSizePolicy; } } return this.autoSizePolicy; }, calculateItems: function (ownerContext, containerSize) { var me = this, targetContext = ownerContext.targetContext, items = ownerContext.childItems, len = items.length, contentWidth = 0, gotWidth = containerSize.gotWidth, blocked, availableWidth, i, itemContext, itemMarginWidth, itemWidth; // No parallel measurement, cannot lay out boxes. if (gotWidth === false) { //\\ TODO: Deal with target padding width // TODO: only block if we have items with columnWidth targetContext.domBlock(me, 'width'); blocked = true; } else if (gotWidth) { availableWidth = containerSize.width; } else { // gotWidth is undefined, which means we must be width shrink wrap. // cannot calculate columnWidths if we're shrink wrapping. return true; } // we need the widths of the columns we don't manage to proceed so we block on them // if they are not ready... for (i = 0; i < len; ++i) { itemContext = items[i]; // this is needed below for non-calculated columns, but is also needed in the // next loop for calculated columns... this way we only call getMarginInfo in // this loop and use the marginInfo property in the next... itemMarginWidth = itemContext.getMarginInfo().width; if (!itemContext.widthModel.calculated) { itemWidth = itemContext.getProp('width'); if (typeof itemWidth != 'number') { itemContext.block(me, 'width'); blocked = true; } contentWidth += itemWidth + itemMarginWidth; } } if (!blocked) { availableWidth = (availableWidth < contentWidth) ? 0 : availableWidth - contentWidth; for (i = 0; i < len; ++i) { itemContext = items[i]; if (itemContext.widthModel.calculated) { itemMarginWidth = itemContext.marginInfo.width; // always set by above loop itemWidth = itemContext.target.columnWidth; itemWidth = Math.floor(itemWidth * availableWidth) - itemMarginWidth; itemWidth = itemContext.setWidth(itemWidth); // constrains to min/maxWidth contentWidth += itemWidth + itemMarginWidth; } } ownerContext.setContentWidth(contentWidth + ownerContext.paddingContext.getPaddingInfo().width); } // we registered all the values that block this calculation, so abort now if blocked... return !blocked; }, setCtSizeIfNeeded: function(ownerContext, containerSize) { var me = this, padding = ownerContext.paddingContext.getPaddingInfo(); me.callParent(arguments); // IE6/7/quirks lose right padding when using the shrink wrap template, so // reduce the size of the outerCt by the amount of right padding. if ((Ext.isIEQuirks || Ext.isIE7m) && me.isShrinkWrapTpl && padding.right) { ownerContext.outerCtContext.setProp('width', containerSize.width + padding.left); } } }); /** * This is a layout that will render form Fields, one under the other all stretched to the Container width. * * @example * Ext.create('Ext.Panel', { * width: 500, * height: 300, * title: "FormLayout Panel", * layout: 'form', * renderTo: Ext.getBody(), * bodyPadding: 5, * defaultType: 'textfield', * items: [{ * fieldLabel: 'First Name', * name: 'first', * allowBlank:false * },{ * fieldLabel: 'Last Name', * name: 'last' * },{ * fieldLabel: 'Company', * name: 'company' * }, { * fieldLabel: 'Email', * name: 'email', * vtype:'email' * }, { * fieldLabel: 'DOB', * name: 'dob', * xtype: 'datefield' * }, { * fieldLabel: 'Age', * name: 'age', * xtype: 'numberfield', * minValue: 0, * maxValue: 100 * }, { * xtype: 'timefield', * fieldLabel: 'Time', * name: 'time', * minValue: '8:00am', * maxValue: '6:00pm' * }] * }); * * Note that any configured {@link Ext.Component#padding padding} will be ignored on items within a Form layout. */ Ext.define('Ext.layout.container.Form', { /* Begin Definitions */ alias: 'layout.form', extend: Ext.layout.container.Container , alternateClassName: 'Ext.layout.FormLayout', /* End Definitions */ tableCls: Ext.baseCSSPrefix + 'form-layout-table', type: 'form', createsInnerCt: true, manageOverflow: true, // Begin with no previous adjustments lastOverflowAdjust: { width: 0, height: 0 }, childEls: ['formTable'], padRow: '', renderTpl: [ '', '{%this.renderBody(out,values)%}', '
    ', '{%this.renderPadder(out,values)%}' ], getRenderData: function(){ var data = this.callParent(); data.tableCls = this.tableCls; return data; }, calculate : function (ownerContext) { var me = this, containerSize = me.getContainerSize(ownerContext, true), tableWidth, childItems, i = 0, length, shrinkwrapHeight = ownerContext.sizeModel.height.shrinkWrap; if (shrinkwrapHeight) { if (ownerContext.hasDomProp('containerChildrenSizeDone')) { ownerContext.setProp('contentHeight', me.formTable.dom.offsetHeight + ownerContext.targetContext.getPaddingInfo().height); } else { me.done = false; } } // Once we have been widthed, we can impose that width (in a non-dirty setting) upon all children at once if (containerSize.gotWidth) { tableWidth = me.formTable.dom.offsetWidth; childItems = ownerContext.childItems; for (length = childItems.length; i < length; ++i) { childItems[i].setWidth(tableWidth, false); } } else { me.done = false; } }, getRenderTarget: function() { return this.formTable; }, getRenderTree: function() { var me = this, result = me.callParent(arguments), i, len; for (i = 0, len = result.length; i < len; i++) { result[i] = me.transformItemRenderTree(result[i]); } return result; }, transformItemRenderTree: function(item) { if (item.tag && item.tag == 'table') { item.tag = 'tbody'; delete item.cellspacing; delete item.cellpadding; // IE6 doesn't separate cells nicely to provide input field // vertical separation. It also does not support transparent borders // which is how the extra 1px is added to the 2px each side cell spacing. // So it needs a 5px high pad row. if (Ext.isIE6) { item.cn = this.padRow; } return item; } return { tag: 'tbody', cn: { tag: 'tr', cn: { tag: 'td', colspan: 3, style: 'width:100%', cn: item } } }; }, isValidParent: function(item, target, position) { return true; }, isItemShrinkWrap: function(item) { return ((item.shrinkWrap === true) ? 3 : item.shrinkWrap||0) & 2; }, getItemSizePolicy: function(item) { return { setsWidth: 1, setsHeight: 0 }; }, // All of the below methods are old methods moved here from Container layout // TODO: remove these methods once Form layout extends Auto layout beginLayoutCycle: function (ownerContext, firstCycle) { var padEl = this.overflowPadderEl; if (padEl) { padEl.setStyle('display', 'none'); } // Begin with the scrollbar adjustment that we used last time - this is more likely to be correct // than beginning with no adjustment at all if (!ownerContext.state.overflowAdjust) { ownerContext.state.overflowAdjust = this.lastOverflowAdjust; } }, /** * Handles overflow processing for a container. This should be called once the layout * has determined contentWidth/Height. In addition to the ownerContext passed to the * {@link #calculate} method, this method also needs the containerSize (the object * returned by {@link #getContainerSize}). * * @param {Ext.layout.ContextItem} ownerContext * @param {Object} containerSize * @param {Number} dimensions A bit mask for the overflow managed dimensions. The 0-bit * is for `width` and the 1-bit is for `height`. In other words, a value of 1 would be * only `width`, 2 would be only `height` and 3 would be both. */ calculateOverflow: function (ownerContext, containerSize, dimensions) { var me = this, targetContext = ownerContext.targetContext, manageOverflow = me.manageOverflow, state = ownerContext.state, overflowAdjust = state.overflowAdjust, padWidth, padHeight, padElContext, padding, scrollRangeFlags, scrollbarSize, contentW, contentH, ownerW, ownerH, scrollbars, xauto, yauto; if (manageOverflow && !state.secondPass && !me.reserveScrollbar) { // Determine the dimensions that have overflow:auto applied. If these come by // way of component config, this does not require a DOM read: xauto = (me.getOverflowXStyle(ownerContext) === 'auto'); yauto = (me.getOverflowYStyle(ownerContext) === 'auto'); // If the container layout is not using width, we don't need to adjust for the // vscroll (likewise for height). Perhaps we don't even need to run the layout // again if the adjustments won't have any effect on the result! if (!containerSize.gotWidth) { xauto = false; } if (!containerSize.gotHeight) { yauto = false; } if (xauto || yauto) { scrollbarSize = Ext.getScrollbarSize(); // as a container we calculate contentWidth/Height, so we don't want // to use getProp and make it look like we are triggered by them... contentW = ownerContext.peek('contentWidth'); contentH = ownerContext.peek('contentHeight'); // The content size includes the target element's padding. Since // the containerSize excludes the target element's padding, we need // to subtract this padding from the content size before checking // to see if scrollbars are needed. padding = targetContext.getPaddingInfo(); contentW -= padding.width; contentH -= padding.height; ownerW = containerSize.width; ownerH = containerSize.height; scrollbars = me.getScrollbarsNeeded(ownerW, ownerH, contentW, contentH); state.overflowState = scrollbars; if (typeof dimensions == 'number') { scrollbars &= ~dimensions; // ignore dimensions that have no effect } overflowAdjust = { width: (xauto && (scrollbars & 2)) ? scrollbarSize.width : 0, height: (yauto && (scrollbars & 1)) ? scrollbarSize.height : 0 }; // We can have 0-sized scrollbars (new Mac OS) and so don't invalidate // the layout unless this will change something... if (overflowAdjust.width !== me.lastOverflowAdjust.width || overflowAdjust.height !== me.lastOverflowAdjust.height) { me.done = false; // we pass overflowAdjust and overflowState in as state for the next // cycle (these are discarded if one of our ownerCt's invalidates): ownerContext.invalidate({ state: { overflowAdjust: overflowAdjust, overflowState: state.overflowState, secondPass: true } }); } } } if (!me.done) { return; } padElContext = ownerContext.padElContext || (ownerContext.padElContext = ownerContext.getEl('overflowPadderEl', me)); // Even if overflow does not effect the layout, we still do need the padEl to be // sized or hidden appropriately... if (padElContext) { scrollbars = state.overflowState; // the true overflow state padWidth = ownerContext.peek('contentWidth'); // the padder element must have a height of at least 1px, or its width will be ignored by the container. // The extra height is adjusted for by adding a -1px top margin to the padder element padHeight = 1; if (scrollbars) { padding = targetContext.getPaddingInfo(); scrollRangeFlags = me.scrollRangeFlags; if ((scrollbars & 2) && (scrollRangeFlags & 1)) { // if (vscroll and loses bottom) padHeight += padding.bottom; } if ((scrollbars & 1) && (scrollRangeFlags & 4)) { // if (hscroll and loses right) padWidth += padding.right; } padElContext.setProp('display', ''); padElContext.setSize(padWidth, padHeight); } else { padElContext.setProp('display', 'none'); } } }, completeLayout: function (ownerContext) { // Cache the scrollbar adjustment this.lastOverflowAdjust = ownerContext.state.overflowAdjust; }, /** * Creates an element that makes bottom/right body padding consistent across browsers. * This element is sized based on the need for scrollbars in {@link #calculateOverflow}. * If the {@link #manageOverflow} option is false, this element is not created. * * See {@link #getScrollRangeFlags} for more details. */ doRenderPadder: function (out, renderData) { // Careful! This method is bolted on to the renderTpl so all we get for context is // the renderData! The "this" pointer is the renderTpl instance! var me = renderData.$layout, owner = me.owner, scrollRangeFlags = me.getScrollRangeFlags(); if (me.manageOverflow) { if (scrollRangeFlags & 5) { // if (loses parent bottom and/or right padding) out.push('
    '); me.scrollRangeFlags = scrollRangeFlags; // remember for calculateOverflow } } }, /** * Returns the container size (that of the target). Only the fixed-sized dimensions can * be returned because the shrinkWrap dimensions are based on the contentWidth/Height * as determined by the container layout. * * If the {@link #calculateOverflow} method is used and if {@link #manageOverflow} is * true, this may adjust the width/height by the size of scrollbars. * * @param {Ext.layout.ContextItem} ownerContext The owner's context item. * @param {Boolean} [inDom=false] True if the container size must be in the DOM. * @param {Boolean} [ignoreOverflow=true] if true scrollbar size will not be * subtracted from container size. * @return {Object} The size * @return {Number} return.width The width * @return {Number} return.height The height * @protected */ getContainerSize : function(ownerContext, inDom, ignoreOverflow) { // Subtle But Important: // // We don't want to call getProp/hasProp et.al. unless we in fact need that value // for our results! If we call it and don't need it, the layout manager will think // we depend on it and will schedule us again should it change. var targetContext = ownerContext.targetContext, frameInfo = targetContext.getFrameInfo(), // if we're managing padding the padding is on the innerCt instead of the targetEl padding = targetContext.getPaddingInfo(), got = 0, needed = 0, overflowAdjust = ignoreOverflow ? null : ownerContext.state.overflowAdjust, gotWidth, gotHeight, width, height; // In an shrinkWrap width/height case, we must not ask for any of these dimensions // because they will be determined by contentWidth/Height which is calculated by // this layout... // Fit/Card layouts are able to set just the width of children, allowing child's // resulting height to autosize the Container. // See examples/tabs/tabs.html for an example of this. if (!ownerContext.widthModel.shrinkWrap) { ++needed; width = inDom ? targetContext.getDomProp('width') : targetContext.getProp('width'); gotWidth = (typeof width == 'number'); if (gotWidth) { ++got; width -= frameInfo.width + padding.width; if (overflowAdjust) { width -= overflowAdjust.width; } } } if (!ownerContext.heightModel.shrinkWrap) { ++needed; height = inDom ? targetContext.getDomProp('height') : targetContext.getProp('height'); gotHeight = (typeof height == 'number'); if (gotHeight) { ++got; height -= frameInfo.height + padding.height; if (overflowAdjust) { height -= overflowAdjust.height; } } } return { width: width, height: height, needed: needed, got: got, gotAll: got == needed, gotWidth: gotWidth, gotHeight: gotHeight }; }, /** * returns the overflow-x style of the render target * @protected * @param {Ext.layout.ContextItem} ownerContext * @return {String} */ getOverflowXStyle: function(ownerContext) { var me = this; return me.overflowXStyle || (me.overflowXStyle = me.owner.scrollFlags.overflowX || ownerContext.targetContext.getStyle('overflow-x')); }, /** * returns the overflow-y style of the render target * @protected * @param {Ext.layout.ContextItem} ownerContext * @return {String} */ getOverflowYStyle: function(ownerContext) { var me = this; return me.overflowYStyle || (me.overflowYStyle = me.owner.scrollFlags.overflowY || ownerContext.targetContext.getStyle('overflow-y')); }, /** * Returns flags indicating cross-browser handling of scrollHeight/Width. In particular, * IE has issues with padding-bottom in a scrolling element (it does not include that * padding in the scrollHeight). Also, margin-bottom on a child in a scrolling element * can be lost. * * All browsers seem to ignore margin-right on children and padding-right on the parent * element (the one with the overflow) * * This method returns a number with the follow bit positions set based on things not * accounted for in scrollHeight and scrollWidth: * * - 1: Scrolling element's padding-bottom is not included in scrollHeight. * - 2: Last child's margin-bottom is not included in scrollHeight. * - 4: Scrolling element's padding-right is not included in scrollWidth. * - 8: Child's margin-right is not included in scrollWidth. * * To work around the margin-bottom issue, it is sufficient to create a 0px tall last * child that will "hide" the margin. This can also be handled by wrapping the children * in an element, again "hiding" the margin. Wrapping the elements is about the only * way to preserve their right margins. This is the strategy used by Column layout. * * To work around the padding-bottom problem, since it is comes from a style on the * parent element, about the only simple fix is to create a last child with height * equal to padding-bottom. To preserve the right padding, the sizing element needs to * have a width that includes the right padding. */ getScrollRangeFlags: (function () { var flags = -1; return function () { if (flags < 0) { var div = Ext.getBody().createChild({ //cls: 'x-border-box x-hide-offsets', cls: Ext.baseCSSPrefix + 'border-box', style: { width: '100px', height: '100px', padding: '10px', overflow: 'auto' }, children: [{ style: { border: '1px solid red', width: '150px', height: '150px', margin: '0 5px 5px 0' // TRBL } }] }), scrollHeight = div.dom.scrollHeight, scrollWidth = div.dom.scrollWidth, heightFlags = { // right answer, nothing missing: 175: 0, // missing parent padding-bottom: 165: 1, // missing child margin-bottom: 170: 2, // missing both 160: 3 }, widthFlags = { // right answer, nothing missing: 175: 0, // missing parent padding-right: 165: 4, // missing child margin-right: 170: 8, // missing both 160: 12 }; flags = (heightFlags[scrollHeight] || 0) | (widthFlags[scrollWidth] || 0); //Ext.log('flags=',flags.toString(2)); div.remove(); } return flags; }; }()), initLayout: function() { var me = this, scrollbarWidth = Ext.getScrollbarSize().width; me.callParent(); // Create a default lastOverflowAdjust based upon scrolling configuration. // If the Container is to overflow, or we *always* reserve space for a scrollbar // then reserve space for a vertical scrollbar if (scrollbarWidth && me.manageOverflow && !me.hasOwnProperty('lastOverflowAdjust')) { if (me.owner.scrollFlags.y || me.reserveScrollbar) { me.lastOverflowAdjust = { width: scrollbarWidth, height: 0 }; } } }, setupRenderTpl: function (renderTpl) { this.callParent(arguments); renderTpl.renderPadder = this.doRenderPadder; } }); /** * A base class for all menu items that require menu-related functionality such as click handling, * sub-menus, icons, etc. * * @example * Ext.create('Ext.menu.Menu', { * width: 100, * height: 100, * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * text: 'icon item', * iconCls: 'add16' * },{ * text: 'text item' * },{ * text: 'plain item', * plain: true * }] * }); */ Ext.define('Ext.menu.Item', { extend: Ext.Component , alias: 'widget.menuitem', alternateClassName: 'Ext.menu.TextItem', mixins: { queryable: Ext.Queryable }, /** * @property {Boolean} activated * Whether or not this item is currently activated */ /** * @property {Ext.menu.Menu} parentMenu * The parent Menu of this item. */ /** * @cfg {String} activeCls * The CSS class added to the menu item when the item is activated (focused/mouseover). */ activeCls: Ext.baseCSSPrefix + 'menu-item-active', /** * @cfg {String} ariaRole * @private */ ariaRole: 'menuitem', /** * @cfg {Boolean} canActivate * Whether or not this menu item can be activated when focused/mouseovered. */ canActivate: true, /** * @cfg {Number} clickHideDelay * The delay in milliseconds to wait before hiding the menu after clicking the menu item. * This only has an effect when `hideOnClick: true`. */ clickHideDelay: 0, /** * @cfg {Boolean} destroyMenu * Whether or not to destroy any associated sub-menu when this item is destroyed. */ destroyMenu: true, /** * @cfg {String} disabledCls * The CSS class added to the menu item when the item is disabled. */ disabledCls: Ext.baseCSSPrefix + 'menu-item-disabled', /** * @cfg {String} [href='#'] * The href attribute to use for the underlying anchor link. */ /** * @cfg {String} hrefTarget * The target attribute to use for the underlying anchor link. */ /** * @cfg {Boolean} hideOnClick * Whether to not to hide the owning menu when this item is clicked. */ hideOnClick: true, /** * @cfg {String} icon * The path to an icon to display in this item. * * Defaults to `Ext.BLANK_IMAGE_URL`. */ /** * @cfg {String} iconCls * A CSS class that specifies a `background-image` to use as the icon for this item. */ /** * @cfg {Number/String} glyph * A numeric unicode character code to use as the icon for this item. The default * font-family for glyphs can be set globally using * {@link Ext#setGlyphFontFamily Ext.setGlyphFontFamily()}. Alternatively, this * config option accepts a string with the charCode and font-family separated by the * `@` symbol. For example '65@My Font Family'. */ isMenuItem: true, /** * @cfg {Ext.menu.Menu/Object} menu * Either an instance of {@link Ext.menu.Menu} or a config object for an {@link Ext.menu.Menu} * which will act as a sub-menu to this item. */ /** * @property {Ext.menu.Menu} menu The sub-menu associated with this item, if one was configured. */ /** * @cfg {String} menuAlign * The default {@link Ext.util.Positionable#getAlignToXY Ext.util.Positionable.getAlignToXY} anchor position value for this * item's sub-menu relative to this item's position. */ menuAlign: 'tl-tr?', /** * @cfg {Number} menuExpandDelay * The delay in milliseconds before this item's sub-menu expands after this item is moused over. */ menuExpandDelay: 200, /** * @cfg {Number} menuHideDelay * The delay in milliseconds before this item's sub-menu hides after this item is moused out. */ menuHideDelay: 200, /** * @cfg {Boolean} plain * Whether or not this item is plain text/html with no icon or visual activation. */ /** * @cfg {String/Object} tooltip * The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or * QuickTips config object. */ /** * @cfg {String} tooltipType * The type of tooltip to use. Either 'qtip' for QuickTips or 'title' for title attribute. */ tooltipType: 'qtip', arrowCls: Ext.baseCSSPrefix + 'menu-item-arrow', childEls: [ 'itemEl', 'iconEl', 'textEl', 'arrowEl' ], renderTpl: [ '', '{text}', '', ' target="{hrefTarget}"', ' hidefocus="true"', // For most browsers the text is already unselectable but Opera needs an explicit unselectable="on". ' unselectable="on"', '', ' tabIndex="{tabIndex}"', '', '>', '', '{text}', '', '', '' ], maskOnDisable: false, /** * @cfg {String} text * The text/html to display in this item. */ /** * @cfg {Function} handler * A function called when the menu item is clicked (can be used instead of {@link #click} event). * @cfg {Ext.menu.Item} handler.item The item that was clicked * @cfg {Ext.EventObject} handler.e The underyling {@link Ext.EventObject}. */ activate: function() { var me = this; if (!me.activated && me.canActivate && me.rendered && !me.isDisabled() && me.isVisible()) { me.el.addCls(me.activeCls); me.focus(); me.activated = true; me.fireEvent('activate', me); } }, getFocusEl: function() { return this.itemEl; }, deactivate: function() { var me = this; if (me.activated) { me.el.removeCls(me.activeCls); me.blur(); me.hideMenu(); me.activated = false; me.fireEvent('deactivate', me); } }, deferHideMenu: function() { if (this.menu.isVisible()) { this.menu.hide(); } }, cancelDeferHide: function(){ clearTimeout(this.hideMenuTimer); }, deferHideParentMenus: function() { var ancestor; Ext.menu.Manager.hideAll(); if (!Ext.Element.getActiveElement()) { // If we have just hidden all Menus, and there is no currently focused element in the dom, transfer focus to the first visible ancestor if any. ancestor = this.up(':not([hidden])'); if (ancestor) { ancestor.focus(); } } }, expandMenu: function(delay) { var me = this; if (me.menu) { me.cancelDeferHide(); if (delay === 0) { me.doExpandMenu(); } else { clearTimeout(me.expandMenuTimer); me.expandMenuTimer = Ext.defer(me.doExpandMenu, Ext.isNumber(delay) ? delay : me.menuExpandDelay, me); } } }, doExpandMenu: function() { var me = this, menu = me.menu; if (me.activated && (!menu.rendered || !menu.isVisible())) { me.parentMenu.activeChild = menu; menu.parentItem = me; menu.parentMenu = me.parentMenu; menu.showBy(me, me.menuAlign); } }, getRefItems: function(deep) { var menu = this.menu, items; if (menu) { items = menu.getRefItems(deep); items.unshift(menu); } return items || []; }, hideMenu: function(delay) { var me = this; if (me.menu) { clearTimeout(me.expandMenuTimer); me.hideMenuTimer = Ext.defer(me.deferHideMenu, Ext.isNumber(delay) ? delay : me.menuHideDelay, me); } }, initComponent: function() { var me = this, prefix = Ext.baseCSSPrefix, cls = [prefix + 'menu-item'], menu; me.addEvents( /** * @event activate * Fires when this item is activated * @param {Ext.menu.Item} item The activated item */ 'activate', /** * @event click * Fires when this item is clicked * @param {Ext.menu.Item} item The item that was clicked * @param {Ext.EventObject} e The underyling {@link Ext.EventObject}. */ 'click', /** * @event deactivate * Fires when this tiem is deactivated * @param {Ext.menu.Item} item The deactivated item */ 'deactivate', /** * @event textchange * Fired when the item's text is changed by the {@link #setText} method. * @param {Ext.menu.Item} this * @param {String} oldText * @param {String} newText */ 'textchange', /** * @event iconchange * Fired when the item's icon is changed by the {@link #setIcon} or {@link #setIconCls} methods. * @param {Ext.menu.Item} this * @param {String} oldIcon * @param {String} newIcon */ 'iconchange' ); if (me.plain) { cls.push(prefix + 'menu-item-plain'); } if (me.cls) { cls.push(me.cls); } me.cls = cls.join(' '); if (me.menu) { menu = me.menu; delete me.menu; me.setMenu(menu); } me.callParent(arguments); }, onClick: function(e) { var me = this, clickHideDelay = me.clickHideDelay; if (!me.href) { e.stopEvent(); } if (me.disabled) { return; } if (me.hideOnClick) { if (!clickHideDelay) { me.deferHideParentMenus(); } else { me.deferHideParentMenusTimer = Ext.defer(me.deferHideParentMenus, clickHideDelay, me); } } Ext.callback(me.handler, me.scope || me, [me, e]); me.fireEvent('click', me, e); if (!me.hideOnClick) { me.focus(); } }, onRemoved: function() { var me = this; // Removing the active item, must deactivate it. if (me.activated && me.parentMenu.activeItem === me) { me.parentMenu.deactivateActiveItem(); } me.callParent(arguments); me.parentMenu = me.ownerButton = null; }, // @private beforeDestroy: function() { var me = this; if (me.rendered) { me.clearTip(); } me.callParent(); }, onDestroy: function() { var me = this; clearTimeout(me.expandMenuTimer); me.cancelDeferHide(); clearTimeout(me.deferHideParentMenusTimer); me.setMenu(null); me.callParent(arguments); }, beforeRender: function() { var me = this, blank = Ext.BLANK_IMAGE_URL, glyph = me.glyph, glyphFontFamily = Ext._glyphFontFamily, glyphParts, iconCls, arrowCls; me.callParent(); if (me.iconAlign === 'right') { iconCls = me.checkChangeDisabled ? me.disabledCls : ''; arrowCls = Ext.baseCSSPrefix + 'menu-item-icon-right ' + me.iconCls; } else { iconCls = (me.iconCls || '') + (me.checkChangeDisabled ? ' ' + me.disabledCls : ''); arrowCls = me.menu ? me.arrowCls : ''; } if (typeof glyph === 'string') { glyphParts = glyph.split('@'); glyph = glyphParts[0]; glyphFontFamily = glyphParts[1]; } Ext.applyIf(me.renderData, { href: me.href || '#', hrefTarget: me.hrefTarget, icon: me.icon, iconCls: iconCls, glyph: glyph, glyphCls: glyph ? Ext.baseCSSPrefix + 'menu-item-glyph' : undefined, glyphFontFamily: glyphFontFamily, hasIcon: !!(me.icon || me.iconCls || glyph), iconAlign: me.iconAlign, plain: me.plain, text: me.text, arrowCls: arrowCls, blank: blank, tabIndex: me.tabIndex }); }, onRender: function() { var me = this; me.callParent(arguments); if (me.tooltip) { me.setTooltip(me.tooltip, true); } }, /** * Set a child menu for this item. See the {@link #cfg-menu} configuration. * @param {Ext.menu.Menu/Object} menu A menu, or menu configuration. null may be * passed to remove the menu. * @param {Boolean} [destroyMenu] True to destroy any existing menu. False to * prevent destruction. If not specified, the {@link #destroyMenu} configuration * will be used. */ setMenu: function(menu, destroyMenu) { var me = this, oldMenu = me.menu, arrowEl = me.arrowEl; if (oldMenu) { delete oldMenu.parentItem; delete oldMenu.parentMenu; delete oldMenu.ownerItem; if (destroyMenu === true || (destroyMenu !== false && me.destroyMenu)) { Ext.destroy(oldMenu); } } if (menu) { me.menu = Ext.menu.Manager.get(menu); me.menu.ownerItem = me; } else { me.menu = null; } if (me.rendered && !me.destroying && arrowEl) { arrowEl[me.menu ? 'addCls' : 'removeCls'](me.arrowCls); } }, /** * Sets the {@link #click} handler of this item * @param {Function} fn The handler function * @param {Object} [scope] The scope of the handler function */ setHandler: function(fn, scope) { this.handler = fn || null; this.scope = scope; }, /** * Sets the {@link #icon} on this item. * @param {String} icon The new icon */ setIcon: function(icon){ var iconEl = this.iconEl, oldIcon = this.icon; if (iconEl) { iconEl.src = icon || Ext.BLANK_IMAGE_URL; } this.icon = icon; this.fireEvent('iconchange', this, oldIcon, icon); }, /** * Sets the {@link #iconCls} of this item * @param {String} iconCls The CSS class to set to {@link #iconCls} */ setIconCls: function(iconCls) { var me = this, iconEl = me.iconEl, oldCls = me.iconCls; if (iconEl) { if (me.iconCls) { iconEl.removeCls(me.iconCls); } if (iconCls) { iconEl.addCls(iconCls); } } me.iconCls = iconCls; me.fireEvent('iconchange', me, oldCls, iconCls); }, /** * Sets the {@link #text} of this item * @param {String} text The {@link #text} */ setText: function(text) { var me = this, el = me.textEl || me.el, oldText = me.text; me.text = text; if (me.rendered) { el.update(text || ''); // cannot just call layout on the component due to stretchmax me.ownerCt.updateLayout(); } me.fireEvent('textchange', me, oldText, text); }, getTipAttr: function(){ return this.tooltipType == 'qtip' ? 'data-qtip' : 'title'; }, //private clearTip: function() { if (Ext.quickTipsActive && Ext.isObject(this.tooltip)) { Ext.tip.QuickTipManager.unregister(this.itemEl); } }, /** * Sets the tooltip for this menu item. * * @param {String/Object} tooltip This may be: * * - **String** : A string to be used as innerHTML (html tags are accepted) to show in a tooltip * - **Object** : A configuration object for {@link Ext.tip.QuickTipManager#register}. * * @return {Ext.menu.Item} this */ setTooltip: function(tooltip, initial) { var me = this; if (me.rendered) { if (!initial) { me.clearTip(); } if (Ext.quickTipsActive && Ext.isObject(tooltip)) { Ext.tip.QuickTipManager.register(Ext.apply({ target: me.itemEl.id }, tooltip)); me.tooltip = tooltip; } else { me.itemEl.dom.setAttribute(me.getTipAttr(), tooltip); } } else { me.tooltip = tooltip; } return me; } }); /** * A menu item that contains a togglable checkbox by default, but that can also be a part of a radio group. * * @example * Ext.create('Ext.menu.Menu', { * width: 100, * height: 110, * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * xtype: 'menucheckitem', * text: 'select all' * },{ * xtype: 'menucheckitem', * text: 'select specific' * },{ * iconCls: 'add16', * text: 'icon item' * },{ * text: 'regular item' * }] * }); */ Ext.define('Ext.menu.CheckItem', { extend: Ext.menu.Item , alias: 'widget.menucheckitem', /** * @cfg {Boolean} [checked=false] * True to render the menuitem initially checked. */ /** * @cfg {Function} checkHandler * Alternative for the {@link #checkchange} event. Gets called with the same parameters. */ /** * @cfg {Object} scope * Scope for the {@link #checkHandler} callback. */ /** * @cfg {String} group * Name of a radio group that the item belongs. * * Specifying this option will turn check item into a radio item. * * Note that the group name must be globally unique. */ /** * @cfg {String} checkedCls * The CSS class used by {@link #cls} to show the checked state. * Defaults to `Ext.baseCSSPrefix + 'menu-item-checked'`. */ checkedCls: Ext.baseCSSPrefix + 'menu-item-checked', /** * @cfg {String} uncheckedCls * The CSS class used by {@link #cls} to show the unchecked state. * Defaults to `Ext.baseCSSPrefix + 'menu-item-unchecked'`. */ uncheckedCls: Ext.baseCSSPrefix + 'menu-item-unchecked', /** * @cfg {String} groupCls * The CSS class applied to this item's icon image to denote being a part of a radio group. * Defaults to `Ext.baseCSSClass + 'menu-group-icon'`. * Any specified {@link #iconCls} overrides this. */ groupCls: Ext.baseCSSPrefix + 'menu-group-icon', /** * @cfg {Boolean} [hideOnClick=false] * Whether to not to hide the owning menu when this item is clicked. * Defaults to `false` for checkbox items, and to `true` for radio group items. */ hideOnClick: false, /** * @cfg {Boolean} [checkChangeDisabled=false] * True to prevent the checked item from being toggled. Any submenu will still be accessible. */ checkChangeDisabled: false, childEls: [ 'itemEl', 'iconEl', 'textEl', 'checkEl' ], showCheckbox: true, renderTpl: [ '', '{text}', '', '{%var showCheckbox = values.showCheckbox,', ' rightCheckbox = showCheckbox && values.hasIcon && (values.iconAlign !== "left"), textCls = rightCheckbox ? "' + Ext.baseCSSPrefix + 'right-check-item-text" : "";%}', 'target="{hrefTarget}" hidefocus="true" unselectable="on"', '', ' tabIndex="{tabIndex}"', '', '>', '{%if (values.hasIcon && (values.iconAlign !== "left")) {%}', '', '{%} else if (showCheckbox){%}', '', '{%}%}', 'style="margin-right: 17px;" >{text}', // CheckItem with an icon puts the icon on the right unless iconAlign=='left' '{%if (rightCheckbox) {%}', '', '{%} else if (values.arrowCls) {%}', '', '{%}%}', '', '' ], initComponent: function() { var me = this; // coerce to bool straight away me.checked = !!me.checked; me.addEvents( /** * @event beforecheckchange * Fires before a change event. Return false to cancel. * @param {Ext.menu.CheckItem} this * @param {Boolean} checked */ 'beforecheckchange', /** * @event checkchange * Fires after a change event. * @param {Ext.menu.CheckItem} this * @param {Boolean} checked */ 'checkchange' ); me.callParent(arguments); Ext.menu.Manager.registerCheckable(me); if (me.group) { me.showCheckbox = false if (!(me.iconCls || me.icon || me.glyph)) { me.iconCls = me.groupCls; } if (me.initialConfig.hideOnClick !== false) { me.hideOnClick = true; } } }, beforeRender: function() { this.callParent(); this.renderData.showCheckbox = this.showCheckbox; }, afterRender: function() { var me = this; me.callParent(); me.checked = !me.checked; me.setChecked(!me.checked, true); if (me.checkChangeDisabled) { me.disableCheckChange(); } }, /** * Disables just the checkbox functionality of this menu Item. If this menu item has a submenu, that submenu * will still be accessible */ disableCheckChange: function() { var me = this, checkEl = me.checkEl; if (checkEl) { checkEl.addCls(me.disabledCls); } // In some cases the checkbox will disappear until repainted // Happens in everything except IE9 strict, see: EXTJSIV-6412 if (!(Ext.isIE10p || (Ext.isIE9 && Ext.isStrict)) && me.rendered) { me.el.repaint(); } me.checkChangeDisabled = true; }, /** * Reenables the checkbox functionality of this menu item after having been disabled by {@link #disableCheckChange} */ enableCheckChange: function() { var me = this, checkEl = me.checkEl; if (checkEl) { checkEl.removeCls(me.disabledCls); } me.checkChangeDisabled = false; }, onClick: function(e) { var me = this; if(!me.disabled && !me.checkChangeDisabled && !(me.checked && me.group)) { me.setChecked(!me.checked); } this.callParent([e]); }, onDestroy: function() { Ext.menu.Manager.unregisterCheckable(this); this.callParent(arguments); }, /** * Sets the checked state of the item * @param {Boolean} checked True to check, false to uncheck * @param {Boolean} [suppressEvents=false] True to prevent firing the checkchange events. */ setChecked: function(checked, suppressEvents) { var me = this; if (me.checked !== checked && (suppressEvents || me.fireEvent('beforecheckchange', me, checked) !== false)) { if (me.el) { me.el[checked ? 'addCls' : 'removeCls'](me.checkedCls)[!checked ? 'addCls' : 'removeCls'](me.uncheckedCls); } me.checked = checked; Ext.menu.Manager.onCheckChange(me, checked); if (!suppressEvents) { Ext.callback(me.checkHandler, me.scope, [me, checked]); me.fireEvent('checkchange', me, checked); } } } }); /** * @private */ Ext.define('Ext.menu.KeyNav', { extend: Ext.util.KeyNav , constructor: function(config) { var me = this; me.menu = config.target; me.callParent([Ext.apply({ down: me.down, enter: me.enter, esc: me.escape, left: me.left, right: me.right, space: me.enter, tab: me.tab, up: me.up }, config)]); }, down: function(e) { var me = this, fi = me.menu.focusedItem; if (fi && e.getKey() == Ext.EventObject.DOWN && me.isWhitelisted(fi)) { return true; } me.focusNextItem(1); }, enter: function(e) { var menu = this.menu, focused = menu.focusedItem; if (menu.activeItem) { menu.onClick(e); } else if (focused && focused.isFormField) { // prevent stopEvent being called return true; } }, escape: function(e) { Ext.menu.Manager.hideAll(); }, focusNextItem: function(step) { var menu = this.menu, items = menu.items, focusedItem = menu.focusedItem, startIdx = focusedItem ? items.indexOf(focusedItem) : -1, idx = startIdx + step, len = items.length, count = 0, item; // Limit the count, since we might not be able to find something to focus while (count < len && idx !== startIdx) { if (idx < 0) { idx = len - 1; } else if (idx >= len) { idx = 0; } item = items.getAt(idx); if (menu.canActivateItem(item)) { menu.setActiveItem(item); break; } idx += step; ++count; } }, isWhitelisted: function(item) { return Ext.FocusManager.isWhitelisted(item); }, left: function(e) { var menu = this.menu, fi = menu.focusedItem; if (fi && this.isWhitelisted(fi)) { return true; } menu.hide(); if (menu.parentMenu) { menu.parentMenu.focus(); } }, right: function(e) { var menu = this.menu, fi = menu.focusedItem, ai = menu.activeItem, am; if (fi && this.isWhitelisted(fi)) { return true; } if (ai) { am = menu.activeItem.menu; if (am) { ai.expandMenu(0); am.setActiveItem(am.child(':focusable')); } } }, tab: function(e) { var me = this; if (e.shiftKey) { me.up(e); } else { me.down(e); } }, up: function(e) { var me = this, fi = me.menu.focusedItem; if (fi && e.getKey() == Ext.EventObject.UP && me.isWhitelisted(fi)) { return true; } me.focusNextItem(-1); } }); /** * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will * add one of these by using "-" in your call to add() or in your items config rather than creating one directly. * * @example * Ext.create('Ext.menu.Menu', { * width: 100, * height: 100, * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * text: 'icon item', * iconCls: 'add16' * },{ * xtype: 'menuseparator' * },{ * text: 'separator above' * },{ * text: 'regular item' * }] * }); */ Ext.define('Ext.menu.Separator', { extend: Ext.menu.Item , alias: 'widget.menuseparator', /** * @cfg {String} activeCls * @private */ /** * @cfg {Boolean} canActivate * @private */ canActivate: false, /** * @cfg {Boolean} clickHideDelay * @private */ /** * @cfg {Boolean} destroyMenu * @private */ /** * @cfg {Boolean} disabledCls * @private */ focusable: false, /** * @cfg {String} href * @private */ /** * @cfg {String} hrefTarget * @private */ /** * @cfg {Boolean} hideOnClick * @private */ hideOnClick: false, /** * @cfg {String} icon * @private */ /** * @cfg {String} iconCls * @private */ /** * @cfg {Object} menu * @private */ /** * @cfg {String} menuAlign * @private */ /** * @cfg {Number} menuExpandDelay * @private */ /** * @cfg {Number} menuHideDelay * @private */ /** * @cfg {Boolean} plain * @private */ plain: true, /** * @cfg {String} separatorCls * The CSS class used by the separator item to show the incised line. */ separatorCls: Ext.baseCSSPrefix + 'menu-item-separator', /** * @cfg {String} text * @private */ text: ' ', beforeRender: function(ct, pos) { var me = this; me.callParent(); me.addCls(me.separatorCls); } }); /** * A menu object. This is the container to which you may add {@link Ext.menu.Item menu items}. * * Menus may contain either {@link Ext.menu.Item menu items}, or general {@link Ext.Component Components}. * Menus may also contain {@link Ext.panel.AbstractPanel#dockedItems docked items} because it extends {@link Ext.panel.Panel}. * * By default, non {@link Ext.menu.Item menu items} are indented so that they line up with the text of menu items. clearing * the icon column. To make a contained general {@link Ext.Component Component} left aligned configure the child * Component with `indent: false. * * By default, Menus are absolutely positioned, floating Components. By configuring a Menu with `{@link #floating}: false`, * a Menu may be used as a child of a {@link Ext.container.Container Container}. * * @example * Ext.create('Ext.menu.Menu', { * width: 100, * margin: '0 0 10 0', * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * text: 'regular item 1' * },{ * text: 'regular item 2' * },{ * text: 'regular item 3' * }] * }); * * Ext.create('Ext.menu.Menu', { * width: 100, * plain: true, * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * text: 'plain item 1' * },{ * text: 'plain item 2' * },{ * text: 'plain item 3' * }] * }); */ Ext.define('Ext.menu.Menu', { extend: Ext.panel.Panel , alias: 'widget.menu', /** * @property {Ext.menu.Menu} parentMenu * The parent Menu of this Menu. */ /** * @cfg {Boolean} [enableKeyNav=true] * True to enable keyboard navigation for controlling the menu. * This option should generally be disabled when form fields are * being used inside the menu. */ enableKeyNav: true, /** * @cfg {Boolean} [allowOtherMenus=false] * True to allow multiple menus to be displayed at the same time. */ allowOtherMenus: false, /** * @cfg {String} ariaRole * @private */ ariaRole: 'menu', /** * @cfg {Boolean} autoRender * Floating is true, so autoRender always happens. * @private */ /** * @cfg {Boolean} [floating=true] * A Menu configured as `floating: true` (the default) will be rendered as an absolutely positioned, * {@link Ext.Component#floating floating} {@link Ext.Component Component}. If configured as `floating: false`, the Menu may be * used as a child item of another {@link Ext.container.Container Container}. */ floating: true, /** * @cfg {Boolean} constrain * Menus are constrained to the document body by default. * @private */ constrain: true, /** * @cfg {Boolean} [hidden=undefined] * True to initially render the Menu as hidden, requiring to be shown manually. * * Defaults to `true` when `floating: true`, and defaults to `false` when `floating: false`. */ hidden: true, hideMode: 'visibility', /** * @cfg {Boolean} [ignoreParentClicks=false] * True to ignore clicks on any item in this menu that is a parent item (displays a submenu) * so that the submenu is not dismissed when clicking the parent item. */ ignoreParentClicks: false, /** * @property {Boolean} isMenu * `true` in this class to identify an object as an instantiated Menu, or subclass thereof. */ isMenu: true, /** * @cfg {Ext.enums.Layout/Object} layout * @private */ /** * @cfg {Boolean} [showSeparator=true] * True to show the icon separator. */ showSeparator : true, /** * @cfg {Number} [minWidth=120] * The minimum width of the Menu. The default minWidth only applies when the {@link #floating} config is true. */ minWidth: undefined, defaultMinWidth: 120, /** * @cfg {Boolean} [plain=false] * True to remove the incised line down the left side of the menu and to not indent general Component items. * * {@link Ext.menu.Item MenuItem}s will *always* have space at their start for an icon. With the `plain` setting, * non {@link Ext.menu.Item MenuItem} child components will not be indented to line up. * * Basically, `plain:true` makes a Menu behave more like a regular {@link Ext.layout.container.HBox HBox layout} * {@link Ext.panel.Panel Panel} which just has the same background as a Menu. * * See also the {@link #showSeparator} config. */ initComponent: function() { var me = this, prefix = Ext.baseCSSPrefix, cls = [prefix + 'menu'], bodyCls = me.bodyCls ? [me.bodyCls] : [], isFloating = me.floating !== false; me.addEvents( /** * @event click * Fires when this menu is clicked * @param {Ext.menu.Menu} menu The menu which has been clicked * @param {Ext.Component} item The menu item that was clicked. `undefined` if not applicable. * @param {Ext.EventObject} e The underlying {@link Ext.EventObject}. */ 'click', /** * @event mouseenter * Fires when the mouse enters this menu * @param {Ext.menu.Menu} menu The menu * @param {Ext.EventObject} e The underlying {@link Ext.EventObject} */ 'mouseenter', /** * @event mouseleave * Fires when the mouse leaves this menu * @param {Ext.menu.Menu} menu The menu * @param {Ext.EventObject} e The underlying {@link Ext.EventObject} */ 'mouseleave', /** * @event mouseover * Fires when the mouse is hovering over this menu * @param {Ext.menu.Menu} menu The menu * @param {Ext.Component} item The menu item that the mouse is over. `undefined` if not applicable. * @param {Ext.EventObject} e The underlying {@link Ext.EventObject} */ 'mouseover' ); Ext.menu.Manager.register(me); // Menu classes if (me.plain) { cls.push(prefix + 'menu-plain'); } me.cls = cls.join(' '); // Menu body classes bodyCls.push(prefix + 'menu-body', Ext.dom.Element.unselectableCls); me.bodyCls = bodyCls.join(' '); // Internal vbox layout, with scrolling overflow // Placed in initComponent (rather than prototype) in order to support dynamic layout/scroller // options if we wish to allow for such configurations on the Menu. // e.g., scrolling speed, vbox align stretch, etc. if (!me.layout) { me.layout = { type: 'vbox', align: 'stretchmax', overflowHandler: 'Scroller' }; } if (isFloating) { // only apply the minWidth when we're floating & one hasn't already been set if (me.minWidth === undefined) { me.minWidth = me.defaultMinWidth; } } else { // hidden defaults to false if floating is configured as false me.hidden = !!me.initialConfig.hidden; me.constrain = false; } me.callParent(arguments); }, // Private implementation for Menus. They are a special case. // They are always global floaters, never contained. registerWithOwnerCt: function() { if (this.floating) { this.ownerCt = null; Ext.WindowManager.register(this); } }, // Menus do not have owning containers on which they depend for visibility. They stand outside // any container hierarchy. initHierarchyEvents: Ext.emptyFn, // Menus are never contained, and must not ascertain their visibility from the ancestor hierarchy isVisible: function() { return this.callParent(); }, // As menus are never contained, a Menu's visibility only ever depends upon its own hidden state. // Ignore hiddenness from the ancestor hierarchy, override it with local hidden state. getHierarchyState: function() { var result = this.callParent(); result.hidden = this.hidden; return result; }, beforeRender: function() { this.callParent(arguments); // Menus are usually floating: true, which means they shrink wrap their items. // However, when they are contained, and not auto sized, we must stretch the items. if (!this.getSizeModel().width.shrinkWrap) { this.layout.align = 'stretch'; } }, onBoxReady: function() { var me = this; me.callParent(arguments); // TODO: Move this to a subTemplate When we support them in the future if (me.showSeparator) { me.iconSepEl = me.layout.getElementTarget().insertFirst({ cls: Ext.baseCSSPrefix + 'menu-icon-separator', html: ' ' }); } me.mon(me.el, { click: me.onClick, mouseover: me.onMouseOver, scope: me }); me.mouseMonitor = me.el.monitorMouseLeave(100, me.onMouseLeave, me); // A Menu is a Panel. The KeyNav can use the Panel's KeyMap if (me.enableKeyNav) { me.keyNav = new Ext.menu.KeyNav({ target: me, keyMap: me.getKeyMap() }); } }, getRefOwner: function() { // If a submenu, this will have a parentMenu property // If a menu of a Button, it will have an ownerButton property // Else use the default method. return this.parentMenu || this.ownerButton || this.callParent(arguments); }, /** * Returns whether a menu item can be activated or not. * @return {Boolean} */ canActivateItem: function(item) { return item && !item.isDisabled() && item.isVisible() && (item.canActivate || item.getXTypes().indexOf('menuitem') < 0); }, /** * Deactivates the current active item on the menu, if one exists. */ deactivateActiveItem: function(andBlurFocusedItem) { var me = this, activeItem = me.activeItem, focusedItem = me.focusedItem; if (activeItem) { activeItem.deactivate(); if (!activeItem.activated) { delete me.activeItem; } } // Blur the focused item if we are being asked to do that too // Only needed if we are being hidden - mouseout does not blur. if (focusedItem && andBlurFocusedItem) { focusedItem.blur(); delete me.focusedItem; } }, // @inheritdoc getFocusEl: function() { return this.focusedItem || this.el; }, // @inheritdoc hide: function() { this.deactivateActiveItem(true); this.callParent(arguments); }, // @private getItemFromEvent: function(e) { return this.getChildByElement(e.getTarget()); }, lookupComponent: function(cmp) { var me = this; if (typeof cmp == 'string') { cmp = me.lookupItemFromString(cmp); } else if (Ext.isObject(cmp)) { cmp = me.lookupItemFromObject(cmp); } // Apply our minWidth to all of our child components so it's accounted // for in our VBox layout cmp.minWidth = cmp.minWidth || me.minWidth; return cmp; }, // @private lookupItemFromObject: function(cmp) { var me = this, prefix = Ext.baseCSSPrefix, cls; if (!cmp.isComponent) { if (!cmp.xtype) { cmp = Ext.create('Ext.menu.' + (Ext.isBoolean(cmp.checked) ? 'Check': '') + 'Item', cmp); } else { cmp = Ext.ComponentManager.create(cmp, cmp.xtype); } } if (cmp.isMenuItem) { cmp.parentMenu = me; } if (!cmp.isMenuItem && !cmp.dock) { cls = [prefix + 'menu-item-cmp']; // The "plain" setting means that the menu does not look so much like a menu. It's more like a grey Panel. // So it has no vertical separator. // Plain menus also will not indent non MenuItem components; there is nothing to indent them to the right of. if (!me.plain && (cmp.indent !== false || cmp.iconCls === 'no-icon')) { cls.push(prefix + 'menu-item-indent'); } if (cmp.rendered) { cmp.el.addCls(cls); } else { cmp.cls = (cmp.cls || '') + ' ' + cls.join(' '); } } return cmp; }, // @private lookupItemFromString: function(cmp) { return (cmp == 'separator' || cmp == '-') ? new Ext.menu.Separator() : new Ext.menu.Item({ canActivate: false, hideOnClick: false, plain: true, text: cmp }); }, onClick: function(e) { var me = this, item; if (me.disabled) { e.stopEvent(); return; } item = (e.type === 'click') ? me.getItemFromEvent(e) : me.activeItem; if (item && item.isMenuItem) { if (!item.menu || !me.ignoreParentClicks) { item.onClick(e); } else { e.stopEvent(); } } // Click event may be fired without an item, so we need a second check if (!item || item.disabled) { item = undefined; } me.fireEvent('click', me, item, e); }, onDestroy: function() { var me = this; Ext.menu.Manager.unregister(me); me.parentMenu = me.ownerButton = null; if (me.rendered) { me.el.un(me.mouseMonitor); Ext.destroy(me.keyNav); me.keyNav = null; } me.callParent(arguments); }, onMouseLeave: function(e) { var me = this; me.deactivateActiveItem(); if (me.disabled) { return; } me.fireEvent('mouseleave', me, e); }, onMouseOver: function(e) { var me = this, fromEl = e.getRelatedTarget(), mouseEnter = !me.el.contains(fromEl), item = me.getItemFromEvent(e), parentMenu = me.parentMenu, parentItem = me.parentItem; if (mouseEnter && parentMenu) { parentMenu.setActiveItem(parentItem); parentItem.cancelDeferHide(); parentMenu.mouseMonitor.mouseenter(); } if (me.disabled) { return; } // Do not activate the item if the mouseover was within the item, and it's already active if (item && !item.activated) { me.setActiveItem(item); if (item.activated && item.expandMenu) { item.expandMenu(); } } if (mouseEnter) { me.fireEvent('mouseenter', me, e); } me.fireEvent('mouseover', me, item, e); }, setActiveItem: function(item) { var me = this; if (item && (item != me.activeItem)) { me.deactivateActiveItem(); if (me.canActivateItem(item)) { if (item.activate) { item.activate(); if (item.activated) { me.activeItem = item; me.focusedItem = item; me.focus(); } } else { item.focus(); me.focusedItem = item; } } item.el.scrollIntoView(me.layout.getRenderTarget()); } }, showBy: function(cmp, pos, off) { var me = this; me.callParent(arguments); if (!me.hidden) { // show may have been vetoed me.setVerticalPosition(); } return me; }, beforeShow: function() { var me = this, viewHeight; // Constrain the height to the containing element's viewable area if (me.floating) { me.savedMaxHeight = me.maxHeight; viewHeight = me.container.getViewSize().height; me.maxHeight = Math.min(me.maxHeight || viewHeight, viewHeight); } me.callParent(arguments); }, afterShow: function() { var me = this; me.callParent(arguments); // Restore configured maxHeight if (me.floating) { me.maxHeight = me.savedMaxHeight; } }, // @private // adjust the vertical position of the menu if the height of the // menu is equal (or greater than) the viewport size setVerticalPosition: function() { var me = this, max, y = me.getY(), returnY = y, height = me.getHeight(), viewportHeight = Ext.Element.getViewportHeight().height, parentEl = me.el.parent(), viewHeight = parentEl.getViewSize().height, normalY = y - parentEl.getScroll().top; // factor in scrollTop of parent parentEl = null; if (me.floating) { max = me.maxHeight ? me.maxHeight : viewHeight - normalY; if (height > viewHeight) { returnY = y - normalY; } else if (max < height) { returnY = y - (height - max); } else if((y + height) > viewportHeight){ // keep the document from scrolling returnY = viewportHeight - height; } } me.setY(returnY); } }); /** * A menu containing a Ext.picker.Color Component. * * Notes: * * - Although not listed here, the **constructor** for this class accepts all of the * configuration options of {@link Ext.picker.Color}. * - If subclassing ColorMenu, any configuration options for the ColorPicker must be * applied to the **initialConfig** property of the ColorMenu. Applying * {@link Ext.picker.Color ColorPicker} configuration settings to `this` will **not** * affect the ColorPicker's configuration. * * Example: * * @example * var colorPicker = Ext.create('Ext.menu.ColorPicker', { * value: '000000' * }); * * Ext.create('Ext.menu.Menu', { * width: 100, * height: 90, * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * text: 'choose a color', * menu: colorPicker * },{ * iconCls: 'add16', * text: 'icon item' * },{ * text: 'regular item' * }] * }); */ Ext.define('Ext.menu.ColorPicker', { extend: Ext.menu.Menu , alias: 'widget.colormenu', /** * @cfg {Boolean} hideOnClick * False to continue showing the menu after a color is selected. */ hideOnClick : true, /** * @cfg {String} pickerId * An id to assign to the underlying color picker. */ pickerId : null, /** * @cfg {Number} maxHeight * @private */ /** * @property {Ext.picker.Color} picker * The {@link Ext.picker.Color} instance for this ColorMenu */ /** * @event click * @private */ initComponent : function(){ var me = this, cfg = Ext.apply({}, me.initialConfig); // Ensure we don't get duplicate listeners delete cfg.listeners; Ext.apply(me, { plain: true, showSeparator: false, items: Ext.applyIf({ cls: Ext.baseCSSPrefix + 'menu-color-item', id: me.pickerId, xtype: 'colorpicker' }, cfg) }); me.callParent(arguments); me.picker = me.down('colorpicker'); /** * @event select * @inheritdoc Ext.picker.Color#select */ me.relayEvents(me.picker, ['select']); if (me.hideOnClick) { me.on('select', me.hidePickerOnSelect, me); } }, /** * Hides picker on select if hideOnClick is true * @private */ hidePickerOnSelect: function() { Ext.menu.Manager.hideAll(); } }); /** * A menu containing an Ext.picker.Date Component. * * Notes: * * - Although not listed here, the **constructor** for this class accepts all of the * configuration options of **{@link Ext.picker.Date}**. * - If subclassing DateMenu, any configuration options for the DatePicker must be applied * to the **initialConfig** property of the DateMenu. Applying {@link Ext.picker.Date Date Picker} * configuration settings to **this** will **not** affect the Date Picker's configuration. * * Example: * * @example * var dateMenu = Ext.create('Ext.menu.DatePicker', { * handler: function(dp, date){ * Ext.Msg.alert('Date Selected', 'You selected ' + Ext.Date.format(date, 'M j, Y')); * } * }); * * Ext.create('Ext.menu.Menu', { * width: 100, * height: 90, * floating: false, // usually you want this set to True (default) * renderTo: Ext.getBody(), // usually rendered by it's containing component * items: [{ * text: 'choose a date', * menu: dateMenu * },{ * iconCls: 'add16', * text: 'icon item' * },{ * text: 'regular item' * }] * }); */ Ext.define('Ext.menu.DatePicker', { extend: Ext.menu.Menu , alias: 'widget.datemenu', /** * @cfg {Boolean} hideOnClick * False to continue showing the menu after a date is selected. */ hideOnClick : true, /** * @cfg {String} pickerId * An id to assign to the underlying date picker. */ pickerId : null, /** * @cfg {Number} maxHeight * @private */ /** * @property {Ext.picker.Date} picker * The {@link Ext.picker.Date} instance for this DateMenu */ initComponent : function(){ var me = this, cfg = Ext.apply({}, me.initialConfig); // Ensure we clear any listeners so they aren't duplicated delete cfg.listeners; Ext.apply(me, { showSeparator: false, plain: true, border: false, bodyPadding: 0, // remove the body padding from the datepicker menu item so it looks like 3.3 items: Ext.applyIf({ cls: Ext.baseCSSPrefix + 'menu-date-item', id: me.pickerId, xtype: 'datepicker' }, cfg) }); me.callParent(arguments); me.picker = me.down('datepicker'); /** * @event select * @inheritdoc Ext.picker.Date#select */ me.relayEvents(me.picker, ['select']); if (me.hideOnClick) { me.on('select', me.hidePickerOnSelect, me); } }, hidePickerOnSelect: function() { Ext.menu.Manager.hideAll(); } }); /** * This class is used to display small visual icons in the header of a panel. There are a set of * 25 icons that can be specified by using the {@link #type} config. The {@link #callback} config * can be used to provide a function that will respond to any click events. In general, this class * will not be instantiated directly, rather it will be created by specifying the {@link Ext.panel.Panel#tools} * configuration on the Panel itself. * * @example * Ext.create('Ext.panel.Panel', { * width: 200, * height: 200, * renderTo: document.body, * title: 'A Panel', * tools: [{ * type: 'help', * callback: function() { * // show help here * } * }, { * itemId: 'refresh', * type: 'refresh', * hidden: true, * callback: function() { * // do refresh * } * }, { * type: 'search', * callback: function (panel) { * // do search * panel.down('#refresh').show(); * } * }] * }); * * The `callback` config was added in Ext JS 4.2.1 as an alternative to {@link #handler} * to provide a more convenient list of arguments. In Ext JS 4.2.1 it is also possible to * pass a method name instead of a direct function: * * tools: [{ * type: 'help', * callback: 'onHelp', * scope: this * }, * ... * * The `callback` (or `handler`) name is looked up on the `scope` which will also be the * `this` reference when the method is called. */ Ext.define('Ext.panel.Tool', { extend: Ext.Component , alias: 'widget.tool', /** * @property {Boolean} isTool * `true` in this class to identify an object as an instantiated Tool, or subclass thereof. */ isTool: true, baseCls: Ext.baseCSSPrefix + 'tool', disabledCls: Ext.baseCSSPrefix + 'tool-disabled', /** * @cfg * @private */ toolPressedCls: Ext.baseCSSPrefix + 'tool-pressed', /** * @cfg * @private */ toolOverCls: Ext.baseCSSPrefix + 'tool-over', ariaRole: 'button', childEls: [ 'toolEl' ], renderTpl: [ '' ], /** * @cfg {Ext.Component} toolOwner * The owner to report to the `callback` method. Default is `null` for the `ownerCt`. * @since 4.2 */ toolOwner: null, /** * @cfg {Function} callback A function to execute when the tool is clicked. * @cfg {Ext.Component} callback.owner The logical owner of the tool. In a typical * `Ext.panel.Panel`, this is set to the owning panel. This value comes from the * `toolOwner` config. * @cfg {Ext.panel.Tool} callback.tool The tool that is calling. * @cfg {Ext.EventObject} callback.event The click event. * @since 4.2 */ /** * @cfg {Function} handler * A function to execute when the tool is clicked. Arguments passed are: * * - **event** : Ext.EventObject - The click event. * - **toolEl** : Ext.Element - The tool Element. * - **owner** : Ext.panel.Header - The host panel header. * - **tool** : Ext.panel.Tool - The tool object */ /** * @cfg {Object} scope * The scope to execute the {@link #callback} or {@link #handler} function. Defaults * to the tool. */ /** * @cfg {String} type * The type of tool to render. The following types are available: * * - close * - minimize * - maximize * - restore * - toggle * - gear * - prev * - next * - pin * - unpin * - right * - left * - down * - up * - refresh * - plus * - minus * - search * - save * - help * - print * - expand * - collapse */ /** * @cfg {String/Object} tooltip * The tooltip for the tool - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config * object */ /** * @cfg {String} tooltipType * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. */ tooltipType: 'qtip', /** * @cfg {Boolean} stopEvent * Specify as false to allow click event to propagate. */ stopEvent: true, // Tool size is fixed so that Box layout can avoid measurements. height: 15, width: 15, _toolTypes: { close:1, collapse:1, down:1, expand:1, gear:1, help:1, left:1, maximize:1, minimize:1, minus:1, //move:1, next:1, pin:1, plus:1, prev:1, print:1, refresh:1, //resize:1, restore:1, right:1, save:1, search:1, toggle:1, unpin:1, up:1 }, initComponent: function() { var me = this; me.addEvents( /** * @event click * Fires when the tool is clicked * @param {Ext.panel.Tool} this * @param {Ext.EventObject} e The event object */ 'click' ); if (me.id && me._toolTypes[me.id] && Ext.global.console) { Ext.global.console.warn('When specifying a tool you should use the type option, the id can conflict now that tool is a Component'); } me.type = me.type || me.id; Ext.applyIf(me.renderData, { baseCls: me.baseCls, blank: Ext.BLANK_IMAGE_URL, type: me.type }); // alias qtip, should use tooltip since it's what we have in the docs me.tooltip = me.tooltip || me.qtip; me.callParent(); }, // inherit docs afterRender: function() { var me = this, attr; me.callParent(arguments); me.el.on({ click: me.onClick, mousedown: me.onMouseDown, mouseover: me.onMouseOver, mouseout: me.onMouseOut, scope: me }); if (me.tooltip) { if (Ext.quickTipsActive && Ext.isObject(me.tooltip)) { Ext.tip.QuickTipManager.register(Ext.apply({ target: me.id }, me.tooltip)); } else { attr = me.tooltipType == 'qtip' ? 'data-qtip' : 'title'; me.el.dom.setAttribute(attr, me.tooltip); } } }, getFocusEl: function() { return this.el; }, /** * Sets the type of the tool. Allows the icon to be changed. * @param {String} type The new type. See the {@link #type} config. * @return {Ext.panel.Tool} this */ setType: function(type) { var me = this, oldType = me.type; me.type = type; if (me.rendered) { if (oldType) { me.toolEl.removeCls(me.baseCls + '-' + oldType); } me.toolEl.addCls(me.baseCls + '-' + type); } else { me.renderData.type = type; } return me; }, /** * Called when the tool element is clicked * @private * @param {Ext.EventObject} e * @param {HTMLElement} target The target element */ onClick: function(e, target) { var me = this; if (me.disabled) { return false; } //remove the pressed + over class me.el.removeCls(me.toolPressedCls); me.el.removeCls(me.toolOverCls); if (me.stopEvent !== false) { e.stopEvent(); } if (me.handler) { Ext.callback(me.handler, me.scope || me, [e, target, me.ownerCt, me]); } else if (me.callback) { Ext.callback(me.callback, me.scope || me, [me.toolOwner || me.ownerCt, me, e]); } me.fireEvent('click', me, e); return true; }, // inherit docs onDestroy: function(){ if (Ext.quickTipsActive && Ext.isObject(this.tooltip)) { Ext.tip.QuickTipManager.unregister(this.id); } this.callParent(); }, /** * Called when the user presses their mouse button down on a tool * Adds the press class ({@link #toolPressedCls}) * @private */ onMouseDown: function() { if (this.disabled) { return false; } this.el.addCls(this.toolPressedCls); }, /** * Called when the user rolls over a tool * Adds the over class ({@link #toolOverCls}) * @private */ onMouseOver: function() { if (this.disabled) { return false; } this.el.addCls(this.toolOverCls); }, /** * Called when the user rolls out from a tool. * Removes the over class ({@link #toolOverCls}) * @private */ onMouseOut: function() { this.el.removeCls(this.toolOverCls); } }); /** * Private utility class for Ext.Splitter. * @private */ Ext.define('Ext.resizer.SplitterTracker', { extend: Ext.dd.DragTracker , enabled: true, overlayCls: Ext.baseCSSPrefix + 'resizable-overlay', createDragOverlay: function () { var overlay; overlay = this.overlay = Ext.getBody().createChild({ cls: this.overlayCls, html: ' ' }); overlay.unselectable(); overlay.setSize(Ext.Element.getViewWidth(true), Ext.Element.getViewHeight(true)); overlay.show(); }, getPrevCmp: function() { var splitter = this.getSplitter(); return splitter.previousSibling(':not([hidden])'); }, getNextCmp: function() { var splitter = this.getSplitter(); return splitter.nextSibling(':not([hidden])'); }, // ensure the tracker is enabled, store boxes of previous and next // components and calculate the constrain region onBeforeStart: function(e) { var me = this, prevCmp = me.getPrevCmp(), nextCmp = me.getNextCmp(), collapseEl = me.getSplitter().collapseEl, target = e.getTarget(), box; if (!prevCmp || !nextCmp) { return false; } if (collapseEl && target === me.getSplitter().collapseEl.dom) { return false; } // SplitterTracker is disabled if any of its adjacents are collapsed. if (nextCmp.collapsed || prevCmp.collapsed) { return false; } // store boxes of previous and next me.prevBox = prevCmp.getEl().getBox(); me.nextBox = nextCmp.getEl().getBox(); me.constrainTo = box = me.calculateConstrainRegion(); if (!box) { return false; } return box; }, // We move the splitter el. Add the proxy class. onStart: function(e) { var splitter = this.getSplitter(); this.createDragOverlay(); splitter.addCls(splitter.baseCls + '-active'); }, // calculate the constrain Region in which the splitter el may be moved. calculateConstrainRegion: function() { var me = this, splitter = me.getSplitter(), splitWidth = splitter.getWidth(), defaultMin = splitter.defaultSplitMin, orient = splitter.orientation, prevBox = me.prevBox, prevCmp = me.getPrevCmp(), nextBox = me.nextBox, nextCmp = me.getNextCmp(), // prev and nextConstrainRegions are the maximumBoxes minus the // minimumBoxes. The result is always the intersection // of these two boxes. prevConstrainRegion, nextConstrainRegion, constrainOptions; // vertical splitters, so resizing left to right if (orient === 'vertical') { constrainOptions = { prevCmp: prevCmp, nextCmp: nextCmp, prevBox: prevBox, nextBox: nextBox, defaultMin: defaultMin, splitWidth: splitWidth }; // Region constructor accepts (top, right, bottom, left) // anchored/calculated from the left prevConstrainRegion = new Ext.util.Region( prevBox.y, me.getVertPrevConstrainRight(constrainOptions), prevBox.bottom, me.getVertPrevConstrainLeft(constrainOptions) ); // anchored/calculated from the right nextConstrainRegion = new Ext.util.Region( nextBox.y, me.getVertNextConstrainRight(constrainOptions), nextBox.bottom, me.getVertNextConstrainLeft(constrainOptions) ); } else { // anchored/calculated from the top prevConstrainRegion = new Ext.util.Region( prevBox.y + (prevCmp.minHeight || defaultMin), prevBox.right, // Bottom boundary is y + maxHeight if there IS a maxHeight. // Otherwise it is calculated based upon the minWidth of the next Component (prevCmp.maxHeight ? prevBox.y + prevCmp.maxHeight : nextBox.bottom - (nextCmp.minHeight || defaultMin)) + splitWidth, prevBox.x ); // anchored/calculated from the bottom nextConstrainRegion = new Ext.util.Region( // Top boundary is bottom - maxHeight if there IS a maxHeight. // Otherwise it is calculated based upon the minHeight of the previous Component (nextCmp.maxHeight ? nextBox.bottom - nextCmp.maxHeight : prevBox.y + (prevCmp.minHeight || defaultMin)) - splitWidth, nextBox.right, nextBox.bottom - (nextCmp.minHeight || defaultMin), nextBox.x ); } // intersection of the two regions to provide region draggable return prevConstrainRegion.intersect(nextConstrainRegion); }, // Performs the actual resizing of the previous and next components performResize: function(e, offset) { var me = this, splitter = me.getSplitter(), orient = splitter.orientation, prevCmp = me.getPrevCmp(), nextCmp = me.getNextCmp(), owner = splitter.ownerCt, flexedSiblings = owner.query('>[flex]'), len = flexedSiblings.length, vertical = orient === 'vertical', i = 0, dimension = vertical ? 'width' : 'height', totalFlex = 0, item, size; // Convert flexes to pixel values proportional to the total pixel width of all flexes. for (; i < len; i++) { item = flexedSiblings[i]; size = vertical ? item.getWidth() : item.getHeight(); totalFlex += size; item.flex = size; } offset = vertical ? offset[0] : offset[1]; if (prevCmp) { size = me.prevBox[dimension] + offset; if (prevCmp.flex) { prevCmp.flex = size; } else { prevCmp[dimension] = size; } } if (nextCmp) { size = me.nextBox[dimension] - offset; if (nextCmp.flex) { nextCmp.flex = size; } else { nextCmp[dimension] = size; } } owner.updateLayout(); }, // Cleans up the overlay (if we have one) and calls the base. This cannot be done in // onEnd, because onEnd is only called if a drag is detected but the overlay is created // regardless (by onBeforeStart). endDrag: function () { var me = this; if (me.overlay) { me.overlay.remove(); delete me.overlay; } me.callParent(arguments); // this calls onEnd }, // perform the resize and remove the proxy class from the splitter el onEnd: function(e) { var me = this, splitter = me.getSplitter(); splitter.removeCls(splitter.baseCls + '-active'); me.performResize(e, me.getResizeOffset()); }, // Track the proxy and set the proper XY coordinates // while constraining the drag onDrag: function(e) { var me = this, offset = me.getOffset('dragTarget'), splitter = me.getSplitter(), splitEl = splitter.getEl(), orient = splitter.orientation; if (orient === "vertical") { splitEl.setX(me.startRegion.left + offset[0]); } else { splitEl.setY(me.startRegion.top + offset[1]); } }, getSplitter: function() { return this.splitter; }, getVertPrevConstrainRight: function(o) { // Right boundary is x + maxWidth if there IS a maxWidth. // Otherwise it is calculated based upon the minWidth of the next Component return (o.prevCmp.maxWidth ? o.prevBox.x + o.prevCmp.maxWidth : o.nextBox.right - (o.nextCmp.minWidth || o.defaultMin)) + o.splitWidth; }, getVertPrevConstrainLeft: function(o) { return o.prevBox.x + (o.prevCmp.minWidth || o.defaultMin); }, getVertNextConstrainRight: function(o) { return o.nextBox.right - (o.nextCmp.minWidth || o.defaultMin); }, getVertNextConstrainLeft: function(o) { // Left boundary is right - maxWidth if there IS a maxWidth. // Otherwise it is calculated based upon the minWidth of the previous Component return (o.nextCmp.maxWidth ? o.nextBox.right - o.nextCmp.maxWidth : o.prevBox.x + (o.prevBox.minWidth || o.defaultMin)) - o.splitWidth; }, getResizeOffset: function() { return this.getOffset('dragTarget'); } }); /** * Private utility class for Ext.BorderSplitter. * @private */ Ext.define('Ext.resizer.BorderSplitterTracker', { extend: Ext.resizer.SplitterTracker , getPrevCmp: null, getNextCmp: null, // calculate the constrain Region in which the splitter el may be moved. calculateConstrainRegion: function() { var me = this, splitter = me.splitter, collapseTarget = splitter.collapseTarget, defaultSplitMin = splitter.defaultSplitMin, sizePropCap = splitter.vertical ? 'Width' : 'Height', minSizeProp = 'min' + sizePropCap, maxSizeProp = 'max' + sizePropCap, getSizeMethod = 'get' + sizePropCap, neighbors = splitter.neighbors, length = neighbors.length, box = collapseTarget.el.getBox(), left = box.x, top = box.y, right = box.right, bottom = box.bottom, size = splitter.vertical ? (right - left) : (bottom - top), //neighborSizes = [], i, neighbor, minRange, maxRange, maxGrowth, maxShrink, targetSize; // if size=100 and minSize=80, we can reduce by 20 so minRange = minSize-size = -20 minRange = (collapseTarget[minSizeProp] || Math.min(size,defaultSplitMin)) - size; // if maxSize=150, maxRange = maxSize - size = 50 maxRange = collapseTarget[maxSizeProp]; if (!maxRange) { maxRange = 1e9; } else { maxRange -= size; } targetSize = size; for (i = 0; i < length; ++i) { neighbor = neighbors[i]; size = neighbor[getSizeMethod](); //neighborSizes.push(size); maxGrowth = size - neighbor[maxSizeProp]; // NaN if no maxSize or negative maxShrink = size - (neighbor[minSizeProp] || Math.min(size,defaultSplitMin)); if (!isNaN(maxGrowth)) { // if neighbor can only grow by 10 (maxGrowth = -10), minRange cannot be // -20 anymore, but now only -10: if (minRange < maxGrowth) { minRange = maxGrowth; } } // if neighbor can shrink by 20 (maxShrink=20), maxRange cannot be 50 anymore, // but now only 20: if (maxRange > maxShrink) { maxRange = maxShrink; } } if (maxRange - minRange < 2) { return null; } box = new Ext.util.Region(top, right, bottom, left); me.constraintAdjusters[me.getCollapseDirection()](box, minRange, maxRange, splitter); me.dragInfo = { minRange: minRange, maxRange: maxRange, //neighborSizes: neighborSizes, targetSize: targetSize }; return box; }, constraintAdjusters: { // splitter is to the right of the box left: function (box, minRange, maxRange, splitter) { box[0] = box.x = box.left = box.right + minRange; box.right += maxRange + splitter.getWidth(); }, // splitter is below the box top: function (box, minRange, maxRange, splitter) { box[1] = box.y = box.top = box.bottom + minRange; box.bottom += maxRange + splitter.getHeight(); }, // splitter is above the box bottom: function (box, minRange, maxRange, splitter) { box.bottom = box.top - minRange; box.top -= maxRange + splitter.getHeight(); }, // splitter is to the left of the box right: function (box, minRange, maxRange, splitter) { box.right = box.left - minRange; box[0] = box.x = box.left = box.x - maxRange + splitter.getWidth(); } }, onBeforeStart: function(e) { var me = this, splitter = me.splitter, collapseTarget = splitter.collapseTarget, neighbors = splitter.neighbors, collapseEl = me.getSplitter().collapseEl, target = e.getTarget(), length = neighbors.length, i, neighbor; if (collapseEl && target === splitter.collapseEl.dom) { return false; } if (collapseTarget.collapsed) { return false; } // disabled if any neighbors are collapsed in parallel direction. for (i = 0; i < length; ++i) { neighbor = neighbors[i]; if (neighbor.collapsed && neighbor.isHorz === collapseTarget.isHorz) { return false; } } if (!(me.constrainTo = me.calculateConstrainRegion())) { return false; } return true; }, performResize: function(e, offset) { var me = this, splitter = me.splitter, collapseDirection = splitter.getCollapseDirection(), collapseTarget = splitter.collapseTarget, // a vertical splitter adjusts horizontal dimensions adjusters = me.splitAdjusters[splitter.vertical ? 'horz' : 'vert'], delta = offset[adjusters.index], dragInfo = me.dragInfo, //neighbors = splitter.neighbors, //length = neighbors.length, //neighborSizes = dragInfo.neighborSizes, //isVert = collapseTarget.isVert, //i, neighbor, owner; if (collapseDirection == 'right' || collapseDirection == 'bottom') { // these splitters grow by moving left/up, so flip the sign of delta... delta = -delta; } // now constrain delta to our computed range: delta = Math.min(Math.max(dragInfo.minRange, delta), dragInfo.maxRange); if (delta) { (owner = splitter.ownerCt).suspendLayouts(); adjusters.adjustTarget(collapseTarget, dragInfo.targetSize, delta); //for (i = 0; i < length; ++i) { // neighbor = neighbors[i]; // if (!neighbor.isCenter && !neighbor.maintainFlex && neighbor.isVert == isVert) { // delete neighbor.flex; // adjusters.adjustNeighbor(neighbor, neighborSizes[i], delta); // } //} owner.resumeLayouts(true); } }, splitAdjusters: { horz: { index: 0, //adjustNeighbor: function (neighbor, size, delta) { // neighbor.setSize(size - delta); //}, adjustTarget: function (target, size, delta) { target.flex = null; target.setSize(size + delta); } }, vert: { index: 1, //adjustNeighbor: function (neighbor, size, delta) { // neighbor.setSize(undefined, size - delta); //}, adjustTarget: function (target, targetSize, delta) { target.flex = null; target.setSize(undefined, targetSize + delta); } } }, getCollapseDirection: function() { return this.splitter.getCollapseDirection(); } }); /** * Provides a handle for 9-point resizing of Elements or Components. */ Ext.define('Ext.resizer.Handle', { extend: Ext.Component , handleCls: '', baseHandleCls: Ext.baseCSSPrefix + 'resizable-handle', // Ext.resizer.Resizer.prototype.possiblePositions define the regions // which will be passed in as a region configuration. region: '', beforeRender: function() { var me = this; me.callParent(); me.protoEl.unselectable(); me.addCls( me.baseHandleCls, me.baseHandleCls + '-' + me.region, me.handleCls ); } }); /** * Private utility class for Ext.resizer.Resizer. * @private */ Ext.define('Ext.resizer.ResizeTracker', { extend: Ext.dd.DragTracker , dynamic: true, preserveRatio: false, // Default to no constraint constrainTo: null, proxyCls: Ext.baseCSSPrefix + 'resizable-proxy', constructor: function(config) { var me = this, widthRatio, heightRatio, throttledResizeFn; if (!config.el) { if (config.target.isComponent) { me.el = config.target.getEl(); } else { me.el = config.target; } } this.callParent(arguments); // Ensure that if we are preserving aspect ratio, the largest minimum is honoured if (me.preserveRatio && me.minWidth && me.minHeight) { widthRatio = me.minWidth / me.el.getWidth(); heightRatio = me.minHeight / me.el.getHeight(); // largest ratio of minimum:size must be preserved. // So if a 400x200 pixel image has // minWidth: 50, maxWidth: 50, the maxWidth will be 400 * (50/200)... that is 100 if (heightRatio > widthRatio) { me.minWidth = me.el.getWidth() * heightRatio; } else { me.minHeight = me.el.getHeight() * widthRatio; } } // If configured as throttled, create an instance version of resize which calls // a throttled function to perform the resize operation. if (me.throttle) { throttledResizeFn = Ext.Function.createThrottled(function() { Ext.resizer.ResizeTracker.prototype.resize.apply(me, arguments); }, me.throttle); me.resize = function(box, direction, atEnd) { if (atEnd) { Ext.resizer.ResizeTracker.prototype.resize.apply(me, arguments); } else { throttledResizeFn.apply(null, arguments); } }; } }, onBeforeStart: function(e) { // record the startBox this.startBox = this.target.getBox(); }, /** * @private * Returns the object that will be resized on every mousemove event. * If dynamic is false, this will be a proxy, otherwise it will be our actual target. */ getDynamicTarget: function() { var me = this, target = me.target; if (me.dynamic) { return target; } else if (!me.proxy) { me.proxy = me.createProxy(target); } me.proxy.show(); return me.proxy; }, /** * Create a proxy for this resizer * @param {Ext.Component/Ext.Element} target The target * @return {Ext.Element} A proxy element */ createProxy: function(target){ var proxy, cls = this.proxyCls; if (target.isComponent) { proxy = target.getProxy().addCls(cls); } else { proxy = target.createProxy({ tag: 'div', cls: cls, id: target.id + '-rzproxy' }, Ext.getBody()); } proxy.removeCls(Ext.baseCSSPrefix + 'proxy-el'); return proxy; }, onStart: function(e) { // returns the Ext.ResizeHandle that the user started dragging this.activeResizeHandle = Ext.get(this.getDragTarget().id); // If we are using a proxy, ensure it is sized. if (!this.dynamic) { this.resize(this.startBox, { horizontal: 'none', vertical: 'none' }); } }, onDrag: function(e) { // dynamic resizing, update dimensions during resize if (this.dynamic || this.proxy) { this.updateDimensions(e); } }, updateDimensions: function(e, atEnd) { var me = this, region = me.activeResizeHandle.region, offset = me.getOffset(me.constrainTo ? 'dragTarget' : null), box = me.startBox, ratio, widthAdjust = 0, heightAdjust = 0, snappedWidth, snappedHeight, adjustX = 0, adjustY = 0, dragRatio, horizDir = offset[0] < 0 ? 'right' : 'left', vertDir = offset[1] < 0 ? 'down' : 'up', oppositeCorner, axis, // 1 = x, 2 = y, 3 = x and y. newBox, newHeight, newWidth; region = me.convertRegionName(region); switch (region) { case 'south': heightAdjust = offset[1]; axis = 2; break; case 'north': heightAdjust = -offset[1]; adjustY = -heightAdjust; axis = 2; break; case 'east': widthAdjust = offset[0]; axis = 1; break; case 'west': widthAdjust = -offset[0]; adjustX = -widthAdjust; axis = 1; break; case 'northeast': heightAdjust = -offset[1]; adjustY = -heightAdjust; widthAdjust = offset[0]; oppositeCorner = [box.x, box.y + box.height]; axis = 3; break; case 'southeast': heightAdjust = offset[1]; widthAdjust = offset[0]; oppositeCorner = [box.x, box.y]; axis = 3; break; case 'southwest': widthAdjust = -offset[0]; adjustX = -widthAdjust; heightAdjust = offset[1]; oppositeCorner = [box.x + box.width, box.y]; axis = 3; break; case 'northwest': heightAdjust = -offset[1]; adjustY = -heightAdjust; widthAdjust = -offset[0]; adjustX = -widthAdjust; oppositeCorner = [box.x + box.width, box.y + box.height]; axis = 3; break; } newBox = { width: box.width + widthAdjust, height: box.height + heightAdjust, x: box.x + adjustX, y: box.y + adjustY }; // Snap value between stops according to configured increments snappedWidth = Ext.Number.snap(newBox.width, me.widthIncrement); snappedHeight = Ext.Number.snap(newBox.height, me.heightIncrement); if (snappedWidth != newBox.width || snappedHeight != newBox.height){ switch (region) { case 'northeast': newBox.y -= snappedHeight - newBox.height; break; case 'north': newBox.y -= snappedHeight - newBox.height; break; case 'southwest': newBox.x -= snappedWidth - newBox.width; break; case 'west': newBox.x -= snappedWidth - newBox.width; break; case 'northwest': newBox.x -= snappedWidth - newBox.width; newBox.y -= snappedHeight - newBox.height; } newBox.width = snappedWidth; newBox.height = snappedHeight; } // out of bounds if (newBox.width < me.minWidth || newBox.width > me.maxWidth) { newBox.width = Ext.Number.constrain(newBox.width, me.minWidth, me.maxWidth); // Re-adjust the X position if we were dragging the west side if (adjustX) { newBox.x = box.x + (box.width - newBox.width); } } else { me.lastX = newBox.x; } if (newBox.height < me.minHeight || newBox.height > me.maxHeight) { newBox.height = Ext.Number.constrain(newBox.height, me.minHeight, me.maxHeight); // Re-adjust the Y position if we were dragging the north side if (adjustY) { newBox.y = box.y + (box.height - newBox.height); } } else { me.lastY = newBox.y; } // If this is configured to preserve the aspect ratio, or they are dragging using the shift key if (me.preserveRatio || e.shiftKey) { ratio = me.startBox.width / me.startBox.height; // Calculate aspect ratio constrained values. newHeight = Math.min(Math.max(me.minHeight, newBox.width / ratio), me.maxHeight); newWidth = Math.min(Math.max(me.minWidth, newBox.height * ratio), me.maxWidth); // X axis: width-only change, height must obey if (axis == 1) { newBox.height = newHeight; } // Y axis: height-only change, width must obey else if (axis == 2) { newBox.width = newWidth; } // Corner drag. else { // Drag ratio is the ratio of the mouse point from the opposite corner. // Basically what edge we are dragging, a horizontal edge or a vertical edge. dragRatio = Math.abs(oppositeCorner[0] - this.lastXY[0]) / Math.abs(oppositeCorner[1] - this.lastXY[1]); // If drag ratio > aspect ratio then width is dominant and height must obey if (dragRatio > ratio) { newBox.height = newHeight; } else { newBox.width = newWidth; } // Handle dragging start coordinates if (region == 'northeast') { newBox.y = box.y - (newBox.height - box.height); } else if (region == 'northwest') { newBox.y = box.y - (newBox.height - box.height); newBox.x = box.x - (newBox.width - box.width); } else if (region == 'southwest') { newBox.x = box.x - (newBox.width - box.width); } } } if (heightAdjust === 0) { vertDir = 'none'; } if (widthAdjust === 0) { horizDir = 'none'; } me.resize(newBox, { horizontal: horizDir, vertical: vertDir }, atEnd); }, getResizeTarget: function(atEnd) { return atEnd ? this.target : this.getDynamicTarget(); }, resize: function(box, direction, atEnd) { var me = this, target = me.getResizeTarget(atEnd); target.setBox(box); // update the originalTarget if it was wrapped, and the target passed in was the wrap el. if (me.originalTarget && (me.dynamic || atEnd)) { me.originalTarget.setBox(box); } }, onEnd: function(e) { this.updateDimensions(e, true); if (this.proxy) { this.proxy.hide(); } }, convertRegionName: function(name) { return name; } }); /** * Applies drag handles to an element or component to make it resizable. The drag handles are inserted into the element * (or component's element) and positioned absolute. * * Textarea and img elements will be wrapped with an additional div because these elements do not support child nodes. * The original element can be accessed through the originalTarget property. * * Here is the list of valid resize handles: * * Value Description * ------ ------------------- * 'n' north * 's' south * 'e' east * 'w' west * 'nw' northwest * 'sw' southwest * 'se' southeast * 'ne' northeast * 'all' all * * {@img Ext.resizer.Resizer/Ext.resizer.Resizer.png Ext.resizer.Resizer component} * * Here's an example showing the creation of a typical Resizer: * * Ext.create('Ext.resizer.Resizer', { * el: 'elToResize', * handles: 'all', * minWidth: 200, * minHeight: 100, * maxWidth: 500, * maxHeight: 400, * pinned: true * }); */ Ext.define('Ext.resizer.Resizer', { mixins: { observable: Ext.util.Observable }, alternateClassName: 'Ext.Resizable', handleCls: Ext.baseCSSPrefix + 'resizable-handle', pinnedCls: Ext.baseCSSPrefix + 'resizable-pinned', overCls: Ext.baseCSSPrefix + 'resizable-over', wrapCls: Ext.baseCSSPrefix + 'resizable-wrap', delimiterRe: /(?:\s*[,;]\s*)|\s+/, /** * @cfg {Boolean} dynamic * Specify as true to update the {@link #target} (Element or {@link Ext.Component Component}) dynamically during * dragging. This is `true` by default, but the {@link Ext.Component Component} class passes `false` when it is * configured as {@link Ext.Component#resizable}. * * If specified as `false`, a proxy element is displayed during the resize operation, and the {@link #target} is * updated on mouseup. */ dynamic: true, /** * @cfg {String} handles * String consisting of the resize handles to display. Defaults to 's e se' for Elements and fixed position * Components. Defaults to 8 point resizing for floating Components (such as Windows). Specify either `'all'` or any * of `'n s e w ne nw se sw'`. */ handles: 's e se', /** * @cfg {Number} height * Optional. The height to set target to in pixels */ height : null, /** * @cfg {Number} width * Optional. The width to set the target to in pixels */ width : null, /** * @cfg {Number} heightIncrement * The increment to snap the height resize in pixels. */ heightIncrement : 0, /** * @cfg {Number} widthIncrement * The increment to snap the width resize in pixels. */ widthIncrement : 0, /** * @cfg {Number} minHeight * The minimum height for the element */ minHeight : 20, /** * @cfg {Number} minWidth * The minimum width for the element */ minWidth : 20, /** * @cfg {Number} maxHeight * The maximum height for the element */ maxHeight : 10000, /** * @cfg {Number} maxWidth * The maximum width for the element */ maxWidth : 10000, /** * @cfg {Boolean} pinned * True to ensure that the resize handles are always visible, false indicates resizing by cursor changes only */ pinned: false, /** * @cfg {Boolean} preserveRatio * True to preserve the original ratio between height and width during resize */ preserveRatio: false, /** * @cfg {Boolean} transparent * True for transparent handles. This is only applied at config time. */ transparent: false, /** * @cfg {Ext.Element/Ext.util.Region} constrainTo * An element, or a {@link Ext.util.Region Region} into which the resize operation must be constrained. */ possiblePositions: { n: 'north', s: 'south', e: 'east', w: 'west', se: 'southeast', sw: 'southwest', nw: 'northwest', ne: 'northeast' }, /** * @cfg {Ext.Element/Ext.Component} target * The Element or Component to resize. */ /** * @property {Ext.Element} el * Outer element for resizing behavior. */ constructor: function(config) { var me = this, target, targetEl, tag, handles = me.handles, handleCls, possibles, len, i = 0, pos, handleEls = [], eastWestStyle, style, box, targetBaseCls, unselectableCls = Ext.dom.Element.unselectableCls; me.addEvents( /** * @event beforeresize * Fired before resize is allowed. Return false to cancel resize. * @param {Ext.resizer.Resizer} this * @param {Number} width The start width * @param {Number} height The start height * @param {Ext.EventObject} e The mousedown event */ 'beforeresize', /** * @event resizedrag * Fires during resizing. Return false to cancel resize. * @param {Ext.resizer.Resizer} this * @param {Number} width The new width * @param {Number} height The new height * @param {Ext.EventObject} e The mousedown event */ 'resizedrag', /** * @event resize * Fired after a resize. * @param {Ext.resizer.Resizer} this * @param {Number} width The new width * @param {Number} height The new height * @param {Ext.EventObject} e The mouseup event */ 'resize' ); if (Ext.isString(config) || Ext.isElement(config) || config.dom) { target = config; config = arguments[1] || {}; config.target = target; } // will apply config to this me.mixins.observable.constructor.call(me, config); // If target is a Component, ensure that we pull the element out. // Resizer must examine the underlying Element. target = me.target; if (target) { if (target.isComponent) { // Resizable Components get a new UI class on them which makes them overflow:visible // if the border width is non-zero and therefore the SASS has embedded the handles // in the borders using -ve position. target.addClsWithUI('resizable'); me.el = target.getEl(); if (target.minWidth) { me.minWidth = target.minWidth; } if (target.minHeight) { me.minHeight = target.minHeight; } if (target.maxWidth) { me.maxWidth = target.maxWidth; } if (target.maxHeight) { me.maxHeight = target.maxHeight; } if (target.floating) { if (!me.hasOwnProperty('handles')) { me.handles = 'n ne e se s sw w nw'; } } } else { me.el = me.target = Ext.get(target); } } // Backwards compatibility with Ext3.x's Resizable which used el as a config. else { me.target = me.el = Ext.get(me.el); } // Tags like textarea and img cannot // have children and therefore must // be wrapped tag = me.el.dom.tagName.toUpperCase(); if (tag == 'TEXTAREA' || tag == 'IMG' || tag == 'TABLE') { /** * @property {Ext.Element/Ext.Component} originalTarget * Reference to the original resize target if the element of the original resize target was a * {@link Ext.form.field.Field Field}, or an IMG or a TEXTAREA which must be wrapped in a DIV. */ me.originalTarget = me.target; targetEl = me.el; box = targetEl.getBox(); me.target = me.el = me.el.wrap({ cls: me.wrapCls, id: me.el.id + '-rzwrap', style: targetEl.getStyles('margin-top', 'margin-bottom') }); // Transfer originalTarget's positioning+sizing+margins me.el.setPositioning(targetEl.getPositioning()); targetEl.clearPositioning(); me.el.setBox(box); // Position the wrapped element absolute so that it does not stretch the wrapper targetEl.setStyle('position', 'absolute'); } // Position the element, this enables us to absolute position // the handles within this.el me.el.position(); if (me.pinned) { me.el.addCls(me.pinnedCls); } /** * @property {Ext.resizer.ResizeTracker} resizeTracker */ me.resizeTracker = new Ext.resizer.ResizeTracker({ disabled: me.disabled, target: me.target, constrainTo: me.constrainTo, overCls: me.overCls, throttle: me.throttle, originalTarget: me.originalTarget, delegate: '.' + me.handleCls, dynamic: me.dynamic, preserveRatio: me.preserveRatio, heightIncrement: me.heightIncrement, widthIncrement: me.widthIncrement, minHeight: me.minHeight, maxHeight: me.maxHeight, minWidth: me.minWidth, maxWidth: me.maxWidth }); // Relay the ResizeTracker's superclass events as our own resize events me.resizeTracker.on({ mousedown: me.onBeforeResize, drag: me.onResize, dragend: me.onResizeEnd, scope: me }); if (me.handles == 'all') { me.handles = 'n s e w ne nw se sw'; } handles = me.handles = me.handles.split(me.delimiterRe); possibles = me.possiblePositions; len = handles.length; handleCls = me.handleCls + ' ' + me.handleCls + '-{0}'; if (me.target.isComponent) { targetBaseCls = me.target.baseCls handleCls += ' ' + targetBaseCls + '-handle ' + targetBaseCls + '-handle-{0}'; if (Ext.supports.CSS3BorderRadius) { handleCls += ' ' + targetBaseCls + '-handle-{0}-br'; } } // Needs heighting on IE6! eastWestStyle = Ext.isIE6 ? ' style="height:' + me.el.getHeight() + 'px"' : ''; for (; i < len; i++){ // if specified and possible, create if (handles[i] && possibles[handles[i]]) { pos = possibles[handles[i]]; if (pos === 'east' || pos === 'west') { style = eastWestStyle; } else { style = ''; } handleEls.push( '
    ' ); } } Ext.DomHelper.append(me.el, handleEls.join('')); // store a reference to each handle element in this.east, this.west, etc for (i = 0; i < len; i++){ // if specified and possible, create if (handles[i] && possibles[handles[i]]) { pos = possibles[handles[i]]; me[pos] = me.el.getById(me.el.id + '-' + pos + '-handle'); me[pos].region = pos; if (me.transparent) { me[pos].setOpacity(0); } } } // Constrain within configured maxima if (Ext.isNumber(me.width)) { me.width = Ext.Number.constrain(me.width, me.minWidth, me.maxWidth); } if (Ext.isNumber(me.height)) { me.height = Ext.Number.constrain(me.height, me.minHeight, me.maxHeight); } // Size the target (and originalTarget) if (me.width !== null || me.height !== null) { if (me.originalTarget) { me.originalTarget.setWidth(me.width); me.originalTarget.setHeight(me.height); } me.resizeTo(me.width, me.height); } me.forceHandlesHeight(); }, disable: function() { this.resizeTracker.disable(); }, enable: function() { this.resizeTracker.enable(); }, /** * @private Relay the Tracker's mousedown event as beforeresize * @param tracker The Resizer * @param e The Event */ onBeforeResize: function(tracker, e) { var box = this.el.getBox(); return this.fireEvent('beforeresize', this, box.width, box.height, e); }, /** * @private Relay the Tracker's drag event as resizedrag * @param tracker The Resizer * @param e The Event */ onResize: function(tracker, e) { var me = this, box = me.el.getBox(); me.forceHandlesHeight(); return me.fireEvent('resizedrag', me, box.width, box.height, e); }, /** * @private Relay the Tracker's dragend event as resize * @param tracker The Resizer * @param e The Event */ onResizeEnd: function(tracker, e) { var me = this, box = me.el.getBox(); me.forceHandlesHeight(); return me.fireEvent('resize', me, box.width, box.height, e); }, /** * Perform a manual resize and fires the 'resize' event. * @param {Number} width * @param {Number} height */ resizeTo : function(width, height) { var me = this; me.target.setSize(width, height); me.fireEvent('resize', me, width, height, null); }, /** * Returns the element that was configured with the el or target config property. If a component was configured with * the target property then this will return the element of this component. * * Textarea and img elements will be wrapped with an additional div because these elements do not support child * nodes. The original element can be accessed through the originalTarget property. * @return {Ext.Element} element */ getEl : function() { return this.el; }, /** * Returns the element or component that was configured with the target config property. * * Textarea and img elements will be wrapped with an additional div because these elements do not support child * nodes. The original element can be accessed through the originalTarget property. * @return {Ext.Element/Ext.Component} */ getTarget: function() { return this.target; }, destroy: function() { var me = this, i, handles = me.handles, len = handles.length, positions = me.possiblePositions, handle; me.resizeTracker.destroy(); for (i = 0; i < len; i++) { if (handle = me[positions[handles[i]]]) { handle.remove(); } } }, /** * @private * Fix IE6 handle height issue. */ forceHandlesHeight : function() { var me = this, handle; if (Ext.isIE6) { handle = me.east; if (handle) { handle.setHeight(me.el.getHeight()); } handle = me.west; if (handle) { handle.setHeight(me.el.getHeight()); } me.el.repaint(); } } }); /** * */ Ext.define('Ext.selection.CellModel', { extend: Ext.selection.Model , alias: 'selection.cellmodel', /** * @cfg {"SINGLE"} mode * Mode of selection. Valid values are: * * - **"SINGLE"** - Only allows selecting one item at a time. This is the default. */ isCellModel: true, /** * @cfg {Boolean} enableKeyNav * Turns on/off keyboard navigation within the grid. */ enableKeyNav: true, /** * @cfg {Boolean} preventWrap * Set this configuration to true to prevent wrapping around of selection as * a user navigates to the first or last column. */ preventWrap: false, // private property to use when firing a deselect when no old selection exists. noSelection: { row: -1, column: -1 }, constructor: function() { this.addEvents( /** * @event deselect * Fired after a cell is deselected * @param {Ext.selection.CellModel} this * @param {Ext.data.Model} record The record of the deselected cell * @param {Number} row The row index deselected * @param {Number} column The column index deselected */ 'deselect', /** * @event select * Fired after a cell is selected * @param {Ext.selection.CellModel} this * @param {Ext.data.Model} record The record of the selected cell * @param {Number} row The row index selected * @param {Number} column The column index selected */ 'select' ); this.callParent(arguments); }, bindComponent: function(view) { var me = this, grid = view.ownerCt; me.primaryView = view; me.views = me.views || []; me.views.push(view); me.bindStore(view.getStore(), true); view.on({ cellmousedown: me.onMouseDown, refresh: me.onViewRefresh, scope: me }); if (grid.optimizedColumnMove !== false) { grid.on('columnmove', me.onColumnMove, me); } if (me.enableKeyNav) { me.initKeyNav(view); } }, initKeyNav: function(view) { var me = this; if (!view.rendered) { view.on('render', Ext.Function.bind(me.initKeyNav, me, [view], 0), me, {single: true}); return; } view.el.set({ tabIndex: -1 }); // view.el has tabIndex -1 to allow for // keyboard events to be passed to it. me.keyNav = new Ext.util.KeyNav({ target: view.el, ignoreInputFields: true, up: me.onKeyUp, down: me.onKeyDown, right: me.onKeyRight, left: me.onKeyLeft, tab: me.onKeyTab, scope: me }); }, getHeaderCt: function() { var selection = this.getCurrentPosition(), view = selection ? selection.view : this.primaryView; return view.headerCt; }, onKeyUp: function(e) { this.doMove('up', e); }, onKeyDown: function(e) { this.doMove('down', e); }, onKeyLeft: function(e) { this.doMove('left', e); }, onKeyRight: function(e) { this.doMove('right', e); }, doMove: function(direction, e){ this.keyNavigation = true; this.move(direction, e); this.keyNavigation = false; }, onVetoUIEvent: Ext.emptyFn, select: function(pos, keepExisting, suppressEvent) { var me = this, row, oldPos = me.getCurrentPosition(), store = me.view.store; if (pos || pos === 0) { if (pos.isModel) { row = store.indexOf(pos); if (row !== -1) { pos = { row: row, column: oldPos ? oldPos.column : 0 }; } else { pos = null; } } else if (typeof pos === 'number') { pos = { row: pos, column: 0 } } } if (pos) { me.selectByPosition(pos, suppressEvent); } else { me.deselect(); } }, deselect: function(record, suppressEvent){ this.selectByPosition(null, suppressEvent); }, move: function(dir, e) { var me = this, pos = me.getCurrentPosition(), newPos; if (pos) { // Calculate the new row and column position newPos = pos.view.walkCells(pos, dir, e, me.preventWrap); // If walk was successful, select new Position if (newPos) { newPos.view = pos.view; return me.setCurrentPosition(newPos); } } // Enforce code correctness in unbuilt source. return null; }, /** * Returns the current position in the format {row: row, column: column} */ getCurrentPosition: function() { // If it's during a select, return nextSelection since we buffer // the real selection until after the event fires return this.selecting ? this.nextSelection : this.selection; }, /** * Sets the current position * @param {Object} position The position to set. * @param {Boolean} suppressEvent True to suppress selection events */ setCurrentPosition: function(pos, suppressEvent) { var me = this, last = me.selection; // onSelectChange uses lastSelection and nextSelection me.lastSelection = last; if (last) { // If the position is the same, jump out & don't fire the event if (pos && (pos.record === last.record && pos.columnHeader === last.columnHeader && pos.view === last.view)) { pos = null; } else { me.onCellDeselect(me.selection, suppressEvent); } } if (pos) { me.nextSelection = new Ext.grid.CellContext(me.primaryView).setPosition(pos); // set this flag here so we know to use nextSelection // if the node is updated during a select me.selecting = true; me.onCellSelect(me.nextSelection, suppressEvent); me.selecting = false; // Deselect triggered by new selection will kill the selection property, so restore it here. return (me.selection = me.nextSelection); } // Enforce code correctness in unbuilt source. return null; }, isCellSelected: function(view, row, column) { var me = this, testPos, pos = me.getCurrentPosition(); if (pos && pos.view === view) { testPos = new Ext.grid.CellContext(view).setPosition({ row: row, column: column }); return (testPos.record === pos.record) && (testPos.columnHeader === pos.columnHeader); } }, // Keep selection model in consistent state upon record deletion. onStoreRemove: function(store, records, indexes) { var me = this, pos = me.getCurrentPosition(), i, length = records.length, index, shuffleCount = 0; me.callParent(arguments); if (pos) { // All deletions are after the selection - do nothing if (indexes[0] > pos.row) { return; } for (i = 0; i < length; i++) { index = indexes[i]; // Deleted a row that was before the selected row, selection will be bumped up by one if (index < pos.row) { shuffleCount++; } // We've gone past the selection. else { break; } } // Deletions were before the selection - bump it up if (shuffleCount) { pos.setRow(pos.row - shuffleCount); } } }, /** * Set the current position based on where the user clicks. * @private */ onMouseDown: function(view, cell, cellIndex, record, row, recordIndex, e) { // Record index will be -1 if the clicked record is a metadata record and not selectable if (recordIndex !== -1) { this.setCurrentPosition({ view: view, row: row, column: cellIndex }); } }, // notify the view that the cell has been selected to update the ui // appropriately and bring the cell into focus onCellSelect: function(position, supressEvent) { if (position && position.row !== undefined && position.row > -1) { this.doSelect(position.record, /*keepExisting*/false, supressEvent); } }, // notify view that the cell has been deselected to update the ui // appropriately onCellDeselect: function(position, supressEvent) { if (position && position.row !== undefined) { this.doDeselect(position.record, supressEvent); } }, onSelectChange: function(record, isSelected, suppressEvent, commitFn) { var me = this, pos, eventName, view; if (isSelected) { pos = me.nextSelection; eventName = 'select'; } else { pos = me.lastSelection || me.noSelection; eventName = 'deselect'; } // CellModel may be shared between two sides of a Lockable. // The position must include a reference to the view in which the selection is current. // Ensure we use the view specifiied by the position. view = pos.view || me.primaryView; if ((suppressEvent || me.fireEvent('before' + eventName, me, record, pos.row, pos.column)) !== false && commitFn() !== false) { if (isSelected) { view.focusRow(record, true); view.onCellSelect(pos); } else { view.onCellDeselect(pos); delete me.selection; } if (!suppressEvent) { me.fireEvent(eventName, me, record, pos.row, pos.column); } } }, // Tab key from the View's KeyNav, *not* from an editor. onKeyTab: function(e, t) { var me = this, pos = me.getCurrentPosition(), editingPlugin; if (pos) { editingPlugin = pos.view.editingPlugin; // If we were in editing mode, but just focused on a non-editable cell, behave as if we tabbed off an editable field if (editingPlugin && me.wasEditing) { me.onEditorTab(editingPlugin, e) } else { me.move(e.shiftKey ? 'left' : 'right', e); } } }, onEditorTab: function(editingPlugin, e) { var me = this, direction = e.shiftKey ? 'left' : 'right', position = me.move(direction, e); // Navigation had somewhere to go.... not hit the buffers. if (position) { // If we were able to begin editing clear the wasEditing flag. It gets set during navigation off an active edit. if (editingPlugin.startEdit(position.record, position.columnHeader)) { me.wasEditing = false; } // If we could not continue editing... // Set a flag that we should go back into editing mode upon next onKeyTab call else { me.wasEditing = true; } } }, refresh: function() { var pos = this.getCurrentPosition(), selRowIdx; // Synchronize the current position's row with the row of the last selected record. if (pos && (selRowIdx = this.store.indexOf(this.selected.last())) !== -1) { pos.row = selRowIdx; } }, /** * @private * When grid uses {@link Ext.panel.Table#optimizedColumnMove optimizedColumnMove} (the default), this is added as a * {@link Ext.panel.Table#columnmove columnmove} handler to correctly maintain the * selected column using the same column header. * * If optimizedColumnMove === false, (which some grid Features set) then the view is refreshed, * so this is not added as a handler because the selected column. */ onColumnMove: function(headerCt, header, fromIdx, toIdx) { var grid = headerCt.up('tablepanel'); if (grid) { this.onViewRefresh(grid.view); } }, onUpdate: function(record) { var me = this, pos; if (me.isSelected(record)) { pos = me.selecting ? me.nextSelection : me.selection; me.view.onCellSelect(pos); } }, onViewRefresh: function(view) { var me = this, pos = me.getCurrentPosition(), headerCt = view.headerCt, record, columnHeader; // Re-establish selection of the same cell coordinate. // DO NOT fire events because the selected if (pos && pos.view === view) { record = pos.record; columnHeader = pos.columnHeader; // After a refresh, recreate the selection using the same record and grid column as before if (!columnHeader.isDescendantOf(headerCt)) { // column header is not a child of the header container // this happens when the grid is reconfigured with new columns // make a best effor to select something by matching on id, then text, then dataIndex columnHeader = headerCt.queryById(columnHeader.id) || headerCt.down('[text="' + columnHeader.text + '"]') || headerCt.down('[dataIndex="' + columnHeader.dataIndex + '"]'); } // If we have a columnHeader (either the column header that already exists in // the headerCt, or a suitable match that was found after reconfiguration) // AND the record still exists in the store (or a record matching the id of // the previously selected record) We are ok to go ahead and set the selection if (columnHeader && (view.store.indexOfId(record.getId()) !== -1)) { me.setCurrentPosition({ row: record, column: columnHeader, view: view }); } } }, selectByPosition: function(position, suppressEvent) { this.setCurrentPosition(position, suppressEvent); } }); /** * Implements row based navigation via keyboard. * * Must synchronize across grid sections. */ Ext.define('Ext.selection.RowModel', { extend: Ext.selection.Model , alias: 'selection.rowmodel', /** * @private * Number of pixels to scroll to the left/right when pressing * left/right keys. */ deltaScroll: 5, /** * @cfg {Boolean} enableKeyNav * * Turns on/off keyboard navigation within the grid. */ enableKeyNav: true, /** * @cfg {Boolean} [ignoreRightMouseSelection=false] * True to ignore selections that are made when using the right mouse button if there are * records that are already selected. If no records are selected, selection will continue * as normal */ ignoreRightMouseSelection: false, constructor: function() { this.addEvents( /** * @event beforedeselect * Fired before a record is deselected. If any listener returns false, the * deselection is cancelled. * @param {Ext.selection.RowModel} this * @param {Ext.data.Model} record The deselected record * @param {Number} index The row index deselected */ 'beforedeselect', /** * @event beforeselect * Fired before a record is selected. If any listener returns false, the * selection is cancelled. * @param {Ext.selection.RowModel} this * @param {Ext.data.Model} record The selected record * @param {Number} index The row index selected */ 'beforeselect', /** * @event deselect * Fired after a record is deselected * @param {Ext.selection.RowModel} this * @param {Ext.data.Model} record The deselected record * @param {Number} index The row index deselected */ 'deselect', /** * @event select * Fired after a record is selected * @param {Ext.selection.RowModel} this * @param {Ext.data.Model} record The selected record * @param {Number} index The row index selected */ 'select' ); this.views = []; this.callParent(arguments); }, bindComponent: function(view) { var me = this; view.on({ itemmousedown: me.onRowMouseDown, itemclick: me.onRowClick, scope: me }); if (me.enableKeyNav) { me.initKeyNav(view); } }, initKeyNav: function(view) { var me = this; if (!view.rendered) { view.on('render', Ext.Function.bind(me.initKeyNav, me, [view], 0), me, {single: true}); return; } // view.el has tabIndex -1 to allow for // keyboard events to be passed to it. view.el.set({ tabIndex: -1 }); // Drive the KeyNav off the View's itemkeydown event so that beforeitemkeydown listeners may veto me.keyNav = new Ext.util.KeyNav({ target: view, ignoreInputFields: true, eventName: 'itemkeydown', processEvent: function(view, record, node, index, event) { event.record = record; event.recordIndex = index; return event; }, up: me.onKeyUp, down: me.onKeyDown, right: me.onKeyRight, left: me.onKeyLeft, pageDown: me.onKeyPageDown, pageUp: me.onKeyPageUp, home: me.onKeyHome, end: me.onKeyEnd, space: me.onKeySpace, enter: me.onKeyEnter, scope: me }); }, onUpdate: function(record) { var me = this, view = me.view, index; if (view && me.isSelected(record)) { index = view.indexOf(record); view.onRowSelect(index); if (record === me.lastFocused) { view.onRowFocus(index, true); } } }, // Returns the number of rows currently visible on the screen or // false if there were no rows. This assumes that all rows are // of the same height and the first view is accurate. getRowsVisible: function() { var rowsVisible = false, view = this.views[0], firstRow = view.all.first(), rowHeight, gridViewHeight; if (firstRow) { rowHeight = firstRow.getHeight(); gridViewHeight = view.el.getHeight(); rowsVisible = Math.floor(gridViewHeight / rowHeight); } return rowsVisible; }, // go to last visible record in grid. onKeyEnd: function(e) { var me = this, view = me.views[0]; if (view.bufferedRenderer) { // If rendering is buffered, we cannot just increment the row - the row may not be there // We have to ask the BufferedRenderer to navigate to the target. // And that may involve asynchronous I/O, so must postprocess in a callback. view.bufferedRenderer.scrollTo(me.store.getCount() - 1, false, function(newIdx, newRecord) { me.afterKeyNavigate(e, newRecord) }); } else { me.afterKeyNavigate(e, view.getRecord(view.all.getCount() - 1)) } }, // go to first visible record in grid. onKeyHome: function(e) { var me = this, view = me.views[0]; if (view.bufferedRenderer) { // If rendering is buffered, we cannot just increment the row - the row may not be there // We have to ask the BufferedRenderer to navigate to the target. // And that may involve asynchronous I/O, so must postprocess in a callback. view.bufferedRenderer.scrollTo(0, false, function(newIdx, newRecord) { me.afterKeyNavigate(e, newRecord) }); } else { me.afterKeyNavigate(e, view.getRecord(0)); } }, // Go one page up from the lastFocused record in the grid. onKeyPageUp: function(e) { var me = this, view = me.views[0], rowsVisible = me.getRowsVisible(), newIdx, newRecord; if (rowsVisible) { // If rendering is buffered, we cannot just increment the row - the row may not be there // We have to ask the BufferedRenderer to navigate to the target. // And that may involve asynchronous I/O, so must postprocess in a callback. if (view.bufferedRenderer) { newIdx = Math.max(e.recordIndex - rowsVisible, 0); (me.lastKeyEvent || (me.lastKeyEvent = new Ext.EventObjectImpl())).setEvent(e.browserEvent); view.bufferedRenderer.scrollTo(newIdx, false, me.afterBufferedScrollTo, me); } else { newRecord = view.walkRecs(e.record, -rowsVisible); me.afterKeyNavigate(e, newRecord); } } }, // Go one page down from the lastFocused record in the grid. onKeyPageDown: function(e) { var me = this, view = me.views[0], rowsVisible = me.getRowsVisible(), newIdx, newRecord; if (rowsVisible) { // If rendering is buffered, we cannot just increment the row - the row may not be there // We have to ask the BufferedRenderer to navigate to the target. // And that may involve asynchronous I/O, so must postprocess in a callback. if (view.bufferedRenderer) { newIdx = Math.min(e.recordIndex + rowsVisible, me.store.getCount() - 1); (me.lastKeyEvent || (me.lastKeyEvent = new Ext.EventObjectImpl())).setEvent(e.browserEvent); view.bufferedRenderer.scrollTo(newIdx, false, me.afterBufferedScrollTo, me); } else { newRecord = view.walkRecs(e.record, rowsVisible); me.afterKeyNavigate(e, newRecord); } } }, // Select/Deselect based on pressing Spacebar. onKeySpace: function(e) { var record = this.lastFocused; if (record) { this.afterKeyNavigate(e, record); } }, onKeyEnter: Ext.emptyFn, // Navigate one record up. This could be a selection or // could be simply focusing a record for discontiguous // selection. Provides bounds checking. onKeyUp: function(e) { var newRecord = this.views[0].walkRecs(e.record, -1); if (newRecord) { this.afterKeyNavigate(e, newRecord); } }, // Navigate one record down. This could be a selection or // could be simply focusing a record for discontiguous // selection. Provides bounds checking. onKeyDown: function(e) { var newRecord = this.views[0].walkRecs(e.record, 1); if (newRecord) { this.afterKeyNavigate(e, newRecord); } }, afterBufferedScrollTo: function(newIdx, newRecord) { this.afterKeyNavigate(this.lastKeyEvent, newRecord) }, scrollByDeltaX: function(delta) { var view = this.views[0], section = view.up(), hScroll = section.horizontalScroller; if (hScroll) { hScroll.scrollByDeltaX(delta); } }, onKeyLeft: function(e) { this.scrollByDeltaX(-this.deltaScroll); }, onKeyRight: function(e) { this.scrollByDeltaX(this.deltaScroll); }, // Select the record with the event included so that // we can take into account ctrlKey, shiftKey, etc onRowMouseDown: function(view, record, item, index, e) { var me = this; // Record index will be -1 if the clicked record is a metadata record and not selectable if (index !== -1) { if (!me.allowRightMouseSelection(e)) { return; } if (!me.isSelected(record)) { me.mousedownAction = true; me.processSelection(view, record, item, index, e); } else { me.mousedownAction = false; } } }, // If the mousedown event is vetoed, we still want to treat it as though we've had // a mousedown because we don't want to proceed on click. For example, the click on // an action column vetoes the mousedown event so the click isn't processed. onVetoUIEvent: function(type, view, cell, rowIndex, cellIndex, e, record){ if (type == 'mousedown') { this.mousedownAction = !this.isSelected(record); } }, onRowClick: function(view, record, item, index, e) { if (this.mousedownAction) { this.mousedownAction = false; } else { this.processSelection(view, record, item, index, e); } }, processSelection: function(view, record, item, index, e) { this.selectWithEvent(record, e); }, /** * Checks whether a selection should proceed based on the ignoreRightMouseSelection * option. * @private * @param {Ext.EventObject} e The event * @return {Boolean} False if the selection should not proceed */ allowRightMouseSelection: function(e) { var disallow = this.ignoreRightMouseSelection && e.button !== 0; if (disallow) { disallow = this.hasSelection(); } return !disallow; }, // Allow the GridView to update the UI by // adding/removing a CSS class from the row. onSelectChange: function(record, isSelected, suppressEvent, commitFn) { var me = this, views = me.views, viewsLn = views.length, rowIdx = views[0].indexOf(record), eventName = isSelected ? 'select' : 'deselect', i = 0; if ((suppressEvent || me.fireEvent('before' + eventName, me, record, rowIdx)) !== false && commitFn() !== false) { for (; i < viewsLn; i++) { if (isSelected) { views[i].onRowSelect(rowIdx, suppressEvent); } else { views[i].onRowDeselect(rowIdx, suppressEvent); } } if (!suppressEvent) { me.fireEvent(eventName, me, record, rowIdx); } } }, // Provide indication of what row was last focused via // the gridview. onLastFocusChanged: function(oldFocused, newFocused, supressFocus) { var views = this.views, viewsLn = views.length, rowIdx, i = 0; if (oldFocused) { rowIdx = views[0].indexOf(oldFocused); if (rowIdx != -1) { for (; i < viewsLn; i++) { views[i].onRowFocus(rowIdx, false, true); } } } if (newFocused) { rowIdx = views[0].indexOf(newFocused); if (rowIdx != -1) { for (i = 0; i < viewsLn; i++) { views[i].onRowFocus(rowIdx, true, supressFocus); } } } this.callParent(arguments); }, onEditorTab: function(editingPlugin, e) { var me = this, view = me.views[0], record = editingPlugin.getActiveRecord(), header = editingPlugin.getActiveColumn(), position = view.getPosition(record, header), direction = e.shiftKey ? 'left' : 'right'; // We want to continue looping while: // 1) We have a valid position // 2) There is no editor at that position // 3) There is an editor, but editing has been cancelled (veto event) do { position = view.walkCells(position, direction, e, me.preventWrap); } while (position && (!position.columnHeader.getEditor(record) || !editingPlugin.startEditByPosition(position))); }, /** * Returns position of the first selected cell in the selection in the format {row: row, column: column} */ getCurrentPosition: function() { var firstSelection = this.selected.items[0]; if (firstSelection) { return new Ext.grid.CellContext(this.view).setPosition(this.store.indexOf(firstSelection), 0); } }, selectByPosition: function(position) { this.select(this.store.getAt(position.row)); }, /** * Selects the record immediately following the currently selected record. * @param {Boolean} [keepExisting] True to retain existing selections * @param {Boolean} [suppressEvent] Set to false to not fire a select event * @return {Boolean} `true` if there is a next record, else `false` */ selectNext: function(keepExisting, suppressEvent) { var me = this, store = me.store, selection = me.getSelection(), record = selection[selection.length - 1], index = me.views[0].indexOf(record) + 1, success; if (index === store.getCount() || index === 0) { success = false; } else { me.doSelect(index, keepExisting, suppressEvent); success = true; } return success; }, /** * Selects the record that precedes the currently selected record. * @param {Boolean} [keepExisting] True to retain existing selections * @param {Boolean} [suppressEvent] Set to false to not fire a select event * @return {Boolean} `true` if there is a previous record, else `false` */ selectPrevious: function(keepExisting, suppressEvent) { var me = this, selection = me.getSelection(), record = selection[0], index = me.views[0].indexOf(record) - 1, success; if (index < 0) { success = false; } else { me.doSelect(index, keepExisting, suppressEvent); success = true; } return success; }, isRowSelected: function(record, index) { return this.isSelected(record); } }); /** * Adds custom behavior for left/right keyboard navigation for use with a tree. * Depends on the view having an expand and collapse method which accepts a * record. This selection model is created by default for {@link Ext.tree.Panel}. */ Ext.define('Ext.selection.TreeModel', { extend: Ext.selection.RowModel , alias: 'selection.treemodel', /** * @cfg {Boolean} pruneRemoved @hide */ constructor: function(config) { this.callParent(arguments); // If pruneRemoved is required, we must listen to the *TreeStore* to know when nodes // are added and removed if (this.pruneRemoved) { this.pruneRemoved = false; this.pruneRemovedNodes = true; } }, // binds the store to the selModel. bindStore: function(store, initial) { var me = this; me.callParent(arguments); // TreePanel should have injected a reference to the TreeStore so that we can // listen for node removal. if (me.pruneRemovedNodes) { me.view.mon(me.treeStore, { remove: me.onNodeRemove, scope: me }); } }, onNodeRemove: function(parent, node, isMove) { // deselection of deleted records done in base Model class if (!isMove) { this.deselectDeletedRecords([node]); } }, onKeyRight: function(e, t) { this.navExpand(e, t); }, navExpand: function(e, t) { var focused = this.getLastFocused(), view = this.view; if (focused) { // tree node is already expanded, go down instead // this handles both the case where we navigate to firstChild and if // there are no children to the nextSibling if (focused.isExpanded()) { this.onKeyDown(e, t); // if its not a leaf node, expand it } else if (focused.isExpandable()) { // If we are the normal side of a locking pair, only the tree view can do expanding if (!view.isTreeView) { view = view.lockingPartner; } view.expand(focused); } } }, onKeyLeft: function(e, t) { this.navCollapse(e, t); }, navCollapse: function(e, t) { var me = this, focused = this.getLastFocused(), view = this.view, parentNode; if (focused) { parentNode = focused.parentNode; // if focused node is already expanded, collapse it if (focused.isExpanded()) { // If we are the normal side of a locking pair, only the tree view can do collapsing if (!view.isTreeView) { view = view.lockingPartner; } view.collapse(focused); // has a parentNode and its not root // TODO: this needs to cover the case where the root isVisible } else if (parentNode && !parentNode.isRoot()) { // Select a range of records when doing multiple selection. if (e.shiftKey) { me.selectRange(parentNode, focused, e.ctrlKey, 'up'); me.setLastFocused(parentNode); // just move focus, not selection } else if (e.ctrlKey) { me.setLastFocused(parentNode); // select it } else { me.select(parentNode); } } } }, onKeySpace: function(e, t) { if (e.record.data.checked != null) { this.toggleCheck(e); } else { this.callParent(arguments); } }, onKeyEnter: function(e, t) { if (e.record.data.checked != null) { this.toggleCheck(e); } else { this.callParent(arguments); } }, toggleCheck: function(e) { var view = this.view, selected = this.getLastSelected(); e.stopEvent(); if (selected) { // If we are the normal side of a locking pair, only the tree view can do on heckChange if (!view.isTreeView) { view = view.lockingPartner; } view.onCheckChange(selected); } } }); /** * @class Ext.slider.Thumb * @private * Represents a single thumb element on a Slider. This would not usually be created manually and would instead * be created internally by an {@link Ext.slider.Multi Multi slider}. */ Ext.define('Ext.slider.Thumb', { /** * @private * @property {Number} topThumbZIndex * The number used internally to set the z index of the top thumb (see promoteThumb for details) */ topZIndex: 10000, /** * @cfg {Ext.slider.MultiSlider} slider (required) * The Slider to render to. */ /** * Creates new slider thumb. * @param {Object} [config] Config object. */ constructor: function(config) { var me = this; /** * @property {Ext.slider.MultiSlider} slider * The slider this thumb is contained within */ Ext.apply(me, config || {}, { cls: Ext.baseCSSPrefix + 'slider-thumb', /** * @cfg {Boolean} constrain True to constrain the thumb so that it cannot overlap its siblings */ constrain: false }); me.callParent([config]); }, /** * Renders the thumb into a slider */ render: function() { var me = this; me.el = me.slider.innerEl.insertFirst(me.getElConfig()); me.onRender(); }, onRender: function() { if (this.disabled) { this.disable(); } this.initEvents(); }, getElConfig: function() { var me = this, slider = me.slider, style = {}; style[slider.vertical ? 'bottom' : slider.horizontalProp] = slider.calculateThumbPosition(slider.normalizeValue(me.value)) + '%'; return { style: style, id : this.id, cls : this.cls }; }, /** * @private * move the thumb */ move: function(v, animate) { var me = this, el = me.el, slider = me.slider, styleProp = slider.vertical ? 'bottom' : slider.horizontalProp, to, from; v += '%'; if (!animate) { el.dom.style[styleProp] = v; } else { to = {}; to[styleProp] = v; if (!Ext.supports.GetPositionPercentage) { from = {}; from[styleProp] = el.dom.style[styleProp]; } new Ext.fx.Anim({ target: el, duration: 350, from: from, to: to }); } }, /** * @private * Bring thumb dom element to front. */ bringToFront: function() { this.el.setStyle('zIndex', this.topZIndex); }, /** * @private * Send thumb dom element to back. */ sendToBack: function() { this.el.setStyle('zIndex', ''); }, /** * Enables the thumb if it is currently disabled */ enable: function() { var me = this; me.disabled = false; if (me.el) { me.el.removeCls(me.slider.disabledCls); } }, /** * Disables the thumb if it is currently enabled */ disable: function() { var me = this; me.disabled = true; if (me.el) { me.el.addCls(me.slider.disabledCls); } }, /** * Sets up an Ext.dd.DragTracker for this thumb */ initEvents: function() { var me = this, el = me.el; me.tracker = new Ext.dd.DragTracker({ onBeforeStart: Ext.Function.bind(me.onBeforeDragStart, me), onStart : Ext.Function.bind(me.onDragStart, me), onDrag : Ext.Function.bind(me.onDrag, me), onEnd : Ext.Function.bind(me.onDragEnd, me), tolerance : 3, autoStart : 300, overCls : Ext.baseCSSPrefix + 'slider-thumb-over' }); me.tracker.initEl(el); }, /** * @private * This is tied into the internal Ext.dd.DragTracker. If the slider is currently disabled, * this returns false to disable the DragTracker too. * @return {Boolean} False if the slider is currently disabled */ onBeforeDragStart : function(e) { if (this.disabled) { return false; } else { this.slider.promoteThumb(this); return true; } }, /** * @private * This is tied into the internal Ext.dd.DragTracker's onStart template method. Adds the drag CSS class * to the thumb and fires the 'dragstart' event */ onDragStart: function(e){ var me = this, slider = me.slider; slider.onDragStart(me, e); me.el.addCls(Ext.baseCSSPrefix + 'slider-thumb-drag'); me.dragging = me.slider.dragging = true; me.dragStartValue = me.value; slider.fireEvent('dragstart', slider, e, me); }, /** * @private * This is tied into the internal Ext.dd.DragTracker's onDrag template method. This is called every time * the DragTracker detects a drag movement. It updates the Slider's value using the position of the drag */ onDrag: function(e) { var me = this, slider = me.slider, index = me.index, newValue = me.getValueFromTracker(), above, below; // If dragged out of range, value will be undefined if (newValue !== undefined) { if (me.constrain) { above = slider.thumbs[index + 1]; below = slider.thumbs[index - 1]; if (below !== undefined && newValue <= below.value) { newValue = below.value; } if (above !== undefined && newValue >= above.value) { newValue = above.value; } } slider.setValue(index, newValue, false); slider.fireEvent('drag', slider, e, me); } }, getValueFromTracker: function() { var slider = this.slider, trackPoint = slider.getTrackpoint(this.tracker.getXY()); // If dragged out of range, value will be undefined if (trackPoint !== undefined) { return slider.reversePixelValue(trackPoint); } }, /** * @private * This is tied to the internal Ext.dd.DragTracker's onEnd template method. Removes the drag CSS class and * fires the 'changecomplete' event with the new value */ onDragEnd: function(e) { var me = this, slider = me.slider, value = me.value; slider.onDragEnd(me, e); me.el.removeCls(Ext.baseCSSPrefix + 'slider-thumb-drag'); me.dragging = slider.dragging = false; slider.fireEvent('dragend', slider, e); if (me.dragStartValue != value) { slider.fireEvent('changecomplete', slider, value, me); } }, destroy: function() { Ext.destroy(this.tracker); } }); /** * Simple plugin for using an Ext.tip.Tip with a slider to show the slider value. In general this class is not created * directly, instead pass the {@link Ext.slider.Multi#useTips} and {@link Ext.slider.Multi#tipText} configuration * options to the slider directly. * * @example * Ext.create('Ext.slider.Single', { * width: 214, * minValue: 0, * maxValue: 100, * useTips: true, * renderTo: Ext.getBody() * }); * * Optionally provide your own tip text by passing tipText: * * @example * Ext.create('Ext.slider.Single', { * width: 214, * minValue: 0, * maxValue: 100, * useTips: true, * tipText: function(thumb){ * return Ext.String.format('**{0}% complete**', thumb.value); * }, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.slider.Tip', { extend: Ext.tip.Tip , minWidth: 10, alias: 'widget.slidertip', /** * @cfg {Array} [offsets=null] * Offsets for aligning the tip to the slider. See {@link Ext.util.Positionable#alignTo}. Default values * for offsets are provided by specifying the {@link #position} config. */ offsets : null, /** * @cfg {String} [align=null] * Alignment configuration for the tip to the slider. See {@link Ext.util.Positionable#alignTo}. Default * values for alignment are provided by specifying the {@link #position} config. */ align: null, /** * @cfg {String} [position=For horizontal sliders, "top", for vertical sliders, "left"] * Sets the position for where the tip will be displayed related to the thumb. This sets * defaults for {@link #align} and {@link #offsets} configurations. If {@link #align} or * {@link #offsets} configurations are specified, they will override the defaults defined * by position. */ position: '', defaultVerticalPosition: 'left', defaultHorizontalPosition: 'top', isSliderTip: true, init: function(slider) { var me = this, align, offsets; if (!me.position) { me.position = slider.vertical ? me.defaultVerticalPosition : me.defaultHorizontalPosition; } switch (me.position) { case 'top': offsets = [0, -10]; align = 'b-t?'; break; case 'bottom': offsets = [0, 10]; align = 't-b?'; break; case 'left': offsets = [-10, 0]; align = 'r-l?'; break; case 'right': offsets = [10, 0]; align = 'l-r?'; } if (!me.align) { me.align = align; } if (!me.offsets) { me.offsets = offsets; } slider.on({ scope : me, dragstart: me.onSlide, drag : me.onSlide, dragend : me.hide, destroy : me.destroy }); }, /** * @private * Called whenever a dragstart or drag event is received on the associated Thumb. * Aligns the Tip with the Thumb's new position. * @param {Ext.slider.MultiSlider} slider The slider * @param {Ext.EventObject} e The Event object * @param {Ext.slider.Thumb} thumb The thumb that the Tip is attached to */ onSlide : function(slider, e, thumb) { var me = this; me.show(); me.update(me.getText(thumb)); me.el.alignTo(thumb.el, me.align, me.offsets); }, /** * Used to create the text that appears in the Tip's body. By default this just returns the value of the Slider * Thumb that the Tip is attached to. Override to customize. * @param {Ext.slider.Thumb} thumb The Thumb that the Tip is attached to * @return {String} The text to display in the tip * @protected * @template */ getText : function(thumb) { return String(thumb.value); } }); /** * Slider which supports vertical or horizontal orientation, keyboard adjustments, configurable snapping, axis clicking * and animation. Can be added as an item to any container. * * Sliders can be created with more than one thumb handle by passing an array of values instead of a single one: * * @example * Ext.create('Ext.slider.Multi', { * width: 200, * values: [25, 50, 75], * increment: 5, * minValue: 0, * maxValue: 100, * * // this defaults to true, setting to false allows the thumbs to pass each other * constrainThumbs: false, * renderTo: Ext.getBody() * }); */ Ext.define('Ext.slider.Multi', { extend: Ext.form.field.Base , alias: 'widget.multislider', alternateClassName: 'Ext.slider.MultiSlider', childEls: [ 'endEl', 'innerEl' ], // note: {id} here is really {inputId}, but {cmpId} is available fieldSubTpl: [ '
    ', '', '
    ', { renderThumbs: function(out, values) { var me = values.$comp, i = 0, thumbs = me.thumbs, len = thumbs.length, thumb, thumbConfig; for (; i < len; i++) { thumb = thumbs[i]; thumbConfig = thumb.getElConfig(); thumbConfig.id = me.id + '-thumb-' + i; Ext.DomHelper.generateMarkup(thumbConfig, out); } }, disableFormats: true } ], horizontalProp: 'left', /** * @cfg {Number} value * A value with which to initialize the slider. Setting this will only result in the creation * of a single slider thumb; if you want multiple thumbs then use the {@link #values} config instead. * * Defaults to #minValue. */ /** * @cfg {Number[]} values * Array of Number values with which to initalize the slider. A separate slider thumb will be created for each value * in this array. This will take precedence over the single {@link #value} config. */ /** * @cfg {Boolean} vertical * Orient the Slider vertically rather than horizontally. */ vertical: false, /** * @cfg {Number} minValue * The minimum value for the Slider. */ minValue: 0, /** * @cfg {Number} maxValue * The maximum value for the Slider. */ maxValue: 100, /** * @cfg {Number/Boolean} decimalPrecision The number of decimal places to which to round the Slider's value. * * To disable rounding, configure as **false**. */ decimalPrecision: 0, /** * @cfg {Number} keyIncrement * How many units to change the Slider when adjusting with keyboard navigation. If the increment * config is larger, it will be used instead. */ keyIncrement: 1, /** * @cfg {Number} increment * How many units to change the slider when adjusting by drag and drop. Use this option to enable 'snapping'. */ increment: 0, /** * @cfg {Boolean} [zeroBasedSnapping=false] * Set to `true` to calculate snap points based on {@link #increment}s from zero as opposed to * from this Slider's {@link #minValue}. * * By Default, valid snap points are calculated starting {@link #increment}s from the {@link #minValue} */ /** * @private * @property {Number[]} clickRange * Determines whether or not a click to the slider component is considered to be a user request to change the value. Specified as an array of [top, bottom], * the click event's 'top' property is compared to these numbers and the click only considered a change request if it falls within them. e.g. if the 'top' * value of the click event is 4 or 16, the click is not considered a change request as it falls outside of the [5, 15] range */ clickRange: [5,15], /** * @cfg {Boolean} clickToChange * Determines whether or not clicking on the Slider axis will change the slider. */ clickToChange : true, /** * @cfg {Boolean} animate * Turn on or off animation. */ animate: true, /** * @property {Boolean} dragging * True while the thumb is in a drag operation */ dragging: false, /** * @cfg {Boolean} constrainThumbs * True to disallow thumbs from overlapping one another. */ constrainThumbs: true, componentLayout: 'sliderfield', /** * @cfg {Object/Boolean} useTips * True to use an {@link Ext.slider.Tip} to display tips for the value. This option may also * provide a configuration object for an {@link Ext.slider.Tip}. */ useTips : true, /** * @cfg {Function} [tipText=undefined] * A function used to display custom text for the slider tip. * * Defaults to null, which will use the default on the plugin. * * @cfg {Ext.slider.Thumb} tipText.thumb The Thumb that the Tip is attached to * @cfg {String} tipText.return The text to display in the tip */ tipText : null, ariaRole: 'slider', // private override initValue: function() { var me = this, extValue = Ext.value, // Fallback for initial values: values config -> value config -> minValue config -> 0 values = extValue(me.values, [extValue(me.value, extValue(me.minValue, 0))]), i = 0, len = values.length; // Store for use in dirty check me.originalValue = values; // Add a thumb for each value for (; i < len; i++) { me.addThumb(values[i]); } }, // private override initComponent : function() { var me = this, tipPlug, hasTip, p, pLen, plugins; /** * @property {Array} thumbs * Array containing references to each thumb */ me.thumbs = []; me.keyIncrement = Math.max(me.increment, me.keyIncrement); me.addEvents( /** * @event beforechange * Fires before the slider value is changed. By returning false from an event handler, you can cancel the * event and prevent the slider from changing. * @param {Ext.slider.Multi} slider The slider * @param {Number} newValue The new value which the slider is being changed to. * @param {Number} oldValue The old value which the slider was previously. */ 'beforechange', /** * @event change * Fires when the slider value is changed. * @param {Ext.slider.Multi} slider The slider * @param {Number} newValue The new value which the slider has been changed to. * @param {Ext.slider.Thumb} thumb The thumb that was changed */ 'change', /** * @event changecomplete * Fires when the slider value is changed by the user and any drag operations have completed. * @param {Ext.slider.Multi} slider The slider * @param {Number} newValue The new value which the slider has been changed to. * @param {Ext.slider.Thumb} thumb The thumb that was changed */ 'changecomplete', /** * @event dragstart * Fires after a drag operation has started. * @param {Ext.slider.Multi} slider The slider * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker */ 'dragstart', /** * @event drag * Fires continuously during the drag operation while the mouse is moving. * @param {Ext.slider.Multi} slider The slider * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker */ 'drag', /** * @event dragend * Fires after the drag operation has completed. * @param {Ext.slider.Multi} slider The slider * @param {Ext.EventObject} e The event fired from Ext.dd.DragTracker */ 'dragend' ); me.callParent(); // only can use it if it exists. if (me.useTips) { if (Ext.isObject(me.useTips)) { tipPlug = Ext.apply({}, me.useTips); } else { tipPlug = me.tipText ? {getText: me.tipText} : {}; } plugins = me.plugins = me.plugins || []; pLen = plugins.length; for (p = 0; p < pLen; p++) { if (plugins[p].isSliderTip) { hasTip = true; break; } } if (!hasTip) { me.plugins.push(new Ext.slider.Tip(tipPlug)); } } }, /** * Creates a new thumb and adds it to the slider * @param {Number} [value=0] The initial value to set on the thumb. * @return {Ext.slider.Thumb} The thumb */ addThumb: function(value) { var me = this, thumb = new Ext.slider.Thumb({ ownerCt : me, ownerLayout : me.getComponentLayout(), value : value, slider : me, index : me.thumbs.length, constrain : me.constrainThumbs, disabled : !!me.readOnly }); me.thumbs.push(thumb); //render the thumb now if needed if (me.rendered) { thumb.render(); } return thumb; }, /** * @private * Moves the given thumb above all other by increasing its z-index. This is called when as drag * any thumb, so that the thumb that was just dragged is always at the highest z-index. This is * required when the thumbs are stacked on top of each other at one of the ends of the slider's * range, which can result in the user not being able to move any of them. * @param {Ext.slider.Thumb} topThumb The thumb to move to the top */ promoteThumb: function(topThumb) { var thumbs = this.thumbs, ln = thumbs.length, zIndex, thumb, i; for (i = 0; i < ln; i++) { thumb = thumbs[i]; if (thumb == topThumb) { thumb.bringToFront(); } else { thumb.sendToBack(); } } }, // private override getSubTplData : function() { var me = this; return Ext.apply(me.callParent(), { $comp: me, vertical: me.vertical ? Ext.baseCSSPrefix + 'slider-vert' : Ext.baseCSSPrefix + 'slider-horz', minValue: me.minValue, maxValue: me.maxValue, value: me.value, childElCls: '' }); }, onRender : function() { var me = this, thumbs = me.thumbs, len = thumbs.length, i = 0, thumb; me.callParent(arguments); for (i = 0; i < len; i++) { thumb = thumbs[i]; thumb.el = me.el.getById(me.id + '-thumb-' + i); thumb.onRender(); } }, /** * @private * Adds keyboard and mouse listeners on this.el. Ignores click events on the internal focus element. */ initEvents : function() { var me = this; me.mon(me.el, { scope : me, mousedown: me.onMouseDown, keydown : me.onKeyDown }); }, onDragStart: Ext.emptyFn, onDragEnd: Ext.emptyFn, /** * @private * Given an `[x, y]` position within the slider's track (Points outside the slider's track are coerced to either the minimum or maximum value), * calculate how many pixels **from the slider origin** (left for horizontal Sliders and bottom for vertical Sliders) that point is. * * If the point is outside the range of the Slider's track, the return value is `undefined` * @param {Number[]} xy The point to calculate the track point for */ getTrackpoint : function(xy) { var me = this, vertical = me.vertical, sliderTrack = me.innerEl, trackLength, result, positionProperty; if (vertical) { positionProperty = 'top'; trackLength = sliderTrack.getHeight(); } else { positionProperty = me.horizontalProp; trackLength = sliderTrack.getWidth(); } xy = me.transformTrackPoints(sliderTrack.translatePoints(xy)); result = Ext.Number.constrain(xy[positionProperty], 0, trackLength); return vertical ? trackLength - result : result; }, transformTrackPoints: Ext.identityFn, /** * @private * Mousedown handler for the slider. If the clickToChange is enabled and the click was not on the draggable 'thumb', * this calculates the new value of the slider and tells the implementation (Horizontal or Vertical) to move the thumb * @param {Ext.EventObject} e The click event */ onMouseDown : function(e) { var me = this, thumbClicked = false, i = 0, thumbs = me.thumbs, len = thumbs.length, trackPoint; if (me.disabled) { return; } //see if the click was on any of the thumbs for (; i < len; i++) { thumbClicked = thumbClicked || e.target == thumbs[i].el.dom; } if (me.clickToChange && !thumbClicked) { trackPoint = me.getTrackpoint(e.getXY()); if (trackPoint !== undefined) { me.onClickChange(trackPoint); } } me.focus(); }, /** * @private * Moves the thumb to the indicated position. * Only changes the value if the click was within this.clickRange. * @param {Number} trackPoint local pixel offset **from the origin** (left for horizontal and bottom for vertical) along the Slider's axis at which the click event occured. */ onClickChange : function(trackPoint) { var me = this, thumb, index; // How far along the track *from the origin* was the click. // If vertical, the origin is the bottom of the slider track. //find the nearest thumb to the click event thumb = me.getNearest(trackPoint); if (!thumb.disabled) { index = thumb.index; me.setValue(index, Ext.util.Format.round(me.reversePixelValue(trackPoint), me.decimalPrecision), undefined, true); } }, /** * @private * Returns the nearest thumb to a click event, along with its distance * @param {Number} trackPoint local pixel position along the Slider's axis to find the Thumb for * @return {Object} The closest thumb object and its distance from the click event */ getNearest: function(trackPoint) { var me = this, clickValue = me.reversePixelValue(trackPoint), nearestDistance = me.getRange() + 5, //add a small fudge for the end of the slider nearest = null, thumbs = me.thumbs, i = 0, len = thumbs.length, thumb, value, dist; for (; i < len; i++) { thumb = me.thumbs[i]; value = thumb.value; dist = Math.abs(value - clickValue); if (Math.abs(dist <= nearestDistance)) { nearest = thumb; nearestDistance = dist; } } return nearest; }, /** * @private * Handler for any keypresses captured by the slider. If the key is UP or RIGHT, the thumb is moved along to the right * by this.keyIncrement. If DOWN or LEFT it is moved left. Pressing CTRL moves the slider to the end in either direction * @param {Ext.EventObject} e The Event object */ onKeyDown : function(e) { /* * The behaviour for keyboard handling with multiple thumbs is currently undefined. * There's no real sane default for it, so leave it like this until we come up * with a better way of doing it. */ var me = this, k, val; if(me.disabled || me.thumbs.length !== 1) { e.preventDefault(); return; } k = e.getKey(); switch(k) { case e.UP: case e.RIGHT: e.stopEvent(); val = e.ctrlKey ? me.maxValue : me.getValue(0) + me.keyIncrement; me.setValue(0, val, undefined, true); break; case e.DOWN: case e.LEFT: e.stopEvent(); val = e.ctrlKey ? me.minValue : me.getValue(0) - me.keyIncrement; me.setValue(0, val, undefined, true); break; default: e.preventDefault(); } }, /** * @private * Returns a snapped, constrained value when given a desired value * @param {Number} value Raw number value * @return {Number} The raw value rounded to the correct d.p. and constrained within the set max and min values */ normalizeValue : function(v) { var me = this, snapFn = me.zeroBasedSnapping ? 'snap' : 'snapInRange'; v = Ext.Number[snapFn](v, me.increment, me.minValue, me.maxValue); v = Ext.util.Format.round(v, me.decimalPrecision); v = Ext.Number.constrain(v, me.minValue, me.maxValue); return v; }, /** * Sets the minimum value for the slider instance. If the current value is less than the minimum value, the current * value will be changed. * @param {Number} val The new minimum value */ setMinValue : function(val) { var me = this, thumbs = me.thumbs, len = thumbs.length, thumb, i; me.minValue = val; if (me.rendered) { me.inputEl.dom.setAttribute('aria-valuemin', val); } for (i = 0; i < len; ++i) { thumb = thumbs[i]; if (thumb.value < val) { me.setValue(i, val, false); } } me.syncThumbs(); }, /** * Sets the maximum value for the slider instance. If the current value is more than the maximum value, the current * value will be changed. * @param {Number} val The new maximum value */ setMaxValue : function(val) { var me = this, thumbs = me.thumbs, len = thumbs.length, thumb, i; me.maxValue = val; if (me.rendered) { me.inputEl.dom.setAttribute('aria-valuemax', val); } for (i = 0; i < len; ++i) { thumb = thumbs[i]; if (thumb.value > val) { me.setValue(i, val, false); } } me.syncThumbs(); }, /** * Programmatically sets the value of the Slider. Ensures that the value is constrained within the minValue and * maxValue. * * Setting a single value: * // Set the second slider value, don't animate * mySlider.setValue(1, 50, false); * * Setting multiple values at once * // Set 3 thumb values, animate * mySlider.setValue([20, 40, 60], true); * * @param {Number/Number[]} index Index of the thumb to move. Alternatively, it can be an array of values to set * for each thumb in the slider. * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue) * @param {Boolean} [animate=true] Turn on or off animation * @return {Ext.slider.Multi} this */ setValue : function(index, value, animate, changeComplete) { var me = this, thumbs = me.thumbs, thumb, len, i, values; if (Ext.isArray(index)) { values = index; animate = value; for (i = 0, len = values.length; i < len; ++i) { thumb = thumbs[i]; if (thumb) { me.setValue(i, values[i], animate); } } return me; } thumb = me.thumbs[index]; // ensures value is contstrained and snapped value = me.normalizeValue(value); if (value !== thumb.value && me.fireEvent('beforechange', me, value, thumb.value, thumb) !== false) { thumb.value = value; if (me.rendered) { // TODO this only handles a single value; need a solution for exposing multiple values to aria. // Perhaps this should go on each thumb element rather than the outer element. me.inputEl.set({ 'aria-valuenow': value, 'aria-valuetext': value }); thumb.move(me.calculateThumbPosition(value), Ext.isDefined(animate) ? animate !== false : me.animate); me.fireEvent('change', me, value, thumb); me.checkDirty(); if (changeComplete) { me.fireEvent('changecomplete', me, value, thumb); } } } return me; }, /** * @private * Given a value within this Slider's range, calculates a Thumb's percentage CSS position to map that value. */ calculateThumbPosition : function(v) { var me = this, minValue = me.minValue, pos = (v - minValue) / me.getRange() * 100; // If the total number of records is <= pageSize then return minValue. if (isNaN(pos)) { pos = minValue; } return pos; }, /** * @private * Returns the ratio of pixels to mapped values. e.g. if the slider is 200px wide and maxValue - minValue is 100, * the ratio is 2 * @return {Number} The ratio of pixels to mapped values */ getRatio : function() { var me = this, innerEl = me.innerEl, trackLength = me.vertical ? innerEl.getHeight() : innerEl.getWidth(), valueRange = me.getRange(); return valueRange === 0 ? trackLength : (trackLength / valueRange); }, getRange: function(){ return this.maxValue - this.minValue; }, /** * @private * Given a pixel location along the slider, returns the mapped slider value for that pixel. * E.g. if we have a slider 200px wide with minValue = 100 and maxValue = 500, reversePixelValue(50) * returns 200 * @param {Number} pos The position along the slider to return a mapped value for * @return {Number} The mapped value for the given position */ reversePixelValue : function(pos) { return this.minValue + (pos / this.getRatio()); }, /** * @private * Given a Thumb's percentage position along the slider, returns the mapped slider value for that pixel. * E.g. if we have a slider 200px wide with minValue = 100 and maxValue = 500, reversePercentageValue(25) * returns 200 * @param {Number} pos The percentage along the slider track to return a mapped value for * @return {Number} The mapped value for the given position */ reversePercentageValue : function(pos) { return this.minValue + this.getRange() * (pos / 100); }, //private onDisable: function() { var me = this, i = 0, thumbs = me.thumbs, len = thumbs.length, thumb, el, xy; me.callParent(); for (; i < len; i++) { thumb = thumbs[i]; el = thumb.el; thumb.disable(); if(Ext.isIE) { //IE breaks when using overflow visible and opacity other than 1. //Create a place holder for the thumb and display it. xy = el.getXY(); el.hide(); me.innerEl.addCls(me.disabledCls).dom.disabled = true; if (!me.thumbHolder) { me.thumbHolder = me.endEl.createChild({cls: Ext.baseCSSPrefix + 'slider-thumb ' + me.disabledCls}); } me.thumbHolder.show().setXY(xy); } } }, //private onEnable: function() { var me = this, i = 0, thumbs = me.thumbs, len = thumbs.length, thumb, el; this.callParent(); for (; i < len; i++) { thumb = thumbs[i]; el = thumb.el; thumb.enable(); if (Ext.isIE) { me.innerEl.removeCls(me.disabledCls).dom.disabled = false; if (me.thumbHolder) { me.thumbHolder.hide(); } el.show(); me.syncThumbs(); } } }, /** * Synchronizes thumbs position to the proper proportion of the total component width based on the current slider * {@link #value}. This will be called automatically when the Slider is resized by a layout, but if it is rendered * auto width, this method can be called from another resize handler to sync the Slider if necessary. */ syncThumbs : function() { if (this.rendered) { var thumbs = this.thumbs, length = thumbs.length, i = 0; for (; i < length; i++) { thumbs[i].move(this.calculateThumbPosition(thumbs[i].value)); } } }, /** * Returns the current value of the slider * @param {Number} index The index of the thumb to return a value for * @return {Number/Number[]} The current value of the slider at the given index, or an array of all thumb values if * no index is given. */ getValue : function(index) { return Ext.isNumber(index) ? this.thumbs[index].value : this.getValues(); }, /** * Returns an array of values - one for the location of each thumb * @return {Number[]} The set of thumb values */ getValues: function() { var values = [], i = 0, thumbs = this.thumbs, len = thumbs.length; for (; i < len; i++) { values.push(thumbs[i].value); } return values; }, getSubmitValue: function() { var me = this; return (me.disabled || !me.submitValue) ? null : me.getValue(); }, reset: function() { var me = this, arr = [].concat(me.originalValue), a = 0, aLen = arr.length, val; for (; a < aLen; a++) { val = arr[a]; me.setValue(a, val); } me.clearInvalid(); // delete here so we reset back to the original state delete me.wasValid; }, setReadOnly: function(readOnly){ var me = this, thumbs = me.thumbs, len = thumbs.length, i = 0; me.callParent(arguments); readOnly = me.readOnly; for (; i < len; ++i) { if (readOnly) { thumbs[i].disable(); } else { thumbs[i].enable(); } } }, // private beforeDestroy : function() { var me = this, thumbs = me.thumbs, t = 0, tLen = thumbs.length, thumb; Ext.destroy(me.innerEl, me.endEl, me.focusEl); for (; t < tLen; t++) { thumb = thumbs[t]; Ext.destroy(thumb); } me.callParent(); } }); /** * @author Ed Spencer * * Represents a single Tab in a {@link Ext.tab.Panel TabPanel}. A Tab is simply a slightly customized {@link Ext.button.Button Button}, * styled to look like a tab. Tabs are optionally closable, and can also be disabled. 99% of the time you will not * need to create Tabs manually as the framework does so automatically when you use a {@link Ext.tab.Panel TabPanel} */ Ext.define('Ext.tab.Tab', { extend: Ext.button.Button , alias: 'widget.tab', /** * @property {Boolean} isTab * `true` in this class to identify an object as an instantiated Tab, or subclass thereof. */ isTab: true, baseCls: Ext.baseCSSPrefix + 'tab', closeElOverCls: Ext.baseCSSPrefix + 'tab-close-btn-over', /** * @cfg {String} activeCls * The CSS class to be applied to a Tab when it is active. * Providing your own CSS for this class enables you to customize the active state. */ activeCls: 'active', /** * @cfg {String} [disabledCls='x-tab-disabled'] * The CSS class to be applied to a Tab when it is disabled. */ /** * @cfg {String} closableCls * The CSS class which is added to the tab when it is closable */ closableCls: 'closable', /** * @cfg {Boolean} closable * True to make the Tab start closable (the close icon will be visible). */ closable: true, // /** * @cfg {String} closeText * The accessible text label for the close button link; only used when {@link #cfg-closable} = true. */ closeText: 'Close Tab', // /** * @property {Boolean} active * Indicates that this tab is currently active. This is NOT a public configuration. * @readonly */ active: false, /** * @property {Boolean} closable * True if the tab is currently closable */ childEls: [ 'closeEl' ], scale: false, position: 'top', initComponent: function() { var me = this; me.addEvents( /** * @event activate * Fired when the tab is activated. * @param {Ext.tab.Tab} this */ 'activate', /** * @event deactivate * Fired when the tab is deactivated. * @param {Ext.tab.Tab} this */ 'deactivate', /** * @event beforeclose * Fires if the user clicks on the Tab's close button, but before the {@link #close} event is fired. Return * false from any listener to stop the close event being fired * @param {Ext.tab.Tab} tab The Tab object */ 'beforeclose', /** * @event close * Fires to indicate that the tab is to be closed, usually because the user has clicked the close button. * @param {Ext.tab.Tab} tab The Tab object */ 'close' ); me.callParent(arguments); if (me.card) { me.setCard(me.card); } me.overCls = ['over', me.position + '-over']; }, getTemplateArgs: function() { var me = this, result = me.callParent(); result.closable = me.closable; result.closeText = me.closeText; return result; }, getFramingInfoCls: function(){ return this.baseCls + '-' + this.ui + '-' + this.position; }, beforeRender: function() { var me = this, tabBar = me.up('tabbar'), tabPanel = me.up('tabpanel'); me.callParent(); me.addClsWithUI(me.position); if (me.active) { me.addClsWithUI([me.activeCls, me.position + '-' + me.activeCls]); } // Set all the state classNames, as they need to include the UI // me.disabledCls = me.getClsWithUIs('disabled'); me.syncClosableUI(); // Propagate minTabWidth and maxTabWidth settings from the owning TabBar then TabPanel if (!me.minWidth) { me.minWidth = (tabBar) ? tabBar.minTabWidth : me.minWidth; if (!me.minWidth && tabPanel) { me.minWidth = tabPanel.minTabWidth; } if (me.minWidth && me.iconCls) { me.minWidth += 25; } } if (!me.maxWidth) { me.maxWidth = (tabBar) ? tabBar.maxTabWidth : me.maxWidth; if (!me.maxWidth && tabPanel) { me.maxWidth = tabPanel.maxTabWidth; } } }, onRender: function() { var me = this; me.setElOrientation(); me.callParent(arguments); if (me.closable) { me.closeEl.addClsOnOver(me.closeElOverCls); } me.keyNav = new Ext.util.KeyNav(me.el, { enter: me.onEnterKey, del: me.onDeleteKey, scope: me }); }, setElOrientation: function() { var position = this.position; if (position === 'left' || position === 'right') { this.el.setVertical(position === 'right' ? 90 : 270); } }, // inherit docs enable : function(silent) { var me = this; me.callParent(arguments); me.removeClsWithUI(me.position + '-disabled'); return me; }, // inherit docs disable : function(silent) { var me = this; me.callParent(arguments); me.addClsWithUI(me.position + '-disabled'); return me; }, onDestroy: function() { var me = this; Ext.destroy(me.keyNav); delete me.keyNav; me.callParent(arguments); }, /** * Sets the tab as either closable or not. * @param {Boolean} closable Pass false to make the tab not closable. Otherwise the tab will be made closable (eg a * close button will appear on the tab) */ setClosable: function(closable) { var me = this; // Closable must be true if no args closable = (!arguments.length || !!closable); if (me.closable != closable) { me.closable = closable; // set property on the user-facing item ('card'): if (me.card) { me.card.closable = closable; } me.syncClosableUI(); if (me.rendered) { me.syncClosableElements(); // Tab will change width to accommodate close icon me.updateLayout(); } } }, /** * This method ensures that the closeBtn element exists or not based on 'closable'. * @private */ syncClosableElements: function () { var me = this, closeEl = me.closeEl; if (me.closable) { if (!closeEl) { closeEl = me.closeEl = me.btnWrap.insertSibling({ tag: 'a', cls: me.baseCls + '-close-btn', href: '#', title: me.closeText }, 'after'); } closeEl.addClsOnOver(me.closeElOverCls); } else if (closeEl) { closeEl.remove(); delete me.closeEl; } }, /** * This method ensures that the UI classes are added or removed based on 'closable'. * @private */ syncClosableUI: function () { var me = this, classes = [me.closableCls, me.closableCls + '-' + me.position]; if (me.closable) { me.addClsWithUI(classes); } else { me.removeClsWithUI(classes); } }, /** * Sets this tab's attached card. Usually this is handled automatically by the {@link Ext.tab.Panel} that this Tab * belongs to and would not need to be done by the developer * @param {Ext.Component} card The card to set */ setCard: function(card) { var me = this; me.card = card; me.setText(me.title || card.title); me.setIconCls(me.iconCls || card.iconCls); me.setIcon(me.icon || card.icon); me.setGlyph(me.glyph || card.glyph); }, /** * @private * Listener attached to click events on the Tab's close button */ onCloseClick: function() { var me = this; if (me.fireEvent('beforeclose', me) !== false) { if (me.tabBar) { if (me.tabBar.closeTab(me) === false) { // beforeclose on the panel vetoed the event, stop here return; } } else { // if there's no tabbar, fire the close event me.fireClose(); } } }, /** * Fires the close event on the tab. * @private */ fireClose: function(){ this.fireEvent('close', this); }, /** * @private */ onEnterKey: function(e) { var me = this; if (me.tabBar) { me.tabBar.onClick(e, me.el); } }, /** * @private */ onDeleteKey: function(e) { if (this.closable) { this.onCloseClick(); } }, // @private activate : function(supressEvent) { var me = this; me.active = true; me.addClsWithUI([me.activeCls, me.position + '-' + me.activeCls]); if (supressEvent !== true) { me.fireEvent('activate', me); } }, // @private deactivate : function(supressEvent) { var me = this; me.active = false; me.removeClsWithUI([me.activeCls, me.position + '-' + me.activeCls]); if (supressEvent !== true) { me.fireEvent('deactivate', me); } } }); /** * Represents a 2D point with x and y properties, useful for comparison and instantiation * from an event: * * var point = Ext.util.Point.fromEvent(e); * */ Ext.define('Ext.util.Point', { /* Begin Definitions */ extend: Ext.util.Region , statics: { /** * Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event * @static * @param {Ext.EventObject/Event} e The event * @return {Ext.util.Point} */ fromEvent: function(e) { e = e.browserEvent || e; e = (e.changedTouches && e.changedTouches.length > 0) ? e.changedTouches[0] : e; return new this(e.pageX, e.pageY); } }, /* End Definitions */ /** * Creates a point from two coordinates. * @param {Number} x X coordinate. * @param {Number} y Y coordinate. */ constructor: function(x, y) { this.callParent([y, x, y, x]); }, /** * Returns a human-eye-friendly string that represents this point, * useful for debugging * @return {String} */ toString: function() { return "Point[" + this.x + "," + this.y + "]"; }, /** * Compare this point and another point * @param {Ext.util.Point/Object} p The point to compare with, either an instance * of Ext.util.Point or an object with left and top properties * @return {Boolean} Returns whether they are equivalent */ equals: function(p) { return (this.x == p.x && this.y == p.y); }, /** * Whether the given point is not away from this point within the given threshold amount. * @param {Ext.util.Point/Object} p The point to check with, either an instance * of Ext.util.Point or an object with left and top properties * @param {Object/Number} threshold Can be either an object with x and y properties or a number * @return {Boolean} */ isWithin: function(p, threshold) { if (!Ext.isObject(threshold)) { threshold = { x: threshold, y: threshold }; } return (this.x <= p.x + threshold.x && this.x >= p.x - threshold.x && this.y <= p.y + threshold.y && this.y >= p.y - threshold.y); }, /** * Determins whether this Point contained by the passed Region, Component or element. * @param {Ext.util.Region/Ext.Component/Ext.dom.Element/HTMLElement} region * The rectangle to check that this Point is within. * @return {Boolean} */ isContainedBy: function(region) { if (!(region instanceof Ext.util.Region)) { region = Ext.get(region.el || region).getRegion(); } return region.contains(this); }, /** * Compare this point with another point when the x and y values of both points are rounded. E.g: * [100.3,199.8] will equals to [100, 200] * @param {Ext.util.Point/Object} p The point to compare with, either an instance * of Ext.util.Point or an object with x and y properties * @return {Boolean} */ roundedEquals: function(p) { return (Math.round(this.x) == Math.round(p.x) && Math.round(this.y) == Math.round(p.y)); } }, function() { /** * @method * Alias for {@link #translateBy} * @inheritdoc Ext.util.Region#translateBy */ this.prototype.translate = Ext.util.Region.prototype.translateBy; }); /** * @author Ed Spencer * TabBar is used internally by a {@link Ext.tab.Panel TabPanel} and typically should not need to be created manually. * The tab bar automatically removes the default title provided by {@link Ext.panel.Header} */ Ext.define('Ext.tab.Bar', { extend: Ext.panel.Header , alias: 'widget.tabbar', baseCls: Ext.baseCSSPrefix + 'tab-bar', /** * @property {Boolean} isTabBar * `true` in this class to identify an object as an instantiated Tab Bar, or subclass thereof. */ isTabBar: true, /** * @cfg {String} title @hide */ /** * @cfg {String} iconCls @hide */ // @private defaultType: 'tab', /** * @cfg {Boolean} plain * True to not show the full background on the tabbar */ plain: false, childEls: [ 'body', 'strip' ], // @private renderTpl: [ '
    {baseCls}-body-{ui} {parent.baseCls}-body-{parent.ui}-{.}" style="{bodyStyle}">', '{%this.renderContainer(out,values)%}', '
    ', '
    {baseCls}-strip-{ui}', ' {parent.baseCls}-strip-{parent.ui}-{.}', '">', '
    ' ], /** * @cfg {Number} minTabWidth * The minimum width for a tab in this tab Bar. Defaults to the tab Panel's {@link Ext.tab.Panel#minTabWidth minTabWidth} value. * @deprecated This config is deprecated. It is much easier to use the {@link Ext.tab.Panel#minTabWidth minTabWidth} config on the TabPanel. */ /** * @cfg {Number} maxTabWidth * The maximum width for a tab in this tab Bar. Defaults to the tab Panel's {@link Ext.tab.Panel#maxTabWidth maxTabWidth} value. * @deprecated This config is deprecated. It is much easier to use the {@link Ext.tab.Panel#maxTabWidth maxTabWidth} config on the TabPanel. */ _reverseDockNames: { left: 'right', right: 'left' }, // @private initComponent: function() { var me = this; if (me.plain) { me.addCls(me.baseCls + '-plain'); } me.addClsWithUI(me.orientation); me.addEvents( /** * @event change * Fired when the currently-active tab has changed * @param {Ext.tab.Bar} tabBar The TabBar * @param {Ext.tab.Tab} tab The new Tab * @param {Ext.Component} card The card that was just shown in the TabPanel */ 'change' ); // Element onClick listener added by Header base class me.callParent(arguments); Ext.merge(me.layout, me.initialConfig.layout); // TabBar must override the Header's align setting. me.layout.align = (me.orientation == 'vertical') ? 'left' : 'top'; me.layout.overflowHandler = new Ext.layout.container.boxOverflow.Scroller(me.layout); me.remove(me.titleCmp); delete me.titleCmp; Ext.apply(me.renderData, { bodyCls: me.bodyCls, dock: me.dock }); }, onRender: function() { var me = this; me.callParent(); if (me.orientation === 'vertical' && (Ext.isIE8 || Ext.isIE9) && Ext.isStrict) { me.el.on({ mousemove: me.onMouseMove, scope: me }); } }, afterRender: function() { var layout = this.layout; this.callParent(); if (Ext.isIE9 && Ext.isStrict && this.orientation === 'vertical') { // EXTJSIV-8765: focusing a vertically-oriented tab in IE9 strict can cause // the innerCt to scroll if the tabs have bordering. layout.innerCt.on('scroll', function() { layout.innerCt.dom.scrollLeft = 0; }); } }, afterLayout: function() { this.adjustTabPositions(); this.callParent(arguments); }, adjustTabPositions: function() { var items = this.items.items, i = items.length, tab; // When tabs are rotated vertically we don't have a reliable way to position // them using CSS in modern browsers. This is because of the way transform-orign // works - it requires the width to be known, and the width is not known in css. // Consequently we have to make an adjustment to the tab's position in these browsers. // This is similar to what we do in Ext.panel.Header#adjustTitlePosition if (!Ext.isIE9m) { if (this.dock === 'right') { // rotated 90 degrees around using the top left corner as the axis. // tabs need to be shifted to the right by their width while (i--) { tab = items[i]; if (tab.isVisible()) { tab.el.setStyle('left', tab.lastBox.width + 'px'); } } } else if (this.dock === 'left') { // rotated 270 degrees around using the top left corner as the axis. // tabs need to be shifted down by their height while (i--) { tab = items[i]; if (tab.isVisible()) { tab.el.setStyle('left', -tab.lastBox.height + 'px'); } } } } }, getLayout: function() { var me = this; me.layout.type = (me.orientation === 'horizontal') ? 'hbox' : 'vbox'; return me.callParent(arguments); }, // @private onAdd: function(tab) { tab.position = this.dock; this.callParent(arguments); }, onRemove: function(tab) { var me = this; if (tab === me.previousTab) { me.previousTab = null; } me.callParent(arguments); }, afterComponentLayout : function(width) { var me = this, needsScroll = me.needsScroll; me.callParent(arguments); if (needsScroll) { me.layout.overflowHandler.scrollToItem(me.activeTab); } delete me.needsScroll; }, // @private onClick: function(e, target) { var me = this, tabPanel = me.tabPanel, tabEl, tab, isCloseClick, tabInfo; if (e.getTarget('.' + Ext.baseCSSPrefix + 'box-scroller')) { return; } if (me.orientation === 'vertical' && (Ext.isIE8 || Ext.isIE9) && Ext.isStrict) { tabInfo = me.getTabInfoFromPoint(e.getXY()); tab = tabInfo.tab; isCloseClick = tabInfo.close; } else { // The target might not be a valid tab el. tabEl = e.getTarget('.' + Ext.tab.Tab.prototype.baseCls); tab = tabEl && Ext.getCmp(tabEl.id); isCloseClick = tab && tab.closeEl && (target === tab.closeEl.dom); } if (isCloseClick) { e.preventDefault(); } if (tab && tab.isDisabled && !tab.isDisabled()) { if (tab.closable && isCloseClick) { tab.onCloseClick(); } else { if (tabPanel) { // TabPanel will card setActiveTab of the TabBar tabPanel.setActiveTab(tab.card); } else { me.setActiveTab(tab); } tab.focus(); } } }, // private onMouseMove: function(e) { var me = this, overTab = me._overTab, tabInfo, tab; if (e.getTarget('.' + Ext.baseCSSPrefix + 'box-scroller')) { return; } tabInfo = me.getTabInfoFromPoint(e.getXY()); tab = tabInfo.tab; if (tab !== overTab) { if (overTab && overTab.rendered) { overTab.onMouseLeave(e); me._overTab = null; } if (tab) { tab.onMouseEnter(e); me._overTab = tab; if (!tab.disabled) { me.el.setStyle('cursor', 'pointer'); } } else { me.el.setStyle('cursor', 'default'); } } }, onMouseLeave: function(e) { var overTab = this._overTab; if (overTab && overTab.rendered) { overTab.onMouseLeave(e); } }, // @private // in IE8 and IE9 the clickable region of a rotated element is not its new rotated // position, but it's original unrotated position. The result is that rotated tabs do // not capture click and mousenter/mosueleave events correctly. This method accepts // an xy position and calculates if the coordinates are within a tab and if they // are within the tab's close icon (if any) getTabInfoFromPoint: function(xy) { var me = this, tabs = me.items.items, length = tabs.length, innerCt = me.layout.innerCt, innerCtXY = innerCt.getXY(), point = new Ext.util.Point(xy[0], xy[1]), i = 0, lastBox, tabRegion, closeEl, close, closeXY, closeX, closeY, closeWidth, closeHeight, tabX, tabY, tabWidth, tabHeight, closeRegion, isTabReversed, direction, tab; for (; i < length; i++) { lastBox = tabs[i].lastBox; tabX = innerCtXY[0] + lastBox.x; tabY = innerCtXY[1] - innerCt.dom.scrollTop + lastBox.y; tabWidth = lastBox.width; tabHeight = lastBox.height; tabRegion = new Ext.util.Region( tabY, tabX + tabWidth, tabY + tabHeight, tabX ); if (tabRegion.contains(point)) { tab = tabs[i]; closeEl = tab.closeEl; if (closeEl) { closeXY = closeEl.getXY(); closeWidth = closeEl.getWidth(); closeHeight = closeEl.getHeight(); // Read the dom to determine if the contents of the tab are reversed // (rotated 180 degrees). If so, we can cache the result becuase // it's safe to assume all tabs in the tabbar will be the same if (me._isTabReversed === undefined) { me._isTabReversed = isTabReversed = // use currentStyle because getComputedStyle won't get the // filter property in IE9 (tab.btnWrap.dom.currentStyle.filter.indexOf('rotation=2') !== -1); } direction = isTabReversed ? this._reverseDockNames[me.dock] : me.dock; if (direction === 'right') { closeX = tabX + tabWidth - ((closeXY[1] - tabY) + closeEl.getHeight()); closeY = tabY + (closeXY[0] - tabX); } else { closeX = tabX + (closeXY[1] - tabY); closeY = tabY + tabX + tabHeight - closeXY[0] - closeEl.getWidth(); } closeRegion = new Ext.util.Region( closeY, closeX + closeWidth, closeY + closeHeight, closeX ); close = closeRegion.contains(point); } break; } } return { tab: tab, close: close }; }, /** * @private * Closes the given tab by removing it from the TabBar and removing the corresponding card from the TabPanel * @param {Ext.tab.Tab} toClose The tab to close */ closeTab: function(toClose) { var me = this, card = toClose.card, tabPanel = me.tabPanel, toActivate; if (card && card.fireEvent('beforeclose', card) === false) { return false; } // If we are closing the active tab, revert to the previously active tab (or the previous or next enabled sibling if // there *is* no previously active tab, or the previously active tab is the one that's being closed or the previously // active tab has since been disabled) toActivate = me.findNextActivatable(toClose); // We are going to remove the associated card, and then, if that was sucessful, remove the Tab, // And then potentially activate another Tab. We should not layout for each of these operations. Ext.suspendLayouts(); if (tabPanel && card) { // Remove the ownerCt so the tab doesn't get destroyed if the remove is successful // We need this so we can have the tab fire it's own close event. delete toClose.ownerCt; // we must fire 'close' before removing the card from panel, otherwise // the event will no loger have any listener card.fireEvent('close', card); tabPanel.remove(card); // Remove succeeded if (!tabPanel.getComponent(card)) { /* * Force the close event to fire. By the time this function returns, * the tab is already destroyed and all listeners have been purged * so the tab can't fire itself. */ toClose.fireClose(); me.remove(toClose); } else { // Restore the ownerCt from above toClose.ownerCt = me; Ext.resumeLayouts(true); return false; } } // If we are closing the active tab, revert to the previously active tab (or the previous sibling or the nnext sibling) if (toActivate) { // Our owning TabPanel calls our setActiveTab method, so only call that if this Bar is being used // in some other context (unlikely) if (tabPanel) { tabPanel.setActiveTab(toActivate.card); } else { me.setActiveTab(toActivate); } toActivate.focus(); } Ext.resumeLayouts(true); }, // private - used by TabPanel too. // Works out the next tab to activate when one tab is closed. findNextActivatable: function(toClose) { var me = this; if (toClose.active && me.items.getCount() > 1) { return (me.previousTab && me.previousTab !== toClose && !me.previousTab.disabled) ? me.previousTab : (toClose.next('tab[disabled=false]') || toClose.prev('tab[disabled=false]')); } }, /** * @private * Marks the given tab as active * @param {Ext.tab.Tab} tab The tab to mark active * @param {Boolean} initial True if we're setting the tab during setup */ setActiveTab: function(tab, initial) { var me = this; if (!tab.disabled && tab !== me.activeTab) { if (me.activeTab) { if (me.activeTab.isDestroyed) { me.previousTab = null; } else { me.previousTab = me.activeTab; me.activeTab.deactivate(); } } tab.activate(); me.activeTab = tab; me.needsScroll = true; // We don't fire the change event when setting the first tab. // Also no need to run a layout if (!initial) { me.fireEvent('change', me, tab, tab.card); // Ensure that after the currently in progress layout, the active tab is scrolled into view me.updateLayout(); } } } }); /** * Provides indentation and folder structure markup for a Tree taking into account * depth and position within the tree hierarchy. * * @private */ Ext.define('Ext.tree.Column', { extend: Ext.grid.column.Column , alias: 'widget.treecolumn', tdCls: Ext.baseCSSPrefix + 'grid-cell-treecolumn', autoLock: true, lockable: false, draggable: false, hideable: false, iconCls: Ext.baseCSSPrefix + 'tree-icon', checkboxCls: Ext.baseCSSPrefix + 'tree-checkbox', elbowCls: Ext.baseCSSPrefix + 'tree-elbow', expanderCls: Ext.baseCSSPrefix + 'tree-expander', textCls: Ext.baseCSSPrefix + 'tree-node-text', innerCls: Ext.baseCSSPrefix + 'grid-cell-inner-treecolumn', isTreeColumn: true, cellTpl: [ '', 'lineempty"/>', '', '-end-plus {expanderCls}"/>', '', 'aria-checked="true" ', 'class="{childCls} {checkboxCls} {checkboxCls}-checked"/>', '', 'leafparent {iconCls}"', 'style="background-image:url({icon})"/>', '', '{value}', '', '{value}', '' ], initComponent: function() { var me = this; me.origRenderer = me.renderer; me.origScope = me.scope || window; me.renderer = me.treeRenderer; me.scope = me; me.callParent(); }, treeRenderer: function(value, metaData, record, rowIdx, colIdx, store, view){ var me = this, cls = record.get('cls'), renderer = me.origRenderer, data = record.data, parent = record.parentNode, rootVisible = view.rootVisible, lines = [], parentData; if (cls) { metaData.tdCls += ' ' + cls; } while (parent && (rootVisible || parent.data.depth > 0)) { parentData = parent.data; lines[rootVisible ? parentData.depth : parentData.depth - 1] = parentData.isLast ? 0 : 1; parent = parent.parentNode; } return me.getTpl('cellTpl').apply({ record: record, baseIconCls: me.iconCls, iconCls: data.iconCls, icon: data.icon, checkboxCls: me.checkboxCls, checked: data.checked, elbowCls: me.elbowCls, expanderCls: me.expanderCls, textCls: me.textCls, leaf: data.leaf, expandable: record.isExpandable(), isLast: data.isLast, blankUrl: Ext.BLANK_IMAGE_URL, href: data.href, hrefTarget: data.hrefTarget, lines: lines, metaData: metaData, // subclasses or overrides can implement a getChildCls() method, which can // return an extra class to add to all of the cell's child elements (icon, // expander, elbow, checkbox). This is used by the rtl override to add the // "x-rtl" class to these elements. childCls: me.getChildCls ? me.getChildCls() + ' ' : '', value: renderer ? renderer.apply(me.origScope, arguments) : value }); } }); /** * A selection model that renders a column of checkboxes that can be toggled to * select or deselect rows. The default mode for this selection model is MULTI. * * The selection model will inject a header for the checkboxes in the first view * and according to the {@link #injectCheckbox} configuration. */ Ext.define('Ext.selection.CheckboxModel', { alias: 'selection.checkboxmodel', extend: Ext.selection.RowModel , /** * @cfg {"SINGLE"/"SIMPLE"/"MULTI"} mode * Modes of selection. * Valid values are `"SINGLE"`, `"SIMPLE"`, and `"MULTI"`. */ mode: 'MULTI', /** * @cfg {Number/String} [injectCheckbox=0] * The index at which to insert the checkbox column. * Supported values are a numeric index, and the strings 'first' and 'last'. */ injectCheckbox: 0, /** * @cfg {Boolean} checkOnly * True if rows can only be selected by clicking on the checkbox column. */ checkOnly: false, /** * @cfg {Boolean} showHeaderCheckbox * Configure as `false` to not display the header checkbox at the top of the column. * When {@link Ext.data.Store#buffered} is set to `true`, this configuration will * not be available because the buffered data set does not always contain all data. */ showHeaderCheckbox: undefined, /** * @cfg {String} [checkSelector="x-grid-row-checker"] * The selector for determining whether the checkbox element is clicked. This may be changed to * allow for a wider area to be clicked, for example, the whole cell for the selector. */ checkSelector: '.' + Ext.baseCSSPrefix + 'grid-row-checker', headerWidth: 24, // private checkerOnCls: Ext.baseCSSPrefix + 'grid-hd-checker-on', constructor: function(){ var me = this; me.callParent(arguments); // If mode is single and showHeaderCheck isn't explicity set to // true, hide it. if (me.mode === 'SINGLE' && me.showHeaderCheckbox !== true) { me.showHeaderCheckbox = false; } }, beforeViewRender: function(view) { var me = this, owner; me.callParent(arguments); // if we have a locked header, only hook up to the first if (!me.hasLockedHeader() || view.headerCt.lockedCt) { if (me.showHeaderCheckbox !== false) { view.headerCt.on('headerclick', me.onHeaderClick, me); } me.addCheckbox(view, true); owner = view.ownerCt; // Listen to the outermost reconfigure event if (view.headerCt.lockedCt) { owner = owner.ownerCt; } me.mon(owner, 'reconfigure', me.onReconfigure, me); } }, bindComponent: function(view) { var me = this; me.sortable = false; me.callParent(arguments); }, hasLockedHeader: function(){ var views = this.views, vLen = views.length, v; for (v = 0; v < vLen; v++) { if (views[v].headerCt.lockedCt) { return true; } } return false; }, /** * Add the header checkbox to the header row * @private * @param {Boolean} initial True if we're binding for the first time. */ addCheckbox: function(view, initial){ var me = this, checkbox = me.injectCheckbox, headerCt = view.headerCt; // Preserve behaviour of false, but not clear why that would ever be done. if (checkbox !== false) { if (checkbox == 'first') { checkbox = 0; } else if (checkbox == 'last') { checkbox = headerCt.getColumnCount(); } Ext.suspendLayouts(); if (view.getStore().buffered) { me.showHeaderCheckbox = false; } headerCt.add(checkbox, me.getHeaderConfig()); Ext.resumeLayouts(); } if (initial !== true) { view.refresh(); } }, /** * Handles the grid's reconfigure event. Adds the checkbox header if the columns have been reconfigured. * @private * @param {Ext.panel.Table} grid * @param {Ext.data.Store} store * @param {Object[]} columns */ onReconfigure: function(grid, store, columns) { if(columns) { this.addCheckbox(this.views[0]); } }, /** * Toggle the ui header between checked and unchecked state. * @param {Boolean} isChecked * @private */ toggleUiHeader: function(isChecked) { var view = this.views[0], headerCt = view.headerCt, checkHd = headerCt.child('gridcolumn[isCheckerHd]'), cls = this.checkerOnCls; if (checkHd) { if (isChecked) { checkHd.addCls(cls); } else { checkHd.removeCls(cls); } } }, /** * Toggle between selecting all and deselecting all when clicking on * a checkbox header. */ onHeaderClick: function(headerCt, header, e) { if (header.isCheckerHd) { e.stopEvent(); var me = this, isChecked = header.el.hasCls(Ext.baseCSSPrefix + 'grid-hd-checker-on'); // Prevent focus changes on the view, since we're selecting/deselecting all records me.preventFocus = true; if (isChecked) { me.deselectAll(); } else { me.selectAll(); } delete me.preventFocus; } }, /** * Retrieve a configuration to be used in a HeaderContainer. * This should be used when injectCheckbox is set to false. */ getHeaderConfig: function() { var me = this, showCheck = me.showHeaderCheckbox !== false; return { isCheckerHd: showCheck, text : ' ', clickTargetName: 'el', width: me.headerWidth, sortable: false, draggable: false, resizable: false, hideable: false, menuDisabled: true, dataIndex: '', cls: showCheck ? Ext.baseCSSPrefix + 'column-header-checkbox ' : '', renderer: Ext.Function.bind(me.renderer, me), editRenderer: me.editRenderer || me.renderEmpty, locked: me.hasLockedHeader() }; }, renderEmpty: function() { return ' '; }, // After refresh, ensure that the header checkbox state matches refresh: function() { this.callParent(arguments); this.updateHeaderState(); }, /** * Generates the HTML to be rendered in the injected checkbox column for each row. * Creates the standard checkbox markup by default; can be overridden to provide custom rendering. * See {@link Ext.grid.column.Column#renderer} for description of allowed parameters. */ renderer: function(value, metaData, record, rowIndex, colIndex, store, view) { var baseCSSPrefix = Ext.baseCSSPrefix; metaData.tdCls = baseCSSPrefix + 'grid-cell-special ' + baseCSSPrefix + 'grid-cell-row-checker'; return '
     
    '; }, processSelection: function(view, record, item, index, e){ var me = this, checker = e.getTarget(me.checkSelector), mode; // checkOnly set, but we didn't click on a checker. if (me.checkOnly && !checker) { return; } if (checker) { mode = me.getSelectionMode(); // dont change the mode if its single otherwise // we would get multiple selection if (mode !== 'SINGLE') { me.setSelectionMode('SIMPLE'); } me.selectWithEvent(record, e); me.setSelectionMode(mode); } else { me.selectWithEvent(record, e); } }, /** * Synchronize header checker value as selection changes. * @private */ onSelectChange: function() { this.callParent(arguments); if (!this.suspendChange) { this.updateHeaderState(); } }, /** * @private */ onStoreLoad: function() { this.callParent(arguments); this.updateHeaderState(); }, onStoreAdd: function() { this.callParent(arguments); this.updateHeaderState(); }, onStoreRemove: function() { this.callParent(arguments); this.updateHeaderState(); }, onStoreRefresh: function(){ this.callParent(arguments); this.updateHeaderState(); }, maybeFireSelectionChange: function(fireEvent) { if (fireEvent && !this.suspendChange) { this.updateHeaderState(); } this.callParent(arguments); }, resumeChanges: function(){ this.callParent(); if (!this.suspendChange) { this.updateHeaderState(); } }, /** * @private */ updateHeaderState: function() { // check to see if all records are selected var me = this, store = me.store, storeCount = store.getCount(), views = me.views, hdSelectStatus = false, selectedCount = 0, selected, len, i; if (!store.buffered && storeCount > 0) { selected = me.selected; hdSelectStatus = true; for (i = 0, len = selected.getCount(); i < len; ++i) { if (!me.storeHasSelected(selected.getAt(i))) { break; } ++selectedCount; } hdSelectStatus = storeCount === selectedCount; } if (views && views.length) { me.toggleUiHeader(hdSelectStatus); } } }); /** * Slider which supports vertical or horizontal orientation, keyboard adjustments, configurable snapping, axis clicking * and animation. Can be added as an item to any container. * * @example * Ext.create('Ext.slider.Single', { * width: 200, * value: 50, * increment: 10, * minValue: 0, * maxValue: 100, * renderTo: Ext.getBody() * }); * * The class Ext.slider.Single is aliased to Ext.Slider for backwards compatibility. */ Ext.define('Ext.slider.Single', { extend: Ext.slider.Multi , alias: ['widget.slider', 'widget.sliderfield'], alternateClassName: ['Ext.Slider', 'Ext.form.SliderField', 'Ext.slider.SingleSlider', 'Ext.slider.Slider'], /** * Returns the current value of the slider * @return {Number} The current value of the slider */ getValue: function() { // just returns the value of the first thumb, which should be the only one in a single slider return this.callParent([0]); }, /** * Programmatically sets the value of the Slider. Ensures that the value is constrained within the minValue and * maxValue. * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue) * @param {Boolean} [animate] Turn on or off animation */ setValue: function(value, animate) { var args = arguments, len = args.length; // this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb // index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider // signature without the required index. The index will always be 0 for a single slider if (len == 1 || (len <= 3 && typeof args[1] != 'number')) { args = Ext.toArray(args); args.unshift(0); } return this.callParent(args); }, // private getNearest : function(){ // Since there's only 1 thumb, it's always the nearest return this.thumbs[0]; } }); /** * A Provider implementation which saves and retrieves state via cookies. The CookieProvider supports the usual cookie * options, such as: * * - {@link #path} * - {@link #expires} * - {@link #domain} * - {@link #secure} * * Example: * * var cp = Ext.create('Ext.state.CookieProvider', { * path: "/cgi-bin/", * expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days * domain: "sencha.com" * }); * * Ext.state.Manager.setProvider(cp); * */ Ext.define('Ext.state.CookieProvider', { extend: Ext.state.Provider , /** * @cfg {String} path * The path for which the cookie is active. Defaults to root '/' which makes it active for all pages in the site. */ /** * @cfg {Date} expires * The cookie expiration date. Defaults to 7 days from now. */ /** * @cfg {String} domain * The domain to save the cookie for. Note that you cannot specify a different domain than your page is on, but you can * specify a sub-domain, or simply the domain itself like 'sencha.com' to include all sub-domains if you need to access * cookies across different sub-domains. Defaults to null which uses the same domain the page is running on including * the 'www' like 'www.sencha.com'. */ /** * @cfg {Boolean} [secure=false] * True if the site is using SSL */ /** * Creates a new CookieProvider. * @param {Object} [config] Config object. */ constructor : function(config){ var me = this; me.path = "/"; me.expires = new Date(Ext.Date.now() + (1000*60*60*24*7)); //7 days me.domain = null; me.secure = false; me.callParent(arguments); me.state = me.readCookies(); }, // private set : function(name, value){ var me = this; if(typeof value == "undefined" || value === null){ me.clear(name); return; } me.setCookie(name, value); me.callParent(arguments); }, // private clear : function(name){ this.clearCookie(name); this.callParent(arguments); }, // private readCookies : function(){ var cookies = {}, c = document.cookie + ";", re = /\s?(.*?)=(.*?);/g, prefix = this.prefix, len = prefix.length, matches, name, value; while((matches = re.exec(c)) != null){ name = matches[1]; value = matches[2]; if (name && name.substring(0, len) == prefix){ cookies[name.substr(len)] = this.decodeValue(value); } } return cookies; }, // private setCookie : function(name, value){ var me = this; document.cookie = me.prefix + name + "=" + me.encodeValue(value) + ((me.expires == null) ? "" : ("; expires=" + me.expires.toGMTString())) + ((me.path == null) ? "" : ("; path=" + me.path)) + ((me.domain == null) ? "" : ("; domain=" + me.domain)) + ((me.secure == true) ? "; secure" : ""); }, // private clearCookie : function(name){ var me = this; document.cookie = me.prefix + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" + ((me.path == null) ? "" : ("; path=" + me.path)) + ((me.domain == null) ? "" : ("; domain=" + me.domain)) + ((me.secure == true) ? "; secure" : ""); } }); /** * @class Ext.state.LocalStorageProvider * A Provider implementation which saves and retrieves state via the HTML5 localStorage object. * If the browser does not support local storage, there will be no attempt to read the state. * Before creating this class, a check should be made to {@link Ext.supports#LocalStorage}. */ Ext.define('Ext.state.LocalStorageProvider', { /* Begin Definitions */ extend: Ext.state.Provider , alias: 'state.localstorage', /* End Definitions */ constructor: function(){ var me = this; me.callParent(arguments); me.store = me.getStorageObject(); if (me.store) { me.state = me.readLocalStorage(); } else { me.state = {}; } }, readLocalStorage: function(){ var store = this.store, i = 0, len = store.length, prefix = this.prefix, prefixLen = prefix.length, data = {}, key; for (; i < len; ++i) { key = store.key(i); if (key.substring(0, prefixLen) == prefix) { data[key.substr(prefixLen)] = this.decodeValue(store.getItem(key)); } } return data; }, set : function(name, value){ var me = this; me.clear(name); if (typeof value == "undefined" || value === null) { return; } me.store.setItem(me.prefix + name, me.encodeValue(value)); me.callParent(arguments); }, // private clear : function(name){ this.store.removeItem(this.prefix + name); this.callParent(arguments); }, getStorageObject: function(){ if (Ext.supports.LocalStorage) { return window.localStorage; } Ext.Error.raise('LocalStorage is not supported by the current browser'); return false; } }); /** * @author Ed Spencer, Tommy Maintz, Brian Moeskau * * A basic tab container. TabPanels can be used exactly like a standard {@link Ext.panel.Panel} for * layout purposes, but also have special support for containing child Components * (`{@link Ext.container.Container#cfg-items items}`) that are managed using a * {@link Ext.layout.container.Card CardLayout layout manager}, and displayed as separate tabs. * * **Note:** By default, a tab's close tool _destroys_ the child tab Component and all its descendants. * This makes the child tab Component, and all its descendants **unusable**. To enable re-use of a tab, * configure the TabPanel with `{@link #autoDestroy autoDestroy: false}`. * * ## TabPanel's layout * * TabPanels use a Dock layout to position the {@link Ext.tab.Bar TabBar} at the top of the widget. * Panels added to the TabPanel will have their header hidden by default because the Tab will * automatically take the Panel's configured title and icon. * * TabPanels use their {@link Ext.panel.Header header} or {@link Ext.panel.Panel#fbar footer} * element (depending on the {@link #tabPosition} configuration) to accommodate the tab selector buttons. * This means that a TabPanel will not display any configured title, and will not display any configured * header {@link Ext.panel.Panel#tools tools}. * * To display a header, embed the TabPanel in a {@link Ext.panel.Panel Panel} which uses * `{@link Ext.container.Container#layout layout: 'fit'}`. * * ## Controlling tabs * * Configuration options for the {@link Ext.tab.Tab} that represents the component can be passed in * by specifying the tabConfig option: * * @example * Ext.create('Ext.tab.Panel', { * width: 400, * height: 400, * renderTo: document.body, * items: [{ * title: 'Foo' * }, { * title: 'Bar', * tabConfig: { * title: 'Custom Title', * tooltip: 'A button tooltip' * } * }] * }); * * ## Vetoing Changes * * User interaction when changing the tabs can be vetoed by listening to the {@link #beforetabchange} event. * By returning `false`, the tab change will not occur. * * @example * Ext.create('Ext.tab.Panel', { * renderTo: Ext.getBody(), * width: 200, * height: 200, * listeners: { * beforetabchange: function(tabs, newTab, oldTab) { * return newTab.title != 'P2'; * } * }, * items: [{ * title: 'P1' * }, { * title: 'P2' * }, { * title: 'P3' * }] * }); * * # Examples * * Here is a basic TabPanel rendered to the body. This also shows the useful configuration {@link #activeTab}, * which allows you to set the active tab on render. If you do not set an {@link #activeTab}, no tabs will be * active by default. * * @example * Ext.create('Ext.tab.Panel', { * width: 300, * height: 200, * activeTab: 0, * items: [ * { * title: 'Tab 1', * bodyPadding: 10, * html : 'A simple tab' * }, * { * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * It is easy to control the visibility of items in the tab bar. Specify hidden: true to have the * tab button hidden initially. Items can be subsequently hidden and show by accessing the * tab property on the child item. * * @example * var tabs = Ext.create('Ext.tab.Panel', { * width: 400, * height: 400, * renderTo: document.body, * items: [{ * title: 'Home', * html: 'Home', * itemId: 'home' * }, { * title: 'Users', * html: 'Users', * itemId: 'users', * hidden: true * }, { * title: 'Tickets', * html: 'Tickets', * itemId: 'tickets' * }] * }); * * setTimeout(function(){ * tabs.child('#home').tab.hide(); * var users = tabs.child('#users'); * users.tab.show(); * tabs.setActiveTab(users); * }, 1000); * * You can remove the background of the TabBar by setting the {@link #plain} property to `true`. * * @example * Ext.create('Ext.tab.Panel', { * width: 300, * height: 200, * activeTab: 0, * plain: true, * items: [ * { * title: 'Tab 1', * bodyPadding: 10, * html : 'A simple tab' * }, * { * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * Another useful configuration of TabPanel is {@link #tabPosition}. This allows you to change the * position where the tabs are displayed. The available options for this are `'top'` (default) and * `'bottom'`. * * @example * Ext.create('Ext.tab.Panel', { * width: 300, * height: 200, * activeTab: 0, * bodyPadding: 10, * tabPosition: 'bottom', * items: [ * { * title: 'Tab 1', * html : 'A simple tab' * }, * { * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * The {@link #setActiveTab} is a very useful method in TabPanel which will allow you to change the * current active tab. You can either give it an index or an instance of a tab. For example: * * @example * var tabs = Ext.create('Ext.tab.Panel', { * items: [ * { * id : 'my-tab', * title: 'Tab 1', * html : 'A simple tab' * }, * { * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * var tab = Ext.getCmp('my-tab'); * * Ext.create('Ext.button.Button', { * renderTo: Ext.getBody(), * text : 'Select the first tab', * scope : this, * handler : function() { * tabs.setActiveTab(tab); * } * }); * * Ext.create('Ext.button.Button', { * text : 'Select the second tab', * scope : this, * handler : function() { * tabs.setActiveTab(1); * }, * renderTo : Ext.getBody() * }); * * The {@link #getActiveTab} is a another useful method in TabPanel which will return the current active tab. * * @example * var tabs = Ext.create('Ext.tab.Panel', { * items: [ * { * title: 'Tab 1', * html : 'A simple tab' * }, * { * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * Ext.create('Ext.button.Button', { * text : 'Get active tab', * scope : this, * handler : function() { * var tab = tabs.getActiveTab(); * alert('Current tab: ' + tab.title); * }, * renderTo : Ext.getBody() * }); * * Adding a new tab is very simple with a TabPanel. You simple call the {@link #method-add} method with an config * object for a panel. * * @example * var tabs = Ext.create('Ext.tab.Panel', { * items: [ * { * title: 'Tab 1', * html : 'A simple tab' * }, * { * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * Ext.create('Ext.button.Button', { * text : 'New tab', * scope : this, * handler : function() { * var tab = tabs.add({ * // we use the tabs.items property to get the length of current items/tabs * title: 'Tab ' + (tabs.items.length + 1), * html : 'Another one' * }); * * tabs.setActiveTab(tab); * }, * renderTo : Ext.getBody() * }); * * Additionally, removing a tab is very also simple with a TabPanel. You simple call the {@link #method-remove} method * with an config object for a panel. * * @example * var tabs = Ext.create('Ext.tab.Panel', { * items: [ * { * title: 'Tab 1', * html : 'A simple tab' * }, * { * id : 'remove-this-tab', * title: 'Tab 2', * html : 'Another one' * } * ], * renderTo : Ext.getBody() * }); * * Ext.create('Ext.button.Button', { * text : 'Remove tab', * scope : this, * handler : function() { * var tab = Ext.getCmp('remove-this-tab'); * tabs.remove(tab); * }, * renderTo : Ext.getBody() * }); */ Ext.define('Ext.tab.Panel', { extend: Ext.panel.Panel , alias: 'widget.tabpanel', alternateClassName: ['Ext.TabPanel'], /** * @cfg {"top"/"bottom"/"left"/"right"} tabPosition * The position where the tab strip should be rendered. Can be `top`, `bottom`, * `left` or `right` */ tabPosition : 'top', /** * @cfg {String/Number} activeItem * Doesn't apply for {@link Ext.tab.Panel TabPanel}, use {@link #activeTab} instead. */ /** * @cfg {String/Number/Ext.Component} activeTab * The tab to activate initially. Either an ID, index or the tab component itself. */ /** * @cfg {Object} tabBar * Optional configuration object for the internal {@link Ext.tab.Bar}. * If present, this is passed straight through to the TabBar's constructor */ /** * @cfg {Ext.enums.Layout/Object} layout * Optional configuration object for the internal {@link Ext.layout.container.Card card layout}. * If present, this is passed straight through to the layout's constructor */ /** * @cfg {Boolean} removePanelHeader * True to instruct each Panel added to the TabContainer to not render its header element. * This is to ensure that the title of the panel does not appear twice. */ removePanelHeader: true, /** * @cfg {Boolean} plain * True to not show the full background on the TabBar. */ plain: false, /** * @cfg {String} [itemCls='x-tabpanel-child'] * The class added to each child item of this TabPanel. */ itemCls: Ext.baseCSSPrefix + 'tabpanel-child', /** * @cfg {Number} minTabWidth * The minimum width for a tab in the {@link #cfg-tabBar}. */ minTabWidth: undefined, /** * @cfg {Number} maxTabWidth The maximum width for each tab. */ maxTabWidth: undefined, /** * @cfg {Boolean} deferredRender * * True by default to defer the rendering of child {@link Ext.container.Container#cfg-items items} to the browsers DOM * until a tab is activated. False will render all contained {@link Ext.container.Container#cfg-items items} as soon as * the {@link Ext.layout.container.Card layout} is rendered. If there is a significant amount of content or a lot of * heavy controls being rendered into panels that are not displayed by default, setting this to true might improve * performance. * * The deferredRender property is internally passed to the layout manager for TabPanels ({@link * Ext.layout.container.Card}) as its {@link Ext.layout.container.Card#deferredRender} configuration value. * * **Note**: leaving deferredRender as true means that the content within an unactivated tab will not be available */ deferredRender : true, //inherit docs initComponent: function() { var me = this, dockedItems = [].concat(me.dockedItems || []), activeTab = me.activeTab || (me.activeTab = 0), tabPosition = me.tabPosition; // Configure the layout with our deferredRender, and with our activeTeb me.layout = new Ext.layout.container.Card(Ext.apply({ owner: me, deferredRender: me.deferredRender, itemCls: me.itemCls, activeItem: activeTab }, me.layout)); /** * @property {Ext.tab.Bar} tabBar Internal reference to the docked TabBar */ me.tabBar = new Ext.tab.Bar(Ext.apply({ ui: me.ui, dock: me.tabPosition, orientation: (tabPosition == 'top' || tabPosition == 'bottom') ? 'horizontal' : 'vertical', plain: me.plain, cardLayout: me.layout, tabPanel: me }, me.tabBar)); dockedItems.push(me.tabBar); me.dockedItems = dockedItems; me.addEvents( /** * @event * Fires before a tab change (activated by {@link #setActiveTab}). Return false in any listener to cancel * the tabchange * @param {Ext.tab.Panel} tabPanel The TabPanel * @param {Ext.Component} newCard The card that is about to be activated * @param {Ext.Component} oldCard The card that is currently active */ 'beforetabchange', /** * @event * Fires when a new tab has been activated (activated by {@link #setActiveTab}). * @param {Ext.tab.Panel} tabPanel The TabPanel * @param {Ext.Component} newCard The newly activated item * @param {Ext.Component} oldCard The previously active item */ 'tabchange' ); me.callParent(arguments); // We have to convert the numeric index/string ID config into its component reference activeTab = me.activeTab = me.getComponent(activeTab); // Ensure that the active child's tab is rendered in the active UI state if (activeTab) { me.tabBar.setActiveTab(activeTab.tab, true); } }, /** * Makes the given card active. Makes it the visible card in the TabPanel's CardLayout and highlights the Tab. * @param {String/Number/Ext.Component} card The card to make active. Either an ID, index or the component itself. * @return {Ext.Component} The resulting active child Component. The call may have been vetoed, or otherwise * modified by an event listener. */ setActiveTab: function(card) { var me = this, previous; card = me.getComponent(card); if (card) { previous = me.getActiveTab(); if (previous !== card && me.fireEvent('beforetabchange', me, card, previous) === false) { return false; } // We may be passed a config object, so add it. // Without doing a layout! if (!card.isComponent) { Ext.suspendLayouts(); card = me.add(card); Ext.resumeLayouts(); } // MUST set the activeTab first so that the machinery which listens for show doesn't // think that the show is "driving" the activation and attempt to recurse into here. me.activeTab = card; // Attempt to switch to the requested card. Suspend layouts because if that was successful // we have to also update the active tab in the tab bar which is another layout operation // and we must coalesce them. Ext.suspendLayouts(); me.layout.setActiveItem(card); // Read the result of the card layout. Events dear boy, events! card = me.activeTab = me.layout.getActiveItem(); // Card switch was not vetoed by an event listener if (card && card !== previous) { // Update the active tab in the tab bar and resume layouts. me.tabBar.setActiveTab(card.tab); Ext.resumeLayouts(true); // previous will be undefined or this.activeTab at instantiation if (previous !== card) { me.fireEvent('tabchange', me, card, previous); } } // Card switch was vetoed by an event listener. Resume layouts (Nothing should have changed on a veto). else { Ext.resumeLayouts(true); } return card; } }, /** * Returns the item that is currently active inside this TabPanel. * @return {Ext.Component} The currently active item. */ getActiveTab: function() { var me = this, // Ensure the calculated result references a Component result = me.getComponent(me.activeTab); // Sanitize the result in case the active tab is no longer there. if (result && me.items.indexOf(result) != -1) { me.activeTab = result; } else { me.activeTab = null; } return me.activeTab; }, /** * Returns the {@link Ext.tab.Bar} currently used in this TabPanel * @return {Ext.tab.Bar} The TabBar */ getTabBar: function() { return this.tabBar; }, /** * @protected * Makes sure we have a Tab for each item added to the TabPanel */ onAdd: function(item, index) { var me = this, cfg = item.tabConfig || {}, defaultConfig = { xtype: 'tab', ui: me.tabBar.ui, card: item, disabled: item.disabled, closable: item.closable, hidden: item.hidden && !item.hiddenByLayout, // only hide if it wasn't hidden by the layout itself tooltip: item.tooltip, tabBar: me.tabBar, position: me.tabPosition, closeText: item.closeText }; cfg = Ext.applyIf(cfg, defaultConfig); // Create the correspondiong tab in the tab bar item.tab = me.tabBar.insert(index, cfg); item.on({ scope : me, enable: me.onItemEnable, disable: me.onItemDisable, beforeshow: me.onItemBeforeShow, iconchange: me.onItemIconChange, iconclschange: me.onItemIconClsChange, titlechange: me.onItemTitleChange }); if (item.isPanel) { if (me.removePanelHeader) { if (item.rendered) { if (item.header) { item.header.hide(); } } else { item.header = false; } } if (item.isPanel && me.border) { item.setBorder(false); } } }, /** * @private * Enable corresponding tab when item is enabled. */ onItemEnable: function(item){ item.tab.enable(); }, /** * @private * Disable corresponding tab when item is enabled. */ onItemDisable: function(item){ item.tab.disable(); }, /** * @private * Sets activeTab before item is shown. */ onItemBeforeShow: function(item) { if (item !== this.activeTab) { this.setActiveTab(item); return false; } }, /** * @private * Update the tab icon when panel icon has been set or changed. */ onItemIconChange: function(item, newIcon) { item.tab.setIcon(newIcon); }, /** * @private * Update the tab iconCls when panel iconCls has been set or changed. */ onItemIconClsChange: function(item, newIconCls) { item.tab.setIconCls(newIconCls); }, /** * @private * Update the tab title when panel title has been set or changed. */ onItemTitleChange: function(item, newTitle) { item.tab.setText(newTitle); }, /** * @private * Unlink the removed child item from its (@link Ext.tab.Tab Tab}. * * If we're removing the currently active tab, activate the nearest one. The item is removed when we call super, * so we can do preprocessing before then to find the card's index */ doRemove: function(item, autoDestroy) { var me = this, toActivate; // Destroying, or removing the last item, nothing to activate if (me.destroying || me.items.getCount() == 1) { me.activeTab = null; } // Ask the TabBar which tab to activate next. // Set the active child panel using the index of that tab else if ((toActivate = me.tabBar.items.indexOf(me.tabBar.findNextActivatable(item.tab))) !== -1) { me.setActiveTab(toActivate); } this.callParent(arguments); // Remove the two references delete item.tab.card; delete item.tab; }, /** * @private * Makes sure we remove the corresponding Tab when an item is removed */ onRemove: function(item, destroying) { var me = this; item.un({ scope : me, enable: me.onItemEnable, disable: me.onItemDisable, beforeshow: me.onItemBeforeShow }); if (!me.destroying && item.tab.ownerCt === me.tabBar) { me.tabBar.remove(item.tab); } } }); /** * A simple element that adds extra horizontal space between items in a toolbar. * By default a 2px wide space is added via CSS specification: * * .x-toolbar .x-toolbar-spacer { * width: 2px; * } * * Example: * * @example * Ext.create('Ext.panel.Panel', { * title: 'Toolbar Spacer Example', * width: 300, * height: 200, * tbar : [ * 'Item 1', * { xtype: 'tbspacer' }, // or ' ' * 'Item 2', * // space width is also configurable via javascript * { xtype: 'tbspacer', width: 50 }, // add a 50px space * 'Item 3' * ], * renderTo: Ext.getBody() * }); */ Ext.define('Ext.toolbar.Spacer', { extend: Ext.Component , alias: 'widget.tbspacer', alternateClassName: 'Ext.Toolbar.Spacer', baseCls: Ext.baseCSSPrefix + 'toolbar-spacer', focusable: false }); /** * The TreePanel provides tree-structured UI representation of tree-structured data. * A TreePanel must be bound to a {@link Ext.data.TreeStore}. TreePanel's support * multiple columns through the {@link #columns} configuration. * * Simple TreePanel using inline data: * * @example * var store = Ext.create('Ext.data.TreeStore', { * root: { * expanded: true, * children: [ * { text: "detention", leaf: true }, * { text: "homework", expanded: true, children: [ * { text: "book report", leaf: true }, * { text: "algebra", leaf: true} * ] }, * { text: "buy lottery tickets", leaf: true } * ] * } * }); * * Ext.create('Ext.tree.Panel', { * title: 'Simple Tree', * width: 200, * height: 150, * store: store, * rootVisible: false, * renderTo: Ext.getBody() * }); * * For the tree node config options (like `text`, `leaf`, `expanded`), see the documentation of * {@link Ext.data.NodeInterface NodeInterface} config options. */ Ext.define('Ext.tree.Panel', { extend: Ext.panel.Table , alias: 'widget.treepanel', alternateClassName: ['Ext.tree.TreePanel', 'Ext.TreePanel'], viewType: 'treeview', selType: 'treemodel', treeCls: Ext.baseCSSPrefix + 'tree-panel', deferRowRender: false, /** * @cfg {Boolean} rowLines * False so that rows are not separated by lines. */ rowLines: false, /** * @cfg {Boolean} lines * False to disable tree lines. */ lines: true, /** * @cfg {Boolean} useArrows * True to use Vista-style arrows in the tree. */ useArrows: false, /** * @cfg {Boolean} singleExpand * True if only 1 node per branch may be expanded. */ singleExpand: false, ddConfig: { enableDrag: true, enableDrop: true }, /** * @cfg {Boolean} animate * True to enable animated expand/collapse. Defaults to the value of {@link Ext#enableFx}. */ /** * @cfg {Boolean} rootVisible * False to hide the root node. */ rootVisible: true, /** * @cfg {String} displayField * The field inside the model that will be used as the node's text. */ displayField: 'text', /** * @cfg {Ext.data.Model/Ext.data.NodeInterface/Object} root * Allows you to not specify a store on this TreePanel. This is useful for creating a simple tree with preloaded * data without having to specify a TreeStore and Model. A store and model will be created and root will be passed * to that store. For example: * * Ext.create('Ext.tree.Panel', { * title: 'Simple Tree', * root: { * text: "Root node", * expanded: true, * children: [ * { text: "Child 1", leaf: true }, * { text: "Child 2", leaf: true } * ] * }, * renderTo: Ext.getBody() * }); */ root: null, // Required for the Lockable Mixin. These are the configurations which will be copied to the // normal and locked sub tablepanels normalCfgCopy: ['displayField', 'root', 'singleExpand', 'useArrows', 'lines', 'rootVisible', 'scroll'], lockedCfgCopy: ['displayField', 'root', 'singleExpand', 'useArrows', 'lines', 'rootVisible'], isTree: true, /** * @cfg {Boolean} hideHeaders * True to hide the headers. */ /** * @cfg {Boolean} folderSort * True to automatically prepend a leaf sorter to the store. */ /** * @cfg {Ext.data.TreeStore} store (required) * The {@link Ext.data.TreeStore Store} the tree should use as its data source. */ arrowCls: Ext.baseCSSPrefix + 'tree-arrows', linesCls: Ext.baseCSSPrefix + 'tree-lines', noLinesCls: Ext.baseCSSPrefix + 'tree-no-lines', autoWidthCls: Ext.baseCSSPrefix + 'autowidth-table', constructor: function(config) { config = config || {}; if (config.animate === undefined) { config.animate = Ext.isBoolean(this.animate) ? this.animate : Ext.enableFx; } this.enableAnimations = config.animate; delete config.animate; this.callParent([config]); }, initComponent: function() { var me = this, cls = [me.treeCls], store = me.store, view; if (me.useArrows) { cls.push(me.arrowCls); me.lines = false; } if (me.lines) { cls.push(me.linesCls); } else if (!me.useArrows) { cls.push(me.noLinesCls); } if (Ext.isString(store)) { store = me.store = Ext.StoreMgr.lookup(store); } else if (!store || Ext.isObject(store) && !store.isStore) { store = me.store = new Ext.data.TreeStore(Ext.apply({ root: me.root, fields: me.fields, model: me.model, folderSort: me.folderSort }, store)); } else if (me.root) { store = me.store = Ext.data.StoreManager.lookup(store); store.setRootNode(me.root); if (me.folderSort !== undefined) { store.folderSort = me.folderSort; store.sort(); } } // I'm not sure if we want to this. It might be confusing // if (me.initialConfig.rootVisible === undefined && !me.getRootNode()) { // me.rootVisible = false; // } me.viewConfig = Ext.apply({ rootVisible: me.rootVisible, animate: me.enableAnimations, singleExpand: me.singleExpand, node: store.getRootNode(), hideHeaders: me.hideHeaders }, me.viewConfig); // If the user specifies the headers collection manually then dont inject our own if (!me.columns) { if (me.initialConfig.hideHeaders === undefined) { me.hideHeaders = true; } me.addCls(me.autoWidthCls); me.columns = [{ xtype : 'treecolumn', text : 'Name', width : Ext.isIE6 ? '100%' : 10000, // IE6 needs width:100% dataIndex: me.displayField }]; } if (me.cls) { cls.push(me.cls); } me.cls = cls.join(' '); me.callParent(); // TreeModel has to know about the TreeStore so that pruneRemoved can work properly upon removal // of nodes. me.selModel.treeStore = me.store; view = me.getView(); // Relay events from the TreeView. // An injected LockingView relays events from its locked side's View me.relayEvents(view, [ /** * @event checkchange * Fires when a node with a checkbox's checked property changes * @param {Ext.data.NodeInterface} node The node who's checked property was changed * @param {Boolean} checked The node's new checked state */ 'checkchange', /** * @event afteritemexpand * @inheritdoc Ext.tree.View#afteritemexpand */ 'afteritemexpand', /** * @event afteritemcollapse * @inheritdoc Ext.tree.View#afteritemcollapse */ 'afteritemcollapse' ]); // If there has been a LockingView injected, this processing will be performed by the locked TreePanel if (!view.isLockingView) { // If the root is not visible and there is no rootnode defined, then just lets load the store if (!view.rootVisible && !me.getRootNode()) { me.setRootNode({ expanded: true }); } } }, // @private // Hook into the TreeStore. // Do not callParent in TreePanel's bindStore // The TreeStore is only relevant to the tree - the View has its own NodeStore bindStore: function(store, initial) { var me = this; me.store = store; // Connect to store. Return a Destroyable object me.storeListeners = me.mon(store, { destroyable: true, load: me.onStoreLoad, rootchange: me.onRootChange, clear: me.onClear, scope: me }); // Relay store events. relayEvents always returns a Destroyable object. me.storeRelayers = me.relayEvents(store, [ /** * @event beforeload * @inheritdoc Ext.data.TreeStore#beforeload */ 'beforeload', /** * @event load * @inheritdoc Ext.data.TreeStore#load */ 'load' ]); // Relay store events with prefix. Return a Destroyable object me.storeRelayers1 = me.mon(store, { destroyable: true, /** * @event itemappend * @inheritdoc Ext.data.TreeStore#append */ append: me.createRelayer('itemappend'), /** * @event itemremove * @inheritdoc Ext.data.TreeStore#remove */ remove: me.createRelayer('itemremove'), /** * @event itemmove * @inheritdoc Ext.data.TreeStore#move */ move: me.createRelayer('itemmove', [0, 4]), /** * @event iteminsert * @inheritdoc Ext.data.TreeStore#insert */ insert: me.createRelayer('iteminsert'), /** * @event beforeitemappend * @inheritdoc Ext.data.TreeStore#beforeappend */ beforeappend: me.createRelayer('beforeitemappend'), /** * @event beforeitemremove * @inheritdoc Ext.data.TreeStore#beforeremove */ beforeremove: me.createRelayer('beforeitemremove'), /** * @event beforeitemmove * @inheritdoc Ext.data.TreeStore#beforemove */ beforemove: me.createRelayer('beforeitemmove'), /** * @event beforeiteminsert * @inheritdoc Ext.data.TreeStore#beforeinsert */ beforeinsert: me.createRelayer('beforeiteminsert'), /** * @event itemexpand * @inheritdoc Ext.data.TreeStore#expand */ expand: me.createRelayer('itemexpand', [0, 1]), /** * @event itemcollapse * @inheritdoc Ext.data.TreeStore#collapse */ collapse: me.createRelayer('itemcollapse', [0, 1]), /** * @event beforeitemexpand * @inheritdoc Ext.data.TreeStore#beforeexpand */ beforeexpand: me.createRelayer('beforeitemexpand', [0, 1]), /** * @event beforeitemcollapse * @inheritdoc Ext.data.TreeStore#beforecollapse */ beforecollapse: me.createRelayer('beforeitemcollapse', [0, 1]) }); // TreeStore must have an upward link to the TreePanel so that nodes can find their owning tree in NodeInterface.getOwnerTree store.ownerTree = me; if (!initial) { me.view.setRootNode(me.getRootNode()); } }, // @private // TODO: Decide whether it is possible to reconfigure a TreePanel. unbindStore: function() { var me = this, store = me.store; if (store) { Ext.destroy(me.storeListeners, me.storeRelayers, me.storeRelayers1); delete store.ownerTree; } }, onClear: function(){ this.view.onClear(); }, /** * Sets root node of this tree. * @param {Ext.data.Model/Ext.data.NodeInterface/Object} root * @return {Ext.data.NodeInterface} The new root */ setRootNode: function() { return this.store.setRootNode.apply(this.store, arguments); }, /** * Returns the root node for this tree. * @return {Ext.data.NodeInterface} */ getRootNode: function() { return this.store.getRootNode(); }, onRootChange: function(root) { this.view.setRootNode(root); }, /** * Retrieve an array of checked records. * @return {Ext.data.NodeInterface[]} An array containing the checked records */ getChecked: function() { return this.getView().getChecked(); }, isItemChecked: function(rec) { return rec.get('checked'); }, /** * Expands a record that is loaded in the tree. * @param {Ext.data.Model} record The record to expand * @param {Boolean} [deep] True to expand nodes all the way down the tree hierarchy. * @param {Function} [callback] The function to run after the expand is completed * @param {Object} [scope] The scope of the callback function. */ expandNode: function(record, deep, callback, scope) { return this.getView().expand(record, deep, callback, scope || this); }, /** * Collapses a record that is loaded in the tree. * @param {Ext.data.Model} record The record to collapse * @param {Boolean} [deep] True to collapse nodes all the way up the tree hierarchy. * @param {Function} [callback] The function to run after the collapse is completed * @param {Object} [scope] The scope of the callback function. */ collapseNode: function(record, deep, callback, scope) { return this.getView().collapse(record, deep, callback, scope || this); }, /** * Expand all nodes * @param {Function} [callback] A function to execute when the expand finishes. * @param {Object} [scope] The scope of the callback function */ expandAll : function(callback, scope) { var me = this, root = me.getRootNode(), animate = me.enableAnimations; if (root) { if (!animate) { Ext.suspendLayouts(); } root.expand(true, callback, scope || me); if (!animate) { Ext.resumeLayouts(true); } } }, /** * Collapse all nodes * @param {Function} [callback] A function to execute when the collapse finishes. * @param {Object} [scope] The scope of the callback function */ collapseAll : function(callback, scope) { var me = this, root = me.getRootNode(), animate = me.enableAnimations, view = me.getView(); if (root) { if (!animate) { Ext.suspendLayouts(); } scope = scope || me; if (view.rootVisible) { root.collapse(true, callback, scope); } else { root.collapseChildren(true, callback, scope); } if (!animate) { Ext.resumeLayouts(true); } } }, /** * Expand the tree to the path of a particular node. * @param {String} path The path to expand. The path should include a leading separator. * @param {String} [field] The field to get the data from. Defaults to the model idProperty. * @param {String} [separator='/'] A separator to use. * @param {Function} [callback] A function to execute when the expand finishes. The callback will be called with * (success, lastNode) where success is if the expand was successful and lastNode is the last node that was expanded. * @param {Object} [scope] The scope of the callback function */ expandPath: function(path, field, separator, callback, scope) { var me = this, current = me.getRootNode(), index = 1, view = me.getView(), keys, expander; field = field || me.getRootNode().idProperty; separator = separator || '/'; if (Ext.isEmpty(path)) { Ext.callback(callback, scope || me, [false, null]); return; } keys = path.split(separator); if (current.get(field) != keys[1]) { // invalid root Ext.callback(callback, scope || me, [false, current]); return; } expander = function(){ if (++index === keys.length) { Ext.callback(callback, scope || me, [true, current]); return; } var node = current.findChild(field, keys[index]); if (!node) { Ext.callback(callback, scope || me, [false, current]); return; } current = node; current.expand(false, expander); }; current.expand(false, expander); }, /** * Expand the tree to the path of a particular node, then select it. * @param {String} path The path to select. The path should include a leading separator. * @param {String} [field] The field to get the data from. Defaults to the model idProperty. * @param {String} [separator='/'] A separator to use. * @param {Function} [callback] A function to execute when the select finishes. The callback will be called with * (bSuccess, oLastNode) where bSuccess is if the select was successful and oLastNode is the last node that was expanded. * @param {Object} [scope] The scope of the callback function */ selectPath: function(path, field, separator, callback, scope) { var me = this, root, keys, last; field = field || me.getRootNode().idProperty; separator = separator || '/'; keys = path.split(separator); last = keys.pop(); if (keys.length > 1) { me.expandPath(keys.join(separator), field, separator, function(success, node){ var lastNode = node; if (success && node) { node = node.findChild(field, last); if (node) { me.getSelectionModel().select(node); Ext.callback(callback, scope || me, [true, node]); return; } } Ext.callback(callback, scope || me, [false, lastNode]); }, me); } else { root = me.getRootNode(); if (root.getId() === last) { me.getSelectionModel().select(root); Ext.callback(callback, scope || me, [true, root]); } else { Ext.callback(callback, scope || me, [false, null]); } } } }); /** * @private */ Ext.define('Ext.view.DragZone', { extend: Ext.dd.DragZone , containerScroll: false, constructor: function(config) { var me = this, view, ownerCt, el; Ext.apply(me, config); // Create a ddGroup unless one has been configured. // User configuration of ddGroups allows users to specify which // DD instances can interact with each other. Using one // based on the id of the View would isolate it and mean it can only // interact with a DropZone on the same View also using a generated ID. if (!me.ddGroup) { me.ddGroup = 'view-dd-zone-' + me.view.id; } // Ext.dd.DragDrop instances are keyed by the ID of their encapsulating element. // So a View's DragZone cannot use the View's main element because the DropZone must use that // because the DropZone may need to scroll on hover at a scrolling boundary, and it is the View's // main element which handles scrolling. // We use the View's parent element to drag from. Ideally, we would use the internal structure, but that // is transient; DataView's recreate the internal structure dynamically as data changes. // TODO: Ext 5.0 DragDrop must allow multiple DD objects to share the same element. view = me.view; ownerCt = view.ownerCt; // We don't just grab the parent el, since the parent el may be // some el injected by the layout if (ownerCt) { el = ownerCt.getTargetEl().dom; } else { el = view.el.dom.parentNode; } me.callParent([el]); me.ddel = Ext.get(document.createElement('div')); me.ddel.addCls(Ext.baseCSSPrefix + 'grid-dd-wrap'); }, init: function(id, sGroup, config) { this.initTarget(id, sGroup, config); this.view.mon(this.view, { itemmousedown: this.onItemMouseDown, scope: this }); }, onValidDrop: function(target, e, id) { this.callParent(); // focus the view that the node was dropped onto so that keynav will be enabled. target.el.focus(); }, onItemMouseDown: function(view, record, item, index, e) { if (!this.isPreventDrag(e, record, item, index)) { // Since handleMouseDown prevents the default behavior of the event, which // is to focus the view, we focus the view now. This ensures that the view // remains focused if the drag is cancelled, or if no drag occurs. if (view.focusRow) { view.focusRow(record); } this.handleMouseDown(e); } }, // private template method isPreventDrag: function(e) { return false; }, getDragData: function(e) { var view = this.view, item = e.getTarget(view.getItemSelector()); if (item) { return { copy: view.copy || (view.allowCopy && e.ctrlKey), event: new Ext.EventObjectImpl(e), view: view, ddel: this.ddel, item: item, records: view.getSelectionModel().getSelection(), fromPosition: Ext.fly(item).getXY() }; } }, onInitDrag: function(x, y) { var me = this, data = me.dragData, view = data.view, selectionModel = view.getSelectionModel(), record = view.getRecord(data.item); // Update the selection to match what would have been selected if the user had // done a full click on the target node rather than starting a drag from it if (!selectionModel.isSelected(record)) { selectionModel.select(record, true); } data.records = selectionModel.getSelection(); me.ddel.update(me.getDragText()); me.proxy.update(me.ddel.dom); me.onStartDrag(x, y); return true; }, getDragText: function() { var count = this.dragData.records.length; return Ext.String.format(this.dragText, count, count == 1 ? '' : 's'); }, getRepairXY : function(e, data){ return data ? data.fromPosition : false; } }); /** * @private */ Ext.define('Ext.tree.ViewDragZone', { extend: Ext.view.DragZone , isPreventDrag: function(e, record) { return (record.get('allowDrag') === false) || !!e.getTarget(this.view.expanderSelector); }, getDragText: function() { var records = this.dragData.records, count = records.length, text = records[0].get(this.displayField), suffix = 's'; if (count === 1 && text) { return text; } else if (!text) { suffix = ''; } return Ext.String.format(this.dragText, count, suffix); }, afterRepair: function() { var me = this, view = me.view, selectedRowCls = view.selectedItemCls, records = me.dragData.records, r, rLen = records.length, fly = Ext.fly, item; if (Ext.enableFx && me.repairHighlight) { // Roll through all records and highlight all the ones we attempted to drag. for (r = 0; r < rLen; r++) { // anonymous fns below, don't hoist up unless below is wrapped in // a self-executing function passing in item. item = view.getNode(records[r]); // We must remove the selected row class before animating, because // the selected row class declares !important on its background-color. fly(item.firstChild).highlight(me.repairHighlightColor, { listeners: { beforeanimate: function() { if (view.isSelected(item)) { fly(item).removeCls(selectedRowCls); } }, afteranimate: function() { if (view.isSelected(item)) { fly(item).addCls(selectedRowCls); } } } }); } } me.dragging = false; } }); /** * @private */ Ext.define('Ext.tree.ViewDropZone', { extend: Ext.view.DropZone , /** * @cfg {Boolean} allowParentInserts * Allow inserting a dragged node between an expanded parent node and its first child that will become a * sibling of the parent when dropped. */ allowParentInserts: false, /** * @cfg {Boolean} allowContainerDrop * True if drops on the tree container (outside of a specific tree node) are allowed. */ allowContainerDrops: false, /** * @cfg {Boolean} appendOnly * True if the tree should only allow append drops (use for trees which are sorted). */ appendOnly: false, /** * @cfg {Number} expandDelay * The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node * over the target. */ expandDelay : 500, indicatorCls: Ext.baseCSSPrefix + 'tree-ddindicator', // @private expandNode : function(node) { var view = this.view; this.expandProcId = false; if (!node.isLeaf() && !node.isExpanded()) { view.expand(node); this.expandProcId = false; } }, // @private queueExpand : function(node) { this.expandProcId = Ext.Function.defer(this.expandNode, this.expandDelay, this, [node]); }, // @private cancelExpand : function() { if (this.expandProcId) { clearTimeout(this.expandProcId); this.expandProcId = false; } }, getPosition: function(e, node) { var view = this.view, record = view.getRecord(node), y = e.getPageY(), noAppend = record.isLeaf(), noBelow = false, region = Ext.fly(node).getRegion(), fragment; // If we are dragging on top of the root node of the tree, we always want to append. if (record.isRoot()) { return 'append'; } // Return 'append' if the node we are dragging on top of is not a leaf else return false. if (this.appendOnly) { return noAppend ? false : 'append'; } if (!this.allowParentInserts) { noBelow = record.hasChildNodes() && record.isExpanded(); } fragment = (region.bottom - region.top) / (noAppend ? 2 : 3); if (y >= region.top && y < (region.top + fragment)) { return 'before'; } else if (!noBelow && (noAppend || (y >= (region.bottom - fragment) && y <= region.bottom))) { return 'after'; } else { return 'append'; } }, isValidDropPoint : function(node, position, dragZone, e, data) { if (!node || !data.item) { return false; } var view = this.view, targetNode = view.getRecord(node), draggedRecords = data.records, dataLength = draggedRecords.length, ln = draggedRecords.length, i, record; // No drop position, or dragged records: invalid drop point if (!(targetNode && position && dataLength)) { return false; } // If the targetNode is within the folder we are dragging for (i = 0; i < ln; i++) { record = draggedRecords[i]; if (record.isNode && record.contains(targetNode)) { return false; } } // Respect the allowDrop field on Tree nodes if (position === 'append' && targetNode.get('allowDrop') === false) { return false; } else if (position != 'append' && targetNode.parentNode.get('allowDrop') === false) { return false; } // If the target record is in the dragged dataset, then invalid drop if (Ext.Array.contains(draggedRecords, targetNode)) { return false; } return view.fireEvent('nodedragover', targetNode, position, data, e) !== false; }, onNodeOver : function(node, dragZone, e, data) { var position = this.getPosition(e, node), returnCls = this.dropNotAllowed, view = this.view, targetNode = view.getRecord(node), indicator = this.getIndicator(), indicatorY = 0; // auto node expand check this.cancelExpand(); if (position == 'append' && !this.expandProcId && !Ext.Array.contains(data.records, targetNode) && !targetNode.isLeaf() && !targetNode.isExpanded()) { this.queueExpand(targetNode); } if (this.isValidDropPoint(node, position, dragZone, e, data)) { this.valid = true; this.currentPosition = position; this.overRecord = targetNode; indicator.setWidth(Ext.fly(node).getWidth()); indicatorY = Ext.fly(node).getY() - Ext.fly(view.el).getY() - 1; /* * In the code below we show the proxy again. The reason for doing this is showing the indicator will * call toFront, causing it to get a new z-index which can sometimes push the proxy behind it. We always * want the proxy to be above, so calling show on the proxy will call toFront and bring it forward. */ if (position == 'before') { returnCls = targetNode.isFirst() ? Ext.baseCSSPrefix + 'tree-drop-ok-above' : Ext.baseCSSPrefix + 'tree-drop-ok-between'; indicator.showAt(0, indicatorY); dragZone.proxy.show(); } else if (position == 'after') { returnCls = targetNode.isLast() ? Ext.baseCSSPrefix + 'tree-drop-ok-below' : Ext.baseCSSPrefix + 'tree-drop-ok-between'; indicatorY += Ext.fly(node).getHeight(); indicator.showAt(0, indicatorY); dragZone.proxy.show(); } else { returnCls = Ext.baseCSSPrefix + 'tree-drop-ok-append'; // @TODO: set a class on the parent folder node to be able to style it indicator.hide(); } } else { this.valid = false; } this.currentCls = returnCls; return returnCls; }, // The mouse is no longer over a tree node, so dropping is not valid onNodeOut : function(n, dd, e, data){ this.valid = false; this.getIndicator().hide(); }, onContainerOver : function(dd, e, data) { return e.getTarget('.' + this.indicatorCls) ? this.currentCls : this.dropNotAllowed; }, notifyOut: function() { this.callParent(arguments); this.cancelExpand(); }, handleNodeDrop : function(data, targetNode, position) { var me = this, targetView = me.view, parentNode = targetNode ? targetNode.parentNode : targetView.panel.getRootNode(), Model = targetView.getStore().treeStore.model, records, i, len, record, insertionMethod, argList, needTargetExpand, transferData; // If the copy flag is set, create a copy of the models if (data.copy) { records = data.records; data.records = []; for (i = 0, len = records.length; i < len; i++) { record = records[i]; if (record.isNode) { data.records.push(record.copy(undefined, true)); } else { // If it's not a node, make a node copy data.records.push(new Model(record.data, record.getId())); } } } // Cancel any pending expand operation me.cancelExpand(); // Grab a reference to the correct node insertion method. // Create an arg list array intended for the apply method of the // chosen node insertion method. // Ensure the target object for the method is referenced by 'targetNode' if (position == 'before') { insertionMethod = parentNode.insertBefore; argList = [null, targetNode]; targetNode = parentNode; } else if (position == 'after') { if (targetNode.nextSibling) { insertionMethod = parentNode.insertBefore; argList = [null, targetNode.nextSibling]; } else { insertionMethod = parentNode.appendChild; argList = [null]; } targetNode = parentNode; } else { if (!(targetNode.isExpanded() || targetNode.isLoading())) { needTargetExpand = true; } insertionMethod = targetNode.appendChild; argList = [null]; } // A function to transfer the data into the destination tree transferData = function() { var color, n; // Coalesce layouts caused by node removal, appending and sorting Ext.suspendLayouts(); targetView.getSelectionModel().clearSelections(); // Insert the records into the target node for (i = 0, len = data.records.length; i < len; i++) { record = data.records[i]; if (!record.isNode) { if (record.isModel) { record = new Model(record.data, record.getId()); } else { record = new Model(record); } data.records[i] = record; } argList[0] = record; insertionMethod.apply(targetNode, argList); } // If configured to sort on drop, do it according to the TreeStore's comparator if (me.sortOnDrop) { targetNode.sort(targetNode.getOwnerTree().store.generateComparator()); } Ext.resumeLayouts(true); // Kick off highlights after everything's been inserted, so they are // more in sync without insertion/render overhead. // Element.highlight can handle highlighting table nodes. if (Ext.enableFx && me.dropHighlight) { color = me.dropHighlightColor; for (i = 0; i < len; i++) { n = targetView.getNode(data.records[i]); if (n) { Ext.fly(n).highlight(color); } } } }; // If dropping right on an unexpanded node, transfer the data after it is expanded. if (needTargetExpand) { targetNode.expand(false, transferData); } // If the node is waiting for its children, we must transfer the data after the expansion. // The expand event does NOT signal UI expansion, it is the SIGNAL for UI expansion. // It's listened for by the NodeStore on the root node. Which means that listeners on the target // node get notified BEFORE UI expansion. So we need a delay. // TODO: Refactor NodeInterface.expand/collapse to notify its owning tree directly when it needs to expand/collapse. else if (targetNode.isLoading()) { targetNode.on({ expand: transferData, delay: 1, single: true }); } // Otherwise, call the data transfer function immediately else { transferData(); } } }); /** * This plugin provides drag and/or drop functionality for a TreeView. * * It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a * {@link Ext.tree.View TreeView} and loads the data object which is passed to a cooperating * {@link Ext.dd.DragZone DragZone}'s methods with the following properties: * * - copy : Boolean * * The value of the TreeView's `copy` property, or `true` if the TreeView was configured with `allowCopy: true` *and* * the control key was pressed when the drag operation was begun. * * - view : TreeView * * The source TreeView from which the drag originated. * * - ddel : HtmlElement * * The drag proxy element which moves with the mouse * * - item : HtmlElement * * The TreeView node upon which the mousedown event was registered. * * - records : Array * * An Array of {@link Ext.data.Model Models} representing the selected data being dragged from the source TreeView. * * It also creates a specialized instance of {@link Ext.dd.DropZone} which cooperates with other DropZones which are * members of the same ddGroup which processes such data objects. * * Adding this plugin to a view means that two new events may be fired from the client TreeView, {@link #beforedrop} and * {@link #drop}. * * Note that the plugin must be added to the tree view, not to the tree panel. For example using viewConfig: * * viewConfig: { * plugins: { ptype: 'treeviewdragdrop' } * } */ Ext.define('Ext.tree.plugin.TreeViewDragDrop', { extend: Ext.AbstractPlugin , alias: 'plugin.treeviewdragdrop', /** * @event beforedrop * * **This event is fired through the TreeView. Add listeners to the TreeView object** * * Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the TreeView. * * Returning `false` to this event signals that the drop gesture was invalid, and if the drag proxy will animate * back to the point from which the drag began. * * The dropHandlers parameter can be used to defer the processing of this event. For example to wait for the result of * a message box confirmation or an asynchronous server call. See the details of this property for more information. * * @example * view.on('beforedrop', function(node, data, overModel, dropPosition, dropHandlers) { * // Defer the handling * dropHandlers.wait = true; * Ext.MessageBox.confirm('Drop', 'Are you sure', function(btn){ * if (btn === 'yes') { * dropHandlers.processDrop(); * } else { * dropHandlers.cancelDrop(); * } * }); * }); * * Any other return value continues with the data transfer operation, unless the wait property is set. * * @param {HTMLElement} node The TreeView node **if any** over which the mouse was positioned. * * @param {Object} data The data object gathered at mousedown time by the cooperating * {@link Ext.dd.DragZone DragZone}'s {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following * properties: * @param {Boolean} data.copy The value of the TreeView's `copy` property, or `true` if the TreeView was configured with * `allowCopy: true` and the control key was pressed when the drag operation was begun * @param {Ext.tree.View} data.view The source TreeView from which the drag originated. * @param {HTMLElement} data.ddel The drag proxy element which moves with the mouse * @param {HTMLElement} data.item The TreeView node upon which the mousedown event was registered. * @param {Ext.data.Model[]} data.records An Array of {@link Ext.data.Model Model}s representing the selected data being * dragged from the source TreeView. * * @param {Ext.data.Model} overModel The Model over which the drop gesture took place. * * @param {String} dropPosition `"before"`, `"after"` or `"append"` depending on whether the mouse is above or below * the midline of the node, or the node is a branch node which accepts new child nodes. * * @param {Object} dropHandlers * This parameter allows the developer to control when the drop action takes place. It is useful if any asynchronous * processing needs to be completed before performing the drop. This object has the following properties: * * @param {Boolean} dropHandlers.wait Indicates whether the drop should be deferred. Set this property to true to defer the drop. * @param {Function} dropHandlers.processDrop A function to be called to complete the drop operation. * @param {Function} dropHandlers.cancelDrop A function to be called to cancel the drop operation. */ /** * @event drop * * **This event is fired through the TreeView. Add listeners to the TreeView object** Fired when a drop operation * has been completed and the data has been moved or copied. * * @param {HTMLElement} node The TreeView node **if any** over which the mouse was positioned. * * @param {Object} data The data object gathered at mousedown time by the cooperating * {@link Ext.dd.DragZone DragZone}'s {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following * properties: * @param {Boolean} data.copy The value of the TreeView's `copy` property, or `true` if the TreeView was configured with * `allowCopy: true` and the control key was pressed when the drag operation was begun * @param {Ext.tree.View} data.view The source TreeView from which the drag originated. * @param {HTMLElement} data.ddel The drag proxy element which moves with the mouse * @param {HTMLElement} data.item The TreeView node upon which the mousedown event was registered. * @param {Ext.data.Model[]} data.records An Array of {@link Ext.data.Model Model}s representing the selected data being * dragged from the source TreeView. * * @param {Ext.data.Model} overModel The Model over which the drop gesture took place. * * @param {String} dropPosition `"before"`, `"after"` or `"append"` depending on whether the mouse is above or below * the midline of the node, or the node is a branch node which accepts new child nodes. */ // /** * @cfg * The text to show while dragging. * * Two placeholders can be used in the text: * * - `{0}` The number of selected items. * - `{1}` 's' when more than 1 items (only useful for English). */ dragText : '{0} selected node{1}', // /** * @cfg {Boolean} allowParentInserts * Allow inserting a dragged node between an expanded parent node and its first child that will become a sibling of * the parent when dropped. */ allowParentInserts: false, /** * @cfg {Boolean} allowContainerDrops * True if drops on the tree container (outside of a specific tree node) are allowed. */ allowContainerDrops: false, /** * @cfg {Boolean} appendOnly * True if the tree should only allow append drops (use for trees which are sorted). */ appendOnly: false, /** * @cfg {String} ddGroup * A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and * DropZone used by this plugin will only interact with other drag drop objects in the same group. */ ddGroup : "TreeDD", /** * True to register this container with the Scrollmanager for auto scrolling during drag operations. * A {@link Ext.dd.ScrollManager} configuration may also be passed. * @cfg {Object/Boolean} containerScroll */ containerScroll: false, /** * @cfg {String} dragGroup * The ddGroup to which the DragZone will belong. * * This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other * Drag/DropZones which are members of the same ddGroup. */ /** * @cfg {String} dropGroup * The ddGroup to which the DropZone will belong. * * This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other * Drag/DropZones which are members of the same ddGroup. */ /** * @cfg {Boolean} [sortOnDrop=false] * Configure as `true` to sort the target node into the current tree sort order after the dropped node is added. */ /** * @cfg {Number} expandDelay * The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node over the * target. */ expandDelay : 1000, /** * @cfg {Boolean} enableDrop * Set to `false` to disallow the View from accepting drop gestures. */ enableDrop: true, /** * @cfg {Boolean} enableDrag * Set to `false` to disallow dragging items from the View. */ enableDrag: true, /** * @cfg {String} nodeHighlightColor * The color to use when visually highlighting the dragged or dropped node (default value is light blue). * The color must be a 6 digit hex value, without a preceding '#'. See also {@link #nodeHighlightOnDrop} and * {@link #nodeHighlightOnRepair}. */ nodeHighlightColor: 'c3daf9', /** * @cfg {Boolean} nodeHighlightOnDrop * Whether or not to highlight any nodes after they are * successfully dropped on their target. Defaults to the value of `Ext.enableFx`. * See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnRepair}. */ nodeHighlightOnDrop: Ext.enableFx, /** * @cfg {Boolean} nodeHighlightOnRepair * Whether or not to highlight any nodes after they are * repaired from an unsuccessful drag/drop. Defaults to the value of `Ext.enableFx`. * See also {@link #nodeHighlightColor} and {@link #nodeHighlightOnDrop}. */ nodeHighlightOnRepair: Ext.enableFx, /** * @cfg {String} displayField * The name of the model field that is used to display the text for the nodes */ displayField: 'text', init : function(view) { view.on('render', this.onViewRender, this, {single: true}); }, /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ destroy: function() { Ext.destroy(this.dragZone, this.dropZone); }, onViewRender : function(view) { var me = this, scrollEl; if (me.enableDrag) { if (me.containerScroll) { scrollEl = view.getEl(); } me.dragZone = new Ext.tree.ViewDragZone({ view: view, ddGroup: me.dragGroup || me.ddGroup, dragText: me.dragText, displayField: me.displayField, repairHighlightColor: me.nodeHighlightColor, repairHighlight: me.nodeHighlightOnRepair, scrollEl: scrollEl }); } if (me.enableDrop) { me.dropZone = new Ext.tree.ViewDropZone({ view: view, ddGroup: me.dropGroup || me.ddGroup, allowContainerDrops: me.allowContainerDrops, appendOnly: me.appendOnly, allowParentInserts: me.allowParentInserts, expandDelay: me.expandDelay, dropHighlightColor: me.nodeHighlightColor, dropHighlight: me.nodeHighlightOnDrop, sortOnDrop: me.sortOnDrop, containerScroll: me.containerScroll }); } } }, function(){ var proto = this.prototype; proto.nodeHighlightOnDrop = proto.nodeHighlightOnRepair = Ext.enableFx; }); /** * Utility class for setting/reading values from browser cookies. * Values can be written using the {@link #set} method. * Values can be read using the {@link #get} method. * A cookie can be invalidated on the client machine using the {@link #clear} method. */ Ext.define('Ext.util.Cookies', { singleton: true, /** * Creates a cookie with the specified name and value. Additional settings for the cookie may be optionally specified * (for example: expiration, access restriction, SSL). * @param {String} name The name of the cookie to set. * @param {Object} value The value to set for the cookie. * @param {Object} [expires] Specify an expiration date the cookie is to persist until. Note that the specified Date * object will be converted to Greenwich Mean Time (GMT). * @param {String} [path] Setting a path on the cookie restricts access to pages that match that path. Defaults to all * pages ('/'). * @param {String} [domain] Setting a domain restricts access to pages on a given domain (typically used to allow * cookie access across subdomains). For example, "sencha.com" will create a cookie that can be accessed from any * subdomain of sencha.com, including www.sencha.com, support.sencha.com, etc. * @param {Boolean} [secure] Specify true to indicate that the cookie should only be accessible via SSL on a page * using the HTTPS protocol. Defaults to false. Note that this will only work if the page calling this code uses the * HTTPS protocol, otherwise the cookie will be created with default options. */ set : function(name, value){ var argv = arguments, argc = arguments.length, expires = (argc > 2) ? argv[2] : null, path = (argc > 3) ? argv[3] : '/', domain = (argc > 4) ? argv[4] : null, secure = (argc > 5) ? argv[5] : false; document.cookie = name + "=" + escape(value) + ((expires === null) ? "" : ("; expires=" + expires.toGMTString())) + ((path === null) ? "" : ("; path=" + path)) + ((domain === null) ? "" : ("; domain=" + domain)) + ((secure === true) ? "; secure" : ""); }, /** * Retrieves cookies that are accessible by the current page. If a cookie does not exist, `get()` returns null. The * following example retrieves the cookie called "valid" and stores the String value in the variable validStatus. * * var validStatus = Ext.util.Cookies.get("valid"); * * @param {String} name The name of the cookie to get * @return {Object} Returns the cookie value for the specified name; * null if the cookie name does not exist. */ get : function(name){ var arg = name + "=", alen = arg.length, clen = document.cookie.length, i = 0, j = 0; while(i < clen){ j = i + alen; if(document.cookie.substring(i, j) == arg){ return this.getCookieVal(j); } i = document.cookie.indexOf(" ", i) + 1; if(i === 0){ break; } } return null; }, /** * Removes a cookie with the provided name from the browser * if found by setting its expiration date to sometime in the past. * @param {String} name The name of the cookie to remove * @param {String} [path] The path for the cookie. * This must be included if you included a path while setting the cookie. */ clear : function(name, path){ if(this.get(name)){ path = path || '/'; document.cookie = name + '=' + '; expires=Thu, 01-Jan-70 00:00:01 GMT; path=' + path; } }, /** * @private */ getCookieVal : function(offset){ var endstr = document.cookie.indexOf(";", offset); if(endstr == -1){ endstr = document.cookie.length; } return unescape(document.cookie.substring(offset, endstr)); } }); /** * @class Ext.util.Grouper Represents a single grouper that can be applied to a Store. The grouper works in the same fashion as the {@link Ext.util.Sorter}. * @markdown */ Ext.define('Ext.util.Grouper', { /* Begin Definitions */ extend: Ext.util.Sorter , /* End Definitions */ isGrouper: true, /** * Returns the value for grouping to be used. * @param {Ext.data.Model} instance The Model instance * @return {String} The group string for this model */ getGroupString: function(instance) { return instance.get(this.property); } }); /** * History management component that allows you to register arbitrary tokens that signify application * history state on navigation actions. You can then handle the history {@link #change} event in order * to reset your application UI to the appropriate state when the user navigates forward or backward through * the browser history stack. * * ## Initializing * * The {@link #init} method of the History object must be called before using History. This sets up the internal * state and must be the first thing called before using History. */ Ext.define('Ext.util.History', { singleton: true, alternateClassName: 'Ext.History', mixins: { observable: Ext.util.Observable }, /** * @property * True to use `window.top.location.hash` or false to use `window.location.hash`. */ useTopWindow: true, /** * @property * The id of the hidden field required for storing the current history token. */ fieldId: Ext.baseCSSPrefix + 'history-field', /** * @property * The id of the iframe required by IE to manage the history stack. */ iframeId: Ext.baseCSSPrefix + 'history-frame', constructor: function() { var me = this; me.oldIEMode = Ext.isIE7m || !Ext.isStrict && Ext.isIE8; me.iframe = null; me.hiddenField = null; me.ready = false; me.currentToken = null; me.mixins.observable.constructor.call(me); }, getHash: function() { var href = window.location.href, i = href.indexOf("#"); return i >= 0 ? href.substr(i + 1) : null; }, setHash: function (hash) { var me = this, win = me.useTopWindow ? window.top : window; try { win.location.hash = hash; } catch (e) { // IE can give Access Denied (esp. in popup windows) } }, doSave: function() { this.hiddenField.value = this.currentToken; }, handleStateChange: function(token) { this.currentToken = token; this.fireEvent('change', token); }, updateIFrame: function(token) { var html = '
    ' + Ext.util.Format.htmlEncode(token) + '
    ', doc; try { doc = this.iframe.contentWindow.document; doc.open(); doc.write(html); doc.close(); return true; } catch (e) { return false; } }, checkIFrame: function () { var me = this, contentWindow = me.iframe.contentWindow, doc, elem, oldToken, oldHash; if (!contentWindow || !contentWindow.document) { Ext.Function.defer(this.checkIFrame, 10, this); return; } doc = contentWindow.document; elem = doc.getElementById("state"); oldToken = elem ? elem.innerText : null; oldHash = me.getHash(); Ext.TaskManager.start({ run: function () { var doc = contentWindow.document, elem = doc.getElementById("state"), newToken = elem ? elem.innerText : null, newHash = me.getHash(); if (newToken !== oldToken) { oldToken = newToken; me.handleStateChange(newToken); me.setHash(newToken); oldHash = newToken; me.doSave(); } else if (newHash !== oldHash) { oldHash = newHash; me.updateIFrame(newHash); } }, interval: 50, scope: me }); me.ready = true; me.fireEvent('ready', me); }, startUp: function () { var me = this, hash; me.currentToken = me.hiddenField.value || this.getHash(); if (me.oldIEMode) { me.checkIFrame(); } else { hash = me.getHash(); Ext.TaskManager.start({ run: function () { var newHash = me.getHash(); if (newHash !== hash) { hash = newHash; me.handleStateChange(hash); me.doSave(); } }, interval: 50, scope: me }); me.ready = true; me.fireEvent('ready', me); } }, /** * Initializes the global History instance. * @param {Function} [onReady] A callback function that will be called once the history * component is fully initialized. * @param {Object} [scope] The scope (`this` reference) in which the callback is executed. * Defaults to the browser window. */ init: function (onReady, scope) { var me = this, DomHelper = Ext.DomHelper; if (me.ready) { Ext.callback(onReady, scope, [me]); return; } if (!Ext.isReady) { Ext.onReady(function() { me.init(onReady, scope); }); return; } /* */ me.hiddenField = Ext.getDom(me.fieldId); if (!me.hiddenField) { me.hiddenField = Ext.getBody().createChild({ id: Ext.id(), tag: 'form', cls: Ext.baseCSSPrefix + 'hide-display', children: [{ tag: 'input', type: 'hidden', id: me.fieldId }] }, false, true).firstChild; } if (me.oldIEMode) { me.iframe = Ext.getDom(me.iframeId); if (!me.iframe) { me.iframe = DomHelper.append(me.hiddenField.parentNode, { tag: 'iframe', id: me.iframeId, src: Ext.SSL_SECURE_URL }); } } me.addEvents( /** * @event ready * Fires when the Ext.util.History singleton has been initialized and is ready for use. * @param {Ext.util.History} The Ext.util.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) { me.on('ready', onReady, scope, {single: true}); } me.startUp(); }, /** * 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 specific history * state of that component. Example usage: * * // Handle tab changes on a TabPanel * tabPanel.on('tabchange', function(tabPanel, tab){ * Ext.History.add(tabPanel.id + ':' + tab.id); * }); * * @param {String} token The value that defines a particular application-specific history state * @param {Boolean} [preventDuplicates=true] When true, if the passed token matches the current token * it will not save a new history step. Set to false if the same state can be saved more than once * at the same history stack location. */ add: function (token, preventDup) { var me = this; if (preventDup !== false) { if (me.getToken() === token) { return true; } } if (me.oldIEMode) { return me.updateIFrame(token); } else { me.setHash(token); return true; } }, /** * Programmatically steps back one step in browser history (equivalent to the user pressing the Back button). */ back: function() { window.history.go(-1); }, /** * Programmatically steps forward one step in browser history (equivalent to the user pressing the Forward button). */ forward: function(){ window.history.go(1); }, /** * Retrieves the currently-active history token. * @return {String} The token */ getToken: function() { return this.ready ? this.currentToken : this.getHash(); } });